klaviyo-api-sdk 17.0.0 → 18.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 +22 -0
- data/README.md +932 -414
- data/klaviyo-api-sdk.gemspec +1 -1
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +215 -155
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +585 -381
- data/lib/klaviyo-api-sdk/api/client_api.rb +100 -0
- data/lib/klaviyo-api-sdk/api/conversations_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +187 -108
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +2755 -83
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/events_api.rb +72 -58
- data/lib/klaviyo-api-sdk/api/flows_api.rb +238 -152
- data/lib/klaviyo-api-sdk/api/forms_api.rb +81 -60
- data/lib/klaviyo-api-sdk/api/images_api.rb +48 -27
- data/lib/klaviyo-api-sdk/api/lists_api.rb +113 -88
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +184 -156
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +445 -226
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +76 -27
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +38 -31
- data/lib/klaviyo-api-sdk/api/segments_api.rb +107 -82
- data/lib/klaviyo-api-sdk/api/tags_api.rb +164 -128
- data/lib/klaviyo-api-sdk/api/templates_api.rb +113 -60
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +24 -17
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +41 -27
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +73 -31
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/action_output_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/action_output_condition_filter.rb +78 -195
- data/lib/klaviyo-api-sdk/models/action_output_split_action_data.rb +2 -6
- data/lib/klaviyo-api-sdk/models/{flow_push_notification_additional_filters.rb → action_output_split_action_data_action_output_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{action_output_condition_condition_group.rb → action_output_split_action_data_action_output_filter_condition_groups_inner.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/api_schema_property.rb +301 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb +15 -2
- data/lib/klaviyo-api-sdk/models/base_style_properties.rb +15 -5
- data/lib/klaviyo-api-sdk/models/button_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/button_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/button_styles.rb +25 -3
- data/lib/klaviyo-api-sdk/models/{action_output_condition_filter2.rb → button_styles_height.rb} +3 -7
- data/lib/klaviyo-api-sdk/models/cart_content.rb +277 -0
- data/lib/klaviyo-api-sdk/models/cart_content_properties.rb +236 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +5 -0
- data/lib/klaviyo-api-sdk/models/constant_property_mapping.rb +287 -0
- data/lib/klaviyo-api-sdk/models/{price_drop_condition_filter2.rb → constant_property_mapping_value.rb} +6 -16
- data/lib/klaviyo-api-sdk/models/content_experiment_action.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{send_push_notification_action_content_experiment_action_data.rb → content_experiment_action_data.rb} +6 -5
- data/lib/klaviyo-api-sdk/models/{send_push_notification_action_current_experiment.rb → content_experiment_action_data_current_experiment.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/{low_inventory_condition_filter2.rb → content_experiment_action_data_main_action.rb} +3 -16
- data/lib/klaviyo-api-sdk/models/countdown_timer_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/coupon_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/custom_css.rb +231 -0
- data/lib/klaviyo-api-sdk/models/custom_html.rb +292 -0
- data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +263 -0
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +450 -0
- data/lib/klaviyo-api-sdk/models/custom_object_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_object_relationship_source.rb +328 -0
- data/lib/klaviyo-api-sdk/models/date_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/display_options.rb +24 -4
- data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/email_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +13 -9
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +13 -9
- data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object_attributes.rb +292 -0
- data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object_attributes_source_mapping.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +15 -2
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +14 -1
- data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter_condition_groups_inner_conditions_inner.rb +5 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_email.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +14 -4
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +15 -2
- data/lib/klaviyo-api-sdk/models/form_create_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/html_text_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen.rb +305 -0
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen_properties.rb +220 -0
- data/lib/klaviyo-api-sdk/models/image_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/image_block_cropping_properties.rb +0 -35
- data/lib/klaviyo-api-sdk/models/image_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +2 -6
- data/lib/klaviyo-api-sdk/models/{low_inventory_condition_filter.rb → low_inventory_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{low_inventory_condition_condition_group.rb → low_inventory_trigger_trigger_filter_condition_groups_inner.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +87 -195
- data/lib/klaviyo-api-sdk/models/metric_trigger.rb +2 -1
- data/lib/klaviyo-api-sdk/models/{flow_email_additional_filters.rb → metric_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{flow_email_additional_filters_condition_groups_inner.rb → metric_trigger_trigger_filter_condition_groups_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/mobile_push_content_create.rb +18 -5
- data/lib/klaviyo-api-sdk/models/mobile_push_content_update.rb +18 -5
- data/lib/klaviyo-api-sdk/models/mobile_push_options_on_open.rb +2 -1
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter_condition_groups_inner_conditions_inner.rb +5 -0
- data/lib/klaviyo-api-sdk/models/object_record_bulk_delete_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{flow_push_notification_additional_filters_condition_groups_inner.rb → object_record_delete_job_create_query_resource_object_relationships.rb} +13 -15
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object_relationships_object_records.rb +220 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_rels_records_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/object_record_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_attributes.rb +322 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships_object_type.rb +218 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships_object_type_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/object_schema_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query_resource_object_attributes.rb +302 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_create_meta.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{metric_property_condition_condition_group.rb → object_schema_relationship_create_query.rb} +14 -14
- data/lib/klaviyo-api-sdk/models/{flow_sms_additional_filters_condition_groups_inner.rb → object_schema_relationship_create_query_data_inner.rb} +37 -15
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_meta.rb +224 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_query.rb +225 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_partial_update_query_data.rb +247 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_update_meta.rb +246 -0
- data/lib/klaviyo-api-sdk/models/object_type_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_type_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/object_type_create_query_resource_object_attributes.rb +307 -0
- data/lib/klaviyo-api-sdk/models/object_type_create_query_resource_object_attributes_object_schema.rb +224 -0
- data/lib/klaviyo-api-sdk/models/object_type_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +13 -4
- data/lib/klaviyo-api-sdk/models/open_tracking_subscription_parameters.rb +258 -0
- data/lib/klaviyo-api-sdk/models/open_tracking_unsubscription_parameters.rb +258 -0
- data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/patch_identifiers.rb +227 -0
- data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +2 -6
- data/lib/klaviyo-api-sdk/models/{flow_sms_additional_filters.rb → price_drop_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{price_drop_condition_condition_group.rb → price_drop_trigger_trigger_filter_condition_groups_inner.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +19 -9
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_email_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{profile_has_not_received_push_message_condition_timeframe_filter.rb → profile_has_not_received_email_message_condition_timeframe_filter.rb} +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_push_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_sms_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +13 -4
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_object_schema_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_create_query.rb +225 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_create_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_delete_query.rb +225 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_delete_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_partial_update_query_data.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_relationship_source.rb +330 -0
- data/lib/klaviyo-api-sdk/models/property_filter.rb +237 -0
- data/lib/klaviyo-api-sdk/models/property_source.rb +254 -0
- data/lib/klaviyo-api-sdk/models/push_action_button.rb +1 -5
- data/lib/klaviyo-api-sdk/models/push_action_button_definition.rb +261 -0
- data/lib/klaviyo-api-sdk/models/push_on_open_web_url.rb +268 -0
- data/lib/klaviyo-api-sdk/models/quote_style.rb +21 -1
- data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/redirect_properties.rb +2 -5
- data/lib/klaviyo-api-sdk/models/related_id_path.rb +273 -0
- data/lib/klaviyo-api-sdk/models/review_block_styles.rb +13 -13
- data/lib/klaviyo-api-sdk/models/review_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/reviewer_name_style.rb +21 -1
- data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/signup_counter_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/simple_property_mapping.rb +287 -0
- data/lib/klaviyo-api-sdk/models/simple_relationship_mapping.rb +287 -0
- data/lib/klaviyo-api-sdk/models/simple_relationship_mapping_source.rb +105 -0
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_link_text_style.rb +319 -0
- data/lib/klaviyo-api-sdk/models/sms_disclosure_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object_attributes_property_mappings_inner.rb +104 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/table_fallback_image_sub_block.rb +0 -13
- data/lib/klaviyo-api-sdk/models/table_image_sub_block.rb +0 -13
- data/lib/klaviyo-api-sdk/models/template_definition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/text_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/version.rb +39 -4
- data/lib/klaviyo-api-sdk/models/version_properties.rb +14 -4
- data/lib/klaviyo-api-sdk/models/version_styles.rb +15 -6
- data/lib/klaviyo-api-sdk/models/version_triggers_inner.rb +1 -0
- data/lib/klaviyo-api-sdk.rb +86 -23
- data/lib/klaviyo-api-sdk.rb.bak +87 -24
- metadata +88 -25
- data/lib/klaviyo-api-sdk/models/custom_object_property_condition_filter.rb +0 -117
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
- data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter2.rb +0 -117
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter.rb +0 -225
|
@@ -19,7 +19,7 @@ module KlaviyoAPI
|
|
|
19
19
|
@api_client = api_client
|
|
20
20
|
end
|
|
21
21
|
# Add Categories to Catalog Item
|
|
22
|
-
# Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
22
|
+
# Create a new catalog category relationship for the given item ID.<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/add_categories_to_catalog_item.json)
|
|
23
23
|
# @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`.
|
|
24
24
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
@@ -39,7 +39,7 @@ module KlaviyoAPI
|
|
|
39
39
|
alias create_catalog_item_relationships_categories add_categories_to_catalog_item
|
|
40
40
|
|
|
41
41
|
# Add Categories to Catalog Item
|
|
42
|
-
# Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
42
|
+
# Create a new catalog category relationship for the given item ID.<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/add_categories_to_catalog_item.json)
|
|
43
43
|
# @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`.
|
|
44
44
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
|
45
45
|
# @param [Hash] opts the optional parameters
|
|
@@ -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-07-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'
|
|
@@ -113,7 +113,7 @@ module KlaviyoAPI
|
|
|
113
113
|
alias create_catalog_item_relationships_categories_with_http_info add_categories_to_catalog_item_with_http_info
|
|
114
114
|
|
|
115
115
|
# Add Items to Catalog Category
|
|
116
|
-
# Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
116
|
+
# Create a new item relationship for the given category ID.<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/add_items_to_catalog_category.json)
|
|
117
117
|
# @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`.
|
|
118
118
|
# @param catalog_category_item_op [CatalogCategoryItemOp]
|
|
119
119
|
# @param [Hash] opts the optional parameters
|
|
@@ -130,7 +130,7 @@ module KlaviyoAPI
|
|
|
130
130
|
alias create_catalog_category_relationships_items add_items_to_catalog_category
|
|
131
131
|
|
|
132
132
|
# Add Items to Catalog Category
|
|
133
|
-
# Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
133
|
+
# Create a new item relationship for the given category ID.<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/add_items_to_catalog_category.json)
|
|
134
134
|
# @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`.
|
|
135
135
|
# @param catalog_category_item_op [CatalogCategoryItemOp]
|
|
136
136
|
# @param [Hash] opts the optional parameters
|
|
@@ -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-07-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'
|
|
@@ -201,9 +201,10 @@ module KlaviyoAPI
|
|
|
201
201
|
alias create_catalog_category_relationships_items_with_http_info add_items_to_catalog_category_with_http_info
|
|
202
202
|
|
|
203
203
|
# Bulk Create Catalog Categories
|
|
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`
|
|
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-07-15/reference/api-overview#sparse-fieldsets
|
|
207
208
|
# @return [Hash<String, Object>]
|
|
208
209
|
def bulk_create_catalog_categories(catalog_category_create_job_create_query, opts = {})
|
|
209
210
|
data, _status_code, _headers = bulk_create_catalog_categories_with_http_info(catalog_category_create_job_create_query, opts)
|
|
@@ -217,9 +218,10 @@ module KlaviyoAPI
|
|
|
217
218
|
alias create_catalog_category_bulk_create_job bulk_create_catalog_categories
|
|
218
219
|
|
|
219
220
|
# Bulk Create Catalog Categories
|
|
220
|
-
# 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`
|
|
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)
|
|
221
222
|
# @param catalog_category_create_job_create_query [CatalogCategoryCreateJobCreateQuery]
|
|
222
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-07-15/reference/api-overview#sparse-fieldsets
|
|
223
225
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
224
226
|
def bulk_create_catalog_categories_with_http_info(catalog_category_create_job_create_query, opts = {})
|
|
225
227
|
if @api_client.config.debugging
|
|
@@ -229,16 +231,21 @@ module KlaviyoAPI
|
|
|
229
231
|
if @api_client.config.client_side_validation && catalog_category_create_job_create_query.nil?
|
|
230
232
|
fail ArgumentError, "Missing the required parameter 'catalog_category_create_job_create_query' when calling CatalogsApi.bulk_create_catalog_categories"
|
|
231
233
|
end
|
|
234
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
235
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_create_job'] && !opts[:'fields_catalog_category_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
|
236
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_create_job\", must include one of #{allowable_values}"
|
|
237
|
+
end
|
|
232
238
|
# resource path
|
|
233
239
|
local_var_path = '/api/catalog-category-bulk-create-jobs'
|
|
234
240
|
|
|
235
241
|
# query parameters
|
|
236
242
|
query_params = opts[:query_params] || {}
|
|
243
|
+
query_params[:'fields[catalog-category-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_create_job'], :csv) if !opts[:'fields_catalog_category_bulk_create_job'].nil?
|
|
237
244
|
|
|
238
245
|
# header parameters
|
|
239
246
|
header_params = opts[:header_params] || {}
|
|
240
247
|
# klaviyo api revision
|
|
241
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
248
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
242
249
|
# HTTP header 'Accept' (if needed)
|
|
243
250
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
244
251
|
# HTTP header 'Content-Type'
|
|
@@ -283,9 +290,10 @@ module KlaviyoAPI
|
|
|
283
290
|
alias create_catalog_category_bulk_create_job_with_http_info bulk_create_catalog_categories_with_http_info
|
|
284
291
|
|
|
285
292
|
# Bulk Create Catalog Items
|
|
286
|
-
# 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`
|
|
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)
|
|
287
294
|
# @param catalog_item_create_job_create_query [CatalogItemCreateJobCreateQuery]
|
|
288
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-07-15/reference/api-overview#sparse-fieldsets
|
|
289
297
|
# @return [Hash<String, Object>]
|
|
290
298
|
def bulk_create_catalog_items(catalog_item_create_job_create_query, opts = {})
|
|
291
299
|
data, _status_code, _headers = bulk_create_catalog_items_with_http_info(catalog_item_create_job_create_query, opts)
|
|
@@ -299,9 +307,10 @@ module KlaviyoAPI
|
|
|
299
307
|
alias create_catalog_item_bulk_create_job bulk_create_catalog_items
|
|
300
308
|
|
|
301
309
|
# Bulk Create Catalog Items
|
|
302
|
-
# 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`
|
|
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)
|
|
303
311
|
# @param catalog_item_create_job_create_query [CatalogItemCreateJobCreateQuery]
|
|
304
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-07-15/reference/api-overview#sparse-fieldsets
|
|
305
314
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
306
315
|
def bulk_create_catalog_items_with_http_info(catalog_item_create_job_create_query, opts = {})
|
|
307
316
|
if @api_client.config.debugging
|
|
@@ -311,16 +320,21 @@ module KlaviyoAPI
|
|
|
311
320
|
if @api_client.config.client_side_validation && catalog_item_create_job_create_query.nil?
|
|
312
321
|
fail ArgumentError, "Missing the required parameter 'catalog_item_create_job_create_query' when calling CatalogsApi.bulk_create_catalog_items"
|
|
313
322
|
end
|
|
323
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
324
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_create_job'] && !opts[:'fields_catalog_item_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
|
325
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_create_job\", must include one of #{allowable_values}"
|
|
326
|
+
end
|
|
314
327
|
# resource path
|
|
315
328
|
local_var_path = '/api/catalog-item-bulk-create-jobs'
|
|
316
329
|
|
|
317
330
|
# query parameters
|
|
318
331
|
query_params = opts[:query_params] || {}
|
|
332
|
+
query_params[:'fields[catalog-item-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_create_job'], :csv) if !opts[:'fields_catalog_item_bulk_create_job'].nil?
|
|
319
333
|
|
|
320
334
|
# header parameters
|
|
321
335
|
header_params = opts[:header_params] || {}
|
|
322
336
|
# klaviyo api revision
|
|
323
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
337
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
324
338
|
# HTTP header 'Accept' (if needed)
|
|
325
339
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
326
340
|
# HTTP header 'Content-Type'
|
|
@@ -365,9 +379,10 @@ module KlaviyoAPI
|
|
|
365
379
|
alias create_catalog_item_bulk_create_job_with_http_info bulk_create_catalog_items_with_http_info
|
|
366
380
|
|
|
367
381
|
# Bulk Create Catalog Variants
|
|
368
|
-
# 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`
|
|
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)
|
|
369
383
|
# @param catalog_variant_create_job_create_query [CatalogVariantCreateJobCreateQuery]
|
|
370
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-07-15/reference/api-overview#sparse-fieldsets
|
|
371
386
|
# @return [Hash<String, Object>]
|
|
372
387
|
def bulk_create_catalog_variants(catalog_variant_create_job_create_query, opts = {})
|
|
373
388
|
data, _status_code, _headers = bulk_create_catalog_variants_with_http_info(catalog_variant_create_job_create_query, opts)
|
|
@@ -381,9 +396,10 @@ module KlaviyoAPI
|
|
|
381
396
|
alias create_catalog_variant_bulk_create_job bulk_create_catalog_variants
|
|
382
397
|
|
|
383
398
|
# Bulk Create Catalog Variants
|
|
384
|
-
# 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`
|
|
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)
|
|
385
400
|
# @param catalog_variant_create_job_create_query [CatalogVariantCreateJobCreateQuery]
|
|
386
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-07-15/reference/api-overview#sparse-fieldsets
|
|
387
403
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
388
404
|
def bulk_create_catalog_variants_with_http_info(catalog_variant_create_job_create_query, opts = {})
|
|
389
405
|
if @api_client.config.debugging
|
|
@@ -393,16 +409,21 @@ module KlaviyoAPI
|
|
|
393
409
|
if @api_client.config.client_side_validation && catalog_variant_create_job_create_query.nil?
|
|
394
410
|
fail ArgumentError, "Missing the required parameter 'catalog_variant_create_job_create_query' when calling CatalogsApi.bulk_create_catalog_variants"
|
|
395
411
|
end
|
|
412
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
413
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_create_job'] && !opts[:'fields_catalog_variant_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
|
414
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_create_job\", must include one of #{allowable_values}"
|
|
415
|
+
end
|
|
396
416
|
# resource path
|
|
397
417
|
local_var_path = '/api/catalog-variant-bulk-create-jobs'
|
|
398
418
|
|
|
399
419
|
# query parameters
|
|
400
420
|
query_params = opts[:query_params] || {}
|
|
421
|
+
query_params[:'fields[catalog-variant-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_create_job'], :csv) if !opts[:'fields_catalog_variant_bulk_create_job'].nil?
|
|
401
422
|
|
|
402
423
|
# header parameters
|
|
403
424
|
header_params = opts[:header_params] || {}
|
|
404
425
|
# klaviyo api revision
|
|
405
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
426
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
406
427
|
# HTTP header 'Accept' (if needed)
|
|
407
428
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
408
429
|
# HTTP header 'Content-Type'
|
|
@@ -447,9 +468,10 @@ module KlaviyoAPI
|
|
|
447
468
|
alias create_catalog_variant_bulk_create_job_with_http_info bulk_create_catalog_variants_with_http_info
|
|
448
469
|
|
|
449
470
|
# Bulk Delete Catalog Categories
|
|
450
|
-
# 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`
|
|
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)
|
|
451
472
|
# @param catalog_category_delete_job_create_query [CatalogCategoryDeleteJobCreateQuery]
|
|
452
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-07-15/reference/api-overview#sparse-fieldsets
|
|
453
475
|
# @return [Hash<String, Object>]
|
|
454
476
|
def bulk_delete_catalog_categories(catalog_category_delete_job_create_query, opts = {})
|
|
455
477
|
data, _status_code, _headers = bulk_delete_catalog_categories_with_http_info(catalog_category_delete_job_create_query, opts)
|
|
@@ -463,9 +485,10 @@ module KlaviyoAPI
|
|
|
463
485
|
alias create_catalog_category_bulk_delete_job bulk_delete_catalog_categories
|
|
464
486
|
|
|
465
487
|
# Bulk Delete Catalog Categories
|
|
466
|
-
# 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`
|
|
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)
|
|
467
489
|
# @param catalog_category_delete_job_create_query [CatalogCategoryDeleteJobCreateQuery]
|
|
468
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-07-15/reference/api-overview#sparse-fieldsets
|
|
469
492
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
470
493
|
def bulk_delete_catalog_categories_with_http_info(catalog_category_delete_job_create_query, opts = {})
|
|
471
494
|
if @api_client.config.debugging
|
|
@@ -475,16 +498,21 @@ module KlaviyoAPI
|
|
|
475
498
|
if @api_client.config.client_side_validation && catalog_category_delete_job_create_query.nil?
|
|
476
499
|
fail ArgumentError, "Missing the required parameter 'catalog_category_delete_job_create_query' when calling CatalogsApi.bulk_delete_catalog_categories"
|
|
477
500
|
end
|
|
501
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
502
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_delete_job'] && !opts[:'fields_catalog_category_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
|
503
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_delete_job\", must include one of #{allowable_values}"
|
|
504
|
+
end
|
|
478
505
|
# resource path
|
|
479
506
|
local_var_path = '/api/catalog-category-bulk-delete-jobs'
|
|
480
507
|
|
|
481
508
|
# query parameters
|
|
482
509
|
query_params = opts[:query_params] || {}
|
|
510
|
+
query_params[:'fields[catalog-category-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_delete_job'], :csv) if !opts[:'fields_catalog_category_bulk_delete_job'].nil?
|
|
483
511
|
|
|
484
512
|
# header parameters
|
|
485
513
|
header_params = opts[:header_params] || {}
|
|
486
514
|
# klaviyo api revision
|
|
487
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
515
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
488
516
|
# HTTP header 'Accept' (if needed)
|
|
489
517
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
490
518
|
# HTTP header 'Content-Type'
|
|
@@ -529,9 +557,10 @@ module KlaviyoAPI
|
|
|
529
557
|
alias create_catalog_category_bulk_delete_job_with_http_info bulk_delete_catalog_categories_with_http_info
|
|
530
558
|
|
|
531
559
|
# Bulk Delete Catalog Items
|
|
532
|
-
# 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`
|
|
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)
|
|
533
561
|
# @param catalog_item_delete_job_create_query [CatalogItemDeleteJobCreateQuery]
|
|
534
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-07-15/reference/api-overview#sparse-fieldsets
|
|
535
564
|
# @return [Hash<String, Object>]
|
|
536
565
|
def bulk_delete_catalog_items(catalog_item_delete_job_create_query, opts = {})
|
|
537
566
|
data, _status_code, _headers = bulk_delete_catalog_items_with_http_info(catalog_item_delete_job_create_query, opts)
|
|
@@ -545,9 +574,10 @@ module KlaviyoAPI
|
|
|
545
574
|
alias create_catalog_item_bulk_delete_job bulk_delete_catalog_items
|
|
546
575
|
|
|
547
576
|
# Bulk Delete Catalog Items
|
|
548
|
-
# 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`
|
|
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)
|
|
549
578
|
# @param catalog_item_delete_job_create_query [CatalogItemDeleteJobCreateQuery]
|
|
550
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-07-15/reference/api-overview#sparse-fieldsets
|
|
551
581
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
552
582
|
def bulk_delete_catalog_items_with_http_info(catalog_item_delete_job_create_query, opts = {})
|
|
553
583
|
if @api_client.config.debugging
|
|
@@ -557,16 +587,21 @@ module KlaviyoAPI
|
|
|
557
587
|
if @api_client.config.client_side_validation && catalog_item_delete_job_create_query.nil?
|
|
558
588
|
fail ArgumentError, "Missing the required parameter 'catalog_item_delete_job_create_query' when calling CatalogsApi.bulk_delete_catalog_items"
|
|
559
589
|
end
|
|
590
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
591
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_delete_job'] && !opts[:'fields_catalog_item_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
|
592
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_delete_job\", must include one of #{allowable_values}"
|
|
593
|
+
end
|
|
560
594
|
# resource path
|
|
561
595
|
local_var_path = '/api/catalog-item-bulk-delete-jobs'
|
|
562
596
|
|
|
563
597
|
# query parameters
|
|
564
598
|
query_params = opts[:query_params] || {}
|
|
599
|
+
query_params[:'fields[catalog-item-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_delete_job'], :csv) if !opts[:'fields_catalog_item_bulk_delete_job'].nil?
|
|
565
600
|
|
|
566
601
|
# header parameters
|
|
567
602
|
header_params = opts[:header_params] || {}
|
|
568
603
|
# klaviyo api revision
|
|
569
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
604
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
570
605
|
# HTTP header 'Accept' (if needed)
|
|
571
606
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
572
607
|
# HTTP header 'Content-Type'
|
|
@@ -611,9 +646,10 @@ module KlaviyoAPI
|
|
|
611
646
|
alias create_catalog_item_bulk_delete_job_with_http_info bulk_delete_catalog_items_with_http_info
|
|
612
647
|
|
|
613
648
|
# Bulk Delete Catalog Variants
|
|
614
|
-
# 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`
|
|
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)
|
|
615
650
|
# @param catalog_variant_delete_job_create_query [CatalogVariantDeleteJobCreateQuery]
|
|
616
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-07-15/reference/api-overview#sparse-fieldsets
|
|
617
653
|
# @return [Hash<String, Object>]
|
|
618
654
|
def bulk_delete_catalog_variants(catalog_variant_delete_job_create_query, opts = {})
|
|
619
655
|
data, _status_code, _headers = bulk_delete_catalog_variants_with_http_info(catalog_variant_delete_job_create_query, opts)
|
|
@@ -627,9 +663,10 @@ module KlaviyoAPI
|
|
|
627
663
|
alias create_catalog_variant_bulk_delete_job bulk_delete_catalog_variants
|
|
628
664
|
|
|
629
665
|
# Bulk Delete Catalog Variants
|
|
630
|
-
# 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`
|
|
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)
|
|
631
667
|
# @param catalog_variant_delete_job_create_query [CatalogVariantDeleteJobCreateQuery]
|
|
632
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-07-15/reference/api-overview#sparse-fieldsets
|
|
633
670
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
634
671
|
def bulk_delete_catalog_variants_with_http_info(catalog_variant_delete_job_create_query, opts = {})
|
|
635
672
|
if @api_client.config.debugging
|
|
@@ -639,16 +676,21 @@ module KlaviyoAPI
|
|
|
639
676
|
if @api_client.config.client_side_validation && catalog_variant_delete_job_create_query.nil?
|
|
640
677
|
fail ArgumentError, "Missing the required parameter 'catalog_variant_delete_job_create_query' when calling CatalogsApi.bulk_delete_catalog_variants"
|
|
641
678
|
end
|
|
679
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
680
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_delete_job'] && !opts[:'fields_catalog_variant_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
|
681
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_delete_job\", must include one of #{allowable_values}"
|
|
682
|
+
end
|
|
642
683
|
# resource path
|
|
643
684
|
local_var_path = '/api/catalog-variant-bulk-delete-jobs'
|
|
644
685
|
|
|
645
686
|
# query parameters
|
|
646
687
|
query_params = opts[:query_params] || {}
|
|
688
|
+
query_params[:'fields[catalog-variant-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_delete_job'], :csv) if !opts[:'fields_catalog_variant_bulk_delete_job'].nil?
|
|
647
689
|
|
|
648
690
|
# header parameters
|
|
649
691
|
header_params = opts[:header_params] || {}
|
|
650
692
|
# klaviyo api revision
|
|
651
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
693
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
652
694
|
# HTTP header 'Accept' (if needed)
|
|
653
695
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
654
696
|
# HTTP header 'Content-Type'
|
|
@@ -693,9 +735,10 @@ module KlaviyoAPI
|
|
|
693
735
|
alias create_catalog_variant_bulk_delete_job_with_http_info bulk_delete_catalog_variants_with_http_info
|
|
694
736
|
|
|
695
737
|
# Bulk Update Catalog Categories
|
|
696
|
-
# 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`
|
|
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)
|
|
697
739
|
# @param catalog_category_update_job_create_query [CatalogCategoryUpdateJobCreateQuery]
|
|
698
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-07-15/reference/api-overview#sparse-fieldsets
|
|
699
742
|
# @return [Hash<String, Object>]
|
|
700
743
|
def bulk_update_catalog_categories(catalog_category_update_job_create_query, opts = {})
|
|
701
744
|
data, _status_code, _headers = bulk_update_catalog_categories_with_http_info(catalog_category_update_job_create_query, opts)
|
|
@@ -709,9 +752,10 @@ module KlaviyoAPI
|
|
|
709
752
|
alias create_catalog_category_bulk_update_job bulk_update_catalog_categories
|
|
710
753
|
|
|
711
754
|
# Bulk Update Catalog Categories
|
|
712
|
-
# 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`
|
|
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)
|
|
713
756
|
# @param catalog_category_update_job_create_query [CatalogCategoryUpdateJobCreateQuery]
|
|
714
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-07-15/reference/api-overview#sparse-fieldsets
|
|
715
759
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
716
760
|
def bulk_update_catalog_categories_with_http_info(catalog_category_update_job_create_query, opts = {})
|
|
717
761
|
if @api_client.config.debugging
|
|
@@ -721,16 +765,21 @@ module KlaviyoAPI
|
|
|
721
765
|
if @api_client.config.client_side_validation && catalog_category_update_job_create_query.nil?
|
|
722
766
|
fail ArgumentError, "Missing the required parameter 'catalog_category_update_job_create_query' when calling CatalogsApi.bulk_update_catalog_categories"
|
|
723
767
|
end
|
|
768
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
769
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_update_job'] && !opts[:'fields_catalog_category_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
|
770
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_update_job\", must include one of #{allowable_values}"
|
|
771
|
+
end
|
|
724
772
|
# resource path
|
|
725
773
|
local_var_path = '/api/catalog-category-bulk-update-jobs'
|
|
726
774
|
|
|
727
775
|
# query parameters
|
|
728
776
|
query_params = opts[:query_params] || {}
|
|
777
|
+
query_params[:'fields[catalog-category-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_update_job'], :csv) if !opts[:'fields_catalog_category_bulk_update_job'].nil?
|
|
729
778
|
|
|
730
779
|
# header parameters
|
|
731
780
|
header_params = opts[:header_params] || {}
|
|
732
781
|
# klaviyo api revision
|
|
733
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
782
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
734
783
|
# HTTP header 'Accept' (if needed)
|
|
735
784
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
736
785
|
# HTTP header 'Content-Type'
|
|
@@ -775,9 +824,10 @@ module KlaviyoAPI
|
|
|
775
824
|
alias create_catalog_category_bulk_update_job_with_http_info bulk_update_catalog_categories_with_http_info
|
|
776
825
|
|
|
777
826
|
# Bulk Update Catalog Items
|
|
778
|
-
# 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`
|
|
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)
|
|
779
828
|
# @param catalog_item_update_job_create_query [CatalogItemUpdateJobCreateQuery]
|
|
780
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-07-15/reference/api-overview#sparse-fieldsets
|
|
781
831
|
# @return [Hash<String, Object>]
|
|
782
832
|
def bulk_update_catalog_items(catalog_item_update_job_create_query, opts = {})
|
|
783
833
|
data, _status_code, _headers = bulk_update_catalog_items_with_http_info(catalog_item_update_job_create_query, opts)
|
|
@@ -791,9 +841,10 @@ module KlaviyoAPI
|
|
|
791
841
|
alias create_catalog_item_bulk_update_job bulk_update_catalog_items
|
|
792
842
|
|
|
793
843
|
# Bulk Update Catalog Items
|
|
794
|
-
# 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`
|
|
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)
|
|
795
845
|
# @param catalog_item_update_job_create_query [CatalogItemUpdateJobCreateQuery]
|
|
796
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-07-15/reference/api-overview#sparse-fieldsets
|
|
797
848
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
798
849
|
def bulk_update_catalog_items_with_http_info(catalog_item_update_job_create_query, opts = {})
|
|
799
850
|
if @api_client.config.debugging
|
|
@@ -803,16 +854,21 @@ module KlaviyoAPI
|
|
|
803
854
|
if @api_client.config.client_side_validation && catalog_item_update_job_create_query.nil?
|
|
804
855
|
fail ArgumentError, "Missing the required parameter 'catalog_item_update_job_create_query' when calling CatalogsApi.bulk_update_catalog_items"
|
|
805
856
|
end
|
|
857
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
858
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_update_job'] && !opts[:'fields_catalog_item_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
|
859
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_update_job\", must include one of #{allowable_values}"
|
|
860
|
+
end
|
|
806
861
|
# resource path
|
|
807
862
|
local_var_path = '/api/catalog-item-bulk-update-jobs'
|
|
808
863
|
|
|
809
864
|
# query parameters
|
|
810
865
|
query_params = opts[:query_params] || {}
|
|
866
|
+
query_params[:'fields[catalog-item-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_update_job'], :csv) if !opts[:'fields_catalog_item_bulk_update_job'].nil?
|
|
811
867
|
|
|
812
868
|
# header parameters
|
|
813
869
|
header_params = opts[:header_params] || {}
|
|
814
870
|
# klaviyo api revision
|
|
815
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
871
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
816
872
|
# HTTP header 'Accept' (if needed)
|
|
817
873
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
818
874
|
# HTTP header 'Content-Type'
|
|
@@ -857,9 +913,10 @@ module KlaviyoAPI
|
|
|
857
913
|
alias create_catalog_item_bulk_update_job_with_http_info bulk_update_catalog_items_with_http_info
|
|
858
914
|
|
|
859
915
|
# Bulk Update Catalog Variants
|
|
860
|
-
# 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`
|
|
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)
|
|
861
917
|
# @param catalog_variant_update_job_create_query [CatalogVariantUpdateJobCreateQuery]
|
|
862
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-07-15/reference/api-overview#sparse-fieldsets
|
|
863
920
|
# @return [Hash<String, Object>]
|
|
864
921
|
def bulk_update_catalog_variants(catalog_variant_update_job_create_query, opts = {})
|
|
865
922
|
data, _status_code, _headers = bulk_update_catalog_variants_with_http_info(catalog_variant_update_job_create_query, opts)
|
|
@@ -873,9 +930,10 @@ module KlaviyoAPI
|
|
|
873
930
|
alias create_catalog_variant_bulk_update_job bulk_update_catalog_variants
|
|
874
931
|
|
|
875
932
|
# Bulk Update Catalog Variants
|
|
876
|
-
# 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`
|
|
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)
|
|
877
934
|
# @param catalog_variant_update_job_create_query [CatalogVariantUpdateJobCreateQuery]
|
|
878
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-07-15/reference/api-overview#sparse-fieldsets
|
|
879
937
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
880
938
|
def bulk_update_catalog_variants_with_http_info(catalog_variant_update_job_create_query, opts = {})
|
|
881
939
|
if @api_client.config.debugging
|
|
@@ -885,16 +943,21 @@ module KlaviyoAPI
|
|
|
885
943
|
if @api_client.config.client_side_validation && catalog_variant_update_job_create_query.nil?
|
|
886
944
|
fail ArgumentError, "Missing the required parameter 'catalog_variant_update_job_create_query' when calling CatalogsApi.bulk_update_catalog_variants"
|
|
887
945
|
end
|
|
946
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
947
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_update_job'] && !opts[:'fields_catalog_variant_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
|
948
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_update_job\", must include one of #{allowable_values}"
|
|
949
|
+
end
|
|
888
950
|
# resource path
|
|
889
951
|
local_var_path = '/api/catalog-variant-bulk-update-jobs'
|
|
890
952
|
|
|
891
953
|
# query parameters
|
|
892
954
|
query_params = opts[:query_params] || {}
|
|
955
|
+
query_params[:'fields[catalog-variant-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_update_job'], :csv) if !opts[:'fields_catalog_variant_bulk_update_job'].nil?
|
|
893
956
|
|
|
894
957
|
# header parameters
|
|
895
958
|
header_params = opts[:header_params] || {}
|
|
896
959
|
# klaviyo api revision
|
|
897
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
960
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
898
961
|
# HTTP header 'Accept' (if needed)
|
|
899
962
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
900
963
|
# HTTP header 'Content-Type'
|
|
@@ -939,7 +1002,7 @@ module KlaviyoAPI
|
|
|
939
1002
|
alias create_catalog_variant_bulk_update_job_with_http_info bulk_update_catalog_variants_with_http_info
|
|
940
1003
|
|
|
941
1004
|
# Create Back In Stock Subscription
|
|
942
|
-
# Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details. This endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:write` `profiles:write`
|
|
1005
|
+
# Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details. This endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:write` `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_back_in_stock_subscription.json)
|
|
943
1006
|
# @param server_bis_subscription_create_query [ServerBISSubscriptionCreateQuery]
|
|
944
1007
|
# @param [Hash] opts the optional parameters
|
|
945
1008
|
# @return [nil]
|
|
@@ -949,7 +1012,7 @@ module KlaviyoAPI
|
|
|
949
1012
|
end
|
|
950
1013
|
|
|
951
1014
|
# Create Back In Stock Subscription
|
|
952
|
-
# Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details. This endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:write` `profiles:write`
|
|
1015
|
+
# Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details. This endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:write` `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_back_in_stock_subscription.json)
|
|
953
1016
|
# @param server_bis_subscription_create_query [ServerBISSubscriptionCreateQuery]
|
|
954
1017
|
# @param [Hash] opts the optional parameters
|
|
955
1018
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -970,7 +1033,7 @@ module KlaviyoAPI
|
|
|
970
1033
|
# header parameters
|
|
971
1034
|
header_params = opts[:header_params] || {}
|
|
972
1035
|
# klaviyo api revision
|
|
973
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1036
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
974
1037
|
# HTTP header 'Accept' (if needed)
|
|
975
1038
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
976
1039
|
# HTTP header 'Content-Type'
|
|
@@ -1009,9 +1072,10 @@ module KlaviyoAPI
|
|
|
1009
1072
|
end
|
|
1010
1073
|
|
|
1011
1074
|
# Create Catalog Category
|
|
1012
|
-
# Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
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)
|
|
1013
1076
|
# @param catalog_category_create_query [CatalogCategoryCreateQuery]
|
|
1014
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-07-15/reference/api-overview#sparse-fieldsets
|
|
1015
1079
|
# @return [Hash<String, Object>]
|
|
1016
1080
|
def create_catalog_category(catalog_category_create_query, opts = {})
|
|
1017
1081
|
data, _status_code, _headers = create_catalog_category_with_http_info(catalog_category_create_query, opts)
|
|
@@ -1019,9 +1083,10 @@ module KlaviyoAPI
|
|
|
1019
1083
|
end
|
|
1020
1084
|
|
|
1021
1085
|
# Create Catalog Category
|
|
1022
|
-
# Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
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)
|
|
1023
1087
|
# @param catalog_category_create_query [CatalogCategoryCreateQuery]
|
|
1024
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-07-15/reference/api-overview#sparse-fieldsets
|
|
1025
1090
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1026
1091
|
def create_catalog_category_with_http_info(catalog_category_create_query, opts = {})
|
|
1027
1092
|
if @api_client.config.debugging
|
|
@@ -1031,16 +1096,21 @@ module KlaviyoAPI
|
|
|
1031
1096
|
if @api_client.config.client_side_validation && catalog_category_create_query.nil?
|
|
1032
1097
|
fail ArgumentError, "Missing the required parameter 'catalog_category_create_query' when calling CatalogsApi.create_catalog_category"
|
|
1033
1098
|
end
|
|
1099
|
+
allowable_values = ["external_id", "id", "name", "updated"]
|
|
1100
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
|
1101
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}"
|
|
1102
|
+
end
|
|
1034
1103
|
# resource path
|
|
1035
1104
|
local_var_path = '/api/catalog-categories'
|
|
1036
1105
|
|
|
1037
1106
|
# query parameters
|
|
1038
1107
|
query_params = opts[:query_params] || {}
|
|
1108
|
+
query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].nil?
|
|
1039
1109
|
|
|
1040
1110
|
# header parameters
|
|
1041
1111
|
header_params = opts[:header_params] || {}
|
|
1042
1112
|
# klaviyo api revision
|
|
1043
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1113
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1044
1114
|
# HTTP header 'Accept' (if needed)
|
|
1045
1115
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1046
1116
|
# HTTP header 'Content-Type'
|
|
@@ -1079,9 +1149,10 @@ module KlaviyoAPI
|
|
|
1079
1149
|
end
|
|
1080
1150
|
|
|
1081
1151
|
# Create Catalog Item
|
|
1082
|
-
# Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
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)
|
|
1083
1153
|
# @param catalog_item_create_query [CatalogItemCreateQuery]
|
|
1084
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-07-15/reference/api-overview#sparse-fieldsets
|
|
1085
1156
|
# @return [Hash<String, Object>]
|
|
1086
1157
|
def create_catalog_item(catalog_item_create_query, opts = {})
|
|
1087
1158
|
data, _status_code, _headers = create_catalog_item_with_http_info(catalog_item_create_query, opts)
|
|
@@ -1089,9 +1160,10 @@ module KlaviyoAPI
|
|
|
1089
1160
|
end
|
|
1090
1161
|
|
|
1091
1162
|
# Create Catalog Item
|
|
1092
|
-
# Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
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)
|
|
1093
1164
|
# @param catalog_item_create_query [CatalogItemCreateQuery]
|
|
1094
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-07-15/reference/api-overview#sparse-fieldsets
|
|
1095
1167
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1096
1168
|
def create_catalog_item_with_http_info(catalog_item_create_query, opts = {})
|
|
1097
1169
|
if @api_client.config.debugging
|
|
@@ -1101,16 +1173,21 @@ module KlaviyoAPI
|
|
|
1101
1173
|
if @api_client.config.client_side_validation && catalog_item_create_query.nil?
|
|
1102
1174
|
fail ArgumentError, "Missing the required parameter 'catalog_item_create_query' when calling CatalogsApi.create_catalog_item"
|
|
1103
1175
|
end
|
|
1176
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "price", "published", "title", "updated", "url"]
|
|
1177
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
|
1178
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
|
1179
|
+
end
|
|
1104
1180
|
# resource path
|
|
1105
1181
|
local_var_path = '/api/catalog-items'
|
|
1106
1182
|
|
|
1107
1183
|
# query parameters
|
|
1108
1184
|
query_params = opts[:query_params] || {}
|
|
1185
|
+
query_params[:'fields[catalog-item]'] = @api_client.build_collection_param(opts[:'fields_catalog_item'], :csv) if !opts[:'fields_catalog_item'].nil?
|
|
1109
1186
|
|
|
1110
1187
|
# header parameters
|
|
1111
1188
|
header_params = opts[:header_params] || {}
|
|
1112
1189
|
# klaviyo api revision
|
|
1113
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1190
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1114
1191
|
# HTTP header 'Accept' (if needed)
|
|
1115
1192
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1116
1193
|
# HTTP header 'Content-Type'
|
|
@@ -1149,9 +1226,10 @@ module KlaviyoAPI
|
|
|
1149
1226
|
end
|
|
1150
1227
|
|
|
1151
1228
|
# Create Catalog Variant
|
|
1152
|
-
# Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
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)
|
|
1153
1230
|
# @param catalog_variant_create_query [CatalogVariantCreateQuery]
|
|
1154
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-07-15/reference/api-overview#sparse-fieldsets
|
|
1155
1233
|
# @return [Hash<String, Object>]
|
|
1156
1234
|
def create_catalog_variant(catalog_variant_create_query, opts = {})
|
|
1157
1235
|
data, _status_code, _headers = create_catalog_variant_with_http_info(catalog_variant_create_query, opts)
|
|
@@ -1159,9 +1237,10 @@ module KlaviyoAPI
|
|
|
1159
1237
|
end
|
|
1160
1238
|
|
|
1161
1239
|
# Create Catalog Variant
|
|
1162
|
-
# Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
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)
|
|
1163
1241
|
# @param catalog_variant_create_query [CatalogVariantCreateQuery]
|
|
1164
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-07-15/reference/api-overview#sparse-fieldsets
|
|
1165
1244
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1166
1245
|
def create_catalog_variant_with_http_info(catalog_variant_create_query, opts = {})
|
|
1167
1246
|
if @api_client.config.debugging
|
|
@@ -1171,16 +1250,21 @@ module KlaviyoAPI
|
|
|
1171
1250
|
if @api_client.config.client_side_validation && catalog_variant_create_query.nil?
|
|
1172
1251
|
fail ArgumentError, "Missing the required parameter 'catalog_variant_create_query' when calling CatalogsApi.create_catalog_variant"
|
|
1173
1252
|
end
|
|
1253
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
1254
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
|
1255
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
|
1256
|
+
end
|
|
1174
1257
|
# resource path
|
|
1175
1258
|
local_var_path = '/api/catalog-variants'
|
|
1176
1259
|
|
|
1177
1260
|
# query parameters
|
|
1178
1261
|
query_params = opts[:query_params] || {}
|
|
1262
|
+
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
|
1179
1263
|
|
|
1180
1264
|
# header parameters
|
|
1181
1265
|
header_params = opts[:header_params] || {}
|
|
1182
1266
|
# klaviyo api revision
|
|
1183
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1267
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1184
1268
|
# HTTP header 'Accept' (if needed)
|
|
1185
1269
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1186
1270
|
# HTTP header 'Content-Type'
|
|
@@ -1219,7 +1303,7 @@ module KlaviyoAPI
|
|
|
1219
1303
|
end
|
|
1220
1304
|
|
|
1221
1305
|
# Delete Catalog Category
|
|
1222
|
-
# Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
1306
|
+
# Delete a catalog category using the given category ID.<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/delete_catalog_category.json)
|
|
1223
1307
|
# @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`.
|
|
1224
1308
|
# @param [Hash] opts the optional parameters
|
|
1225
1309
|
# @return [nil]
|
|
@@ -1229,7 +1313,7 @@ module KlaviyoAPI
|
|
|
1229
1313
|
end
|
|
1230
1314
|
|
|
1231
1315
|
# Delete Catalog Category
|
|
1232
|
-
# Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
1316
|
+
# Delete a catalog category using the given category ID.<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/delete_catalog_category.json)
|
|
1233
1317
|
# @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`.
|
|
1234
1318
|
# @param [Hash] opts the optional parameters
|
|
1235
1319
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -1250,7 +1334,7 @@ module KlaviyoAPI
|
|
|
1250
1334
|
# header parameters
|
|
1251
1335
|
header_params = opts[:header_params] || {}
|
|
1252
1336
|
# klaviyo api revision
|
|
1253
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1337
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1254
1338
|
# HTTP header 'Accept' (if needed)
|
|
1255
1339
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1256
1340
|
|
|
@@ -1284,7 +1368,7 @@ module KlaviyoAPI
|
|
|
1284
1368
|
end
|
|
1285
1369
|
|
|
1286
1370
|
# Delete Catalog Item
|
|
1287
|
-
# Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
1371
|
+
# Delete a catalog item with the given item ID.<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/delete_catalog_item.json)
|
|
1288
1372
|
# @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`.
|
|
1289
1373
|
# @param [Hash] opts the optional parameters
|
|
1290
1374
|
# @return [nil]
|
|
@@ -1294,7 +1378,7 @@ module KlaviyoAPI
|
|
|
1294
1378
|
end
|
|
1295
1379
|
|
|
1296
1380
|
# Delete Catalog Item
|
|
1297
|
-
# Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
1381
|
+
# Delete a catalog item with the given item ID.<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/delete_catalog_item.json)
|
|
1298
1382
|
# @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`.
|
|
1299
1383
|
# @param [Hash] opts the optional parameters
|
|
1300
1384
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -1315,7 +1399,7 @@ module KlaviyoAPI
|
|
|
1315
1399
|
# header parameters
|
|
1316
1400
|
header_params = opts[:header_params] || {}
|
|
1317
1401
|
# klaviyo api revision
|
|
1318
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1402
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1319
1403
|
# HTTP header 'Accept' (if needed)
|
|
1320
1404
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1321
1405
|
|
|
@@ -1349,7 +1433,7 @@ module KlaviyoAPI
|
|
|
1349
1433
|
end
|
|
1350
1434
|
|
|
1351
1435
|
# Delete Catalog Variant
|
|
1352
|
-
# Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
1436
|
+
# Delete a catalog item variant with the given variant ID.<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/delete_catalog_variant.json)
|
|
1353
1437
|
# @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`.
|
|
1354
1438
|
# @param [Hash] opts the optional parameters
|
|
1355
1439
|
# @return [nil]
|
|
@@ -1359,7 +1443,7 @@ module KlaviyoAPI
|
|
|
1359
1443
|
end
|
|
1360
1444
|
|
|
1361
1445
|
# Delete Catalog Variant
|
|
1362
|
-
# Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
1446
|
+
# Delete a catalog item variant with the given variant ID.<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/delete_catalog_variant.json)
|
|
1363
1447
|
# @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`.
|
|
1364
1448
|
# @param [Hash] opts the optional parameters
|
|
1365
1449
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -1380,7 +1464,7 @@ module KlaviyoAPI
|
|
|
1380
1464
|
# header parameters
|
|
1381
1465
|
header_params = opts[:header_params] || {}
|
|
1382
1466
|
# klaviyo api revision
|
|
1383
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1467
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1384
1468
|
# HTTP header 'Accept' (if needed)
|
|
1385
1469
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1386
1470
|
|
|
@@ -1414,12 +1498,12 @@ module KlaviyoAPI
|
|
|
1414
1498
|
end
|
|
1415
1499
|
|
|
1416
1500
|
# Get Bulk Create Catalog Items Job
|
|
1417
|
-
# Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
1418
1502
|
# @param job_id [String] ID of the job to retrieve.
|
|
1419
1503
|
# @param [Hash] opts the optional parameters
|
|
1420
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1421
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1422
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
1506
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
1423
1507
|
# @return [Hash<String, Object>]
|
|
1424
1508
|
def get_bulk_create_catalog_items_job(job_id, opts = {})
|
|
1425
1509
|
data, _status_code, _headers = get_bulk_create_catalog_items_job_with_http_info(job_id, opts)
|
|
@@ -1433,12 +1517,12 @@ module KlaviyoAPI
|
|
|
1433
1517
|
alias get_catalog_item_bulk_create_job get_bulk_create_catalog_items_job
|
|
1434
1518
|
|
|
1435
1519
|
# Get Bulk Create Catalog Items Job
|
|
1436
|
-
# Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
1437
1521
|
# @param job_id [String] ID of the job to retrieve.
|
|
1438
1522
|
# @param [Hash] opts the optional parameters
|
|
1439
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1440
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1441
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
1525
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
1442
1526
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1443
1527
|
def get_bulk_create_catalog_items_job_with_http_info(job_id, opts = {})
|
|
1444
1528
|
if @api_client.config.debugging
|
|
@@ -1448,11 +1532,11 @@ module KlaviyoAPI
|
|
|
1448
1532
|
if @api_client.config.client_side_validation && job_id.nil?
|
|
1449
1533
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_create_catalog_items_job"
|
|
1450
1534
|
end
|
|
1451
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
1535
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
1452
1536
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_create_job'] && !opts[:'fields_catalog_item_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
|
1453
1537
|
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_create_job\", must include one of #{allowable_values}"
|
|
1454
1538
|
end
|
|
1455
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "price", "published", "title", "updated", "url"]
|
|
1539
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "price", "published", "title", "updated", "url"]
|
|
1456
1540
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
|
1457
1541
|
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
|
1458
1542
|
end
|
|
@@ -1472,7 +1556,7 @@ module KlaviyoAPI
|
|
|
1472
1556
|
# header parameters
|
|
1473
1557
|
header_params = opts[:header_params] || {}
|
|
1474
1558
|
# klaviyo api revision
|
|
1475
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1559
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1476
1560
|
# HTTP header 'Accept' (if needed)
|
|
1477
1561
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1478
1562
|
|
|
@@ -1512,11 +1596,11 @@ module KlaviyoAPI
|
|
|
1512
1596
|
alias get_catalog_item_bulk_create_job_with_http_info get_bulk_create_catalog_items_job_with_http_info
|
|
1513
1597
|
|
|
1514
1598
|
# Get Bulk Create Catalog Items Jobs
|
|
1515
|
-
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
1516
1600
|
# @param [Hash] opts the optional parameters
|
|
1517
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1518
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1519
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
1602
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
1603
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1520
1604
|
# @return [Hash<String, Object>]
|
|
1521
1605
|
def get_bulk_create_catalog_items_jobs(opts = {})
|
|
1522
1606
|
data, _status_code, _headers = get_bulk_create_catalog_items_jobs_with_http_info(opts)
|
|
@@ -1530,17 +1614,17 @@ module KlaviyoAPI
|
|
|
1530
1614
|
alias get_catalog_item_bulk_create_jobs get_bulk_create_catalog_items_jobs
|
|
1531
1615
|
|
|
1532
1616
|
# Get Bulk Create Catalog Items Jobs
|
|
1533
|
-
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
1534
1618
|
# @param [Hash] opts the optional parameters
|
|
1535
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1536
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1537
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
1620
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
1621
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1538
1622
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1539
1623
|
def get_bulk_create_catalog_items_jobs_with_http_info(opts = {})
|
|
1540
1624
|
if @api_client.config.debugging
|
|
1541
1625
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_create_catalog_items_jobs ...'
|
|
1542
1626
|
end
|
|
1543
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
1627
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
1544
1628
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_create_job'] && !opts[:'fields_catalog_item_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
|
1545
1629
|
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_create_job\", must include one of #{allowable_values}"
|
|
1546
1630
|
end
|
|
@@ -1556,7 +1640,7 @@ module KlaviyoAPI
|
|
|
1556
1640
|
# header parameters
|
|
1557
1641
|
header_params = opts[:header_params] || {}
|
|
1558
1642
|
# klaviyo api revision
|
|
1559
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1643
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1560
1644
|
# HTTP header 'Accept' (if needed)
|
|
1561
1645
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1562
1646
|
|
|
@@ -1596,12 +1680,12 @@ module KlaviyoAPI
|
|
|
1596
1680
|
alias get_catalog_item_bulk_create_jobs_with_http_info get_bulk_create_catalog_items_jobs_with_http_info
|
|
1597
1681
|
|
|
1598
1682
|
# Get Bulk Create Categories Job
|
|
1599
|
-
# Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
1600
1684
|
# @param job_id [String] ID of the job to retrieve.
|
|
1601
1685
|
# @param [Hash] opts the optional parameters
|
|
1602
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1603
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1604
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
1688
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
1605
1689
|
# @return [Hash<String, Object>]
|
|
1606
1690
|
def get_bulk_create_categories_job(job_id, opts = {})
|
|
1607
1691
|
data, _status_code, _headers = get_bulk_create_categories_job_with_http_info(job_id, opts)
|
|
@@ -1615,12 +1699,12 @@ module KlaviyoAPI
|
|
|
1615
1699
|
alias get_catalog_category_bulk_create_job get_bulk_create_categories_job
|
|
1616
1700
|
|
|
1617
1701
|
# Get Bulk Create Categories Job
|
|
1618
|
-
# Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
1619
1703
|
# @param job_id [String] ID of the job to retrieve.
|
|
1620
1704
|
# @param [Hash] opts the optional parameters
|
|
1621
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1622
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1623
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
1707
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
1624
1708
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1625
1709
|
def get_bulk_create_categories_job_with_http_info(job_id, opts = {})
|
|
1626
1710
|
if @api_client.config.debugging
|
|
@@ -1630,11 +1714,11 @@ module KlaviyoAPI
|
|
|
1630
1714
|
if @api_client.config.client_side_validation && job_id.nil?
|
|
1631
1715
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_create_categories_job"
|
|
1632
1716
|
end
|
|
1633
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
1717
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
1634
1718
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_create_job'] && !opts[:'fields_catalog_category_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
|
1635
1719
|
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_create_job\", must include one of #{allowable_values}"
|
|
1636
1720
|
end
|
|
1637
|
-
allowable_values = ["external_id", "name", "updated"]
|
|
1721
|
+
allowable_values = ["external_id", "id", "name", "updated"]
|
|
1638
1722
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
|
1639
1723
|
fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}"
|
|
1640
1724
|
end
|
|
@@ -1654,7 +1738,7 @@ module KlaviyoAPI
|
|
|
1654
1738
|
# header parameters
|
|
1655
1739
|
header_params = opts[:header_params] || {}
|
|
1656
1740
|
# klaviyo api revision
|
|
1657
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1741
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1658
1742
|
# HTTP header 'Accept' (if needed)
|
|
1659
1743
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1660
1744
|
|
|
@@ -1694,11 +1778,11 @@ module KlaviyoAPI
|
|
|
1694
1778
|
alias get_catalog_category_bulk_create_job_with_http_info get_bulk_create_categories_job_with_http_info
|
|
1695
1779
|
|
|
1696
1780
|
# Get Bulk Create Categories Jobs
|
|
1697
|
-
# Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
1698
1782
|
# @param [Hash] opts the optional parameters
|
|
1699
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1700
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1701
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
1784
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
1785
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1702
1786
|
# @return [Hash<String, Object>]
|
|
1703
1787
|
def get_bulk_create_categories_jobs(opts = {})
|
|
1704
1788
|
data, _status_code, _headers = get_bulk_create_categories_jobs_with_http_info(opts)
|
|
@@ -1712,17 +1796,17 @@ module KlaviyoAPI
|
|
|
1712
1796
|
alias get_catalog_category_bulk_create_jobs get_bulk_create_categories_jobs
|
|
1713
1797
|
|
|
1714
1798
|
# Get Bulk Create Categories Jobs
|
|
1715
|
-
# Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
1716
1800
|
# @param [Hash] opts the optional parameters
|
|
1717
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1718
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1719
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
1802
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
1803
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1720
1804
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1721
1805
|
def get_bulk_create_categories_jobs_with_http_info(opts = {})
|
|
1722
1806
|
if @api_client.config.debugging
|
|
1723
1807
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_create_categories_jobs ...'
|
|
1724
1808
|
end
|
|
1725
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
1809
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
1726
1810
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_create_job'] && !opts[:'fields_catalog_category_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
|
1727
1811
|
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_create_job\", must include one of #{allowable_values}"
|
|
1728
1812
|
end
|
|
@@ -1738,7 +1822,7 @@ module KlaviyoAPI
|
|
|
1738
1822
|
# header parameters
|
|
1739
1823
|
header_params = opts[:header_params] || {}
|
|
1740
1824
|
# klaviyo api revision
|
|
1741
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1825
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1742
1826
|
# HTTP header 'Accept' (if needed)
|
|
1743
1827
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1744
1828
|
|
|
@@ -1778,12 +1862,12 @@ module KlaviyoAPI
|
|
|
1778
1862
|
alias get_catalog_category_bulk_create_jobs_with_http_info get_bulk_create_categories_jobs_with_http_info
|
|
1779
1863
|
|
|
1780
1864
|
# Get Bulk Create Variants Job
|
|
1781
|
-
# Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
1782
1866
|
# @param job_id [String] ID of the job to retrieve.
|
|
1783
1867
|
# @param [Hash] opts the optional parameters
|
|
1784
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1785
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1786
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
1870
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
1787
1871
|
# @return [Hash<String, Object>]
|
|
1788
1872
|
def get_bulk_create_variants_job(job_id, opts = {})
|
|
1789
1873
|
data, _status_code, _headers = get_bulk_create_variants_job_with_http_info(job_id, opts)
|
|
@@ -1797,12 +1881,12 @@ module KlaviyoAPI
|
|
|
1797
1881
|
alias get_catalog_variant_bulk_create_job get_bulk_create_variants_job
|
|
1798
1882
|
|
|
1799
1883
|
# Get Bulk Create Variants Job
|
|
1800
|
-
# Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
1801
1885
|
# @param job_id [String] ID of the job to retrieve.
|
|
1802
1886
|
# @param [Hash] opts the optional parameters
|
|
1803
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1804
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1805
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
1889
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
1806
1890
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1807
1891
|
def get_bulk_create_variants_job_with_http_info(job_id, opts = {})
|
|
1808
1892
|
if @api_client.config.debugging
|
|
@@ -1812,11 +1896,11 @@ module KlaviyoAPI
|
|
|
1812
1896
|
if @api_client.config.client_side_validation && job_id.nil?
|
|
1813
1897
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_create_variants_job"
|
|
1814
1898
|
end
|
|
1815
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
1899
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
1816
1900
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_create_job'] && !opts[:'fields_catalog_variant_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
|
1817
1901
|
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_create_job\", must include one of #{allowable_values}"
|
|
1818
1902
|
end
|
|
1819
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
1903
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
1820
1904
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
|
1821
1905
|
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
|
1822
1906
|
end
|
|
@@ -1836,7 +1920,7 @@ module KlaviyoAPI
|
|
|
1836
1920
|
# header parameters
|
|
1837
1921
|
header_params = opts[:header_params] || {}
|
|
1838
1922
|
# klaviyo api revision
|
|
1839
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1923
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1840
1924
|
# HTTP header 'Accept' (if needed)
|
|
1841
1925
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1842
1926
|
|
|
@@ -1876,11 +1960,11 @@ module KlaviyoAPI
|
|
|
1876
1960
|
alias get_catalog_variant_bulk_create_job_with_http_info get_bulk_create_variants_job_with_http_info
|
|
1877
1961
|
|
|
1878
1962
|
# Get Bulk Create Variants Jobs
|
|
1879
|
-
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
1880
1964
|
# @param [Hash] opts the optional parameters
|
|
1881
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1882
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1883
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
1966
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
1967
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1884
1968
|
# @return [Hash<String, Object>]
|
|
1885
1969
|
def get_bulk_create_variants_jobs(opts = {})
|
|
1886
1970
|
data, _status_code, _headers = get_bulk_create_variants_jobs_with_http_info(opts)
|
|
@@ -1894,17 +1978,17 @@ module KlaviyoAPI
|
|
|
1894
1978
|
alias get_catalog_variant_bulk_create_jobs get_bulk_create_variants_jobs
|
|
1895
1979
|
|
|
1896
1980
|
# Get Bulk Create Variants Jobs
|
|
1897
|
-
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
1898
1982
|
# @param [Hash] opts the optional parameters
|
|
1899
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1900
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1901
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
1984
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
1985
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1902
1986
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1903
1987
|
def get_bulk_create_variants_jobs_with_http_info(opts = {})
|
|
1904
1988
|
if @api_client.config.debugging
|
|
1905
1989
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_create_variants_jobs ...'
|
|
1906
1990
|
end
|
|
1907
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
1991
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
1908
1992
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_create_job'] && !opts[:'fields_catalog_variant_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
|
1909
1993
|
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_create_job\", must include one of #{allowable_values}"
|
|
1910
1994
|
end
|
|
@@ -1920,7 +2004,7 @@ module KlaviyoAPI
|
|
|
1920
2004
|
# header parameters
|
|
1921
2005
|
header_params = opts[:header_params] || {}
|
|
1922
2006
|
# klaviyo api revision
|
|
1923
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2007
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1924
2008
|
# HTTP header 'Accept' (if needed)
|
|
1925
2009
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1926
2010
|
|
|
@@ -1960,10 +2044,10 @@ module KlaviyoAPI
|
|
|
1960
2044
|
alias get_catalog_variant_bulk_create_jobs_with_http_info get_bulk_create_variants_jobs_with_http_info
|
|
1961
2045
|
|
|
1962
2046
|
# Get Bulk Delete Catalog Items Job
|
|
1963
|
-
# Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
1964
2048
|
# @param job_id [String] ID of the job to retrieve.
|
|
1965
2049
|
# @param [Hash] opts the optional parameters
|
|
1966
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
1967
2051
|
# @return [Hash<String, Object>]
|
|
1968
2052
|
def get_bulk_delete_catalog_items_job(job_id, opts = {})
|
|
1969
2053
|
data, _status_code, _headers = get_bulk_delete_catalog_items_job_with_http_info(job_id, opts)
|
|
@@ -1977,10 +2061,10 @@ module KlaviyoAPI
|
|
|
1977
2061
|
alias get_catalog_item_bulk_delete_job get_bulk_delete_catalog_items_job
|
|
1978
2062
|
|
|
1979
2063
|
# Get Bulk Delete Catalog Items Job
|
|
1980
|
-
# Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
1981
2065
|
# @param job_id [String] ID of the job to retrieve.
|
|
1982
2066
|
# @param [Hash] opts the optional parameters
|
|
1983
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
1984
2068
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1985
2069
|
def get_bulk_delete_catalog_items_job_with_http_info(job_id, opts = {})
|
|
1986
2070
|
if @api_client.config.debugging
|
|
@@ -1990,7 +2074,7 @@ module KlaviyoAPI
|
|
|
1990
2074
|
if @api_client.config.client_side_validation && job_id.nil?
|
|
1991
2075
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_delete_catalog_items_job"
|
|
1992
2076
|
end
|
|
1993
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
2077
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
1994
2078
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_delete_job'] && !opts[:'fields_catalog_item_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
|
1995
2079
|
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_delete_job\", must include one of #{allowable_values}"
|
|
1996
2080
|
end
|
|
@@ -2004,7 +2088,7 @@ module KlaviyoAPI
|
|
|
2004
2088
|
# header parameters
|
|
2005
2089
|
header_params = opts[:header_params] || {}
|
|
2006
2090
|
# klaviyo api revision
|
|
2007
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2091
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2008
2092
|
# HTTP header 'Accept' (if needed)
|
|
2009
2093
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2010
2094
|
|
|
@@ -2044,11 +2128,11 @@ module KlaviyoAPI
|
|
|
2044
2128
|
alias get_catalog_item_bulk_delete_job_with_http_info get_bulk_delete_catalog_items_job_with_http_info
|
|
2045
2129
|
|
|
2046
2130
|
# Get Bulk Delete Catalog Items Jobs
|
|
2047
|
-
# Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2048
2132
|
# @param [Hash] opts the optional parameters
|
|
2049
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2050
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2051
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2134
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2135
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2052
2136
|
# @return [Hash<String, Object>]
|
|
2053
2137
|
def get_bulk_delete_catalog_items_jobs(opts = {})
|
|
2054
2138
|
data, _status_code, _headers = get_bulk_delete_catalog_items_jobs_with_http_info(opts)
|
|
@@ -2062,17 +2146,17 @@ module KlaviyoAPI
|
|
|
2062
2146
|
alias get_catalog_item_bulk_delete_jobs get_bulk_delete_catalog_items_jobs
|
|
2063
2147
|
|
|
2064
2148
|
# Get Bulk Delete Catalog Items Jobs
|
|
2065
|
-
# Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2066
2150
|
# @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-
|
|
2068
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2069
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2152
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2153
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2070
2154
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2071
2155
|
def get_bulk_delete_catalog_items_jobs_with_http_info(opts = {})
|
|
2072
2156
|
if @api_client.config.debugging
|
|
2073
2157
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_delete_catalog_items_jobs ...'
|
|
2074
2158
|
end
|
|
2075
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
2159
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
2076
2160
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_delete_job'] && !opts[:'fields_catalog_item_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
|
2077
2161
|
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_delete_job\", must include one of #{allowable_values}"
|
|
2078
2162
|
end
|
|
@@ -2088,7 +2172,7 @@ module KlaviyoAPI
|
|
|
2088
2172
|
# header parameters
|
|
2089
2173
|
header_params = opts[:header_params] || {}
|
|
2090
2174
|
# klaviyo api revision
|
|
2091
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2175
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2092
2176
|
# HTTP header 'Accept' (if needed)
|
|
2093
2177
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2094
2178
|
|
|
@@ -2128,10 +2212,10 @@ module KlaviyoAPI
|
|
|
2128
2212
|
alias get_catalog_item_bulk_delete_jobs_with_http_info get_bulk_delete_catalog_items_jobs_with_http_info
|
|
2129
2213
|
|
|
2130
2214
|
# Get Bulk Delete Categories Job
|
|
2131
|
-
# Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2132
2216
|
# @param job_id [String] ID of the job to retrieve.
|
|
2133
2217
|
# @param [Hash] opts the optional parameters
|
|
2134
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2135
2219
|
# @return [Hash<String, Object>]
|
|
2136
2220
|
def get_bulk_delete_categories_job(job_id, opts = {})
|
|
2137
2221
|
data, _status_code, _headers = get_bulk_delete_categories_job_with_http_info(job_id, opts)
|
|
@@ -2145,10 +2229,10 @@ module KlaviyoAPI
|
|
|
2145
2229
|
alias get_catalog_category_bulk_delete_job get_bulk_delete_categories_job
|
|
2146
2230
|
|
|
2147
2231
|
# Get Bulk Delete Categories Job
|
|
2148
|
-
# Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2149
2233
|
# @param job_id [String] ID of the job to retrieve.
|
|
2150
2234
|
# @param [Hash] opts the optional parameters
|
|
2151
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2152
2236
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2153
2237
|
def get_bulk_delete_categories_job_with_http_info(job_id, opts = {})
|
|
2154
2238
|
if @api_client.config.debugging
|
|
@@ -2158,7 +2242,7 @@ module KlaviyoAPI
|
|
|
2158
2242
|
if @api_client.config.client_side_validation && job_id.nil?
|
|
2159
2243
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_delete_categories_job"
|
|
2160
2244
|
end
|
|
2161
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
2245
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
2162
2246
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_delete_job'] && !opts[:'fields_catalog_category_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
|
2163
2247
|
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_delete_job\", must include one of #{allowable_values}"
|
|
2164
2248
|
end
|
|
@@ -2172,7 +2256,7 @@ module KlaviyoAPI
|
|
|
2172
2256
|
# header parameters
|
|
2173
2257
|
header_params = opts[:header_params] || {}
|
|
2174
2258
|
# klaviyo api revision
|
|
2175
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2259
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2176
2260
|
# HTTP header 'Accept' (if needed)
|
|
2177
2261
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2178
2262
|
|
|
@@ -2212,11 +2296,11 @@ module KlaviyoAPI
|
|
|
2212
2296
|
alias get_catalog_category_bulk_delete_job_with_http_info get_bulk_delete_categories_job_with_http_info
|
|
2213
2297
|
|
|
2214
2298
|
# Get Bulk Delete Categories Jobs
|
|
2215
|
-
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2216
2300
|
# @param [Hash] opts the optional parameters
|
|
2217
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2218
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2219
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2302
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2303
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2220
2304
|
# @return [Hash<String, Object>]
|
|
2221
2305
|
def get_bulk_delete_categories_jobs(opts = {})
|
|
2222
2306
|
data, _status_code, _headers = get_bulk_delete_categories_jobs_with_http_info(opts)
|
|
@@ -2230,17 +2314,17 @@ module KlaviyoAPI
|
|
|
2230
2314
|
alias get_catalog_category_bulk_delete_jobs get_bulk_delete_categories_jobs
|
|
2231
2315
|
|
|
2232
2316
|
# Get Bulk Delete Categories Jobs
|
|
2233
|
-
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2234
2318
|
# @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-
|
|
2236
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2237
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2320
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2321
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2238
2322
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2239
2323
|
def get_bulk_delete_categories_jobs_with_http_info(opts = {})
|
|
2240
2324
|
if @api_client.config.debugging
|
|
2241
2325
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_delete_categories_jobs ...'
|
|
2242
2326
|
end
|
|
2243
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
2327
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
2244
2328
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_delete_job'] && !opts[:'fields_catalog_category_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
|
2245
2329
|
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_delete_job\", must include one of #{allowable_values}"
|
|
2246
2330
|
end
|
|
@@ -2256,7 +2340,7 @@ module KlaviyoAPI
|
|
|
2256
2340
|
# header parameters
|
|
2257
2341
|
header_params = opts[:header_params] || {}
|
|
2258
2342
|
# klaviyo api revision
|
|
2259
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2343
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2260
2344
|
# HTTP header 'Accept' (if needed)
|
|
2261
2345
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2262
2346
|
|
|
@@ -2296,10 +2380,10 @@ module KlaviyoAPI
|
|
|
2296
2380
|
alias get_catalog_category_bulk_delete_jobs_with_http_info get_bulk_delete_categories_jobs_with_http_info
|
|
2297
2381
|
|
|
2298
2382
|
# Get Bulk Delete Variants Job
|
|
2299
|
-
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2300
2384
|
# @param job_id [String] ID of the job to retrieve.
|
|
2301
2385
|
# @param [Hash] opts the optional parameters
|
|
2302
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2303
2387
|
# @return [Hash<String, Object>]
|
|
2304
2388
|
def get_bulk_delete_variants_job(job_id, opts = {})
|
|
2305
2389
|
data, _status_code, _headers = get_bulk_delete_variants_job_with_http_info(job_id, opts)
|
|
@@ -2313,10 +2397,10 @@ module KlaviyoAPI
|
|
|
2313
2397
|
alias get_catalog_variant_bulk_delete_job get_bulk_delete_variants_job
|
|
2314
2398
|
|
|
2315
2399
|
# Get Bulk Delete Variants Job
|
|
2316
|
-
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2317
2401
|
# @param job_id [String] ID of the job to retrieve.
|
|
2318
2402
|
# @param [Hash] opts the optional parameters
|
|
2319
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2320
2404
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2321
2405
|
def get_bulk_delete_variants_job_with_http_info(job_id, opts = {})
|
|
2322
2406
|
if @api_client.config.debugging
|
|
@@ -2326,7 +2410,7 @@ module KlaviyoAPI
|
|
|
2326
2410
|
if @api_client.config.client_side_validation && job_id.nil?
|
|
2327
2411
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_delete_variants_job"
|
|
2328
2412
|
end
|
|
2329
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
2413
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
2330
2414
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_delete_job'] && !opts[:'fields_catalog_variant_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
|
2331
2415
|
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_delete_job\", must include one of #{allowable_values}"
|
|
2332
2416
|
end
|
|
@@ -2340,7 +2424,7 @@ module KlaviyoAPI
|
|
|
2340
2424
|
# header parameters
|
|
2341
2425
|
header_params = opts[:header_params] || {}
|
|
2342
2426
|
# klaviyo api revision
|
|
2343
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2427
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2344
2428
|
# HTTP header 'Accept' (if needed)
|
|
2345
2429
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2346
2430
|
|
|
@@ -2380,11 +2464,11 @@ module KlaviyoAPI
|
|
|
2380
2464
|
alias get_catalog_variant_bulk_delete_job_with_http_info get_bulk_delete_variants_job_with_http_info
|
|
2381
2465
|
|
|
2382
2466
|
# Get Bulk Delete Variants Jobs
|
|
2383
|
-
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2384
2468
|
# @param [Hash] opts the optional parameters
|
|
2385
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2386
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2387
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2470
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2471
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2388
2472
|
# @return [Hash<String, Object>]
|
|
2389
2473
|
def get_bulk_delete_variants_jobs(opts = {})
|
|
2390
2474
|
data, _status_code, _headers = get_bulk_delete_variants_jobs_with_http_info(opts)
|
|
@@ -2398,17 +2482,17 @@ module KlaviyoAPI
|
|
|
2398
2482
|
alias get_catalog_variant_bulk_delete_jobs get_bulk_delete_variants_jobs
|
|
2399
2483
|
|
|
2400
2484
|
# Get Bulk Delete Variants Jobs
|
|
2401
|
-
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2402
2486
|
# @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-
|
|
2404
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2405
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2488
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2489
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2406
2490
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2407
2491
|
def get_bulk_delete_variants_jobs_with_http_info(opts = {})
|
|
2408
2492
|
if @api_client.config.debugging
|
|
2409
2493
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_delete_variants_jobs ...'
|
|
2410
2494
|
end
|
|
2411
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
2495
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
2412
2496
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_delete_job'] && !opts[:'fields_catalog_variant_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
|
2413
2497
|
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_delete_job\", must include one of #{allowable_values}"
|
|
2414
2498
|
end
|
|
@@ -2424,7 +2508,7 @@ module KlaviyoAPI
|
|
|
2424
2508
|
# header parameters
|
|
2425
2509
|
header_params = opts[:header_params] || {}
|
|
2426
2510
|
# klaviyo api revision
|
|
2427
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2511
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2428
2512
|
# HTTP header 'Accept' (if needed)
|
|
2429
2513
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2430
2514
|
|
|
@@ -2464,12 +2548,12 @@ module KlaviyoAPI
|
|
|
2464
2548
|
alias get_catalog_variant_bulk_delete_jobs_with_http_info get_bulk_delete_variants_jobs_with_http_info
|
|
2465
2549
|
|
|
2466
2550
|
# Get Bulk Update Catalog Items Job
|
|
2467
|
-
# Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
2468
2552
|
# @param job_id [String] ID of the job to retrieve.
|
|
2469
2553
|
# @param [Hash] opts the optional parameters
|
|
2470
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2471
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2472
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
2556
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
2473
2557
|
# @return [Hash<String, Object>]
|
|
2474
2558
|
def get_bulk_update_catalog_items_job(job_id, opts = {})
|
|
2475
2559
|
data, _status_code, _headers = get_bulk_update_catalog_items_job_with_http_info(job_id, opts)
|
|
@@ -2483,12 +2567,12 @@ module KlaviyoAPI
|
|
|
2483
2567
|
alias get_catalog_item_bulk_update_job get_bulk_update_catalog_items_job
|
|
2484
2568
|
|
|
2485
2569
|
# Get Bulk Update Catalog Items Job
|
|
2486
|
-
# Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
2487
2571
|
# @param job_id [String] ID of the job to retrieve.
|
|
2488
2572
|
# @param [Hash] opts the optional parameters
|
|
2489
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2490
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2491
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
2575
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
2492
2576
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2493
2577
|
def get_bulk_update_catalog_items_job_with_http_info(job_id, opts = {})
|
|
2494
2578
|
if @api_client.config.debugging
|
|
@@ -2498,11 +2582,11 @@ module KlaviyoAPI
|
|
|
2498
2582
|
if @api_client.config.client_side_validation && job_id.nil?
|
|
2499
2583
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_update_catalog_items_job"
|
|
2500
2584
|
end
|
|
2501
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
2585
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
2502
2586
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_update_job'] && !opts[:'fields_catalog_item_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
|
2503
2587
|
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_update_job\", must include one of #{allowable_values}"
|
|
2504
2588
|
end
|
|
2505
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "price", "published", "title", "updated", "url"]
|
|
2589
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "price", "published", "title", "updated", "url"]
|
|
2506
2590
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
|
2507
2591
|
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
|
2508
2592
|
end
|
|
@@ -2522,7 +2606,7 @@ module KlaviyoAPI
|
|
|
2522
2606
|
# header parameters
|
|
2523
2607
|
header_params = opts[:header_params] || {}
|
|
2524
2608
|
# klaviyo api revision
|
|
2525
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2609
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2526
2610
|
# HTTP header 'Accept' (if needed)
|
|
2527
2611
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2528
2612
|
|
|
@@ -2562,11 +2646,11 @@ module KlaviyoAPI
|
|
|
2562
2646
|
alias get_catalog_item_bulk_update_job_with_http_info get_bulk_update_catalog_items_job_with_http_info
|
|
2563
2647
|
|
|
2564
2648
|
# Get Bulk Update Catalog Items Jobs
|
|
2565
|
-
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
2566
2650
|
# @param [Hash] opts the optional parameters
|
|
2567
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2568
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2569
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2652
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2653
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2570
2654
|
# @return [Hash<String, Object>]
|
|
2571
2655
|
def get_bulk_update_catalog_items_jobs(opts = {})
|
|
2572
2656
|
data, _status_code, _headers = get_bulk_update_catalog_items_jobs_with_http_info(opts)
|
|
@@ -2580,17 +2664,17 @@ module KlaviyoAPI
|
|
|
2580
2664
|
alias get_catalog_item_bulk_update_jobs get_bulk_update_catalog_items_jobs
|
|
2581
2665
|
|
|
2582
2666
|
# Get Bulk Update Catalog Items Jobs
|
|
2583
|
-
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
2584
2668
|
# @param [Hash] opts the optional parameters
|
|
2585
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2586
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2587
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2670
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2671
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2588
2672
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2589
2673
|
def get_bulk_update_catalog_items_jobs_with_http_info(opts = {})
|
|
2590
2674
|
if @api_client.config.debugging
|
|
2591
2675
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_update_catalog_items_jobs ...'
|
|
2592
2676
|
end
|
|
2593
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
2677
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
2594
2678
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_update_job'] && !opts[:'fields_catalog_item_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
|
2595
2679
|
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_update_job\", must include one of #{allowable_values}"
|
|
2596
2680
|
end
|
|
@@ -2606,7 +2690,7 @@ module KlaviyoAPI
|
|
|
2606
2690
|
# header parameters
|
|
2607
2691
|
header_params = opts[:header_params] || {}
|
|
2608
2692
|
# klaviyo api revision
|
|
2609
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2693
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2610
2694
|
# HTTP header 'Accept' (if needed)
|
|
2611
2695
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2612
2696
|
|
|
@@ -2646,12 +2730,12 @@ module KlaviyoAPI
|
|
|
2646
2730
|
alias get_catalog_item_bulk_update_jobs_with_http_info get_bulk_update_catalog_items_jobs_with_http_info
|
|
2647
2731
|
|
|
2648
2732
|
# Get Bulk Update Categories Job
|
|
2649
|
-
# Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2650
2734
|
# @param job_id [String] ID of the job to retrieve.
|
|
2651
2735
|
# @param [Hash] opts the optional parameters
|
|
2652
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2653
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2654
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
2738
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
2655
2739
|
# @return [Hash<String, Object>]
|
|
2656
2740
|
def get_bulk_update_categories_job(job_id, opts = {})
|
|
2657
2741
|
data, _status_code, _headers = get_bulk_update_categories_job_with_http_info(job_id, opts)
|
|
@@ -2665,12 +2749,12 @@ module KlaviyoAPI
|
|
|
2665
2749
|
alias get_catalog_category_bulk_update_job get_bulk_update_categories_job
|
|
2666
2750
|
|
|
2667
2751
|
# Get Bulk Update Categories Job
|
|
2668
|
-
# Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2669
2753
|
# @param job_id [String] ID of the job to retrieve.
|
|
2670
2754
|
# @param [Hash] opts the optional parameters
|
|
2671
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2672
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2673
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
2757
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
2674
2758
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2675
2759
|
def get_bulk_update_categories_job_with_http_info(job_id, opts = {})
|
|
2676
2760
|
if @api_client.config.debugging
|
|
@@ -2680,11 +2764,11 @@ module KlaviyoAPI
|
|
|
2680
2764
|
if @api_client.config.client_side_validation && job_id.nil?
|
|
2681
2765
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_update_categories_job"
|
|
2682
2766
|
end
|
|
2683
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
2767
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
2684
2768
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_update_job'] && !opts[:'fields_catalog_category_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
|
2685
2769
|
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_update_job\", must include one of #{allowable_values}"
|
|
2686
2770
|
end
|
|
2687
|
-
allowable_values = ["external_id", "name", "updated"]
|
|
2771
|
+
allowable_values = ["external_id", "id", "name", "updated"]
|
|
2688
2772
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
|
2689
2773
|
fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}"
|
|
2690
2774
|
end
|
|
@@ -2704,7 +2788,7 @@ module KlaviyoAPI
|
|
|
2704
2788
|
# header parameters
|
|
2705
2789
|
header_params = opts[:header_params] || {}
|
|
2706
2790
|
# klaviyo api revision
|
|
2707
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2791
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2708
2792
|
# HTTP header 'Accept' (if needed)
|
|
2709
2793
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2710
2794
|
|
|
@@ -2744,11 +2828,11 @@ module KlaviyoAPI
|
|
|
2744
2828
|
alias get_catalog_category_bulk_update_job_with_http_info get_bulk_update_categories_job_with_http_info
|
|
2745
2829
|
|
|
2746
2830
|
# Get Bulk Update Categories Jobs
|
|
2747
|
-
# Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2748
2832
|
# @param [Hash] opts the optional parameters
|
|
2749
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2750
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2751
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2834
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2835
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2752
2836
|
# @return [Hash<String, Object>]
|
|
2753
2837
|
def get_bulk_update_categories_jobs(opts = {})
|
|
2754
2838
|
data, _status_code, _headers = get_bulk_update_categories_jobs_with_http_info(opts)
|
|
@@ -2762,17 +2846,17 @@ module KlaviyoAPI
|
|
|
2762
2846
|
alias get_catalog_category_bulk_update_jobs get_bulk_update_categories_jobs
|
|
2763
2847
|
|
|
2764
2848
|
# Get Bulk Update Categories Jobs
|
|
2765
|
-
# Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
2766
2850
|
# @param [Hash] opts the optional parameters
|
|
2767
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2768
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2769
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
2852
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2853
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2770
2854
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2771
2855
|
def get_bulk_update_categories_jobs_with_http_info(opts = {})
|
|
2772
2856
|
if @api_client.config.debugging
|
|
2773
2857
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_update_categories_jobs ...'
|
|
2774
2858
|
end
|
|
2775
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
2859
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
2776
2860
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_update_job'] && !opts[:'fields_catalog_category_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
|
2777
2861
|
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_update_job\", must include one of #{allowable_values}"
|
|
2778
2862
|
end
|
|
@@ -2788,7 +2872,7 @@ module KlaviyoAPI
|
|
|
2788
2872
|
# header parameters
|
|
2789
2873
|
header_params = opts[:header_params] || {}
|
|
2790
2874
|
# klaviyo api revision
|
|
2791
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2875
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2792
2876
|
# HTTP header 'Accept' (if needed)
|
|
2793
2877
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2794
2878
|
|
|
@@ -2828,12 +2912,12 @@ module KlaviyoAPI
|
|
|
2828
2912
|
alias get_catalog_category_bulk_update_jobs_with_http_info get_bulk_update_categories_jobs_with_http_info
|
|
2829
2913
|
|
|
2830
2914
|
# Get Bulk Update Variants Job
|
|
2831
|
-
# Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
2832
2916
|
# @param job_id [String] ID of the job to retrieve.
|
|
2833
2917
|
# @param [Hash] opts the optional parameters
|
|
2834
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2835
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2836
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
2920
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
2837
2921
|
# @return [Hash<String, Object>]
|
|
2838
2922
|
def get_bulk_update_variants_job(job_id, opts = {})
|
|
2839
2923
|
data, _status_code, _headers = get_bulk_update_variants_job_with_http_info(job_id, opts)
|
|
@@ -2847,12 +2931,12 @@ module KlaviyoAPI
|
|
|
2847
2931
|
alias get_catalog_variant_bulk_update_job get_bulk_update_variants_job
|
|
2848
2932
|
|
|
2849
2933
|
# Get Bulk Update Variants Job
|
|
2850
|
-
# Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
2851
2935
|
# @param job_id [String] ID of the job to retrieve.
|
|
2852
2936
|
# @param [Hash] opts the optional parameters
|
|
2853
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2854
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2855
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
2939
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
2856
2940
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2857
2941
|
def get_bulk_update_variants_job_with_http_info(job_id, opts = {})
|
|
2858
2942
|
if @api_client.config.debugging
|
|
@@ -2862,11 +2946,11 @@ module KlaviyoAPI
|
|
|
2862
2946
|
if @api_client.config.client_side_validation && job_id.nil?
|
|
2863
2947
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_update_variants_job"
|
|
2864
2948
|
end
|
|
2865
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
2949
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
2866
2950
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_update_job'] && !opts[:'fields_catalog_variant_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
|
2867
2951
|
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_update_job\", must include one of #{allowable_values}"
|
|
2868
2952
|
end
|
|
2869
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
2953
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
2870
2954
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
|
2871
2955
|
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
|
2872
2956
|
end
|
|
@@ -2886,7 +2970,7 @@ module KlaviyoAPI
|
|
|
2886
2970
|
# header parameters
|
|
2887
2971
|
header_params = opts[:header_params] || {}
|
|
2888
2972
|
# klaviyo api revision
|
|
2889
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2973
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2890
2974
|
# HTTP header 'Accept' (if needed)
|
|
2891
2975
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2892
2976
|
|
|
@@ -2926,11 +3010,11 @@ module KlaviyoAPI
|
|
|
2926
3010
|
alias get_catalog_variant_bulk_update_job_with_http_info get_bulk_update_variants_job_with_http_info
|
|
2927
3011
|
|
|
2928
3012
|
# Get Bulk Update Variants Jobs
|
|
2929
|
-
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
2930
3014
|
# @param [Hash] opts the optional parameters
|
|
2931
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2932
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2933
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
3016
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
3017
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2934
3018
|
# @return [Hash<String, Object>]
|
|
2935
3019
|
def get_bulk_update_variants_jobs(opts = {})
|
|
2936
3020
|
data, _status_code, _headers = get_bulk_update_variants_jobs_with_http_info(opts)
|
|
@@ -2944,17 +3028,17 @@ module KlaviyoAPI
|
|
|
2944
3028
|
alias get_catalog_variant_bulk_update_jobs get_bulk_update_variants_jobs
|
|
2945
3029
|
|
|
2946
3030
|
# Get Bulk Update Variants Jobs
|
|
2947
|
-
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `
|
|
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)
|
|
2948
3032
|
# @param [Hash] opts the optional parameters
|
|
2949
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2950
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2951
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
3034
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
3035
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2952
3036
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2953
3037
|
def get_bulk_update_variants_jobs_with_http_info(opts = {})
|
|
2954
3038
|
if @api_client.config.debugging
|
|
2955
3039
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_update_variants_jobs ...'
|
|
2956
3040
|
end
|
|
2957
|
-
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "status", "total_count"]
|
|
3041
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "errors", "expires_at", "failed_count", "id", "status", "total_count"]
|
|
2958
3042
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_update_job'] && !opts[:'fields_catalog_variant_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
|
2959
3043
|
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_update_job\", must include one of #{allowable_values}"
|
|
2960
3044
|
end
|
|
@@ -2970,7 +3054,7 @@ module KlaviyoAPI
|
|
|
2970
3054
|
# header parameters
|
|
2971
3055
|
header_params = opts[:header_params] || {}
|
|
2972
3056
|
# klaviyo api revision
|
|
2973
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3057
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2974
3058
|
# HTTP header 'Accept' (if needed)
|
|
2975
3059
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2976
3060
|
|
|
@@ -3010,12 +3094,13 @@ module KlaviyoAPI
|
|
|
3010
3094
|
alias get_catalog_variant_bulk_update_jobs_with_http_info get_bulk_update_variants_jobs_with_http_info
|
|
3011
3095
|
|
|
3012
3096
|
# Get Catalog Categories
|
|
3013
|
-
# Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3014
3098
|
# @param [Hash] opts the optional parameters
|
|
3015
|
-
# @option opts [Array<String>] :fields_catalog_category 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-
|
|
3018
|
-
# @option opts [
|
|
3099
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
3100
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
|
3101
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3019
3104
|
# @return [Hash<String, Object>]
|
|
3020
3105
|
def get_catalog_categories(opts = {})
|
|
3021
3106
|
data, _status_code, _headers = get_catalog_categories_with_http_info(opts)
|
|
@@ -3023,21 +3108,30 @@ module KlaviyoAPI
|
|
|
3023
3108
|
end
|
|
3024
3109
|
|
|
3025
3110
|
# Get Catalog Categories
|
|
3026
|
-
# Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3027
3112
|
# @param [Hash] opts the optional parameters
|
|
3028
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3029
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3030
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3031
|
-
# @option opts [
|
|
3113
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
3114
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
|
3115
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3032
3118
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3033
3119
|
def get_catalog_categories_with_http_info(opts = {})
|
|
3034
3120
|
if @api_client.config.debugging
|
|
3035
3121
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_categories ...'
|
|
3036
3122
|
end
|
|
3037
|
-
allowable_values = ["external_id", "name", "updated"]
|
|
3123
|
+
allowable_values = ["external_id", "id", "name", "updated"]
|
|
3038
3124
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
|
3039
3125
|
fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}"
|
|
3040
3126
|
end
|
|
3127
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
3128
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_catalog_categories, must be smaller than or equal to 100.'
|
|
3129
|
+
end
|
|
3130
|
+
|
|
3131
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
3132
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_catalog_categories, must be greater than or equal to 1.'
|
|
3133
|
+
end
|
|
3134
|
+
|
|
3041
3135
|
allowable_values = ["created", "-created"]
|
|
3042
3136
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
3043
3137
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
@@ -3050,12 +3144,13 @@ module KlaviyoAPI
|
|
|
3050
3144
|
query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].nil?
|
|
3051
3145
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
3052
3146
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
3147
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
3053
3148
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
3054
3149
|
|
|
3055
3150
|
# header parameters
|
|
3056
3151
|
header_params = opts[:header_params] || {}
|
|
3057
3152
|
# klaviyo api revision
|
|
3058
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3153
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
3059
3154
|
# HTTP header 'Accept' (if needed)
|
|
3060
3155
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3061
3156
|
|
|
@@ -3089,10 +3184,10 @@ module KlaviyoAPI
|
|
|
3089
3184
|
end
|
|
3090
3185
|
|
|
3091
3186
|
# Get Catalog Category
|
|
3092
|
-
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3093
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`.
|
|
3094
3189
|
# @param [Hash] opts the optional parameters
|
|
3095
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
3096
3191
|
# @return [Hash<String, Object>]
|
|
3097
3192
|
def get_catalog_category(id, opts = {})
|
|
3098
3193
|
data, _status_code, _headers = get_catalog_category_with_http_info(id, opts)
|
|
@@ -3100,10 +3195,10 @@ module KlaviyoAPI
|
|
|
3100
3195
|
end
|
|
3101
3196
|
|
|
3102
3197
|
# Get Catalog Category
|
|
3103
|
-
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3104
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`.
|
|
3105
3200
|
# @param [Hash] opts the optional parameters
|
|
3106
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
3107
3202
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3108
3203
|
def get_catalog_category_with_http_info(id, opts = {})
|
|
3109
3204
|
if @api_client.config.debugging
|
|
@@ -3113,7 +3208,7 @@ module KlaviyoAPI
|
|
|
3113
3208
|
if @api_client.config.client_side_validation && id.nil?
|
|
3114
3209
|
fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.get_catalog_category"
|
|
3115
3210
|
end
|
|
3116
|
-
allowable_values = ["external_id", "name", "updated"]
|
|
3211
|
+
allowable_values = ["external_id", "id", "name", "updated"]
|
|
3117
3212
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
|
3118
3213
|
fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}"
|
|
3119
3214
|
end
|
|
@@ -3127,7 +3222,7 @@ module KlaviyoAPI
|
|
|
3127
3222
|
# header parameters
|
|
3128
3223
|
header_params = opts[:header_params] || {}
|
|
3129
3224
|
# klaviyo api revision
|
|
3130
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3225
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
3131
3226
|
# HTTP header 'Accept' (if needed)
|
|
3132
3227
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3133
3228
|
|
|
@@ -3161,12 +3256,12 @@ module KlaviyoAPI
|
|
|
3161
3256
|
end
|
|
3162
3257
|
|
|
3163
3258
|
# Get Catalog Item
|
|
3164
|
-
# Get a specific catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3165
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`.
|
|
3166
3261
|
# @param [Hash] opts the optional parameters
|
|
3167
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3168
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3169
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
3264
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
3170
3265
|
# @return [Hash<String, Object>]
|
|
3171
3266
|
def get_catalog_item(id, opts = {})
|
|
3172
3267
|
data, _status_code, _headers = get_catalog_item_with_http_info(id, opts)
|
|
@@ -3174,12 +3269,12 @@ module KlaviyoAPI
|
|
|
3174
3269
|
end
|
|
3175
3270
|
|
|
3176
3271
|
# Get Catalog Item
|
|
3177
|
-
# Get a specific catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3178
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`.
|
|
3179
3274
|
# @param [Hash] opts the optional parameters
|
|
3180
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3181
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3182
|
-
# @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-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
3277
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
3183
3278
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3184
3279
|
def get_catalog_item_with_http_info(id, opts = {})
|
|
3185
3280
|
if @api_client.config.debugging
|
|
@@ -3189,11 +3284,11 @@ module KlaviyoAPI
|
|
|
3189
3284
|
if @api_client.config.client_side_validation && id.nil?
|
|
3190
3285
|
fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.get_catalog_item"
|
|
3191
3286
|
end
|
|
3192
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "price", "published", "title", "updated", "url"]
|
|
3287
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "price", "published", "title", "updated", "url"]
|
|
3193
3288
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
|
3194
3289
|
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
|
3195
3290
|
end
|
|
3196
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
3291
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
3197
3292
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
|
3198
3293
|
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
|
3199
3294
|
end
|
|
@@ -3213,7 +3308,7 @@ module KlaviyoAPI
|
|
|
3213
3308
|
# header parameters
|
|
3214
3309
|
header_params = opts[:header_params] || {}
|
|
3215
3310
|
# klaviyo api revision
|
|
3216
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3311
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
3217
3312
|
# HTTP header 'Accept' (if needed)
|
|
3218
3313
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3219
3314
|
|
|
@@ -3247,14 +3342,15 @@ module KlaviyoAPI
|
|
|
3247
3342
|
end
|
|
3248
3343
|
|
|
3249
3344
|
# Get Catalog Items
|
|
3250
|
-
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3251
3346
|
# @param [Hash] opts the optional parameters
|
|
3252
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3253
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3254
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3255
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3256
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3257
|
-
# @option opts [
|
|
3347
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
3349
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
3350
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
3351
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3258
3354
|
# @return [Hash<String, Object>]
|
|
3259
3355
|
def get_catalog_items(opts = {})
|
|
3260
3356
|
data, _status_code, _headers = get_catalog_items_with_http_info(opts)
|
|
@@ -3262,24 +3358,25 @@ module KlaviyoAPI
|
|
|
3262
3358
|
end
|
|
3263
3359
|
|
|
3264
3360
|
# Get Catalog Items
|
|
3265
|
-
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3266
3362
|
# @param [Hash] opts the optional parameters
|
|
3267
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3268
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3269
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3270
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3271
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3272
|
-
# @option opts [
|
|
3363
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
3365
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
3366
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
3367
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3273
3370
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3274
3371
|
def get_catalog_items_with_http_info(opts = {})
|
|
3275
3372
|
if @api_client.config.debugging
|
|
3276
3373
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_items ...'
|
|
3277
3374
|
end
|
|
3278
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "price", "published", "title", "updated", "url"]
|
|
3375
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "price", "published", "title", "updated", "url"]
|
|
3279
3376
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
|
3280
3377
|
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
|
3281
3378
|
end
|
|
3282
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
3379
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
3283
3380
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
|
3284
3381
|
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
|
3285
3382
|
end
|
|
@@ -3287,6 +3384,14 @@ module KlaviyoAPI
|
|
|
3287
3384
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
3288
3385
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
3289
3386
|
end
|
|
3387
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
3388
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_catalog_items, must be smaller than or equal to 100.'
|
|
3389
|
+
end
|
|
3390
|
+
|
|
3391
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
3392
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_catalog_items, must be greater than or equal to 1.'
|
|
3393
|
+
end
|
|
3394
|
+
|
|
3290
3395
|
allowable_values = ["created", "-created"]
|
|
3291
3396
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
3292
3397
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
@@ -3301,12 +3406,13 @@ module KlaviyoAPI
|
|
|
3301
3406
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
3302
3407
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
3303
3408
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
3409
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
3304
3410
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
3305
3411
|
|
|
3306
3412
|
# header parameters
|
|
3307
3413
|
header_params = opts[:header_params] || {}
|
|
3308
3414
|
# klaviyo api revision
|
|
3309
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3415
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
3310
3416
|
# HTTP header 'Accept' (if needed)
|
|
3311
3417
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3312
3418
|
|
|
@@ -3340,10 +3446,10 @@ module KlaviyoAPI
|
|
|
3340
3446
|
end
|
|
3341
3447
|
|
|
3342
3448
|
# Get Catalog Variant
|
|
3343
|
-
# Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3344
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`.
|
|
3345
3451
|
# @param [Hash] opts the optional parameters
|
|
3346
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
3347
3453
|
# @return [Hash<String, Object>]
|
|
3348
3454
|
def get_catalog_variant(id, opts = {})
|
|
3349
3455
|
data, _status_code, _headers = get_catalog_variant_with_http_info(id, opts)
|
|
@@ -3351,10 +3457,10 @@ module KlaviyoAPI
|
|
|
3351
3457
|
end
|
|
3352
3458
|
|
|
3353
3459
|
# Get Catalog Variant
|
|
3354
|
-
# Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3355
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`.
|
|
3356
3462
|
# @param [Hash] opts the optional parameters
|
|
3357
|
-
# @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-07-15/reference/api-overview#sparse-fieldsets
|
|
3358
3464
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3359
3465
|
def get_catalog_variant_with_http_info(id, opts = {})
|
|
3360
3466
|
if @api_client.config.debugging
|
|
@@ -3364,7 +3470,7 @@ module KlaviyoAPI
|
|
|
3364
3470
|
if @api_client.config.client_side_validation && id.nil?
|
|
3365
3471
|
fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.get_catalog_variant"
|
|
3366
3472
|
end
|
|
3367
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
3473
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
3368
3474
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
|
3369
3475
|
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
|
3370
3476
|
end
|
|
@@ -3378,7 +3484,7 @@ module KlaviyoAPI
|
|
|
3378
3484
|
# header parameters
|
|
3379
3485
|
header_params = opts[:header_params] || {}
|
|
3380
3486
|
# klaviyo api revision
|
|
3381
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3487
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
3382
3488
|
# HTTP header 'Accept' (if needed)
|
|
3383
3489
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3384
3490
|
|
|
@@ -3412,12 +3518,13 @@ module KlaviyoAPI
|
|
|
3412
3518
|
end
|
|
3413
3519
|
|
|
3414
3520
|
# Get Catalog Variants
|
|
3415
|
-
# Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3416
3522
|
# @param [Hash] opts the optional parameters
|
|
3417
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3418
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3419
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3420
|
-
# @option opts [
|
|
3523
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
3524
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
3525
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3421
3528
|
# @return [Hash<String, Object>]
|
|
3422
3529
|
def get_catalog_variants(opts = {})
|
|
3423
3530
|
data, _status_code, _headers = get_catalog_variants_with_http_info(opts)
|
|
@@ -3425,21 +3532,30 @@ module KlaviyoAPI
|
|
|
3425
3532
|
end
|
|
3426
3533
|
|
|
3427
3534
|
# Get Catalog Variants
|
|
3428
|
-
# Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3429
3536
|
# @param [Hash] opts the optional parameters
|
|
3430
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3431
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3432
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3433
|
-
# @option opts [
|
|
3537
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
3538
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
3539
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3434
3542
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3435
3543
|
def get_catalog_variants_with_http_info(opts = {})
|
|
3436
3544
|
if @api_client.config.debugging
|
|
3437
3545
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_variants ...'
|
|
3438
3546
|
end
|
|
3439
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
3547
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
3440
3548
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
|
3441
3549
|
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
|
3442
3550
|
end
|
|
3551
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
3552
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_catalog_variants, must be smaller than or equal to 100.'
|
|
3553
|
+
end
|
|
3554
|
+
|
|
3555
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
3556
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_catalog_variants, must be greater than or equal to 1.'
|
|
3557
|
+
end
|
|
3558
|
+
|
|
3443
3559
|
allowable_values = ["created", "-created"]
|
|
3444
3560
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
3445
3561
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
@@ -3452,12 +3568,13 @@ module KlaviyoAPI
|
|
|
3452
3568
|
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
|
3453
3569
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
3454
3570
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
3571
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
3455
3572
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
3456
3573
|
|
|
3457
3574
|
# header parameters
|
|
3458
3575
|
header_params = opts[:header_params] || {}
|
|
3459
3576
|
# klaviyo api revision
|
|
3460
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3577
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
3461
3578
|
# HTTP header 'Accept' (if needed)
|
|
3462
3579
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3463
3580
|
|
|
@@ -3491,13 +3608,14 @@ module KlaviyoAPI
|
|
|
3491
3608
|
end
|
|
3492
3609
|
|
|
3493
3610
|
# Get Categories for Catalog Item
|
|
3494
|
-
# Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3495
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`.
|
|
3496
3613
|
# @param [Hash] opts the optional parameters
|
|
3497
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3498
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3499
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3500
|
-
# @option opts [
|
|
3614
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
3615
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
|
3616
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3501
3619
|
# @return [Hash<String, Object>]
|
|
3502
3620
|
def get_categories_for_catalog_item(id, opts = {})
|
|
3503
3621
|
data, _status_code, _headers = get_categories_for_catalog_item_with_http_info(id, opts)
|
|
@@ -3508,22 +3626,31 @@ module KlaviyoAPI
|
|
|
3508
3626
|
alias get_catalog_item_categories get_categories_for_catalog_item
|
|
3509
3627
|
|
|
3510
3628
|
# Get Categories for Catalog Item
|
|
3511
|
-
# Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3512
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`.
|
|
3513
3631
|
# @param [Hash] opts the optional parameters
|
|
3514
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3515
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3516
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3517
|
-
# @option opts [
|
|
3632
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
3633
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
|
3634
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3518
3637
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3519
3638
|
def get_categories_for_catalog_item_with_http_info(id, opts = {})
|
|
3520
3639
|
if @api_client.config.debugging
|
|
3521
3640
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_categories_for_catalog_item ...'
|
|
3522
3641
|
end
|
|
3523
|
-
allowable_values = ["external_id", "name", "updated"]
|
|
3642
|
+
allowable_values = ["external_id", "id", "name", "updated"]
|
|
3524
3643
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
|
3525
3644
|
fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}"
|
|
3526
3645
|
end
|
|
3646
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
3647
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_categories_for_catalog_item, must be smaller than or equal to 100.'
|
|
3648
|
+
end
|
|
3649
|
+
|
|
3650
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
3651
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_categories_for_catalog_item, must be greater than or equal to 1.'
|
|
3652
|
+
end
|
|
3653
|
+
|
|
3527
3654
|
allowable_values = ["created", "-created"]
|
|
3528
3655
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
3529
3656
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
@@ -3536,12 +3663,13 @@ module KlaviyoAPI
|
|
|
3536
3663
|
query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].nil?
|
|
3537
3664
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
3538
3665
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
3666
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
3539
3667
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
3540
3668
|
|
|
3541
3669
|
# header parameters
|
|
3542
3670
|
header_params = opts[:header_params] || {}
|
|
3543
3671
|
# klaviyo api revision
|
|
3544
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3672
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
3545
3673
|
# HTTP header 'Accept' (if needed)
|
|
3546
3674
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3547
3675
|
|
|
@@ -3578,12 +3706,13 @@ module KlaviyoAPI
|
|
|
3578
3706
|
alias get_catalog_item_categories_with_http_info get_categories_for_catalog_item_with_http_info
|
|
3579
3707
|
|
|
3580
3708
|
# Get Category IDs for Catalog Item
|
|
3581
|
-
# Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3582
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`.
|
|
3583
3711
|
# @param [Hash] opts the optional parameters
|
|
3584
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3585
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3586
|
-
# @option opts [
|
|
3712
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
|
3713
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3587
3716
|
# @return [Hash<String, Object>]
|
|
3588
3717
|
def get_category_ids_for_catalog_item(id, opts = {})
|
|
3589
3718
|
data, _status_code, _headers = get_category_ids_for_catalog_item_with_http_info(id, opts)
|
|
@@ -3594,17 +3723,26 @@ module KlaviyoAPI
|
|
|
3594
3723
|
alias get_catalog_item_relationships_categories get_category_ids_for_catalog_item
|
|
3595
3724
|
|
|
3596
3725
|
# Get Category IDs for Catalog Item
|
|
3597
|
-
# Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3598
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`.
|
|
3599
3728
|
# @param [Hash] opts the optional parameters
|
|
3600
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3601
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3602
|
-
# @option opts [
|
|
3729
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
|
3730
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3603
3733
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3604
3734
|
def get_category_ids_for_catalog_item_with_http_info(id, opts = {})
|
|
3605
3735
|
if @api_client.config.debugging
|
|
3606
3736
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_category_ids_for_catalog_item ...'
|
|
3607
3737
|
end
|
|
3738
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
3739
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_category_ids_for_catalog_item, must be smaller than or equal to 100.'
|
|
3740
|
+
end
|
|
3741
|
+
|
|
3742
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
3743
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_category_ids_for_catalog_item, must be greater than or equal to 1.'
|
|
3744
|
+
end
|
|
3745
|
+
|
|
3608
3746
|
allowable_values = ["created", "-created"]
|
|
3609
3747
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
3610
3748
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
@@ -3616,12 +3754,13 @@ module KlaviyoAPI
|
|
|
3616
3754
|
query_params = opts[:query_params] || {}
|
|
3617
3755
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
3618
3756
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
3757
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
3619
3758
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
3620
3759
|
|
|
3621
3760
|
# header parameters
|
|
3622
3761
|
header_params = opts[:header_params] || {}
|
|
3623
3762
|
# klaviyo api revision
|
|
3624
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3763
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
3625
3764
|
# HTTP header 'Accept' (if needed)
|
|
3626
3765
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3627
3766
|
|
|
@@ -3658,12 +3797,13 @@ module KlaviyoAPI
|
|
|
3658
3797
|
alias get_catalog_item_relationships_categories_with_http_info get_category_ids_for_catalog_item_with_http_info
|
|
3659
3798
|
|
|
3660
3799
|
# Get Item IDs for Catalog Category
|
|
3661
|
-
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3662
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`.
|
|
3663
3802
|
# @param [Hash] opts the optional parameters
|
|
3664
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3665
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3666
|
-
# @option opts [
|
|
3803
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
3804
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3667
3807
|
# @return [Hash<String, Object>]
|
|
3668
3808
|
def get_item_ids_for_catalog_category(id, opts = {})
|
|
3669
3809
|
data, _status_code, _headers = get_item_ids_for_catalog_category_with_http_info(id, opts)
|
|
@@ -3674,17 +3814,26 @@ module KlaviyoAPI
|
|
|
3674
3814
|
alias get_catalog_category_relationships_items get_item_ids_for_catalog_category
|
|
3675
3815
|
|
|
3676
3816
|
# Get Item IDs for Catalog Category
|
|
3677
|
-
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3678
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`.
|
|
3679
3819
|
# @param [Hash] opts the optional parameters
|
|
3680
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3681
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3682
|
-
# @option opts [
|
|
3820
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
3821
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3683
3824
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3684
3825
|
def get_item_ids_for_catalog_category_with_http_info(id, opts = {})
|
|
3685
3826
|
if @api_client.config.debugging
|
|
3686
3827
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_item_ids_for_catalog_category ...'
|
|
3687
3828
|
end
|
|
3829
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
3830
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_item_ids_for_catalog_category, must be smaller than or equal to 100.'
|
|
3831
|
+
end
|
|
3832
|
+
|
|
3833
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
3834
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_item_ids_for_catalog_category, must be greater than or equal to 1.'
|
|
3835
|
+
end
|
|
3836
|
+
|
|
3688
3837
|
allowable_values = ["created", "-created"]
|
|
3689
3838
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
3690
3839
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
@@ -3696,12 +3845,13 @@ module KlaviyoAPI
|
|
|
3696
3845
|
query_params = opts[:query_params] || {}
|
|
3697
3846
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
3698
3847
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
3848
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
3699
3849
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
3700
3850
|
|
|
3701
3851
|
# header parameters
|
|
3702
3852
|
header_params = opts[:header_params] || {}
|
|
3703
3853
|
# klaviyo api revision
|
|
3704
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3854
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
3705
3855
|
# HTTP header 'Accept' (if needed)
|
|
3706
3856
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3707
3857
|
|
|
@@ -3738,15 +3888,16 @@ module KlaviyoAPI
|
|
|
3738
3888
|
alias get_catalog_category_relationships_items_with_http_info get_item_ids_for_catalog_category_with_http_info
|
|
3739
3889
|
|
|
3740
3890
|
# Get Items for Catalog Category
|
|
3741
|
-
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3742
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`.
|
|
3743
3893
|
# @param [Hash] opts the optional parameters
|
|
3744
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3745
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3746
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3747
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3748
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3749
|
-
# @option opts [
|
|
3894
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
3896
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
3897
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
3898
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3750
3901
|
# @return [Hash<String, Object>]
|
|
3751
3902
|
def get_items_for_catalog_category(id, opts = {})
|
|
3752
3903
|
data, _status_code, _headers = get_items_for_catalog_category_with_http_info(id, opts)
|
|
@@ -3757,25 +3908,26 @@ module KlaviyoAPI
|
|
|
3757
3908
|
alias get_catalog_category_items get_items_for_catalog_category
|
|
3758
3909
|
|
|
3759
3910
|
# Get Items for Catalog Category
|
|
3760
|
-
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3761
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`.
|
|
3762
3913
|
# @param [Hash] opts the optional parameters
|
|
3763
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3764
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3765
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3766
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3767
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3768
|
-
# @option opts [
|
|
3914
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2026-07-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-07-15/reference/api-overview#sparse-fieldsets
|
|
3916
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
3917
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
3918
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3769
3921
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3770
3922
|
def get_items_for_catalog_category_with_http_info(id, opts = {})
|
|
3771
3923
|
if @api_client.config.debugging
|
|
3772
3924
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_items_for_catalog_category ...'
|
|
3773
3925
|
end
|
|
3774
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "price", "published", "title", "updated", "url"]
|
|
3926
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "price", "published", "title", "updated", "url"]
|
|
3775
3927
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
|
3776
3928
|
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
|
3777
3929
|
end
|
|
3778
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
3930
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
3779
3931
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
|
3780
3932
|
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
|
3781
3933
|
end
|
|
@@ -3783,6 +3935,14 @@ module KlaviyoAPI
|
|
|
3783
3935
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
3784
3936
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
3785
3937
|
end
|
|
3938
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
3939
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_items_for_catalog_category, must be smaller than or equal to 100.'
|
|
3940
|
+
end
|
|
3941
|
+
|
|
3942
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
3943
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_items_for_catalog_category, must be greater than or equal to 1.'
|
|
3944
|
+
end
|
|
3945
|
+
|
|
3786
3946
|
allowable_values = ["created", "-created"]
|
|
3787
3947
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
3788
3948
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
@@ -3797,12 +3957,13 @@ module KlaviyoAPI
|
|
|
3797
3957
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
3798
3958
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
3799
3959
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
3960
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
3800
3961
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
3801
3962
|
|
|
3802
3963
|
# header parameters
|
|
3803
3964
|
header_params = opts[:header_params] || {}
|
|
3804
3965
|
# klaviyo api revision
|
|
3805
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3966
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
3806
3967
|
# HTTP header 'Accept' (if needed)
|
|
3807
3968
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3808
3969
|
|
|
@@ -3839,12 +4000,13 @@ module KlaviyoAPI
|
|
|
3839
4000
|
alias get_catalog_category_items_with_http_info get_items_for_catalog_category_with_http_info
|
|
3840
4001
|
|
|
3841
4002
|
# Get Variant IDs for Catalog Item
|
|
3842
|
-
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3843
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`.
|
|
3844
4005
|
# @param [Hash] opts the optional parameters
|
|
3845
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3846
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3847
|
-
# @option opts [
|
|
4006
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
4007
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3848
4010
|
# @return [Hash<String, Object>]
|
|
3849
4011
|
def get_variant_ids_for_catalog_item(id, opts = {})
|
|
3850
4012
|
data, _status_code, _headers = get_variant_ids_for_catalog_item_with_http_info(id, opts)
|
|
@@ -3855,17 +4017,26 @@ module KlaviyoAPI
|
|
|
3855
4017
|
alias get_catalog_item_relationships_variants get_variant_ids_for_catalog_item
|
|
3856
4018
|
|
|
3857
4019
|
# Get Variant IDs for Catalog Item
|
|
3858
|
-
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3859
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`.
|
|
3860
4022
|
# @param [Hash] opts the optional parameters
|
|
3861
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3862
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3863
|
-
# @option opts [
|
|
4023
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
4024
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3864
4027
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3865
4028
|
def get_variant_ids_for_catalog_item_with_http_info(id, opts = {})
|
|
3866
4029
|
if @api_client.config.debugging
|
|
3867
4030
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_variant_ids_for_catalog_item ...'
|
|
3868
4031
|
end
|
|
4032
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
4033
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_variant_ids_for_catalog_item, must be smaller than or equal to 100.'
|
|
4034
|
+
end
|
|
4035
|
+
|
|
4036
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
4037
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_variant_ids_for_catalog_item, must be greater than or equal to 1.'
|
|
4038
|
+
end
|
|
4039
|
+
|
|
3869
4040
|
allowable_values = ["created", "-created"]
|
|
3870
4041
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
3871
4042
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
@@ -3877,12 +4048,13 @@ module KlaviyoAPI
|
|
|
3877
4048
|
query_params = opts[:query_params] || {}
|
|
3878
4049
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
3879
4050
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
4051
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
3880
4052
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
3881
4053
|
|
|
3882
4054
|
# header parameters
|
|
3883
4055
|
header_params = opts[:header_params] || {}
|
|
3884
4056
|
# klaviyo api revision
|
|
3885
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4057
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
3886
4058
|
# HTTP header 'Accept' (if needed)
|
|
3887
4059
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3888
4060
|
|
|
@@ -3919,13 +4091,14 @@ module KlaviyoAPI
|
|
|
3919
4091
|
alias get_catalog_item_relationships_variants_with_http_info get_variant_ids_for_catalog_item_with_http_info
|
|
3920
4092
|
|
|
3921
4093
|
# Get Variants for Catalog Item
|
|
3922
|
-
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3923
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`.
|
|
3924
4096
|
# @param [Hash] opts the optional parameters
|
|
3925
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3926
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3927
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3928
|
-
# @option opts [
|
|
4097
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
4098
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
4099
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3929
4102
|
# @return [Hash<String, Object>]
|
|
3930
4103
|
def get_variants_for_catalog_item(id, opts = {})
|
|
3931
4104
|
data, _status_code, _headers = get_variants_for_catalog_item_with_http_info(id, opts)
|
|
@@ -3936,22 +4109,31 @@ module KlaviyoAPI
|
|
|
3936
4109
|
alias get_catalog_item_variants get_variants_for_catalog_item
|
|
3937
4110
|
|
|
3938
4111
|
# Get Variants for Catalog Item
|
|
3939
|
-
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
|
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)
|
|
3940
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`.
|
|
3941
4114
|
# @param [Hash] opts the optional parameters
|
|
3942
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3943
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3944
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3945
|
-
# @option opts [
|
|
4115
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
4116
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
4117
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
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-07-15/reference/api-overview#sorting
|
|
3946
4120
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3947
4121
|
def get_variants_for_catalog_item_with_http_info(id, opts = {})
|
|
3948
4122
|
if @api_client.config.debugging
|
|
3949
4123
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_variants_for_catalog_item ...'
|
|
3950
4124
|
end
|
|
3951
|
-
allowable_values = ["created", "custom_metadata", "description", "external_id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
4125
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
3952
4126
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
|
3953
4127
|
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
|
3954
4128
|
end
|
|
4129
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
4130
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_variants_for_catalog_item, must be smaller than or equal to 100.'
|
|
4131
|
+
end
|
|
4132
|
+
|
|
4133
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
4134
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogsApi.get_variants_for_catalog_item, must be greater than or equal to 1.'
|
|
4135
|
+
end
|
|
4136
|
+
|
|
3955
4137
|
allowable_values = ["created", "-created"]
|
|
3956
4138
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
3957
4139
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
@@ -3964,12 +4146,13 @@ module KlaviyoAPI
|
|
|
3964
4146
|
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
|
3965
4147
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
3966
4148
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
4149
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
3967
4150
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
3968
4151
|
|
|
3969
4152
|
# header parameters
|
|
3970
4153
|
header_params = opts[:header_params] || {}
|
|
3971
4154
|
# klaviyo api revision
|
|
3972
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4155
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
3973
4156
|
# HTTP header 'Accept' (if needed)
|
|
3974
4157
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3975
4158
|
|
|
@@ -4006,7 +4189,7 @@ module KlaviyoAPI
|
|
|
4006
4189
|
alias get_catalog_item_variants_with_http_info get_variants_for_catalog_item_with_http_info
|
|
4007
4190
|
|
|
4008
4191
|
# Remove Categories from Catalog Item
|
|
4009
|
-
# Delete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4192
|
+
# Delete catalog category relationships for the given item ID.<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/remove_categories_from_catalog_item.json)
|
|
4010
4193
|
# @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`.
|
|
4011
4194
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
|
4012
4195
|
# @param [Hash] opts the optional parameters
|
|
@@ -4020,7 +4203,7 @@ module KlaviyoAPI
|
|
|
4020
4203
|
alias delete_catalog_item_relationships_categories remove_categories_from_catalog_item
|
|
4021
4204
|
|
|
4022
4205
|
# Remove Categories from Catalog Item
|
|
4023
|
-
# Delete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4206
|
+
# Delete catalog category relationships for the given item ID.<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/remove_categories_from_catalog_item.json)
|
|
4024
4207
|
# @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`.
|
|
4025
4208
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
|
4026
4209
|
# @param [Hash] opts the optional parameters
|
|
@@ -4046,7 +4229,7 @@ module KlaviyoAPI
|
|
|
4046
4229
|
# header parameters
|
|
4047
4230
|
header_params = opts[:header_params] || {}
|
|
4048
4231
|
# klaviyo api revision
|
|
4049
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4232
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
4050
4233
|
# HTTP header 'Accept' (if needed)
|
|
4051
4234
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4052
4235
|
# HTTP header 'Content-Type'
|
|
@@ -4088,7 +4271,7 @@ module KlaviyoAPI
|
|
|
4088
4271
|
alias delete_catalog_item_relationships_categories_with_http_info remove_categories_from_catalog_item_with_http_info
|
|
4089
4272
|
|
|
4090
4273
|
# Remove Items from Catalog Category
|
|
4091
|
-
# Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4274
|
+
# Delete item relationships for the given category ID.<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/remove_items_from_catalog_category.json)
|
|
4092
4275
|
# @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`.
|
|
4093
4276
|
# @param catalog_category_item_op [CatalogCategoryItemOp]
|
|
4094
4277
|
# @param [Hash] opts the optional parameters
|
|
@@ -4102,7 +4285,7 @@ module KlaviyoAPI
|
|
|
4102
4285
|
alias delete_catalog_category_relationships_items remove_items_from_catalog_category
|
|
4103
4286
|
|
|
4104
4287
|
# Remove Items from Catalog Category
|
|
4105
|
-
# Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4288
|
+
# Delete item relationships for the given category ID.<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/remove_items_from_catalog_category.json)
|
|
4106
4289
|
# @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`.
|
|
4107
4290
|
# @param catalog_category_item_op [CatalogCategoryItemOp]
|
|
4108
4291
|
# @param [Hash] opts the optional parameters
|
|
@@ -4128,7 +4311,7 @@ module KlaviyoAPI
|
|
|
4128
4311
|
# header parameters
|
|
4129
4312
|
header_params = opts[:header_params] || {}
|
|
4130
4313
|
# klaviyo api revision
|
|
4131
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4314
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
4132
4315
|
# HTTP header 'Accept' (if needed)
|
|
4133
4316
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4134
4317
|
# HTTP header 'Content-Type'
|
|
@@ -4170,10 +4353,11 @@ module KlaviyoAPI
|
|
|
4170
4353
|
alias delete_catalog_category_relationships_items_with_http_info remove_items_from_catalog_category_with_http_info
|
|
4171
4354
|
|
|
4172
4355
|
# Update Catalog Category
|
|
4173
|
-
# Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4356
|
+
# Update a catalog category with the given category ID.<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/update_catalog_category.json)
|
|
4174
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`.
|
|
4175
4358
|
# @param catalog_category_update_query [CatalogCategoryUpdateQuery]
|
|
4176
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-07-15/reference/api-overview#sparse-fieldsets
|
|
4177
4361
|
# @return [Hash<String, Object>]
|
|
4178
4362
|
def update_catalog_category(id, catalog_category_update_query, opts = {})
|
|
4179
4363
|
data, _status_code, _headers = update_catalog_category_with_http_info(id, catalog_category_update_query, opts)
|
|
@@ -4181,10 +4365,11 @@ module KlaviyoAPI
|
|
|
4181
4365
|
end
|
|
4182
4366
|
|
|
4183
4367
|
# Update Catalog Category
|
|
4184
|
-
# Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4368
|
+
# Update a catalog category with the given category ID.<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/update_catalog_category.json)
|
|
4185
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`.
|
|
4186
4370
|
# @param catalog_category_update_query [CatalogCategoryUpdateQuery]
|
|
4187
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-07-15/reference/api-overview#sparse-fieldsets
|
|
4188
4373
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
4189
4374
|
def update_catalog_category_with_http_info(id, catalog_category_update_query, opts = {})
|
|
4190
4375
|
if @api_client.config.debugging
|
|
@@ -4198,16 +4383,21 @@ module KlaviyoAPI
|
|
|
4198
4383
|
if @api_client.config.client_side_validation && catalog_category_update_query.nil?
|
|
4199
4384
|
fail ArgumentError, "Missing the required parameter 'catalog_category_update_query' when calling CatalogsApi.update_catalog_category"
|
|
4200
4385
|
end
|
|
4386
|
+
allowable_values = ["external_id", "id", "name", "updated"]
|
|
4387
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
|
4388
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}"
|
|
4389
|
+
end
|
|
4201
4390
|
# resource path
|
|
4202
4391
|
local_var_path = '/api/catalog-categories/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
4203
4392
|
|
|
4204
4393
|
# query parameters
|
|
4205
4394
|
query_params = opts[:query_params] || {}
|
|
4395
|
+
query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].nil?
|
|
4206
4396
|
|
|
4207
4397
|
# header parameters
|
|
4208
4398
|
header_params = opts[:header_params] || {}
|
|
4209
4399
|
# klaviyo api revision
|
|
4210
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4400
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
4211
4401
|
# HTTP header 'Accept' (if needed)
|
|
4212
4402
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4213
4403
|
# HTTP header 'Content-Type'
|
|
@@ -4246,10 +4436,11 @@ module KlaviyoAPI
|
|
|
4246
4436
|
end
|
|
4247
4437
|
|
|
4248
4438
|
# Update Catalog Item
|
|
4249
|
-
# Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4439
|
+
# Update a catalog item with the given item ID.<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/update_catalog_item.json)
|
|
4250
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`.
|
|
4251
4441
|
# @param catalog_item_update_query [CatalogItemUpdateQuery]
|
|
4252
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-07-15/reference/api-overview#sparse-fieldsets
|
|
4253
4444
|
# @return [Hash<String, Object>]
|
|
4254
4445
|
def update_catalog_item(id, catalog_item_update_query, opts = {})
|
|
4255
4446
|
data, _status_code, _headers = update_catalog_item_with_http_info(id, catalog_item_update_query, opts)
|
|
@@ -4257,10 +4448,11 @@ module KlaviyoAPI
|
|
|
4257
4448
|
end
|
|
4258
4449
|
|
|
4259
4450
|
# Update Catalog Item
|
|
4260
|
-
# Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4451
|
+
# Update a catalog item with the given item ID.<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/update_catalog_item.json)
|
|
4261
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`.
|
|
4262
4453
|
# @param catalog_item_update_query [CatalogItemUpdateQuery]
|
|
4263
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-07-15/reference/api-overview#sparse-fieldsets
|
|
4264
4456
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
4265
4457
|
def update_catalog_item_with_http_info(id, catalog_item_update_query, opts = {})
|
|
4266
4458
|
if @api_client.config.debugging
|
|
@@ -4274,16 +4466,21 @@ module KlaviyoAPI
|
|
|
4274
4466
|
if @api_client.config.client_side_validation && catalog_item_update_query.nil?
|
|
4275
4467
|
fail ArgumentError, "Missing the required parameter 'catalog_item_update_query' when calling CatalogsApi.update_catalog_item"
|
|
4276
4468
|
end
|
|
4469
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "price", "published", "title", "updated", "url"]
|
|
4470
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
|
4471
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
|
4472
|
+
end
|
|
4277
4473
|
# resource path
|
|
4278
4474
|
local_var_path = '/api/catalog-items/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
4279
4475
|
|
|
4280
4476
|
# query parameters
|
|
4281
4477
|
query_params = opts[:query_params] || {}
|
|
4478
|
+
query_params[:'fields[catalog-item]'] = @api_client.build_collection_param(opts[:'fields_catalog_item'], :csv) if !opts[:'fields_catalog_item'].nil?
|
|
4282
4479
|
|
|
4283
4480
|
# header parameters
|
|
4284
4481
|
header_params = opts[:header_params] || {}
|
|
4285
4482
|
# klaviyo api revision
|
|
4286
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4483
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
4287
4484
|
# HTTP header 'Accept' (if needed)
|
|
4288
4485
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4289
4486
|
# HTTP header 'Content-Type'
|
|
@@ -4322,10 +4519,11 @@ module KlaviyoAPI
|
|
|
4322
4519
|
end
|
|
4323
4520
|
|
|
4324
4521
|
# Update Catalog Variant
|
|
4325
|
-
# Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4522
|
+
# Update a catalog item variant with the given variant ID.<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/update_catalog_variant.json)
|
|
4326
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`.
|
|
4327
4524
|
# @param catalog_variant_update_query [CatalogVariantUpdateQuery]
|
|
4328
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-07-15/reference/api-overview#sparse-fieldsets
|
|
4329
4527
|
# @return [Hash<String, Object>]
|
|
4330
4528
|
def update_catalog_variant(id, catalog_variant_update_query, opts = {})
|
|
4331
4529
|
data, _status_code, _headers = update_catalog_variant_with_http_info(id, catalog_variant_update_query, opts)
|
|
@@ -4333,10 +4531,11 @@ module KlaviyoAPI
|
|
|
4333
4531
|
end
|
|
4334
4532
|
|
|
4335
4533
|
# Update Catalog Variant
|
|
4336
|
-
# Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4534
|
+
# Update a catalog item variant with the given variant ID.<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/update_catalog_variant.json)
|
|
4337
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`.
|
|
4338
4536
|
# @param catalog_variant_update_query [CatalogVariantUpdateQuery]
|
|
4339
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-07-15/reference/api-overview#sparse-fieldsets
|
|
4340
4539
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
4341
4540
|
def update_catalog_variant_with_http_info(id, catalog_variant_update_query, opts = {})
|
|
4342
4541
|
if @api_client.config.debugging
|
|
@@ -4350,16 +4549,21 @@ module KlaviyoAPI
|
|
|
4350
4549
|
if @api_client.config.client_side_validation && catalog_variant_update_query.nil?
|
|
4351
4550
|
fail ArgumentError, "Missing the required parameter 'catalog_variant_update_query' when calling CatalogsApi.update_catalog_variant"
|
|
4352
4551
|
end
|
|
4552
|
+
allowable_values = ["created", "custom_metadata", "description", "external_id", "id", "image_full_url", "image_thumbnail_url", "images", "inventory_policy", "inventory_quantity", "price", "published", "sku", "title", "updated", "url"]
|
|
4553
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
|
4554
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
|
4555
|
+
end
|
|
4353
4556
|
# resource path
|
|
4354
4557
|
local_var_path = '/api/catalog-variants/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
4355
4558
|
|
|
4356
4559
|
# query parameters
|
|
4357
4560
|
query_params = opts[:query_params] || {}
|
|
4561
|
+
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
|
4358
4562
|
|
|
4359
4563
|
# header parameters
|
|
4360
4564
|
header_params = opts[:header_params] || {}
|
|
4361
4565
|
# klaviyo api revision
|
|
4362
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4566
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
4363
4567
|
# HTTP header 'Accept' (if needed)
|
|
4364
4568
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4365
4569
|
# HTTP header 'Content-Type'
|
|
@@ -4398,7 +4602,7 @@ module KlaviyoAPI
|
|
|
4398
4602
|
end
|
|
4399
4603
|
|
|
4400
4604
|
# Update Categories for Catalog Item
|
|
4401
|
-
# Update catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4605
|
+
# Update catalog category relationships for the given item ID.<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/update_categories_for_catalog_item.json)
|
|
4402
4606
|
# @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`.
|
|
4403
4607
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
|
4404
4608
|
# @param [Hash] opts the optional parameters
|
|
@@ -4412,7 +4616,7 @@ module KlaviyoAPI
|
|
|
4412
4616
|
alias update_catalog_item_relationships_categories update_categories_for_catalog_item
|
|
4413
4617
|
|
|
4414
4618
|
# Update Categories for Catalog Item
|
|
4415
|
-
# Update catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4619
|
+
# Update catalog category relationships for the given item ID.<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/update_categories_for_catalog_item.json)
|
|
4416
4620
|
# @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`.
|
|
4417
4621
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
|
4418
4622
|
# @param [Hash] opts the optional parameters
|
|
@@ -4438,7 +4642,7 @@ module KlaviyoAPI
|
|
|
4438
4642
|
# header parameters
|
|
4439
4643
|
header_params = opts[:header_params] || {}
|
|
4440
4644
|
# klaviyo api revision
|
|
4441
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4645
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
4442
4646
|
# HTTP header 'Accept' (if needed)
|
|
4443
4647
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4444
4648
|
# HTTP header 'Content-Type'
|
|
@@ -4480,7 +4684,7 @@ module KlaviyoAPI
|
|
|
4480
4684
|
alias update_catalog_item_relationships_categories_with_http_info update_categories_for_catalog_item_with_http_info
|
|
4481
4685
|
|
|
4482
4686
|
# Update Items for Catalog Category
|
|
4483
|
-
# Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4687
|
+
# Update item relationships for the given category ID.<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/update_items_for_catalog_category.json)
|
|
4484
4688
|
# @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`.
|
|
4485
4689
|
# @param catalog_category_item_op [CatalogCategoryItemOp]
|
|
4486
4690
|
# @param [Hash] opts the optional parameters
|
|
@@ -4494,7 +4698,7 @@ module KlaviyoAPI
|
|
|
4494
4698
|
alias update_catalog_category_relationships_items update_items_for_catalog_category
|
|
4495
4699
|
|
|
4496
4700
|
# Update Items for Catalog Category
|
|
4497
|
-
# Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `catalogs:write`
|
|
4701
|
+
# Update item relationships for the given category ID.<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/update_items_for_catalog_category.json)
|
|
4498
4702
|
# @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`.
|
|
4499
4703
|
# @param catalog_category_item_op [CatalogCategoryItemOp]
|
|
4500
4704
|
# @param [Hash] opts the optional parameters
|
|
@@ -4520,7 +4724,7 @@ module KlaviyoAPI
|
|
|
4520
4724
|
# header parameters
|
|
4521
4725
|
header_params = opts[:header_params] || {}
|
|
4522
4726
|
# klaviyo api revision
|
|
4523
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
4727
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
4524
4728
|
# HTTP header 'Accept' (if needed)
|
|
4525
4729
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
4526
4730
|
# HTTP header 'Content-Type'
|