klaviyo-api-sdk 18.0.0 → 19.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +44 -0
- data/README.md +1525 -459
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -6
- data/lib/klaviyo-api-sdk/api/billing_api.rb +162 -0
- data/lib/klaviyo-api-sdk/api/brands_api.rb +1933 -0
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +3298 -653
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +265 -265
- data/lib/klaviyo-api-sdk/api/client_api.rb +9 -13
- data/lib/klaviyo-api-sdk/api/conversations_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +80 -80
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +120 -117
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/events_api.rb +39 -39
- data/lib/klaviyo-api-sdk/api/flows_api.rb +190 -113
- data/lib/klaviyo-api-sdk/api/forms_api.rb +292 -43
- data/lib/klaviyo-api-sdk/api/images_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api/lists_api.rb +64 -64
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +94 -94
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +163 -163
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +27 -27
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api/segments_api.rb +58 -58
- data/lib/klaviyo-api-sdk/api/tags_api.rb +62 -62
- data/lib/klaviyo-api-sdk/api/templates_api.rb +236 -76
- data/lib/klaviyo-api-sdk/api/text_messaging_api.rb +774 -0
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +11 -11
- data/lib/klaviyo-api-sdk/api/translations_api.rb +1102 -0
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +19 -19
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +27 -27
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{push_on_open_app.rb → ab_test_action_link_only.rb} +23 -9
- data/lib/klaviyo-api-sdk/models/{sms_message_definition_create.rb → ab_test_settings.rb} +36 -35
- data/lib/klaviyo-api-sdk/models/action_output_split_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/address.rb +295 -0
- data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/age_gate_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → animation.rb} +56 -44
- data/lib/klaviyo-api-sdk/models/api_schema_property.rb +2 -2
- data/lib/klaviyo-api-sdk/models/audience_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object.rb → audience_clone_query_resource_object.rb} +7 -7
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes.rb → audience_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{html_block_data_v0.rb → audience_create_query_resource_object_relationships.rb} +19 -24
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages.rb +220 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{audiences_update.rb → audience_definition.rb} +32 -10
- data/lib/klaviyo-api-sdk/models/audience_inline_create.rb +261 -0
- data/lib/klaviyo-api-sdk/models/audience_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/audience_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object_attributes.rb → audience_update_query_resource_object_attributes.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/border_styles.rb +297 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object_attributes.rb +298 -0
- data/lib/klaviyo-api-sdk/models/brand_button_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object_attributes.rb +275 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object_attributes.rb +233 -0
- data/lib/klaviyo-api-sdk/models/brand_color_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options.rb → brand_email_body_patch_attributes.rb} +68 -38
- data/lib/klaviyo-api-sdk/models/brand_email_default_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object.rb +261 -0
- data/lib/klaviyo-api-sdk/models/{audiences.rb → brand_email_default_partial_update_query_resource_object_attributes.rb} +25 -28
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships.rb +236 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_button.rb +218 -0
- data/lib/klaviyo-api-sdk/models/{content_repeat_v0.rb → brand_email_default_partial_update_query_resource_object_relationships_brand_button_data.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_social_group.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_rels_brand_social_group_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_email_footer_patch_attributes.rb +283 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_content_update.rb → brand_email_header_patch_attributes.rb} +36 -38
- data/lib/klaviyo-api-sdk/models/brand_library_button_styles.rb +262 -0
- data/lib/klaviyo-api-sdk/models/brand_library_text_styles.rb +368 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_options_badge.rb → brand_library_text_styles_letter_spacing.rb} +3 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object.rb → brand_logo_create_query_resource_object.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_attributes.rb +264 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships.rb → brand_logo_create_query_resource_object_relationships.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query.rb → brand_logo_partial_update_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object.rb +261 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object_attributes.rb +259 -0
- data/lib/klaviyo-api-sdk/models/brand_social_group_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object.rb → brand_social_group_create_query_resource_object.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/brand_social_group_create_query_resource_object_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_badge_badge_options.rb → brand_social_group_create_query_resource_object_attributes_social_links_inner.rb} +3 -5
- data/lib/klaviyo-api-sdk/models/brand_social_group_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query.rb → brand_social_group_partial_update_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query_resource_object.rb → brand_social_group_partial_update_query_resource_object.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/brand_social_group_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_descriptor.rb +248 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/button_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/button_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/button_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/campaign_audience_clone_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_audience_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +9 -9
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +30 -63
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships.rb +236 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{push_action_button_definition.rb → campaign_definition.rb} +56 -44
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_attributes.rb +298 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/{non_local_static_send.rb → campaign_message_schedule_update_query_resource_object_attributes.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +12 -48
- data/lib/klaviyo-api-sdk/models/campaign_schedule_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_variation_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/checkboxes_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{mobile_push_no_badge.rb → click_tracking_subscription_parameters.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{campaign_message_increment.rb → click_tracking_unsubscription_parameters.rb} +22 -21
- data/lib/klaviyo-api-sdk/models/close_button_style.rb +49 -4
- data/lib/klaviyo-api-sdk/models/{push_on_open_web_url.rb → code_action_link_only.rb} +17 -14
- data/lib/klaviyo-api-sdk/models/color.rb +237 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/consent_page_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/content_experiment_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{push_on_open_deep_link.rb → continue_with_shop.rb} +29 -22
- data/lib/klaviyo-api-sdk/models/{text_block_data_v0.rb → continue_with_shop_autofill.rb} +50 -37
- data/lib/klaviyo-api-sdk/models/continue_with_shop_phone_consent.rb +262 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_update.rb → continue_with_shop_properties.rb} +76 -59
- data/lib/klaviyo-api-sdk/models/continue_with_shop_styles.rb +298 -0
- data/lib/klaviyo-api-sdk/models/conversation_message_create_query_resource_object_attributes.rb +17 -4
- data/lib/klaviyo-api-sdk/models/countdown_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/countdown_timer_properties.rb +33 -1
- data/lib/klaviyo-api-sdk/models/{horizontal_rule_block_v0.rb → coupon_assigner_configuration.rb} +40 -48
- data/lib/klaviyo-api-sdk/models/coupon_block_data.rb +1 -5
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/coupon_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +11 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger_trigger_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger_trigger_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/{local_static_send.rb → custom_social_link.rb} +72 -31
- data/lib/klaviyo-api-sdk/models/customer_hub_block_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object.rb +5 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_attributes.rb +5 -1
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships.rb +5 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_create_job_create_query_resource_object.rb +5 -0
- data/lib/klaviyo-api-sdk/models/date_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/date_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/dropdown_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{mobile_push_badge.rb → dynamic_sms_image.rb} +29 -28
- data/lib/klaviyo-api-sdk/models/{email_content.rb → email_channel_details.rb} +97 -42
- data/lib/klaviyo-api-sdk/models/{push_send_options.rb → email_header_link.rb} +29 -14
- data/lib/klaviyo-api-sdk/models/email_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/email_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +13 -4
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +13 -4
- data/lib/klaviyo-api-sdk/models/enroll_form_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +5 -14
- data/lib/klaviyo-api-sdk/models/{smart_send_time_strategy.rb → first_party_social_link.rb} +30 -31
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes_definition.rb +126 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes.rb +245 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_campaign_messages.rb → flow_action_insert_query_resource_object_attributes_anchor_action.rb} +6 -8
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes_definition.rb +124 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow.rb +218 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_action_update_query_resource_object_attributes_definition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{mobile_push_options_on_open.rb → flow_sms_message_hierarchy_inner.rb} +3 -4
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +25 -5
- data/lib/klaviyo-api-sdk/models/{campaigns_sms_tracking_options.rb → flow_whats_app_with_ac.rb} +86 -16
- data/lib/klaviyo-api-sdk/models/form_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form.rb +218 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships_image.rb → form_unpublish_job_create_query_resource_object_relationships_form.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships_image_data.rb → form_unpublish_job_create_query_resource_object_relationships_form_data.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/html_text_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen_properties.rb +36 -4
- data/lib/klaviyo-api-sdk/models/{html_block_v0.rb → iaf_open_url.rb} +42 -34
- data/lib/klaviyo-api-sdk/models/{sms_content_create.rb → iaf_open_url_properties.rb} +12 -12
- data/lib/klaviyo-api-sdk/models/image_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/image_asset.rb +409 -0
- data/lib/klaviyo-api-sdk/models/image_block_styles.rb +11 -1
- data/lib/klaviyo-api-sdk/models/image_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{throttled_send_strategy.rb → inline_message_schedule.rb} +69 -55
- data/lib/klaviyo-api-sdk/models/input_style_overrides.rb +307 -0
- data/lib/klaviyo-api-sdk/models/internal_service_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/link_text_styles.rb +352 -0
- data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options_custom_tracking_params_inner.rb → link_text_styles_letter_spacing.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/list_update_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox.rb +291 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_properties.rb +372 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_styles.rb +283 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_static_count.rb → marketing_tracking_consent_configuration.rb} +31 -30
- data/lib/klaviyo-api-sdk/models/media_asset.rb +318 -0
- data/lib/klaviyo-api-sdk/models/media_asset_reference.rb +240 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object.rb +266 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_attributes.rb +236 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships.rb +237 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{static_send_strategy.rb → message_definition.rb} +52 -42
- data/lib/klaviyo-api-sdk/models/{text_block_v0.rb → message_hierarchy_rcs_item.rb} +56 -57
- data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item.rb +301 -0
- data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item_image.rb +105 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_tracking_options.rb → message_hierarchy_sms_item_media.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{block_display_options.rb → message_inline_create.rb} +64 -33
- data/lib/klaviyo-api-sdk/models/message_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object_attributes.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_send_options.rb +344 -0
- data/lib/klaviyo-api-sdk/models/message_tracking_options.rb +239 -0
- data/lib/klaviyo-api-sdk/models/{static_tracking_param.rb → multi_branch_split_action_link_only.rb} +15 -32
- data/lib/klaviyo-api-sdk/models/multi_branch_split_action_link_only_data.rb +225 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter_condition_groups_inner_conditions_inner.rb +4 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_link_only.rb +237 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/phone_number_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +15 -5
- data/lib/klaviyo-api-sdk/models/profile_has_custom_object_filter_filter.rb +2 -0
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +5 -1
- data/lib/klaviyo-api-sdk/models/profile_permissions_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/push_action_button_v0.rb +322 -0
- data/lib/klaviyo-api-sdk/models/{push_action_button.rb → push_action_button_v2.rb} +28 -8
- data/lib/klaviyo-api-sdk/models/push_channel_details.rb +512 -0
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -10
- data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/radio_buttons_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/rcs_card.rb +290 -0
- data/lib/klaviyo-api-sdk/models/rcs_card_image.rb +105 -0
- data/lib/klaviyo-api-sdk/models/rcs_card_video.rb +105 -0
- data/lib/klaviyo-api-sdk/models/{sms_send_options.rb → rcs_rich_content.rb} +36 -14
- data/lib/klaviyo-api-sdk/models/{spacer_block_v0.rb → rcs_suggestion.rb} +63 -34
- data/lib/klaviyo-api-sdk/models/review_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/review_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +2 -0
- data/lib/klaviyo-api-sdk/models/send_email_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_settings.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{image_block_v0.rb → send_whats_app_with_ac_action.rb} +35 -31
- data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_data.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/signup_counter_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/slim_image_reference.rb +242 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_update.rb → sms_channel_details.rb} +135 -34
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{render_options.rb → spacing_styles.rb} +48 -40
- data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/static_sms_image.rb +270 -0
- data/lib/klaviyo-api-sdk/models/target_date_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query.rb → template_preview_send_job_create_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_options.rb → template_preview_send_job_create_query_resource_object_relationships.rb} +21 -31
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile.rb +218 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template.rb +218 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_attrs_text_messaging_sender_registration.rb +224 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_create.rb → text_messaging_sender_create_query_resource_object_attributes.rb} +50 -68
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_attributes.rb +440 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender.rb +218 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{button_block_v0.rb → text_style_overrides.rb} +54 -53
- data/lib/klaviyo-api-sdk/models/text_style_overrides_font_family.rb +103 -0
- data/lib/klaviyo-api-sdk/models/text_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{campaign_message_property.rb → throttled_options.rb} +31 -32
- data/lib/klaviyo-api-sdk/models/time_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{email_send_options.rb → timezone_options.rb} +13 -13
- data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object_attributes.rb +440 -0
- data/lib/klaviyo-api-sdk/models/{immediate_send_strategy.rb → toll_free_sender_details.rb} +22 -21
- data/lib/klaviyo-api-sdk/models/translation_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_create.rb → translation_create_query_resource_object_attributes.rb} +54 -41
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships.rb +254 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/translation_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/translation_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_content_create.rb → translation_partial_update_query_resource_object_attributes.rb} +39 -41
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object_attributes.rb → universal_content_create_query_v1_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_strategy.rb → universal_content_create_query_v1_resource_object_attributes_definition.rb} +17 -6
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query_resource_object_attributes.rb → universal_content_partial_update_query_v1_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes_definition.rb → universal_content_partial_update_query_v1_resource_object_attributes_definition.rb} +18 -5
- data/lib/klaviyo-api-sdk/models/update_profile_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/variation_definition.rb +230 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_options.rb → variation_definition_details.rb} +6 -5
- data/lib/klaviyo-api-sdk/models/variation_inline_create.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/verified_badge_style.rb +266 -0
- data/lib/klaviyo-api-sdk/models/{email_message_definition.rb → whatsapp_channel_details.rb} +23 -25
- data/lib/klaviyo-api-sdk.rb +305 -78
- data/lib/klaviyo-api-sdk.rb.bak +306 -79
- metadata +315 -82
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +0 -107
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +0 -107
- data/lib/klaviyo-api-sdk/models/drop_shadow_block_v0.rb +0 -293
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +0 -349
- data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +0 -105
- data/lib/klaviyo-api-sdk/models/text_block_styles_v0.rb +0 -533
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +0 -109
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +0 -109
|
@@ -65,7 +65,7 @@ module KlaviyoAPI
|
|
|
65
65
|
# header parameters
|
|
66
66
|
header_params = opts[:header_params] || {}
|
|
67
67
|
# klaviyo api revision
|
|
68
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
68
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
69
69
|
# HTTP header 'Accept' (if needed)
|
|
70
70
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
71
71
|
# HTTP header 'Content-Type'
|
|
@@ -156,7 +156,7 @@ module KlaviyoAPI
|
|
|
156
156
|
# header parameters
|
|
157
157
|
header_params = opts[:header_params] || {}
|
|
158
158
|
# klaviyo api revision
|
|
159
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
159
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
160
160
|
# HTTP header 'Accept' (if needed)
|
|
161
161
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
162
162
|
# HTTP header 'Content-Type'
|
|
@@ -204,7 +204,7 @@ module KlaviyoAPI
|
|
|
204
204
|
# Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_categories.json)
|
|
205
205
|
# @param catalog_category_create_job_create_query [CatalogCategoryCreateJobCreateQuery]
|
|
206
206
|
# @param [Hash] opts the optional parameters
|
|
207
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
207
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
208
208
|
# @return [Hash<String, Object>]
|
|
209
209
|
def bulk_create_catalog_categories(catalog_category_create_job_create_query, opts = {})
|
|
210
210
|
data, _status_code, _headers = bulk_create_catalog_categories_with_http_info(catalog_category_create_job_create_query, opts)
|
|
@@ -221,7 +221,7 @@ module KlaviyoAPI
|
|
|
221
221
|
# Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_categories.json)
|
|
222
222
|
# @param catalog_category_create_job_create_query [CatalogCategoryCreateJobCreateQuery]
|
|
223
223
|
# @param [Hash] opts the optional parameters
|
|
224
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
224
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
225
225
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
226
226
|
def bulk_create_catalog_categories_with_http_info(catalog_category_create_job_create_query, opts = {})
|
|
227
227
|
if @api_client.config.debugging
|
|
@@ -245,7 +245,7 @@ module KlaviyoAPI
|
|
|
245
245
|
# header parameters
|
|
246
246
|
header_params = opts[:header_params] || {}
|
|
247
247
|
# klaviyo api revision
|
|
248
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
248
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
249
249
|
# HTTP header 'Accept' (if needed)
|
|
250
250
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
251
251
|
# HTTP header 'Content-Type'
|
|
@@ -293,7 +293,7 @@ module KlaviyoAPI
|
|
|
293
293
|
# Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_items.json)
|
|
294
294
|
# @param catalog_item_create_job_create_query [CatalogItemCreateJobCreateQuery]
|
|
295
295
|
# @param [Hash] opts the optional parameters
|
|
296
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
296
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
297
297
|
# @return [Hash<String, Object>]
|
|
298
298
|
def bulk_create_catalog_items(catalog_item_create_job_create_query, opts = {})
|
|
299
299
|
data, _status_code, _headers = bulk_create_catalog_items_with_http_info(catalog_item_create_job_create_query, opts)
|
|
@@ -310,7 +310,7 @@ module KlaviyoAPI
|
|
|
310
310
|
# Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_items.json)
|
|
311
311
|
# @param catalog_item_create_job_create_query [CatalogItemCreateJobCreateQuery]
|
|
312
312
|
# @param [Hash] opts the optional parameters
|
|
313
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
313
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
314
314
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
315
315
|
def bulk_create_catalog_items_with_http_info(catalog_item_create_job_create_query, opts = {})
|
|
316
316
|
if @api_client.config.debugging
|
|
@@ -334,7 +334,7 @@ module KlaviyoAPI
|
|
|
334
334
|
# header parameters
|
|
335
335
|
header_params = opts[:header_params] || {}
|
|
336
336
|
# klaviyo api revision
|
|
337
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
337
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
338
338
|
# HTTP header 'Accept' (if needed)
|
|
339
339
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
340
340
|
# HTTP header 'Content-Type'
|
|
@@ -382,7 +382,7 @@ module KlaviyoAPI
|
|
|
382
382
|
# Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_variants.json)
|
|
383
383
|
# @param catalog_variant_create_job_create_query [CatalogVariantCreateJobCreateQuery]
|
|
384
384
|
# @param [Hash] opts the optional parameters
|
|
385
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
385
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
386
386
|
# @return [Hash<String, Object>]
|
|
387
387
|
def bulk_create_catalog_variants(catalog_variant_create_job_create_query, opts = {})
|
|
388
388
|
data, _status_code, _headers = bulk_create_catalog_variants_with_http_info(catalog_variant_create_job_create_query, opts)
|
|
@@ -399,7 +399,7 @@ module KlaviyoAPI
|
|
|
399
399
|
# Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_variants.json)
|
|
400
400
|
# @param catalog_variant_create_job_create_query [CatalogVariantCreateJobCreateQuery]
|
|
401
401
|
# @param [Hash] opts the optional parameters
|
|
402
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
402
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
403
403
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
404
404
|
def bulk_create_catalog_variants_with_http_info(catalog_variant_create_job_create_query, opts = {})
|
|
405
405
|
if @api_client.config.debugging
|
|
@@ -423,7 +423,7 @@ module KlaviyoAPI
|
|
|
423
423
|
# header parameters
|
|
424
424
|
header_params = opts[:header_params] || {}
|
|
425
425
|
# klaviyo api revision
|
|
426
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
426
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
427
427
|
# HTTP header 'Accept' (if needed)
|
|
428
428
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
429
429
|
# HTTP header 'Content-Type'
|
|
@@ -471,7 +471,7 @@ module KlaviyoAPI
|
|
|
471
471
|
# Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_categories.json)
|
|
472
472
|
# @param catalog_category_delete_job_create_query [CatalogCategoryDeleteJobCreateQuery]
|
|
473
473
|
# @param [Hash] opts the optional parameters
|
|
474
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
474
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
475
475
|
# @return [Hash<String, Object>]
|
|
476
476
|
def bulk_delete_catalog_categories(catalog_category_delete_job_create_query, opts = {})
|
|
477
477
|
data, _status_code, _headers = bulk_delete_catalog_categories_with_http_info(catalog_category_delete_job_create_query, opts)
|
|
@@ -488,7 +488,7 @@ module KlaviyoAPI
|
|
|
488
488
|
# Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_categories.json)
|
|
489
489
|
# @param catalog_category_delete_job_create_query [CatalogCategoryDeleteJobCreateQuery]
|
|
490
490
|
# @param [Hash] opts the optional parameters
|
|
491
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
491
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
492
492
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
493
493
|
def bulk_delete_catalog_categories_with_http_info(catalog_category_delete_job_create_query, opts = {})
|
|
494
494
|
if @api_client.config.debugging
|
|
@@ -512,7 +512,7 @@ module KlaviyoAPI
|
|
|
512
512
|
# header parameters
|
|
513
513
|
header_params = opts[:header_params] || {}
|
|
514
514
|
# klaviyo api revision
|
|
515
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
515
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
516
516
|
# HTTP header 'Accept' (if needed)
|
|
517
517
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
518
518
|
# HTTP header 'Content-Type'
|
|
@@ -560,7 +560,7 @@ module KlaviyoAPI
|
|
|
560
560
|
# Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_items.json)
|
|
561
561
|
# @param catalog_item_delete_job_create_query [CatalogItemDeleteJobCreateQuery]
|
|
562
562
|
# @param [Hash] opts the optional parameters
|
|
563
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
563
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
564
564
|
# @return [Hash<String, Object>]
|
|
565
565
|
def bulk_delete_catalog_items(catalog_item_delete_job_create_query, opts = {})
|
|
566
566
|
data, _status_code, _headers = bulk_delete_catalog_items_with_http_info(catalog_item_delete_job_create_query, opts)
|
|
@@ -577,7 +577,7 @@ module KlaviyoAPI
|
|
|
577
577
|
# Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_items.json)
|
|
578
578
|
# @param catalog_item_delete_job_create_query [CatalogItemDeleteJobCreateQuery]
|
|
579
579
|
# @param [Hash] opts the optional parameters
|
|
580
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
580
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
581
581
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
582
582
|
def bulk_delete_catalog_items_with_http_info(catalog_item_delete_job_create_query, opts = {})
|
|
583
583
|
if @api_client.config.debugging
|
|
@@ -601,7 +601,7 @@ module KlaviyoAPI
|
|
|
601
601
|
# header parameters
|
|
602
602
|
header_params = opts[:header_params] || {}
|
|
603
603
|
# klaviyo api revision
|
|
604
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
604
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
605
605
|
# HTTP header 'Accept' (if needed)
|
|
606
606
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
607
607
|
# HTTP header 'Content-Type'
|
|
@@ -649,7 +649,7 @@ module KlaviyoAPI
|
|
|
649
649
|
# Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_variants.json)
|
|
650
650
|
# @param catalog_variant_delete_job_create_query [CatalogVariantDeleteJobCreateQuery]
|
|
651
651
|
# @param [Hash] opts the optional parameters
|
|
652
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
652
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
653
653
|
# @return [Hash<String, Object>]
|
|
654
654
|
def bulk_delete_catalog_variants(catalog_variant_delete_job_create_query, opts = {})
|
|
655
655
|
data, _status_code, _headers = bulk_delete_catalog_variants_with_http_info(catalog_variant_delete_job_create_query, opts)
|
|
@@ -666,7 +666,7 @@ module KlaviyoAPI
|
|
|
666
666
|
# Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_variants.json)
|
|
667
667
|
# @param catalog_variant_delete_job_create_query [CatalogVariantDeleteJobCreateQuery]
|
|
668
668
|
# @param [Hash] opts the optional parameters
|
|
669
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
669
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
670
670
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
671
671
|
def bulk_delete_catalog_variants_with_http_info(catalog_variant_delete_job_create_query, opts = {})
|
|
672
672
|
if @api_client.config.debugging
|
|
@@ -690,7 +690,7 @@ module KlaviyoAPI
|
|
|
690
690
|
# header parameters
|
|
691
691
|
header_params = opts[:header_params] || {}
|
|
692
692
|
# klaviyo api revision
|
|
693
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
693
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
694
694
|
# HTTP header 'Accept' (if needed)
|
|
695
695
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
696
696
|
# HTTP header 'Content-Type'
|
|
@@ -738,7 +738,7 @@ module KlaviyoAPI
|
|
|
738
738
|
# Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_categories.json)
|
|
739
739
|
# @param catalog_category_update_job_create_query [CatalogCategoryUpdateJobCreateQuery]
|
|
740
740
|
# @param [Hash] opts the optional parameters
|
|
741
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
741
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
742
742
|
# @return [Hash<String, Object>]
|
|
743
743
|
def bulk_update_catalog_categories(catalog_category_update_job_create_query, opts = {})
|
|
744
744
|
data, _status_code, _headers = bulk_update_catalog_categories_with_http_info(catalog_category_update_job_create_query, opts)
|
|
@@ -755,7 +755,7 @@ module KlaviyoAPI
|
|
|
755
755
|
# Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_categories.json)
|
|
756
756
|
# @param catalog_category_update_job_create_query [CatalogCategoryUpdateJobCreateQuery]
|
|
757
757
|
# @param [Hash] opts the optional parameters
|
|
758
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
758
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
759
759
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
760
760
|
def bulk_update_catalog_categories_with_http_info(catalog_category_update_job_create_query, opts = {})
|
|
761
761
|
if @api_client.config.debugging
|
|
@@ -779,7 +779,7 @@ module KlaviyoAPI
|
|
|
779
779
|
# header parameters
|
|
780
780
|
header_params = opts[:header_params] || {}
|
|
781
781
|
# klaviyo api revision
|
|
782
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
782
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
783
783
|
# HTTP header 'Accept' (if needed)
|
|
784
784
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
785
785
|
# HTTP header 'Content-Type'
|
|
@@ -827,7 +827,7 @@ module KlaviyoAPI
|
|
|
827
827
|
# Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_items.json)
|
|
828
828
|
# @param catalog_item_update_job_create_query [CatalogItemUpdateJobCreateQuery]
|
|
829
829
|
# @param [Hash] opts the optional parameters
|
|
830
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
830
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
831
831
|
# @return [Hash<String, Object>]
|
|
832
832
|
def bulk_update_catalog_items(catalog_item_update_job_create_query, opts = {})
|
|
833
833
|
data, _status_code, _headers = bulk_update_catalog_items_with_http_info(catalog_item_update_job_create_query, opts)
|
|
@@ -844,7 +844,7 @@ module KlaviyoAPI
|
|
|
844
844
|
# Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_items.json)
|
|
845
845
|
# @param catalog_item_update_job_create_query [CatalogItemUpdateJobCreateQuery]
|
|
846
846
|
# @param [Hash] opts the optional parameters
|
|
847
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
847
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
848
848
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
849
849
|
def bulk_update_catalog_items_with_http_info(catalog_item_update_job_create_query, opts = {})
|
|
850
850
|
if @api_client.config.debugging
|
|
@@ -868,7 +868,7 @@ module KlaviyoAPI
|
|
|
868
868
|
# header parameters
|
|
869
869
|
header_params = opts[:header_params] || {}
|
|
870
870
|
# klaviyo api revision
|
|
871
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
871
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
872
872
|
# HTTP header 'Accept' (if needed)
|
|
873
873
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
874
874
|
# HTTP header 'Content-Type'
|
|
@@ -916,7 +916,7 @@ module KlaviyoAPI
|
|
|
916
916
|
# Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_variants.json)
|
|
917
917
|
# @param catalog_variant_update_job_create_query [CatalogVariantUpdateJobCreateQuery]
|
|
918
918
|
# @param [Hash] opts the optional parameters
|
|
919
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
919
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
920
920
|
# @return [Hash<String, Object>]
|
|
921
921
|
def bulk_update_catalog_variants(catalog_variant_update_job_create_query, opts = {})
|
|
922
922
|
data, _status_code, _headers = bulk_update_catalog_variants_with_http_info(catalog_variant_update_job_create_query, opts)
|
|
@@ -933,7 +933,7 @@ module KlaviyoAPI
|
|
|
933
933
|
# Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_variants.json)
|
|
934
934
|
# @param catalog_variant_update_job_create_query [CatalogVariantUpdateJobCreateQuery]
|
|
935
935
|
# @param [Hash] opts the optional parameters
|
|
936
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
936
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
937
937
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
938
938
|
def bulk_update_catalog_variants_with_http_info(catalog_variant_update_job_create_query, opts = {})
|
|
939
939
|
if @api_client.config.debugging
|
|
@@ -957,7 +957,7 @@ module KlaviyoAPI
|
|
|
957
957
|
# header parameters
|
|
958
958
|
header_params = opts[:header_params] || {}
|
|
959
959
|
# klaviyo api revision
|
|
960
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
960
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
961
961
|
# HTTP header 'Accept' (if needed)
|
|
962
962
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
963
963
|
# HTTP header 'Content-Type'
|
|
@@ -1033,7 +1033,7 @@ module KlaviyoAPI
|
|
|
1033
1033
|
# header parameters
|
|
1034
1034
|
header_params = opts[:header_params] || {}
|
|
1035
1035
|
# klaviyo api revision
|
|
1036
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1036
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1037
1037
|
# HTTP header 'Accept' (if needed)
|
|
1038
1038
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1039
1039
|
# HTTP header 'Content-Type'
|
|
@@ -1075,7 +1075,7 @@ module KlaviyoAPI
|
|
|
1075
1075
|
# Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_category.json)
|
|
1076
1076
|
# @param catalog_category_create_query [CatalogCategoryCreateQuery]
|
|
1077
1077
|
# @param [Hash] opts the optional parameters
|
|
1078
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1078
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1079
1079
|
# @return [Hash<String, Object>]
|
|
1080
1080
|
def create_catalog_category(catalog_category_create_query, opts = {})
|
|
1081
1081
|
data, _status_code, _headers = create_catalog_category_with_http_info(catalog_category_create_query, opts)
|
|
@@ -1086,7 +1086,7 @@ module KlaviyoAPI
|
|
|
1086
1086
|
# Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_category.json)
|
|
1087
1087
|
# @param catalog_category_create_query [CatalogCategoryCreateQuery]
|
|
1088
1088
|
# @param [Hash] opts the optional parameters
|
|
1089
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1089
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1090
1090
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1091
1091
|
def create_catalog_category_with_http_info(catalog_category_create_query, opts = {})
|
|
1092
1092
|
if @api_client.config.debugging
|
|
@@ -1110,7 +1110,7 @@ module KlaviyoAPI
|
|
|
1110
1110
|
# header parameters
|
|
1111
1111
|
header_params = opts[:header_params] || {}
|
|
1112
1112
|
# klaviyo api revision
|
|
1113
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1113
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1114
1114
|
# HTTP header 'Accept' (if needed)
|
|
1115
1115
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1116
1116
|
# HTTP header 'Content-Type'
|
|
@@ -1152,7 +1152,7 @@ module KlaviyoAPI
|
|
|
1152
1152
|
# Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_item.json)
|
|
1153
1153
|
# @param catalog_item_create_query [CatalogItemCreateQuery]
|
|
1154
1154
|
# @param [Hash] opts the optional parameters
|
|
1155
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1155
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1156
1156
|
# @return [Hash<String, Object>]
|
|
1157
1157
|
def create_catalog_item(catalog_item_create_query, opts = {})
|
|
1158
1158
|
data, _status_code, _headers = create_catalog_item_with_http_info(catalog_item_create_query, opts)
|
|
@@ -1163,7 +1163,7 @@ module KlaviyoAPI
|
|
|
1163
1163
|
# Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_item.json)
|
|
1164
1164
|
# @param catalog_item_create_query [CatalogItemCreateQuery]
|
|
1165
1165
|
# @param [Hash] opts the optional parameters
|
|
1166
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1166
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1167
1167
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1168
1168
|
def create_catalog_item_with_http_info(catalog_item_create_query, opts = {})
|
|
1169
1169
|
if @api_client.config.debugging
|
|
@@ -1187,7 +1187,7 @@ module KlaviyoAPI
|
|
|
1187
1187
|
# header parameters
|
|
1188
1188
|
header_params = opts[:header_params] || {}
|
|
1189
1189
|
# klaviyo api revision
|
|
1190
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1190
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1191
1191
|
# HTTP header 'Accept' (if needed)
|
|
1192
1192
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1193
1193
|
# HTTP header 'Content-Type'
|
|
@@ -1229,7 +1229,7 @@ module KlaviyoAPI
|
|
|
1229
1229
|
# Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_variant.json)
|
|
1230
1230
|
# @param catalog_variant_create_query [CatalogVariantCreateQuery]
|
|
1231
1231
|
# @param [Hash] opts the optional parameters
|
|
1232
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1232
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1233
1233
|
# @return [Hash<String, Object>]
|
|
1234
1234
|
def create_catalog_variant(catalog_variant_create_query, opts = {})
|
|
1235
1235
|
data, _status_code, _headers = create_catalog_variant_with_http_info(catalog_variant_create_query, opts)
|
|
@@ -1240,7 +1240,7 @@ module KlaviyoAPI
|
|
|
1240
1240
|
# Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_variant.json)
|
|
1241
1241
|
# @param catalog_variant_create_query [CatalogVariantCreateQuery]
|
|
1242
1242
|
# @param [Hash] opts the optional parameters
|
|
1243
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1243
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1244
1244
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1245
1245
|
def create_catalog_variant_with_http_info(catalog_variant_create_query, opts = {})
|
|
1246
1246
|
if @api_client.config.debugging
|
|
@@ -1264,7 +1264,7 @@ module KlaviyoAPI
|
|
|
1264
1264
|
# header parameters
|
|
1265
1265
|
header_params = opts[:header_params] || {}
|
|
1266
1266
|
# klaviyo api revision
|
|
1267
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1267
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1268
1268
|
# HTTP header 'Accept' (if needed)
|
|
1269
1269
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1270
1270
|
# HTTP header 'Content-Type'
|
|
@@ -1334,7 +1334,7 @@ module KlaviyoAPI
|
|
|
1334
1334
|
# header parameters
|
|
1335
1335
|
header_params = opts[:header_params] || {}
|
|
1336
1336
|
# klaviyo api revision
|
|
1337
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1337
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1338
1338
|
# HTTP header 'Accept' (if needed)
|
|
1339
1339
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1340
1340
|
|
|
@@ -1399,7 +1399,7 @@ module KlaviyoAPI
|
|
|
1399
1399
|
# header parameters
|
|
1400
1400
|
header_params = opts[:header_params] || {}
|
|
1401
1401
|
# klaviyo api revision
|
|
1402
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1402
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1403
1403
|
# HTTP header 'Accept' (if needed)
|
|
1404
1404
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1405
1405
|
|
|
@@ -1464,7 +1464,7 @@ module KlaviyoAPI
|
|
|
1464
1464
|
# header parameters
|
|
1465
1465
|
header_params = opts[:header_params] || {}
|
|
1466
1466
|
# klaviyo api revision
|
|
1467
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1467
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1468
1468
|
# HTTP header 'Accept' (if needed)
|
|
1469
1469
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1470
1470
|
|
|
@@ -1501,9 +1501,9 @@ module KlaviyoAPI
|
|
|
1501
1501
|
# 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: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_catalog_items_job.json)
|
|
1502
1502
|
# @param job_id [String] ID of the job to retrieve.
|
|
1503
1503
|
# @param [Hash] opts the optional parameters
|
|
1504
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1505
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1506
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1504
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1505
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1506
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
1507
1507
|
# @return [Hash<String, Object>]
|
|
1508
1508
|
def get_bulk_create_catalog_items_job(job_id, opts = {})
|
|
1509
1509
|
data, _status_code, _headers = get_bulk_create_catalog_items_job_with_http_info(job_id, opts)
|
|
@@ -1520,9 +1520,9 @@ module KlaviyoAPI
|
|
|
1520
1520
|
# 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: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_catalog_items_job.json)
|
|
1521
1521
|
# @param job_id [String] ID of the job to retrieve.
|
|
1522
1522
|
# @param [Hash] opts the optional parameters
|
|
1523
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1524
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1525
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1523
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1524
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1525
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
1526
1526
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1527
1527
|
def get_bulk_create_catalog_items_job_with_http_info(job_id, opts = {})
|
|
1528
1528
|
if @api_client.config.debugging
|
|
@@ -1556,7 +1556,7 @@ module KlaviyoAPI
|
|
|
1556
1556
|
# header parameters
|
|
1557
1557
|
header_params = opts[:header_params] || {}
|
|
1558
1558
|
# klaviyo api revision
|
|
1559
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1559
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1560
1560
|
# HTTP header 'Accept' (if needed)
|
|
1561
1561
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1562
1562
|
|
|
@@ -1598,9 +1598,9 @@ module KlaviyoAPI
|
|
|
1598
1598
|
# Get Bulk Create Catalog Items Jobs
|
|
1599
1599
|
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_catalog_items_jobs.json)
|
|
1600
1600
|
# @param [Hash] opts the optional parameters
|
|
1601
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1602
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1603
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1601
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1602
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
1603
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1604
1604
|
# @return [Hash<String, Object>]
|
|
1605
1605
|
def get_bulk_create_catalog_items_jobs(opts = {})
|
|
1606
1606
|
data, _status_code, _headers = get_bulk_create_catalog_items_jobs_with_http_info(opts)
|
|
@@ -1616,9 +1616,9 @@ module KlaviyoAPI
|
|
|
1616
1616
|
# Get Bulk Create Catalog Items Jobs
|
|
1617
1617
|
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_catalog_items_jobs.json)
|
|
1618
1618
|
# @param [Hash] opts the optional parameters
|
|
1619
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1620
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1621
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1619
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1620
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
1621
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1622
1622
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1623
1623
|
def get_bulk_create_catalog_items_jobs_with_http_info(opts = {})
|
|
1624
1624
|
if @api_client.config.debugging
|
|
@@ -1640,7 +1640,7 @@ module KlaviyoAPI
|
|
|
1640
1640
|
# header parameters
|
|
1641
1641
|
header_params = opts[:header_params] || {}
|
|
1642
1642
|
# klaviyo api revision
|
|
1643
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1643
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1644
1644
|
# HTTP header 'Accept' (if needed)
|
|
1645
1645
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1646
1646
|
|
|
@@ -1683,9 +1683,9 @@ module KlaviyoAPI
|
|
|
1683
1683
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_categories_job.json)
|
|
1684
1684
|
# @param job_id [String] ID of the job to retrieve.
|
|
1685
1685
|
# @param [Hash] opts the optional parameters
|
|
1686
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1687
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1688
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1686
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1687
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1688
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
1689
1689
|
# @return [Hash<String, Object>]
|
|
1690
1690
|
def get_bulk_create_categories_job(job_id, opts = {})
|
|
1691
1691
|
data, _status_code, _headers = get_bulk_create_categories_job_with_http_info(job_id, opts)
|
|
@@ -1702,9 +1702,9 @@ module KlaviyoAPI
|
|
|
1702
1702
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_categories_job.json)
|
|
1703
1703
|
# @param job_id [String] ID of the job to retrieve.
|
|
1704
1704
|
# @param [Hash] opts the optional parameters
|
|
1705
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1706
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1707
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1705
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1706
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1707
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
1708
1708
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1709
1709
|
def get_bulk_create_categories_job_with_http_info(job_id, opts = {})
|
|
1710
1710
|
if @api_client.config.debugging
|
|
@@ -1738,7 +1738,7 @@ module KlaviyoAPI
|
|
|
1738
1738
|
# header parameters
|
|
1739
1739
|
header_params = opts[:header_params] || {}
|
|
1740
1740
|
# klaviyo api revision
|
|
1741
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1741
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1742
1742
|
# HTTP header 'Accept' (if needed)
|
|
1743
1743
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1744
1744
|
|
|
@@ -1780,9 +1780,9 @@ module KlaviyoAPI
|
|
|
1780
1780
|
# Get Bulk Create Categories Jobs
|
|
1781
1781
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_categories_jobs.json)
|
|
1782
1782
|
# @param [Hash] opts the optional parameters
|
|
1783
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1784
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1785
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1783
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1784
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
1785
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1786
1786
|
# @return [Hash<String, Object>]
|
|
1787
1787
|
def get_bulk_create_categories_jobs(opts = {})
|
|
1788
1788
|
data, _status_code, _headers = get_bulk_create_categories_jobs_with_http_info(opts)
|
|
@@ -1798,9 +1798,9 @@ module KlaviyoAPI
|
|
|
1798
1798
|
# Get Bulk Create Categories Jobs
|
|
1799
1799
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_categories_jobs.json)
|
|
1800
1800
|
# @param [Hash] opts the optional parameters
|
|
1801
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1802
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1803
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1801
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1802
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
1803
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1804
1804
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1805
1805
|
def get_bulk_create_categories_jobs_with_http_info(opts = {})
|
|
1806
1806
|
if @api_client.config.debugging
|
|
@@ -1822,7 +1822,7 @@ module KlaviyoAPI
|
|
|
1822
1822
|
# header parameters
|
|
1823
1823
|
header_params = opts[:header_params] || {}
|
|
1824
1824
|
# klaviyo api revision
|
|
1825
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1825
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1826
1826
|
# HTTP header 'Accept' (if needed)
|
|
1827
1827
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1828
1828
|
|
|
@@ -1865,9 +1865,9 @@ module KlaviyoAPI
|
|
|
1865
1865
|
# 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: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_variants_job.json)
|
|
1866
1866
|
# @param job_id [String] ID of the job to retrieve.
|
|
1867
1867
|
# @param [Hash] opts the optional parameters
|
|
1868
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1869
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1870
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1868
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1869
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1870
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
1871
1871
|
# @return [Hash<String, Object>]
|
|
1872
1872
|
def get_bulk_create_variants_job(job_id, opts = {})
|
|
1873
1873
|
data, _status_code, _headers = get_bulk_create_variants_job_with_http_info(job_id, opts)
|
|
@@ -1884,9 +1884,9 @@ module KlaviyoAPI
|
|
|
1884
1884
|
# 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: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_variants_job.json)
|
|
1885
1885
|
# @param job_id [String] ID of the job to retrieve.
|
|
1886
1886
|
# @param [Hash] opts the optional parameters
|
|
1887
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1888
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1889
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1887
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1888
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1889
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
1890
1890
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1891
1891
|
def get_bulk_create_variants_job_with_http_info(job_id, opts = {})
|
|
1892
1892
|
if @api_client.config.debugging
|
|
@@ -1920,7 +1920,7 @@ module KlaviyoAPI
|
|
|
1920
1920
|
# header parameters
|
|
1921
1921
|
header_params = opts[:header_params] || {}
|
|
1922
1922
|
# klaviyo api revision
|
|
1923
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1923
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1924
1924
|
# HTTP header 'Accept' (if needed)
|
|
1925
1925
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1926
1926
|
|
|
@@ -1962,9 +1962,9 @@ module KlaviyoAPI
|
|
|
1962
1962
|
# Get Bulk Create Variants Jobs
|
|
1963
1963
|
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_variants_jobs.json)
|
|
1964
1964
|
# @param [Hash] opts the optional parameters
|
|
1965
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1966
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1967
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1965
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1966
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
1967
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1968
1968
|
# @return [Hash<String, Object>]
|
|
1969
1969
|
def get_bulk_create_variants_jobs(opts = {})
|
|
1970
1970
|
data, _status_code, _headers = get_bulk_create_variants_jobs_with_http_info(opts)
|
|
@@ -1980,9 +1980,9 @@ module KlaviyoAPI
|
|
|
1980
1980
|
# Get Bulk Create Variants Jobs
|
|
1981
1981
|
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_variants_jobs.json)
|
|
1982
1982
|
# @param [Hash] opts the optional parameters
|
|
1983
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1984
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1985
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1983
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1984
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
1985
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1986
1986
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1987
1987
|
def get_bulk_create_variants_jobs_with_http_info(opts = {})
|
|
1988
1988
|
if @api_client.config.debugging
|
|
@@ -2004,7 +2004,7 @@ module KlaviyoAPI
|
|
|
2004
2004
|
# header parameters
|
|
2005
2005
|
header_params = opts[:header_params] || {}
|
|
2006
2006
|
# klaviyo api revision
|
|
2007
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2007
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2008
2008
|
# HTTP header 'Accept' (if needed)
|
|
2009
2009
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2010
2010
|
|
|
@@ -2047,7 +2047,7 @@ module KlaviyoAPI
|
|
|
2047
2047
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_catalog_items_job.json)
|
|
2048
2048
|
# @param job_id [String] ID of the job to retrieve.
|
|
2049
2049
|
# @param [Hash] opts the optional parameters
|
|
2050
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2050
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2051
2051
|
# @return [Hash<String, Object>]
|
|
2052
2052
|
def get_bulk_delete_catalog_items_job(job_id, opts = {})
|
|
2053
2053
|
data, _status_code, _headers = get_bulk_delete_catalog_items_job_with_http_info(job_id, opts)
|
|
@@ -2064,7 +2064,7 @@ module KlaviyoAPI
|
|
|
2064
2064
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_catalog_items_job.json)
|
|
2065
2065
|
# @param job_id [String] ID of the job to retrieve.
|
|
2066
2066
|
# @param [Hash] opts the optional parameters
|
|
2067
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2067
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2068
2068
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2069
2069
|
def get_bulk_delete_catalog_items_job_with_http_info(job_id, opts = {})
|
|
2070
2070
|
if @api_client.config.debugging
|
|
@@ -2088,7 +2088,7 @@ module KlaviyoAPI
|
|
|
2088
2088
|
# header parameters
|
|
2089
2089
|
header_params = opts[:header_params] || {}
|
|
2090
2090
|
# klaviyo api revision
|
|
2091
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2091
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2092
2092
|
# HTTP header 'Accept' (if needed)
|
|
2093
2093
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2094
2094
|
|
|
@@ -2130,9 +2130,9 @@ module KlaviyoAPI
|
|
|
2130
2130
|
# Get Bulk Delete Catalog Items Jobs
|
|
2131
2131
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_catalog_items_jobs.json)
|
|
2132
2132
|
# @param [Hash] opts the optional parameters
|
|
2133
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2134
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2135
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2133
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2134
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
2135
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
2136
2136
|
# @return [Hash<String, Object>]
|
|
2137
2137
|
def get_bulk_delete_catalog_items_jobs(opts = {})
|
|
2138
2138
|
data, _status_code, _headers = get_bulk_delete_catalog_items_jobs_with_http_info(opts)
|
|
@@ -2148,9 +2148,9 @@ module KlaviyoAPI
|
|
|
2148
2148
|
# Get Bulk Delete Catalog Items Jobs
|
|
2149
2149
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_catalog_items_jobs.json)
|
|
2150
2150
|
# @param [Hash] opts the optional parameters
|
|
2151
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2152
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2153
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2151
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2152
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
2153
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
2154
2154
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2155
2155
|
def get_bulk_delete_catalog_items_jobs_with_http_info(opts = {})
|
|
2156
2156
|
if @api_client.config.debugging
|
|
@@ -2172,7 +2172,7 @@ module KlaviyoAPI
|
|
|
2172
2172
|
# header parameters
|
|
2173
2173
|
header_params = opts[:header_params] || {}
|
|
2174
2174
|
# klaviyo api revision
|
|
2175
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2175
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2176
2176
|
# HTTP header 'Accept' (if needed)
|
|
2177
2177
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2178
2178
|
|
|
@@ -2215,7 +2215,7 @@ module KlaviyoAPI
|
|
|
2215
2215
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_categories_job.json)
|
|
2216
2216
|
# @param job_id [String] ID of the job to retrieve.
|
|
2217
2217
|
# @param [Hash] opts the optional parameters
|
|
2218
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2218
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2219
2219
|
# @return [Hash<String, Object>]
|
|
2220
2220
|
def get_bulk_delete_categories_job(job_id, opts = {})
|
|
2221
2221
|
data, _status_code, _headers = get_bulk_delete_categories_job_with_http_info(job_id, opts)
|
|
@@ -2232,7 +2232,7 @@ module KlaviyoAPI
|
|
|
2232
2232
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_categories_job.json)
|
|
2233
2233
|
# @param job_id [String] ID of the job to retrieve.
|
|
2234
2234
|
# @param [Hash] opts the optional parameters
|
|
2235
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2235
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2236
2236
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2237
2237
|
def get_bulk_delete_categories_job_with_http_info(job_id, opts = {})
|
|
2238
2238
|
if @api_client.config.debugging
|
|
@@ -2256,7 +2256,7 @@ module KlaviyoAPI
|
|
|
2256
2256
|
# header parameters
|
|
2257
2257
|
header_params = opts[:header_params] || {}
|
|
2258
2258
|
# klaviyo api revision
|
|
2259
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2259
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2260
2260
|
# HTTP header 'Accept' (if needed)
|
|
2261
2261
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2262
2262
|
|
|
@@ -2298,9 +2298,9 @@ module KlaviyoAPI
|
|
|
2298
2298
|
# Get Bulk Delete Categories Jobs
|
|
2299
2299
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_categories_jobs.json)
|
|
2300
2300
|
# @param [Hash] opts the optional parameters
|
|
2301
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2302
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2303
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2301
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2302
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
2303
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
2304
2304
|
# @return [Hash<String, Object>]
|
|
2305
2305
|
def get_bulk_delete_categories_jobs(opts = {})
|
|
2306
2306
|
data, _status_code, _headers = get_bulk_delete_categories_jobs_with_http_info(opts)
|
|
@@ -2316,9 +2316,9 @@ module KlaviyoAPI
|
|
|
2316
2316
|
# Get Bulk Delete Categories Jobs
|
|
2317
2317
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_categories_jobs.json)
|
|
2318
2318
|
# @param [Hash] opts the optional parameters
|
|
2319
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2320
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2321
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2319
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2320
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
2321
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
2322
2322
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2323
2323
|
def get_bulk_delete_categories_jobs_with_http_info(opts = {})
|
|
2324
2324
|
if @api_client.config.debugging
|
|
@@ -2340,7 +2340,7 @@ module KlaviyoAPI
|
|
|
2340
2340
|
# header parameters
|
|
2341
2341
|
header_params = opts[:header_params] || {}
|
|
2342
2342
|
# klaviyo api revision
|
|
2343
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2343
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2344
2344
|
# HTTP header 'Accept' (if needed)
|
|
2345
2345
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2346
2346
|
|
|
@@ -2383,7 +2383,7 @@ module KlaviyoAPI
|
|
|
2383
2383
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_variants_job.json)
|
|
2384
2384
|
# @param job_id [String] ID of the job to retrieve.
|
|
2385
2385
|
# @param [Hash] opts the optional parameters
|
|
2386
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2386
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2387
2387
|
# @return [Hash<String, Object>]
|
|
2388
2388
|
def get_bulk_delete_variants_job(job_id, opts = {})
|
|
2389
2389
|
data, _status_code, _headers = get_bulk_delete_variants_job_with_http_info(job_id, opts)
|
|
@@ -2400,7 +2400,7 @@ module KlaviyoAPI
|
|
|
2400
2400
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_variants_job.json)
|
|
2401
2401
|
# @param job_id [String] ID of the job to retrieve.
|
|
2402
2402
|
# @param [Hash] opts the optional parameters
|
|
2403
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2403
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2404
2404
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2405
2405
|
def get_bulk_delete_variants_job_with_http_info(job_id, opts = {})
|
|
2406
2406
|
if @api_client.config.debugging
|
|
@@ -2424,7 +2424,7 @@ module KlaviyoAPI
|
|
|
2424
2424
|
# header parameters
|
|
2425
2425
|
header_params = opts[:header_params] || {}
|
|
2426
2426
|
# klaviyo api revision
|
|
2427
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2427
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2428
2428
|
# HTTP header 'Accept' (if needed)
|
|
2429
2429
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2430
2430
|
|
|
@@ -2466,9 +2466,9 @@ module KlaviyoAPI
|
|
|
2466
2466
|
# Get Bulk Delete Variants Jobs
|
|
2467
2467
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_variants_jobs.json)
|
|
2468
2468
|
# @param [Hash] opts the optional parameters
|
|
2469
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2470
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2471
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2469
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2470
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
2471
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
2472
2472
|
# @return [Hash<String, Object>]
|
|
2473
2473
|
def get_bulk_delete_variants_jobs(opts = {})
|
|
2474
2474
|
data, _status_code, _headers = get_bulk_delete_variants_jobs_with_http_info(opts)
|
|
@@ -2484,9 +2484,9 @@ module KlaviyoAPI
|
|
|
2484
2484
|
# Get Bulk Delete Variants Jobs
|
|
2485
2485
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_variants_jobs.json)
|
|
2486
2486
|
# @param [Hash] opts the optional parameters
|
|
2487
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2488
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2489
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2487
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2488
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
2489
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
2490
2490
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2491
2491
|
def get_bulk_delete_variants_jobs_with_http_info(opts = {})
|
|
2492
2492
|
if @api_client.config.debugging
|
|
@@ -2508,7 +2508,7 @@ module KlaviyoAPI
|
|
|
2508
2508
|
# header parameters
|
|
2509
2509
|
header_params = opts[:header_params] || {}
|
|
2510
2510
|
# klaviyo api revision
|
|
2511
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2511
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2512
2512
|
# HTTP header 'Accept' (if needed)
|
|
2513
2513
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2514
2514
|
|
|
@@ -2551,9 +2551,9 @@ module KlaviyoAPI
|
|
|
2551
2551
|
# 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: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_catalog_items_job.json)
|
|
2552
2552
|
# @param job_id [String] ID of the job to retrieve.
|
|
2553
2553
|
# @param [Hash] opts the optional parameters
|
|
2554
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2555
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2556
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2554
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2555
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2556
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
2557
2557
|
# @return [Hash<String, Object>]
|
|
2558
2558
|
def get_bulk_update_catalog_items_job(job_id, opts = {})
|
|
2559
2559
|
data, _status_code, _headers = get_bulk_update_catalog_items_job_with_http_info(job_id, opts)
|
|
@@ -2570,9 +2570,9 @@ module KlaviyoAPI
|
|
|
2570
2570
|
# 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: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_catalog_items_job.json)
|
|
2571
2571
|
# @param job_id [String] ID of the job to retrieve.
|
|
2572
2572
|
# @param [Hash] opts the optional parameters
|
|
2573
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2574
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2575
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2573
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2574
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2575
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
2576
2576
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2577
2577
|
def get_bulk_update_catalog_items_job_with_http_info(job_id, opts = {})
|
|
2578
2578
|
if @api_client.config.debugging
|
|
@@ -2606,7 +2606,7 @@ module KlaviyoAPI
|
|
|
2606
2606
|
# header parameters
|
|
2607
2607
|
header_params = opts[:header_params] || {}
|
|
2608
2608
|
# klaviyo api revision
|
|
2609
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2609
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2610
2610
|
# HTTP header 'Accept' (if needed)
|
|
2611
2611
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2612
2612
|
|
|
@@ -2648,9 +2648,9 @@ module KlaviyoAPI
|
|
|
2648
2648
|
# Get Bulk Update Catalog Items Jobs
|
|
2649
2649
|
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_catalog_items_jobs.json)
|
|
2650
2650
|
# @param [Hash] opts the optional parameters
|
|
2651
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2652
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2653
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2651
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2652
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
2653
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
2654
2654
|
# @return [Hash<String, Object>]
|
|
2655
2655
|
def get_bulk_update_catalog_items_jobs(opts = {})
|
|
2656
2656
|
data, _status_code, _headers = get_bulk_update_catalog_items_jobs_with_http_info(opts)
|
|
@@ -2666,9 +2666,9 @@ module KlaviyoAPI
|
|
|
2666
2666
|
# Get Bulk Update Catalog Items Jobs
|
|
2667
2667
|
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_catalog_items_jobs.json)
|
|
2668
2668
|
# @param [Hash] opts the optional parameters
|
|
2669
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2670
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2671
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2669
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2670
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
2671
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
2672
2672
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2673
2673
|
def get_bulk_update_catalog_items_jobs_with_http_info(opts = {})
|
|
2674
2674
|
if @api_client.config.debugging
|
|
@@ -2690,7 +2690,7 @@ module KlaviyoAPI
|
|
|
2690
2690
|
# header parameters
|
|
2691
2691
|
header_params = opts[:header_params] || {}
|
|
2692
2692
|
# klaviyo api revision
|
|
2693
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2693
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2694
2694
|
# HTTP header 'Accept' (if needed)
|
|
2695
2695
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2696
2696
|
|
|
@@ -2733,9 +2733,9 @@ module KlaviyoAPI
|
|
|
2733
2733
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_categories_job.json)
|
|
2734
2734
|
# @param job_id [String] ID of the job to retrieve.
|
|
2735
2735
|
# @param [Hash] opts the optional parameters
|
|
2736
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2737
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2738
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2736
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2737
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2738
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
2739
2739
|
# @return [Hash<String, Object>]
|
|
2740
2740
|
def get_bulk_update_categories_job(job_id, opts = {})
|
|
2741
2741
|
data, _status_code, _headers = get_bulk_update_categories_job_with_http_info(job_id, opts)
|
|
@@ -2752,9 +2752,9 @@ module KlaviyoAPI
|
|
|
2752
2752
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_categories_job.json)
|
|
2753
2753
|
# @param job_id [String] ID of the job to retrieve.
|
|
2754
2754
|
# @param [Hash] opts the optional parameters
|
|
2755
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2756
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2757
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2755
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2756
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2757
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
2758
2758
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2759
2759
|
def get_bulk_update_categories_job_with_http_info(job_id, opts = {})
|
|
2760
2760
|
if @api_client.config.debugging
|
|
@@ -2788,7 +2788,7 @@ module KlaviyoAPI
|
|
|
2788
2788
|
# header parameters
|
|
2789
2789
|
header_params = opts[:header_params] || {}
|
|
2790
2790
|
# klaviyo api revision
|
|
2791
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2791
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2792
2792
|
# HTTP header 'Accept' (if needed)
|
|
2793
2793
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2794
2794
|
|
|
@@ -2830,9 +2830,9 @@ module KlaviyoAPI
|
|
|
2830
2830
|
# Get Bulk Update Categories Jobs
|
|
2831
2831
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_categories_jobs.json)
|
|
2832
2832
|
# @param [Hash] opts the optional parameters
|
|
2833
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2834
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2835
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2833
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2834
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
2835
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
2836
2836
|
# @return [Hash<String, Object>]
|
|
2837
2837
|
def get_bulk_update_categories_jobs(opts = {})
|
|
2838
2838
|
data, _status_code, _headers = get_bulk_update_categories_jobs_with_http_info(opts)
|
|
@@ -2848,9 +2848,9 @@ module KlaviyoAPI
|
|
|
2848
2848
|
# Get Bulk Update Categories Jobs
|
|
2849
2849
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_categories_jobs.json)
|
|
2850
2850
|
# @param [Hash] opts the optional parameters
|
|
2851
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2852
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2853
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2851
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2852
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
2853
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
2854
2854
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2855
2855
|
def get_bulk_update_categories_jobs_with_http_info(opts = {})
|
|
2856
2856
|
if @api_client.config.debugging
|
|
@@ -2872,7 +2872,7 @@ module KlaviyoAPI
|
|
|
2872
2872
|
# header parameters
|
|
2873
2873
|
header_params = opts[:header_params] || {}
|
|
2874
2874
|
# klaviyo api revision
|
|
2875
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2875
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2876
2876
|
# HTTP header 'Accept' (if needed)
|
|
2877
2877
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2878
2878
|
|
|
@@ -2915,9 +2915,9 @@ module KlaviyoAPI
|
|
|
2915
2915
|
# 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: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_variants_job.json)
|
|
2916
2916
|
# @param job_id [String] ID of the job to retrieve.
|
|
2917
2917
|
# @param [Hash] opts the optional parameters
|
|
2918
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2919
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2920
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2918
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2919
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2920
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
2921
2921
|
# @return [Hash<String, Object>]
|
|
2922
2922
|
def get_bulk_update_variants_job(job_id, opts = {})
|
|
2923
2923
|
data, _status_code, _headers = get_bulk_update_variants_job_with_http_info(job_id, opts)
|
|
@@ -2934,9 +2934,9 @@ module KlaviyoAPI
|
|
|
2934
2934
|
# 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: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_variants_job.json)
|
|
2935
2935
|
# @param job_id [String] ID of the job to retrieve.
|
|
2936
2936
|
# @param [Hash] opts the optional parameters
|
|
2937
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2938
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2939
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2937
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2938
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
2939
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
2940
2940
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2941
2941
|
def get_bulk_update_variants_job_with_http_info(job_id, opts = {})
|
|
2942
2942
|
if @api_client.config.debugging
|
|
@@ -2970,7 +2970,7 @@ module KlaviyoAPI
|
|
|
2970
2970
|
# header parameters
|
|
2971
2971
|
header_params = opts[:header_params] || {}
|
|
2972
2972
|
# klaviyo api revision
|
|
2973
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2973
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2974
2974
|
# HTTP header 'Accept' (if needed)
|
|
2975
2975
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2976
2976
|
|
|
@@ -3012,9 +3012,9 @@ module KlaviyoAPI
|
|
|
3012
3012
|
# Get Bulk Update Variants Jobs
|
|
3013
3013
|
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_variants_jobs.json)
|
|
3014
3014
|
# @param [Hash] opts the optional parameters
|
|
3015
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3016
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3017
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3015
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3016
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
3017
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3018
3018
|
# @return [Hash<String, Object>]
|
|
3019
3019
|
def get_bulk_update_variants_jobs(opts = {})
|
|
3020
3020
|
data, _status_code, _headers = get_bulk_update_variants_jobs_with_http_info(opts)
|
|
@@ -3030,9 +3030,9 @@ module KlaviyoAPI
|
|
|
3030
3030
|
# Get Bulk Update Variants Jobs
|
|
3031
3031
|
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_variants_jobs.json)
|
|
3032
3032
|
# @param [Hash] opts the optional parameters
|
|
3033
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3034
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3035
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3033
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3034
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
3035
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3036
3036
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3037
3037
|
def get_bulk_update_variants_jobs_with_http_info(opts = {})
|
|
3038
3038
|
if @api_client.config.debugging
|
|
@@ -3054,7 +3054,7 @@ module KlaviyoAPI
|
|
|
3054
3054
|
# header parameters
|
|
3055
3055
|
header_params = opts[:header_params] || {}
|
|
3056
3056
|
# klaviyo api revision
|
|
3057
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3057
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3058
3058
|
# HTTP header 'Accept' (if needed)
|
|
3059
3059
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3060
3060
|
|
|
@@ -3096,11 +3096,11 @@ module KlaviyoAPI
|
|
|
3096
3096
|
# Get Catalog Categories
|
|
3097
3097
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_categories.json)
|
|
3098
3098
|
# @param [Hash] opts the optional parameters
|
|
3099
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3100
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3101
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3099
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3100
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`item.id`: `equals` (string)<br>`name`: `contains` (string)
|
|
3101
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3102
3102
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3103
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3103
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3104
3104
|
# @return [Hash<String, Object>]
|
|
3105
3105
|
def get_catalog_categories(opts = {})
|
|
3106
3106
|
data, _status_code, _headers = get_catalog_categories_with_http_info(opts)
|
|
@@ -3110,11 +3110,11 @@ module KlaviyoAPI
|
|
|
3110
3110
|
# Get Catalog Categories
|
|
3111
3111
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_categories.json)
|
|
3112
3112
|
# @param [Hash] opts the optional parameters
|
|
3113
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3114
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3115
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3113
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3114
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`item.id`: `equals` (string)<br>`name`: `contains` (string)
|
|
3115
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3116
3116
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3117
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3117
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3118
3118
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3119
3119
|
def get_catalog_categories_with_http_info(opts = {})
|
|
3120
3120
|
if @api_client.config.debugging
|
|
@@ -3150,7 +3150,7 @@ module KlaviyoAPI
|
|
|
3150
3150
|
# header parameters
|
|
3151
3151
|
header_params = opts[:header_params] || {}
|
|
3152
3152
|
# klaviyo api revision
|
|
3153
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3153
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3154
3154
|
# HTTP header 'Accept' (if needed)
|
|
3155
3155
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3156
3156
|
|
|
@@ -3187,7 +3187,7 @@ module KlaviyoAPI
|
|
|
3187
3187
|
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_category.json)
|
|
3188
3188
|
# @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`.
|
|
3189
3189
|
# @param [Hash] opts the optional parameters
|
|
3190
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3190
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3191
3191
|
# @return [Hash<String, Object>]
|
|
3192
3192
|
def get_catalog_category(id, opts = {})
|
|
3193
3193
|
data, _status_code, _headers = get_catalog_category_with_http_info(id, opts)
|
|
@@ -3198,7 +3198,7 @@ module KlaviyoAPI
|
|
|
3198
3198
|
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_category.json)
|
|
3199
3199
|
# @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`.
|
|
3200
3200
|
# @param [Hash] opts the optional parameters
|
|
3201
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3201
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3202
3202
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3203
3203
|
def get_catalog_category_with_http_info(id, opts = {})
|
|
3204
3204
|
if @api_client.config.debugging
|
|
@@ -3222,7 +3222,7 @@ module KlaviyoAPI
|
|
|
3222
3222
|
# header parameters
|
|
3223
3223
|
header_params = opts[:header_params] || {}
|
|
3224
3224
|
# klaviyo api revision
|
|
3225
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3225
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3226
3226
|
# HTTP header 'Accept' (if needed)
|
|
3227
3227
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3228
3228
|
|
|
@@ -3259,9 +3259,9 @@ module KlaviyoAPI
|
|
|
3259
3259
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_item.json)
|
|
3260
3260
|
# @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`.
|
|
3261
3261
|
# @param [Hash] opts the optional parameters
|
|
3262
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3263
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3264
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3262
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3263
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3264
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
3265
3265
|
# @return [Hash<String, Object>]
|
|
3266
3266
|
def get_catalog_item(id, opts = {})
|
|
3267
3267
|
data, _status_code, _headers = get_catalog_item_with_http_info(id, opts)
|
|
@@ -3272,9 +3272,9 @@ module KlaviyoAPI
|
|
|
3272
3272
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_item.json)
|
|
3273
3273
|
# @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`.
|
|
3274
3274
|
# @param [Hash] opts the optional parameters
|
|
3275
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3276
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3277
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3275
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3276
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3277
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
3278
3278
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3279
3279
|
def get_catalog_item_with_http_info(id, opts = {})
|
|
3280
3280
|
if @api_client.config.debugging
|
|
@@ -3308,7 +3308,7 @@ module KlaviyoAPI
|
|
|
3308
3308
|
# header parameters
|
|
3309
3309
|
header_params = opts[:header_params] || {}
|
|
3310
3310
|
# klaviyo api revision
|
|
3311
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3311
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3312
3312
|
# HTTP header 'Accept' (if needed)
|
|
3313
3313
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3314
3314
|
|
|
@@ -3344,13 +3344,13 @@ module KlaviyoAPI
|
|
|
3344
3344
|
# Get Catalog Items
|
|
3345
3345
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_items.json)
|
|
3346
3346
|
# @param [Hash] opts the optional parameters
|
|
3347
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3348
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3349
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3350
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3351
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3347
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3348
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3349
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`category.id`: `equals` (string)<br>`title`: `contains` (string)<br>`published`: `equals` (boolean)
|
|
3350
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
3351
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3352
3352
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3353
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3353
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3354
3354
|
# @return [Hash<String, Object>]
|
|
3355
3355
|
def get_catalog_items(opts = {})
|
|
3356
3356
|
data, _status_code, _headers = get_catalog_items_with_http_info(opts)
|
|
@@ -3360,13 +3360,13 @@ module KlaviyoAPI
|
|
|
3360
3360
|
# Get Catalog Items
|
|
3361
3361
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_items.json)
|
|
3362
3362
|
# @param [Hash] opts the optional parameters
|
|
3363
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3364
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3365
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3366
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3367
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3363
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3364
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3365
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`category.id`: `equals` (string)<br>`title`: `contains` (string)<br>`published`: `equals` (boolean)
|
|
3366
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
3367
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3368
3368
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3369
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3369
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3370
3370
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3371
3371
|
def get_catalog_items_with_http_info(opts = {})
|
|
3372
3372
|
if @api_client.config.debugging
|
|
@@ -3412,7 +3412,7 @@ module KlaviyoAPI
|
|
|
3412
3412
|
# header parameters
|
|
3413
3413
|
header_params = opts[:header_params] || {}
|
|
3414
3414
|
# klaviyo api revision
|
|
3415
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3415
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3416
3416
|
# HTTP header 'Accept' (if needed)
|
|
3417
3417
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3418
3418
|
|
|
@@ -3449,7 +3449,7 @@ module KlaviyoAPI
|
|
|
3449
3449
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_variant.json)
|
|
3450
3450
|
# @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`.
|
|
3451
3451
|
# @param [Hash] opts the optional parameters
|
|
3452
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3452
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3453
3453
|
# @return [Hash<String, Object>]
|
|
3454
3454
|
def get_catalog_variant(id, opts = {})
|
|
3455
3455
|
data, _status_code, _headers = get_catalog_variant_with_http_info(id, opts)
|
|
@@ -3460,7 +3460,7 @@ module KlaviyoAPI
|
|
|
3460
3460
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_variant.json)
|
|
3461
3461
|
# @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`.
|
|
3462
3462
|
# @param [Hash] opts the optional parameters
|
|
3463
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3463
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3464
3464
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3465
3465
|
def get_catalog_variant_with_http_info(id, opts = {})
|
|
3466
3466
|
if @api_client.config.debugging
|
|
@@ -3484,7 +3484,7 @@ module KlaviyoAPI
|
|
|
3484
3484
|
# header parameters
|
|
3485
3485
|
header_params = opts[:header_params] || {}
|
|
3486
3486
|
# klaviyo api revision
|
|
3487
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3487
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3488
3488
|
# HTTP header 'Accept' (if needed)
|
|
3489
3489
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3490
3490
|
|
|
@@ -3520,11 +3520,11 @@ module KlaviyoAPI
|
|
|
3520
3520
|
# Get Catalog Variants
|
|
3521
3521
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_variants.json)
|
|
3522
3522
|
# @param [Hash] opts the optional parameters
|
|
3523
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3524
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3525
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3523
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3524
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`item.id`: `equals` (string)<br>`sku`: `equals` (string)<br>`title`: `contains` (string)<br>`published`: `equals` (boolean)
|
|
3525
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3526
3526
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3527
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3527
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3528
3528
|
# @return [Hash<String, Object>]
|
|
3529
3529
|
def get_catalog_variants(opts = {})
|
|
3530
3530
|
data, _status_code, _headers = get_catalog_variants_with_http_info(opts)
|
|
@@ -3534,11 +3534,11 @@ module KlaviyoAPI
|
|
|
3534
3534
|
# Get Catalog Variants
|
|
3535
3535
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_variants.json)
|
|
3536
3536
|
# @param [Hash] opts the optional parameters
|
|
3537
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3538
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3539
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3537
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3538
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`item.id`: `equals` (string)<br>`sku`: `equals` (string)<br>`title`: `contains` (string)<br>`published`: `equals` (boolean)
|
|
3539
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3540
3540
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3541
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3541
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3542
3542
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3543
3543
|
def get_catalog_variants_with_http_info(opts = {})
|
|
3544
3544
|
if @api_client.config.debugging
|
|
@@ -3574,7 +3574,7 @@ module KlaviyoAPI
|
|
|
3574
3574
|
# header parameters
|
|
3575
3575
|
header_params = opts[:header_params] || {}
|
|
3576
3576
|
# klaviyo api revision
|
|
3577
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3577
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3578
3578
|
# HTTP header 'Accept' (if needed)
|
|
3579
3579
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3580
3580
|
|
|
@@ -3611,11 +3611,11 @@ module KlaviyoAPI
|
|
|
3611
3611
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_categories_for_catalog_item.json)
|
|
3612
3612
|
# @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`.
|
|
3613
3613
|
# @param [Hash] opts the optional parameters
|
|
3614
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3615
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3616
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3614
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3615
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`item.id`: `equals` (string)<br>`name`: `contains` (string)
|
|
3616
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3617
3617
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3618
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3618
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3619
3619
|
# @return [Hash<String, Object>]
|
|
3620
3620
|
def get_categories_for_catalog_item(id, opts = {})
|
|
3621
3621
|
data, _status_code, _headers = get_categories_for_catalog_item_with_http_info(id, opts)
|
|
@@ -3629,11 +3629,11 @@ module KlaviyoAPI
|
|
|
3629
3629
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_categories_for_catalog_item.json)
|
|
3630
3630
|
# @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`.
|
|
3631
3631
|
# @param [Hash] opts the optional parameters
|
|
3632
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3633
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3634
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3632
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3633
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`item.id`: `equals` (string)<br>`name`: `contains` (string)
|
|
3634
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3635
3635
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3636
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3636
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3637
3637
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3638
3638
|
def get_categories_for_catalog_item_with_http_info(id, opts = {})
|
|
3639
3639
|
if @api_client.config.debugging
|
|
@@ -3669,7 +3669,7 @@ module KlaviyoAPI
|
|
|
3669
3669
|
# header parameters
|
|
3670
3670
|
header_params = opts[:header_params] || {}
|
|
3671
3671
|
# klaviyo api revision
|
|
3672
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3672
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3673
3673
|
# HTTP header 'Accept' (if needed)
|
|
3674
3674
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3675
3675
|
|
|
@@ -3709,10 +3709,10 @@ module KlaviyoAPI
|
|
|
3709
3709
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_category_ids_for_catalog_item.json)
|
|
3710
3710
|
# @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`.
|
|
3711
3711
|
# @param [Hash] opts the optional parameters
|
|
3712
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3713
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3712
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`item.id`: `equals` (string)<br>`name`: `contains` (string)
|
|
3713
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3714
3714
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3715
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3715
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3716
3716
|
# @return [Hash<String, Object>]
|
|
3717
3717
|
def get_category_ids_for_catalog_item(id, opts = {})
|
|
3718
3718
|
data, _status_code, _headers = get_category_ids_for_catalog_item_with_http_info(id, opts)
|
|
@@ -3726,10 +3726,10 @@ module KlaviyoAPI
|
|
|
3726
3726
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_category_ids_for_catalog_item.json)
|
|
3727
3727
|
# @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`.
|
|
3728
3728
|
# @param [Hash] opts the optional parameters
|
|
3729
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3730
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3729
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`item.id`: `equals` (string)<br>`name`: `contains` (string)
|
|
3730
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3731
3731
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3732
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3732
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3733
3733
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3734
3734
|
def get_category_ids_for_catalog_item_with_http_info(id, opts = {})
|
|
3735
3735
|
if @api_client.config.debugging
|
|
@@ -3760,7 +3760,7 @@ module KlaviyoAPI
|
|
|
3760
3760
|
# header parameters
|
|
3761
3761
|
header_params = opts[:header_params] || {}
|
|
3762
3762
|
# klaviyo api revision
|
|
3763
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3763
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3764
3764
|
# HTTP header 'Accept' (if needed)
|
|
3765
3765
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3766
3766
|
|
|
@@ -3800,10 +3800,10 @@ module KlaviyoAPI
|
|
|
3800
3800
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_item_ids_for_catalog_category.json)
|
|
3801
3801
|
# @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`.
|
|
3802
3802
|
# @param [Hash] opts the optional parameters
|
|
3803
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3804
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3803
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`category.id`: `equals` (string)<br>`title`: `contains` (string)<br>`published`: `equals` (boolean)
|
|
3804
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3805
3805
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3806
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3806
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3807
3807
|
# @return [Hash<String, Object>]
|
|
3808
3808
|
def get_item_ids_for_catalog_category(id, opts = {})
|
|
3809
3809
|
data, _status_code, _headers = get_item_ids_for_catalog_category_with_http_info(id, opts)
|
|
@@ -3817,10 +3817,10 @@ module KlaviyoAPI
|
|
|
3817
3817
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_item_ids_for_catalog_category.json)
|
|
3818
3818
|
# @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`.
|
|
3819
3819
|
# @param [Hash] opts the optional parameters
|
|
3820
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3821
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3820
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`category.id`: `equals` (string)<br>`title`: `contains` (string)<br>`published`: `equals` (boolean)
|
|
3821
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3822
3822
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3823
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3823
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3824
3824
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3825
3825
|
def get_item_ids_for_catalog_category_with_http_info(id, opts = {})
|
|
3826
3826
|
if @api_client.config.debugging
|
|
@@ -3851,7 +3851,7 @@ module KlaviyoAPI
|
|
|
3851
3851
|
# header parameters
|
|
3852
3852
|
header_params = opts[:header_params] || {}
|
|
3853
3853
|
# klaviyo api revision
|
|
3854
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3854
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3855
3855
|
# HTTP header 'Accept' (if needed)
|
|
3856
3856
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3857
3857
|
|
|
@@ -3891,13 +3891,13 @@ module KlaviyoAPI
|
|
|
3891
3891
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_items_for_catalog_category.json)
|
|
3892
3892
|
# @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`.
|
|
3893
3893
|
# @param [Hash] opts the optional parameters
|
|
3894
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3895
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3896
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3897
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3898
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3894
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3895
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3896
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`category.id`: `equals` (string)<br>`title`: `contains` (string)<br>`published`: `equals` (boolean)
|
|
3897
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
3898
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3899
3899
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3900
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3900
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3901
3901
|
# @return [Hash<String, Object>]
|
|
3902
3902
|
def get_items_for_catalog_category(id, opts = {})
|
|
3903
3903
|
data, _status_code, _headers = get_items_for_catalog_category_with_http_info(id, opts)
|
|
@@ -3911,13 +3911,13 @@ module KlaviyoAPI
|
|
|
3911
3911
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_items_for_catalog_category.json)
|
|
3912
3912
|
# @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`.
|
|
3913
3913
|
# @param [Hash] opts the optional parameters
|
|
3914
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3915
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3916
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3917
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3918
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3914
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3915
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
3916
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`category.id`: `equals` (string)<br>`title`: `contains` (string)<br>`published`: `equals` (boolean)
|
|
3917
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
3918
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
3919
3919
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
3920
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3920
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
3921
3921
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3922
3922
|
def get_items_for_catalog_category_with_http_info(id, opts = {})
|
|
3923
3923
|
if @api_client.config.debugging
|
|
@@ -3963,7 +3963,7 @@ module KlaviyoAPI
|
|
|
3963
3963
|
# header parameters
|
|
3964
3964
|
header_params = opts[:header_params] || {}
|
|
3965
3965
|
# klaviyo api revision
|
|
3966
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3966
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3967
3967
|
# HTTP header 'Accept' (if needed)
|
|
3968
3968
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3969
3969
|
|
|
@@ -4003,10 +4003,10 @@ module KlaviyoAPI
|
|
|
4003
4003
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variant_ids_for_catalog_item.json)
|
|
4004
4004
|
# @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`.
|
|
4005
4005
|
# @param [Hash] opts the optional parameters
|
|
4006
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4007
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4006
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`item.id`: `equals` (string)<br>`sku`: `equals` (string)<br>`title`: `contains` (string)<br>`published`: `equals` (boolean)
|
|
4007
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
4008
4008
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
4009
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4009
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
4010
4010
|
# @return [Hash<String, Object>]
|
|
4011
4011
|
def get_variant_ids_for_catalog_item(id, opts = {})
|
|
4012
4012
|
data, _status_code, _headers = get_variant_ids_for_catalog_item_with_http_info(id, opts)
|
|
@@ -4020,10 +4020,10 @@ module KlaviyoAPI
|
|
|
4020
4020
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variant_ids_for_catalog_item.json)
|
|
4021
4021
|
# @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`.
|
|
4022
4022
|
# @param [Hash] opts the optional parameters
|
|
4023
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4024
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4023
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`item.id`: `equals` (string)<br>`sku`: `equals` (string)<br>`title`: `contains` (string)<br>`published`: `equals` (boolean)
|
|
4024
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
4025
4025
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
4026
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4026
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
4027
4027
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
4028
4028
|
def get_variant_ids_for_catalog_item_with_http_info(id, opts = {})
|
|
4029
4029
|
if @api_client.config.debugging
|
|
@@ -4054,7 +4054,7 @@ module KlaviyoAPI
|
|
|
4054
4054
|
# header parameters
|
|
4055
4055
|
header_params = opts[:header_params] || {}
|
|
4056
4056
|
# klaviyo api revision
|
|
4057
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4057
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
4058
4058
|
# HTTP header 'Accept' (if needed)
|
|
4059
4059
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4060
4060
|
|
|
@@ -4094,11 +4094,11 @@ module KlaviyoAPI
|
|
|
4094
4094
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variants_for_catalog_item.json)
|
|
4095
4095
|
# @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`.
|
|
4096
4096
|
# @param [Hash] opts the optional parameters
|
|
4097
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4098
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4099
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4097
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
4098
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`item.id`: `equals` (string)<br>`sku`: `equals` (string)<br>`title`: `contains` (string)<br>`published`: `equals` (boolean)
|
|
4099
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
4100
4100
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
4101
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4101
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
4102
4102
|
# @return [Hash<String, Object>]
|
|
4103
4103
|
def get_variants_for_catalog_item(id, opts = {})
|
|
4104
4104
|
data, _status_code, _headers = get_variants_for_catalog_item_with_http_info(id, opts)
|
|
@@ -4112,11 +4112,11 @@ module KlaviyoAPI
|
|
|
4112
4112
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variants_for_catalog_item.json)
|
|
4113
4113
|
# @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`.
|
|
4114
4114
|
# @param [Hash] opts the optional parameters
|
|
4115
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4116
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4117
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4115
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
4116
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any` (string)<br>`item.id`: `equals` (string)<br>`sku`: `equals` (string)<br>`title`: `contains` (string)<br>`published`: `equals` (boolean)
|
|
4117
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
4118
4118
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
4119
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4119
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
4120
4120
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
4121
4121
|
def get_variants_for_catalog_item_with_http_info(id, opts = {})
|
|
4122
4122
|
if @api_client.config.debugging
|
|
@@ -4152,7 +4152,7 @@ module KlaviyoAPI
|
|
|
4152
4152
|
# header parameters
|
|
4153
4153
|
header_params = opts[:header_params] || {}
|
|
4154
4154
|
# klaviyo api revision
|
|
4155
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4155
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
4156
4156
|
# HTTP header 'Accept' (if needed)
|
|
4157
4157
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4158
4158
|
|
|
@@ -4229,7 +4229,7 @@ module KlaviyoAPI
|
|
|
4229
4229
|
# header parameters
|
|
4230
4230
|
header_params = opts[:header_params] || {}
|
|
4231
4231
|
# klaviyo api revision
|
|
4232
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4232
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
4233
4233
|
# HTTP header 'Accept' (if needed)
|
|
4234
4234
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4235
4235
|
# HTTP header 'Content-Type'
|
|
@@ -4311,7 +4311,7 @@ module KlaviyoAPI
|
|
|
4311
4311
|
# header parameters
|
|
4312
4312
|
header_params = opts[:header_params] || {}
|
|
4313
4313
|
# klaviyo api revision
|
|
4314
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4314
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
4315
4315
|
# HTTP header 'Accept' (if needed)
|
|
4316
4316
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4317
4317
|
# HTTP header 'Content-Type'
|
|
@@ -4357,7 +4357,7 @@ module KlaviyoAPI
|
|
|
4357
4357
|
# @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`.
|
|
4358
4358
|
# @param catalog_category_update_query [CatalogCategoryUpdateQuery]
|
|
4359
4359
|
# @param [Hash] opts the optional parameters
|
|
4360
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4360
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
4361
4361
|
# @return [Hash<String, Object>]
|
|
4362
4362
|
def update_catalog_category(id, catalog_category_update_query, opts = {})
|
|
4363
4363
|
data, _status_code, _headers = update_catalog_category_with_http_info(id, catalog_category_update_query, opts)
|
|
@@ -4369,7 +4369,7 @@ module KlaviyoAPI
|
|
|
4369
4369
|
# @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`.
|
|
4370
4370
|
# @param catalog_category_update_query [CatalogCategoryUpdateQuery]
|
|
4371
4371
|
# @param [Hash] opts the optional parameters
|
|
4372
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4372
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
4373
4373
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
4374
4374
|
def update_catalog_category_with_http_info(id, catalog_category_update_query, opts = {})
|
|
4375
4375
|
if @api_client.config.debugging
|
|
@@ -4397,7 +4397,7 @@ module KlaviyoAPI
|
|
|
4397
4397
|
# header parameters
|
|
4398
4398
|
header_params = opts[:header_params] || {}
|
|
4399
4399
|
# klaviyo api revision
|
|
4400
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4400
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
4401
4401
|
# HTTP header 'Accept' (if needed)
|
|
4402
4402
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4403
4403
|
# HTTP header 'Content-Type'
|
|
@@ -4440,7 +4440,7 @@ module KlaviyoAPI
|
|
|
4440
4440
|
# @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`.
|
|
4441
4441
|
# @param catalog_item_update_query [CatalogItemUpdateQuery]
|
|
4442
4442
|
# @param [Hash] opts the optional parameters
|
|
4443
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4443
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
4444
4444
|
# @return [Hash<String, Object>]
|
|
4445
4445
|
def update_catalog_item(id, catalog_item_update_query, opts = {})
|
|
4446
4446
|
data, _status_code, _headers = update_catalog_item_with_http_info(id, catalog_item_update_query, opts)
|
|
@@ -4452,7 +4452,7 @@ module KlaviyoAPI
|
|
|
4452
4452
|
# @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`.
|
|
4453
4453
|
# @param catalog_item_update_query [CatalogItemUpdateQuery]
|
|
4454
4454
|
# @param [Hash] opts the optional parameters
|
|
4455
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4455
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
4456
4456
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
4457
4457
|
def update_catalog_item_with_http_info(id, catalog_item_update_query, opts = {})
|
|
4458
4458
|
if @api_client.config.debugging
|
|
@@ -4480,7 +4480,7 @@ module KlaviyoAPI
|
|
|
4480
4480
|
# header parameters
|
|
4481
4481
|
header_params = opts[:header_params] || {}
|
|
4482
4482
|
# klaviyo api revision
|
|
4483
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4483
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
4484
4484
|
# HTTP header 'Accept' (if needed)
|
|
4485
4485
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4486
4486
|
# HTTP header 'Content-Type'
|
|
@@ -4523,7 +4523,7 @@ module KlaviyoAPI
|
|
|
4523
4523
|
# @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`.
|
|
4524
4524
|
# @param catalog_variant_update_query [CatalogVariantUpdateQuery]
|
|
4525
4525
|
# @param [Hash] opts the optional parameters
|
|
4526
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4526
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
4527
4527
|
# @return [Hash<String, Object>]
|
|
4528
4528
|
def update_catalog_variant(id, catalog_variant_update_query, opts = {})
|
|
4529
4529
|
data, _status_code, _headers = update_catalog_variant_with_http_info(id, catalog_variant_update_query, opts)
|
|
@@ -4535,7 +4535,7 @@ module KlaviyoAPI
|
|
|
4535
4535
|
# @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`.
|
|
4536
4536
|
# @param catalog_variant_update_query [CatalogVariantUpdateQuery]
|
|
4537
4537
|
# @param [Hash] opts the optional parameters
|
|
4538
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
4538
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
4539
4539
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
4540
4540
|
def update_catalog_variant_with_http_info(id, catalog_variant_update_query, opts = {})
|
|
4541
4541
|
if @api_client.config.debugging
|
|
@@ -4563,7 +4563,7 @@ module KlaviyoAPI
|
|
|
4563
4563
|
# header parameters
|
|
4564
4564
|
header_params = opts[:header_params] || {}
|
|
4565
4565
|
# klaviyo api revision
|
|
4566
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4566
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
4567
4567
|
# HTTP header 'Accept' (if needed)
|
|
4568
4568
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4569
4569
|
# HTTP header 'Content-Type'
|
|
@@ -4642,7 +4642,7 @@ module KlaviyoAPI
|
|
|
4642
4642
|
# header parameters
|
|
4643
4643
|
header_params = opts[:header_params] || {}
|
|
4644
4644
|
# klaviyo api revision
|
|
4645
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4645
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
4646
4646
|
# HTTP header 'Accept' (if needed)
|
|
4647
4647
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4648
4648
|
# HTTP header 'Content-Type'
|
|
@@ -4724,7 +4724,7 @@ module KlaviyoAPI
|
|
|
4724
4724
|
# header parameters
|
|
4725
4725
|
header_params = opts[:header_params] || {}
|
|
4726
4726
|
# klaviyo api revision
|
|
4727
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4727
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
4728
4728
|
# HTTP header 'Accept' (if needed)
|
|
4729
4729
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4730
4730
|
# HTTP header 'Content-Type'
|