klaviyo-api-sdk 11.0.0 → 12.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 +31 -0
- data/README.md +677 -357
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +9 -9
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +422 -159
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +405 -307
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +170 -149
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/events_api.rb +147 -135
- data/lib/klaviyo-api-sdk/api/flows_api.rb +431 -311
- data/lib/klaviyo-api-sdk/api/forms_api.rb +76 -44
- data/lib/klaviyo-api-sdk/api/images_api.rb +21 -21
- data/lib/klaviyo-api-sdk/api/lists_api.rb +416 -362
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +184 -148
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +242 -212
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +63 -21
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +101 -25
- data/lib/klaviyo-api-sdk/api/segments_api.rb +226 -202
- data/lib/klaviyo-api-sdk/api/tags_api.rb +167 -101
- data/lib/klaviyo-api-sdk/api/templates_api.rb +45 -45
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +13 -13
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +19 -10
- data/lib/klaviyo-api-sdk/models/ab_test_action.rb +265 -0
- data/lib/klaviyo-api-sdk/models/ab_test_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/any_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{audiences_sub_object.rb → audiences.rb} +9 -5
- data/lib/klaviyo-api-sdk/models/audiences_update.rb +236 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action.rb +255 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/block_display_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/block_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/boolean_branch_links.rb +230 -0
- data/lib/klaviyo-api-sdk/models/boolean_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/boolean_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/branch_action.rb +265 -0
- data/lib/klaviyo-api-sdk/models/branch_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +4 -3
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +4 -3
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_strategy.rb +108 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +3 -3
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +14 -5
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +11 -42
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes_content.rb → campaign_message_create_query_resource_object_attributes_definition.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +14 -5
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +9 -29
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +107 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +4 -3
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +108 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +35 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{catalog_category_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_item_op_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/code_action.rb +265 -0
- data/lib/klaviyo-api-sdk/models/code_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/condition_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/conditional_branch_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data.rb +224 -0
- data/lib/klaviyo-api-sdk/models/conditional_split_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/content_repeat.rb +1 -1
- data/lib/klaviyo-api-sdk/models/countdown_delay_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/countdown_delay_action_data.rb +312 -0
- data/lib/klaviyo-api-sdk/models/countdown_delay_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +395 -0
- data/lib/klaviyo-api-sdk/models/custom_object_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/deep_link_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +1 -1
- data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{email_content_sub_object.rb → email_content.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/email_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_message_definition.rb +244 -0
- data/lib/klaviyo-api-sdk/models/email_send_options.rb +223 -0
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{email_tracking_options_sub_object.rb → email_tracking_options.rb} +50 -38
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +224 -0
- data/lib/klaviyo-api-sdk/models/equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/fake_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/false_or_misleading_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/featured_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/{sto_schedule_options.rb → flow_create_query.rb} +14 -15
- data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object_attributes.rb +239 -0
- data/lib/klaviyo-api-sdk/models/flow_definition.rb +269 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +122 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +111 -0
- data/lib/klaviyo-api-sdk/models/flow_email.rb +364 -0
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_internal_alert.rb +286 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +394 -0
- data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +386 -0
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_static_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_webhook.rb +259 -0
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +294 -0
- data/lib/klaviyo-api-sdk/models/form_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
- data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_block.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/immediate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/immediate_send_strategy.rb +224 -0
- data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_the_last_base_relative_date_filter.rb +301 -0
- data/lib/klaviyo-api-sdk/models/in_the_last_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{send_strategy_sub_object.rb → internal_service_action.rb} +46 -33
- data/lib/klaviyo-api-sdk/models/internal_service_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/link.rb +220 -0
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_trigger.rb +234 -0
- data/lib/klaviyo-api-sdk/models/list_update_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → list_update_action_data.rb} +34 -43
- data/lib/klaviyo-api-sdk/models/list_update_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/{static_schedule_options.rb → local_static_send.rb} +46 -22
- data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +262 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_property_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +328 -0
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +266 -0
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +118 -0
- data/lib/klaviyo-api-sdk/models/metric_property_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/metric_property_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/metric_trigger.rb +243 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_badge.rb +259 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_content_create.rb +247 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_content_update.rb +243 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_message_standard_definition_create.rb +261 -0
- data/lib/klaviyo-api-sdk/models/{sms_tracking_options_sub_object.rb → mobile_push_message_standard_definition_update.rb} +40 -23
- data/lib/klaviyo-api-sdk/models/mobile_push_no_badge.rb +259 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_options.rb +243 -0
- data/lib/klaviyo-api-sdk/models/{email_tracking_options_sub_object_custom_tracking_params_inner.rb → mobile_push_options_badge.rb} +5 -4
- data/lib/klaviyo-api-sdk/models/mobile_push_options_on_open.rb +105 -0
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/non_local_static_send.rb +259 -0
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_range_filter.rb +301 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/open_app_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/other_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/pending_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +262 -0
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/price_drop_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/price_drop_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/price_drop_property_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +349 -0
- data/lib/klaviyo-api-sdk/models/private_information_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profanity_or_inappropriate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition_timeframe_filter.rb +105 -0
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_delete.rb +273 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_boolean.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date_property_value.rb +105 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_list.rb +328 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_numeric.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_string.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_date_trigger.rb +395 -0
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_random_sample_condition.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_sample_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +8 -3
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +20 -6
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/published_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_on_open_app.rb +224 -0
- data/lib/klaviyo-api-sdk/models/push_on_open_deep_link.rb +246 -0
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{email_send_options_sub_object.rb → push_send_options.rb} +7 -5
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_fake.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_misleading.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_other.rb +235 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_private_information.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_profanity.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_unrelated.rb +224 -0
- data/lib/klaviyo-api-sdk/models/rejected_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{render_options_sub_object.rb → render_options.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/review_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes.rb +220 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes_status.rb +109 -0
- data/lib/klaviyo-api-sdk/models/review_status_featured.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_status_pending.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_status_published.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_status_rejected.rb +238 -0
- data/lib/klaviyo-api-sdk/models/review_status_rejected_rejection_reason.rb +110 -0
- data/lib/klaviyo-api-sdk/models/review_status_unpublished.rb +224 -0
- data/lib/klaviyo-api-sdk/models/scheduled_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/scheduled_trigger.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_trigger.rb +234 -0
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_email_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_email_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_email_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_mobile_push_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_sms_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_whatsapp_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/smart_send_time_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/smart_send_time_strategy.rb +239 -0
- data/lib/klaviyo-api-sdk/models/{sms_content_sub_object_create.rb → sms_content_create.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_message_definition_create.rb +242 -0
- data/lib/klaviyo-api-sdk/models/{sms_send_options_sub_object.rb → sms_send_options.rb} +7 -5
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +240 -0
- data/lib/klaviyo-api-sdk/models/sms_unsubscription_parameters.rb +228 -0
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/split_action.rb +255 -0
- data/lib/klaviyo-api-sdk/models/split_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/split_links.rb +226 -0
- data/lib/klaviyo-api-sdk/models/standard_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{throttled_schedule_options.rb → static_send_strategy.rb} +26 -17
- data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/target_date_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/target_date_action_data.rb +276 -0
- data/lib/klaviyo-api-sdk/models/target_date_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/throttled_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_send_strategy.rb +288 -0
- data/lib/klaviyo-api-sdk/models/time_delay_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/time_delay_action_data.rb +325 -0
- data/lib/klaviyo-api-sdk/models/time_delay_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/trigger_branch_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data.rb +310 -0
- data/lib/klaviyo-api-sdk/models/trigger_split_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/union_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/union_condition_group_conditions_inner.rb +114 -0
- data/lib/klaviyo-api-sdk/models/union_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unpublished_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/unrelated_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_channels.rb +228 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_parameters.rb +259 -0
- data/lib/klaviyo-api-sdk/models/update_profile_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/update_profile_action_data.rb +273 -0
- data/lib/klaviyo-api-sdk/models/update_profile_action_data_profile_operations_inner.rb +109 -0
- data/lib/klaviyo-api-sdk/models/update_profile_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/utm_param.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{static_tracking_param.rb → utm_param_info.rb} +17 -33
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +2 -2
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +192 -18
- metadata +193 -19
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document:
|
6
|
+
The version of the OpenAPI document: 2025-01-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -19,40 +19,43 @@ module KlaviyoAPI
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Add
|
22
|
+
# Add Categories to Catalog Item
|
23
23
|
# Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
24
24
|
# @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`.
|
25
25
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
27
|
# @return [nil]
|
28
|
-
def
|
29
|
-
|
28
|
+
def add_categories_to_catalog_item(id, catalog_item_category_op, opts = {})
|
29
|
+
add_categories_to_catalog_item_with_http_info(id, catalog_item_category_op, opts)
|
30
30
|
nil
|
31
31
|
end
|
32
32
|
|
33
|
-
# alias of `
|
34
|
-
alias
|
33
|
+
# alias of `add_categories_to_catalog_item`
|
34
|
+
alias add_category_to_catalog_item add_categories_to_catalog_item
|
35
35
|
|
36
|
-
# alias of `
|
37
|
-
alias create_catalog_item_relationships_category
|
36
|
+
# alias of `add_categories_to_catalog_item`
|
37
|
+
alias create_catalog_item_relationships_category add_categories_to_catalog_item
|
38
38
|
|
39
|
-
#
|
39
|
+
# alias of `add_categories_to_catalog_item`
|
40
|
+
alias create_catalog_item_relationships_categories add_categories_to_catalog_item
|
41
|
+
|
42
|
+
# Add Categories to Catalog Item
|
40
43
|
# Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
41
44
|
# @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`.
|
42
45
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
43
46
|
# @param [Hash] opts the optional parameters
|
44
47
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
45
|
-
def
|
48
|
+
def add_categories_to_catalog_item_with_http_info(id, catalog_item_category_op, opts = {})
|
46
49
|
if @api_client.config.debugging
|
47
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
50
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.add_categories_to_catalog_item ...'
|
48
51
|
end
|
49
52
|
# verify the required parameter 'id' is set
|
50
53
|
if @api_client.config.client_side_validation && id.nil?
|
51
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.
|
54
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.add_categories_to_catalog_item"
|
52
55
|
end
|
53
56
|
# verify the required parameter 'catalog_item_category_op' is set
|
54
57
|
if @api_client.config.client_side_validation && catalog_item_category_op.nil?
|
55
|
-
fail ArgumentError, "Missing the required parameter 'catalog_item_category_op' when calling CatalogsApi.
|
58
|
+
fail ArgumentError, "Missing the required parameter 'catalog_item_category_op' when calling CatalogsApi.add_categories_to_catalog_item"
|
56
59
|
end
|
57
60
|
# resource path
|
58
61
|
local_var_path = '/api/catalog-items/{id}/relationships/categories'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
@@ -63,7 +66,7 @@ module KlaviyoAPI
|
|
63
66
|
# header parameters
|
64
67
|
header_params = opts[:header_params] || {}
|
65
68
|
# klaviyo api revision
|
66
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
69
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
67
70
|
# HTTP header 'Accept' (if needed)
|
68
71
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
69
72
|
# HTTP header 'Content-Type'
|
@@ -82,10 +85,10 @@ module KlaviyoAPI
|
|
82
85
|
return_type = opts[:debug_return_type]
|
83
86
|
|
84
87
|
# auth_names
|
85
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
88
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
86
89
|
|
87
90
|
new_options = opts.merge(
|
88
|
-
:operation => :"CatalogsApi.
|
91
|
+
:operation => :"CatalogsApi.add_categories_to_catalog_item",
|
89
92
|
:header_params => header_params,
|
90
93
|
:query_params => query_params,
|
91
94
|
:form_params => form_params,
|
@@ -96,16 +99,19 @@ module KlaviyoAPI
|
|
96
99
|
|
97
100
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
98
101
|
if @api_client.config.debugging
|
99
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
102
|
+
@api_client.config.logger.debug "API called: CatalogsApi#add_categories_to_catalog_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
100
103
|
end
|
101
104
|
return data, status_code, headers
|
102
105
|
end
|
103
106
|
|
104
|
-
# alias of `
|
105
|
-
alias
|
107
|
+
# alias of `add_categories_to_catalog_item_with_http_info`
|
108
|
+
alias add_category_to_catalog_item_with_http_info add_categories_to_catalog_item_with_http_info
|
109
|
+
|
110
|
+
# alias of `add_categories_to_catalog_item_with_http_info`
|
111
|
+
alias create_catalog_item_relationships_category_with_http_info add_categories_to_catalog_item_with_http_info
|
106
112
|
|
107
|
-
# alias of `
|
108
|
-
alias
|
113
|
+
# alias of `add_categories_to_catalog_item_with_http_info`
|
114
|
+
alias create_catalog_item_relationships_categories_with_http_info add_categories_to_catalog_item_with_http_info
|
109
115
|
|
110
116
|
# Add Items to Catalog Category
|
111
117
|
# Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
@@ -119,10 +125,10 @@ module KlaviyoAPI
|
|
119
125
|
end
|
120
126
|
|
121
127
|
# alias of `add_items_to_catalog_category`
|
122
|
-
alias
|
128
|
+
alias create_catalog_category_relationships_item add_items_to_catalog_category
|
123
129
|
|
124
130
|
# alias of `add_items_to_catalog_category`
|
125
|
-
alias
|
131
|
+
alias create_catalog_category_relationships_items add_items_to_catalog_category
|
126
132
|
|
127
133
|
# Add Items to Catalog Category
|
128
134
|
# Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
@@ -151,7 +157,7 @@ module KlaviyoAPI
|
|
151
157
|
# header parameters
|
152
158
|
header_params = opts[:header_params] || {}
|
153
159
|
# klaviyo api revision
|
154
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
160
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
155
161
|
# HTTP header 'Accept' (if needed)
|
156
162
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
157
163
|
# HTTP header 'Content-Type'
|
@@ -170,7 +176,7 @@ module KlaviyoAPI
|
|
170
176
|
return_type = opts[:debug_return_type]
|
171
177
|
|
172
178
|
# auth_names
|
173
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
179
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
174
180
|
|
175
181
|
new_options = opts.merge(
|
176
182
|
:operation => :"CatalogsApi.add_items_to_catalog_category",
|
@@ -190,10 +196,10 @@ module KlaviyoAPI
|
|
190
196
|
end
|
191
197
|
|
192
198
|
# alias of `add_items_to_catalog_category_with_http_info`
|
193
|
-
alias
|
199
|
+
alias create_catalog_category_relationships_item_with_http_info add_items_to_catalog_category_with_http_info
|
194
200
|
|
195
201
|
# alias of `add_items_to_catalog_category_with_http_info`
|
196
|
-
alias
|
202
|
+
alias create_catalog_category_relationships_items_with_http_info add_items_to_catalog_category_with_http_info
|
197
203
|
|
198
204
|
# Bulk Create Catalog Categories
|
199
205
|
# 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: `700/m` **Scopes:** `catalogs:write`
|
@@ -233,7 +239,7 @@ module KlaviyoAPI
|
|
233
239
|
# header parameters
|
234
240
|
header_params = opts[:header_params] || {}
|
235
241
|
# klaviyo api revision
|
236
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
242
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
237
243
|
# HTTP header 'Accept' (if needed)
|
238
244
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
239
245
|
# HTTP header 'Content-Type'
|
@@ -252,7 +258,7 @@ module KlaviyoAPI
|
|
252
258
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
253
259
|
|
254
260
|
# auth_names
|
255
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
261
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
256
262
|
|
257
263
|
new_options = opts.merge(
|
258
264
|
:operation => :"CatalogsApi.bulk_create_catalog_categories",
|
@@ -315,7 +321,7 @@ module KlaviyoAPI
|
|
315
321
|
# header parameters
|
316
322
|
header_params = opts[:header_params] || {}
|
317
323
|
# klaviyo api revision
|
318
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
324
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
319
325
|
# HTTP header 'Accept' (if needed)
|
320
326
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
321
327
|
# HTTP header 'Content-Type'
|
@@ -334,7 +340,7 @@ module KlaviyoAPI
|
|
334
340
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
335
341
|
|
336
342
|
# auth_names
|
337
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
343
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
338
344
|
|
339
345
|
new_options = opts.merge(
|
340
346
|
:operation => :"CatalogsApi.bulk_create_catalog_items",
|
@@ -397,7 +403,7 @@ module KlaviyoAPI
|
|
397
403
|
# header parameters
|
398
404
|
header_params = opts[:header_params] || {}
|
399
405
|
# klaviyo api revision
|
400
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
406
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
401
407
|
# HTTP header 'Accept' (if needed)
|
402
408
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
403
409
|
# HTTP header 'Content-Type'
|
@@ -416,7 +422,7 @@ module KlaviyoAPI
|
|
416
422
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
417
423
|
|
418
424
|
# auth_names
|
419
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
425
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
420
426
|
|
421
427
|
new_options = opts.merge(
|
422
428
|
:operation => :"CatalogsApi.bulk_create_catalog_variants",
|
@@ -479,7 +485,7 @@ module KlaviyoAPI
|
|
479
485
|
# header parameters
|
480
486
|
header_params = opts[:header_params] || {}
|
481
487
|
# klaviyo api revision
|
482
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
488
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
483
489
|
# HTTP header 'Accept' (if needed)
|
484
490
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
485
491
|
# HTTP header 'Content-Type'
|
@@ -498,7 +504,7 @@ module KlaviyoAPI
|
|
498
504
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
499
505
|
|
500
506
|
# auth_names
|
501
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
507
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
502
508
|
|
503
509
|
new_options = opts.merge(
|
504
510
|
:operation => :"CatalogsApi.bulk_delete_catalog_categories",
|
@@ -561,7 +567,7 @@ module KlaviyoAPI
|
|
561
567
|
# header parameters
|
562
568
|
header_params = opts[:header_params] || {}
|
563
569
|
# klaviyo api revision
|
564
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
570
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
565
571
|
# HTTP header 'Accept' (if needed)
|
566
572
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
567
573
|
# HTTP header 'Content-Type'
|
@@ -580,7 +586,7 @@ module KlaviyoAPI
|
|
580
586
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
581
587
|
|
582
588
|
# auth_names
|
583
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
589
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
584
590
|
|
585
591
|
new_options = opts.merge(
|
586
592
|
:operation => :"CatalogsApi.bulk_delete_catalog_items",
|
@@ -643,7 +649,7 @@ module KlaviyoAPI
|
|
643
649
|
# header parameters
|
644
650
|
header_params = opts[:header_params] || {}
|
645
651
|
# klaviyo api revision
|
646
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
652
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
647
653
|
# HTTP header 'Accept' (if needed)
|
648
654
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
649
655
|
# HTTP header 'Content-Type'
|
@@ -662,7 +668,7 @@ module KlaviyoAPI
|
|
662
668
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
663
669
|
|
664
670
|
# auth_names
|
665
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
671
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
666
672
|
|
667
673
|
new_options = opts.merge(
|
668
674
|
:operation => :"CatalogsApi.bulk_delete_catalog_variants",
|
@@ -725,7 +731,7 @@ module KlaviyoAPI
|
|
725
731
|
# header parameters
|
726
732
|
header_params = opts[:header_params] || {}
|
727
733
|
# klaviyo api revision
|
728
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
734
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
729
735
|
# HTTP header 'Accept' (if needed)
|
730
736
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
731
737
|
# HTTP header 'Content-Type'
|
@@ -744,7 +750,7 @@ module KlaviyoAPI
|
|
744
750
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
745
751
|
|
746
752
|
# auth_names
|
747
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
753
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
748
754
|
|
749
755
|
new_options = opts.merge(
|
750
756
|
:operation => :"CatalogsApi.bulk_update_catalog_categories",
|
@@ -807,7 +813,7 @@ module KlaviyoAPI
|
|
807
813
|
# header parameters
|
808
814
|
header_params = opts[:header_params] || {}
|
809
815
|
# klaviyo api revision
|
810
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
816
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
811
817
|
# HTTP header 'Accept' (if needed)
|
812
818
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
813
819
|
# HTTP header 'Content-Type'
|
@@ -826,7 +832,7 @@ module KlaviyoAPI
|
|
826
832
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
827
833
|
|
828
834
|
# auth_names
|
829
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
835
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
830
836
|
|
831
837
|
new_options = opts.merge(
|
832
838
|
:operation => :"CatalogsApi.bulk_update_catalog_items",
|
@@ -889,7 +895,7 @@ module KlaviyoAPI
|
|
889
895
|
# header parameters
|
890
896
|
header_params = opts[:header_params] || {}
|
891
897
|
# klaviyo api revision
|
892
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
898
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
893
899
|
# HTTP header 'Accept' (if needed)
|
894
900
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
895
901
|
# HTTP header 'Content-Type'
|
@@ -908,7 +914,7 @@ module KlaviyoAPI
|
|
908
914
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
909
915
|
|
910
916
|
# auth_names
|
911
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
917
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
912
918
|
|
913
919
|
new_options = opts.merge(
|
914
920
|
:operation => :"CatalogsApi.bulk_update_catalog_variants",
|
@@ -965,7 +971,7 @@ module KlaviyoAPI
|
|
965
971
|
# header parameters
|
966
972
|
header_params = opts[:header_params] || {}
|
967
973
|
# klaviyo api revision
|
968
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
974
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
969
975
|
# HTTP header 'Accept' (if needed)
|
970
976
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
971
977
|
# HTTP header 'Content-Type'
|
@@ -984,7 +990,7 @@ module KlaviyoAPI
|
|
984
990
|
return_type = opts[:debug_return_type]
|
985
991
|
|
986
992
|
# auth_names
|
987
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
993
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
988
994
|
|
989
995
|
new_options = opts.merge(
|
990
996
|
:operation => :"CatalogsApi.create_back_in_stock_subscription",
|
@@ -1035,7 +1041,7 @@ module KlaviyoAPI
|
|
1035
1041
|
# header parameters
|
1036
1042
|
header_params = opts[:header_params] || {}
|
1037
1043
|
# klaviyo api revision
|
1038
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1044
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1039
1045
|
# HTTP header 'Accept' (if needed)
|
1040
1046
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1041
1047
|
# HTTP header 'Content-Type'
|
@@ -1054,7 +1060,7 @@ module KlaviyoAPI
|
|
1054
1060
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1055
1061
|
|
1056
1062
|
# auth_names
|
1057
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1063
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1058
1064
|
|
1059
1065
|
new_options = opts.merge(
|
1060
1066
|
:operation => :"CatalogsApi.create_catalog_category",
|
@@ -1105,7 +1111,7 @@ module KlaviyoAPI
|
|
1105
1111
|
# header parameters
|
1106
1112
|
header_params = opts[:header_params] || {}
|
1107
1113
|
# klaviyo api revision
|
1108
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1114
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1109
1115
|
# HTTP header 'Accept' (if needed)
|
1110
1116
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1111
1117
|
# HTTP header 'Content-Type'
|
@@ -1124,7 +1130,7 @@ module KlaviyoAPI
|
|
1124
1130
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1125
1131
|
|
1126
1132
|
# auth_names
|
1127
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1133
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1128
1134
|
|
1129
1135
|
new_options = opts.merge(
|
1130
1136
|
:operation => :"CatalogsApi.create_catalog_item",
|
@@ -1175,7 +1181,7 @@ module KlaviyoAPI
|
|
1175
1181
|
# header parameters
|
1176
1182
|
header_params = opts[:header_params] || {}
|
1177
1183
|
# klaviyo api revision
|
1178
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1184
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1179
1185
|
# HTTP header 'Accept' (if needed)
|
1180
1186
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1181
1187
|
# HTTP header 'Content-Type'
|
@@ -1194,7 +1200,7 @@ module KlaviyoAPI
|
|
1194
1200
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1195
1201
|
|
1196
1202
|
# auth_names
|
1197
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1203
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1198
1204
|
|
1199
1205
|
new_options = opts.merge(
|
1200
1206
|
:operation => :"CatalogsApi.create_catalog_variant",
|
@@ -1245,7 +1251,7 @@ module KlaviyoAPI
|
|
1245
1251
|
# header parameters
|
1246
1252
|
header_params = opts[:header_params] || {}
|
1247
1253
|
# klaviyo api revision
|
1248
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1254
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1249
1255
|
# HTTP header 'Accept' (if needed)
|
1250
1256
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1251
1257
|
|
@@ -1259,7 +1265,7 @@ module KlaviyoAPI
|
|
1259
1265
|
return_type = opts[:debug_return_type]
|
1260
1266
|
|
1261
1267
|
# auth_names
|
1262
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1268
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1263
1269
|
|
1264
1270
|
new_options = opts.merge(
|
1265
1271
|
:operation => :"CatalogsApi.delete_catalog_category",
|
@@ -1310,7 +1316,7 @@ module KlaviyoAPI
|
|
1310
1316
|
# header parameters
|
1311
1317
|
header_params = opts[:header_params] || {}
|
1312
1318
|
# klaviyo api revision
|
1313
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1319
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1314
1320
|
# HTTP header 'Accept' (if needed)
|
1315
1321
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1316
1322
|
|
@@ -1324,7 +1330,7 @@ module KlaviyoAPI
|
|
1324
1330
|
return_type = opts[:debug_return_type]
|
1325
1331
|
|
1326
1332
|
# auth_names
|
1327
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1333
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1328
1334
|
|
1329
1335
|
new_options = opts.merge(
|
1330
1336
|
:operation => :"CatalogsApi.delete_catalog_item",
|
@@ -1375,7 +1381,7 @@ module KlaviyoAPI
|
|
1375
1381
|
# header parameters
|
1376
1382
|
header_params = opts[:header_params] || {}
|
1377
1383
|
# klaviyo api revision
|
1378
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1384
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1379
1385
|
# HTTP header 'Accept' (if needed)
|
1380
1386
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1381
1387
|
|
@@ -1389,7 +1395,7 @@ module KlaviyoAPI
|
|
1389
1395
|
return_type = opts[:debug_return_type]
|
1390
1396
|
|
1391
1397
|
# auth_names
|
1392
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1398
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1393
1399
|
|
1394
1400
|
new_options = opts.merge(
|
1395
1401
|
:operation => :"CatalogsApi.delete_catalog_variant",
|
@@ -1412,9 +1418,9 @@ module KlaviyoAPI
|
|
1412
1418
|
# Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1413
1419
|
# @param job_id [String] ID of the job to retrieve.
|
1414
1420
|
# @param [Hash] opts the optional parameters
|
1415
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
1416
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
1417
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
1421
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1422
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1423
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
1418
1424
|
# @return [Hash<String, Object>]
|
1419
1425
|
def get_bulk_create_catalog_items_job(job_id, opts = {})
|
1420
1426
|
data, _status_code, _headers = get_bulk_create_catalog_items_job_with_http_info(job_id, opts)
|
@@ -1431,9 +1437,9 @@ module KlaviyoAPI
|
|
1431
1437
|
# Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1432
1438
|
# @param job_id [String] ID of the job to retrieve.
|
1433
1439
|
# @param [Hash] opts the optional parameters
|
1434
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
1435
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
1436
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
1440
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1441
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1442
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
1437
1443
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1438
1444
|
def get_bulk_create_catalog_items_job_with_http_info(job_id, opts = {})
|
1439
1445
|
if @api_client.config.debugging
|
@@ -1467,7 +1473,7 @@ module KlaviyoAPI
|
|
1467
1473
|
# header parameters
|
1468
1474
|
header_params = opts[:header_params] || {}
|
1469
1475
|
# klaviyo api revision
|
1470
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1476
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1471
1477
|
# HTTP header 'Accept' (if needed)
|
1472
1478
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1473
1479
|
|
@@ -1481,7 +1487,7 @@ module KlaviyoAPI
|
|
1481
1487
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1482
1488
|
|
1483
1489
|
# auth_names
|
1484
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1490
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1485
1491
|
|
1486
1492
|
new_options = opts.merge(
|
1487
1493
|
:operation => :"CatalogsApi.get_bulk_create_catalog_items_job",
|
@@ -1509,9 +1515,9 @@ module KlaviyoAPI
|
|
1509
1515
|
# Get Bulk Create Catalog Items Jobs
|
1510
1516
|
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1511
1517
|
# @param [Hash] opts the optional parameters
|
1512
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
1513
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1514
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1518
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1519
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1520
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1515
1521
|
# @return [Hash<String, Object>]
|
1516
1522
|
def get_bulk_create_catalog_items_jobs(opts = {})
|
1517
1523
|
data, _status_code, _headers = get_bulk_create_catalog_items_jobs_with_http_info(opts)
|
@@ -1527,9 +1533,9 @@ module KlaviyoAPI
|
|
1527
1533
|
# Get Bulk Create Catalog Items Jobs
|
1528
1534
|
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1529
1535
|
# @param [Hash] opts the optional parameters
|
1530
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
1531
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1532
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1536
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1537
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1538
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1533
1539
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1534
1540
|
def get_bulk_create_catalog_items_jobs_with_http_info(opts = {})
|
1535
1541
|
if @api_client.config.debugging
|
@@ -1551,7 +1557,7 @@ module KlaviyoAPI
|
|
1551
1557
|
# header parameters
|
1552
1558
|
header_params = opts[:header_params] || {}
|
1553
1559
|
# klaviyo api revision
|
1554
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1560
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1555
1561
|
# HTTP header 'Accept' (if needed)
|
1556
1562
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1557
1563
|
|
@@ -1565,7 +1571,7 @@ module KlaviyoAPI
|
|
1565
1571
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1566
1572
|
|
1567
1573
|
# auth_names
|
1568
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1574
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1569
1575
|
|
1570
1576
|
new_options = opts.merge(
|
1571
1577
|
:operation => :"CatalogsApi.get_bulk_create_catalog_items_jobs",
|
@@ -1594,7 +1600,7 @@ module KlaviyoAPI
|
|
1594
1600
|
# 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`
|
1595
1601
|
# @param job_id [String] ID of the job to retrieve.
|
1596
1602
|
# @param [Hash] opts the optional parameters
|
1597
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
1603
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1598
1604
|
# @return [Hash<String, Object>]
|
1599
1605
|
def get_bulk_delete_catalog_items_job(job_id, opts = {})
|
1600
1606
|
data, _status_code, _headers = get_bulk_delete_catalog_items_job_with_http_info(job_id, opts)
|
@@ -1611,7 +1617,7 @@ module KlaviyoAPI
|
|
1611
1617
|
# 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`
|
1612
1618
|
# @param job_id [String] ID of the job to retrieve.
|
1613
1619
|
# @param [Hash] opts the optional parameters
|
1614
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
1620
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1615
1621
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1616
1622
|
def get_bulk_delete_catalog_items_job_with_http_info(job_id, opts = {})
|
1617
1623
|
if @api_client.config.debugging
|
@@ -1635,7 +1641,7 @@ module KlaviyoAPI
|
|
1635
1641
|
# header parameters
|
1636
1642
|
header_params = opts[:header_params] || {}
|
1637
1643
|
# klaviyo api revision
|
1638
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1644
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1639
1645
|
# HTTP header 'Accept' (if needed)
|
1640
1646
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1641
1647
|
|
@@ -1649,7 +1655,7 @@ module KlaviyoAPI
|
|
1649
1655
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1650
1656
|
|
1651
1657
|
# auth_names
|
1652
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1658
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1653
1659
|
|
1654
1660
|
new_options = opts.merge(
|
1655
1661
|
:operation => :"CatalogsApi.get_bulk_delete_catalog_items_job",
|
@@ -1677,9 +1683,9 @@ module KlaviyoAPI
|
|
1677
1683
|
# Get Bulk Delete Catalog Items Jobs
|
1678
1684
|
# 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`
|
1679
1685
|
# @param [Hash] opts the optional parameters
|
1680
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
1681
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1682
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1686
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1687
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1688
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1683
1689
|
# @return [Hash<String, Object>]
|
1684
1690
|
def get_bulk_delete_catalog_items_jobs(opts = {})
|
1685
1691
|
data, _status_code, _headers = get_bulk_delete_catalog_items_jobs_with_http_info(opts)
|
@@ -1695,9 +1701,9 @@ module KlaviyoAPI
|
|
1695
1701
|
# Get Bulk Delete Catalog Items Jobs
|
1696
1702
|
# 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`
|
1697
1703
|
# @param [Hash] opts the optional parameters
|
1698
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
1699
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1700
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1704
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1705
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1706
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1701
1707
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1702
1708
|
def get_bulk_delete_catalog_items_jobs_with_http_info(opts = {})
|
1703
1709
|
if @api_client.config.debugging
|
@@ -1719,7 +1725,7 @@ module KlaviyoAPI
|
|
1719
1725
|
# header parameters
|
1720
1726
|
header_params = opts[:header_params] || {}
|
1721
1727
|
# klaviyo api revision
|
1722
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1728
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1723
1729
|
# HTTP header 'Accept' (if needed)
|
1724
1730
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1725
1731
|
|
@@ -1733,7 +1739,7 @@ module KlaviyoAPI
|
|
1733
1739
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1734
1740
|
|
1735
1741
|
# auth_names
|
1736
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1742
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1737
1743
|
|
1738
1744
|
new_options = opts.merge(
|
1739
1745
|
:operation => :"CatalogsApi.get_bulk_delete_catalog_items_jobs",
|
@@ -1762,9 +1768,9 @@ module KlaviyoAPI
|
|
1762
1768
|
# Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1763
1769
|
# @param job_id [String] ID of the job to retrieve.
|
1764
1770
|
# @param [Hash] opts the optional parameters
|
1765
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
1766
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
1767
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
1771
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1772
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1773
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
1768
1774
|
# @return [Hash<String, Object>]
|
1769
1775
|
def get_bulk_update_catalog_items_job(job_id, opts = {})
|
1770
1776
|
data, _status_code, _headers = get_bulk_update_catalog_items_job_with_http_info(job_id, opts)
|
@@ -1781,9 +1787,9 @@ module KlaviyoAPI
|
|
1781
1787
|
# Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1782
1788
|
# @param job_id [String] ID of the job to retrieve.
|
1783
1789
|
# @param [Hash] opts the optional parameters
|
1784
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
1785
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
1786
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
1790
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1791
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1792
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
1787
1793
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1788
1794
|
def get_bulk_update_catalog_items_job_with_http_info(job_id, opts = {})
|
1789
1795
|
if @api_client.config.debugging
|
@@ -1817,7 +1823,7 @@ module KlaviyoAPI
|
|
1817
1823
|
# header parameters
|
1818
1824
|
header_params = opts[:header_params] || {}
|
1819
1825
|
# klaviyo api revision
|
1820
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1826
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1821
1827
|
# HTTP header 'Accept' (if needed)
|
1822
1828
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1823
1829
|
|
@@ -1831,7 +1837,7 @@ module KlaviyoAPI
|
|
1831
1837
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1832
1838
|
|
1833
1839
|
# auth_names
|
1834
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1840
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1835
1841
|
|
1836
1842
|
new_options = opts.merge(
|
1837
1843
|
:operation => :"CatalogsApi.get_bulk_update_catalog_items_job",
|
@@ -1859,9 +1865,9 @@ module KlaviyoAPI
|
|
1859
1865
|
# Get Bulk Update Catalog Items Jobs
|
1860
1866
|
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1861
1867
|
# @param [Hash] opts the optional parameters
|
1862
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
1863
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1864
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1868
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1869
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1870
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1865
1871
|
# @return [Hash<String, Object>]
|
1866
1872
|
def get_bulk_update_catalog_items_jobs(opts = {})
|
1867
1873
|
data, _status_code, _headers = get_bulk_update_catalog_items_jobs_with_http_info(opts)
|
@@ -1877,9 +1883,9 @@ module KlaviyoAPI
|
|
1877
1883
|
# Get Bulk Update Catalog Items Jobs
|
1878
1884
|
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1879
1885
|
# @param [Hash] opts the optional parameters
|
1880
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
1881
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1882
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1886
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1887
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1888
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1883
1889
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1884
1890
|
def get_bulk_update_catalog_items_jobs_with_http_info(opts = {})
|
1885
1891
|
if @api_client.config.debugging
|
@@ -1901,7 +1907,7 @@ module KlaviyoAPI
|
|
1901
1907
|
# header parameters
|
1902
1908
|
header_params = opts[:header_params] || {}
|
1903
1909
|
# klaviyo api revision
|
1904
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1910
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1905
1911
|
# HTTP header 'Accept' (if needed)
|
1906
1912
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1907
1913
|
|
@@ -1915,7 +1921,7 @@ module KlaviyoAPI
|
|
1915
1921
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1916
1922
|
|
1917
1923
|
# auth_names
|
1918
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1924
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1919
1925
|
|
1920
1926
|
new_options = opts.merge(
|
1921
1927
|
:operation => :"CatalogsApi.get_bulk_update_catalog_items_jobs",
|
@@ -1943,10 +1949,10 @@ module KlaviyoAPI
|
|
1943
1949
|
# Get Catalog Categories
|
1944
1950
|
# 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`
|
1945
1951
|
# @param [Hash] opts the optional parameters
|
1946
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
1947
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1948
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1949
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
1952
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1953
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
1954
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1955
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
1950
1956
|
# @return [Hash<String, Object>]
|
1951
1957
|
def get_catalog_categories(opts = {})
|
1952
1958
|
data, _status_code, _headers = get_catalog_categories_with_http_info(opts)
|
@@ -1956,10 +1962,10 @@ module KlaviyoAPI
|
|
1956
1962
|
# Get Catalog Categories
|
1957
1963
|
# 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`
|
1958
1964
|
# @param [Hash] opts the optional parameters
|
1959
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
1960
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1961
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1962
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
1965
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1966
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
1967
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1968
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
1963
1969
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1964
1970
|
def get_catalog_categories_with_http_info(opts = {})
|
1965
1971
|
if @api_client.config.debugging
|
@@ -1986,7 +1992,7 @@ module KlaviyoAPI
|
|
1986
1992
|
# header parameters
|
1987
1993
|
header_params = opts[:header_params] || {}
|
1988
1994
|
# klaviyo api revision
|
1989
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1995
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1990
1996
|
# HTTP header 'Accept' (if needed)
|
1991
1997
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1992
1998
|
|
@@ -2000,7 +2006,7 @@ module KlaviyoAPI
|
|
2000
2006
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2001
2007
|
|
2002
2008
|
# auth_names
|
2003
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2009
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2004
2010
|
|
2005
2011
|
new_options = opts.merge(
|
2006
2012
|
:operation => :"CatalogsApi.get_catalog_categories",
|
@@ -2023,7 +2029,7 @@ module KlaviyoAPI
|
|
2023
2029
|
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2024
2030
|
# @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`.
|
2025
2031
|
# @param [Hash] opts the optional parameters
|
2026
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
2032
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2027
2033
|
# @return [Hash<String, Object>]
|
2028
2034
|
def get_catalog_category(id, opts = {})
|
2029
2035
|
data, _status_code, _headers = get_catalog_category_with_http_info(id, opts)
|
@@ -2034,7 +2040,7 @@ module KlaviyoAPI
|
|
2034
2040
|
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2035
2041
|
# @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`.
|
2036
2042
|
# @param [Hash] opts the optional parameters
|
2037
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
2043
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2038
2044
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2039
2045
|
def get_catalog_category_with_http_info(id, opts = {})
|
2040
2046
|
if @api_client.config.debugging
|
@@ -2058,7 +2064,7 @@ module KlaviyoAPI
|
|
2058
2064
|
# header parameters
|
2059
2065
|
header_params = opts[:header_params] || {}
|
2060
2066
|
# klaviyo api revision
|
2061
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2067
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2062
2068
|
# HTTP header 'Accept' (if needed)
|
2063
2069
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2064
2070
|
|
@@ -2072,7 +2078,7 @@ module KlaviyoAPI
|
|
2072
2078
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2073
2079
|
|
2074
2080
|
# auth_names
|
2075
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2081
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2076
2082
|
|
2077
2083
|
new_options = opts.merge(
|
2078
2084
|
:operation => :"CatalogsApi.get_catalog_category",
|
@@ -2095,9 +2101,9 @@ module KlaviyoAPI
|
|
2095
2101
|
# 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`
|
2096
2102
|
# @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`.
|
2097
2103
|
# @param [Hash] opts the optional parameters
|
2098
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
2099
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
2100
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
2104
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2105
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2106
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
2101
2107
|
# @return [Hash<String, Object>]
|
2102
2108
|
def get_catalog_item(id, opts = {})
|
2103
2109
|
data, _status_code, _headers = get_catalog_item_with_http_info(id, opts)
|
@@ -2108,9 +2114,9 @@ module KlaviyoAPI
|
|
2108
2114
|
# 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`
|
2109
2115
|
# @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`.
|
2110
2116
|
# @param [Hash] opts the optional parameters
|
2111
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
2112
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
2113
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
2117
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2118
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2119
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
2114
2120
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2115
2121
|
def get_catalog_item_with_http_info(id, opts = {})
|
2116
2122
|
if @api_client.config.debugging
|
@@ -2144,7 +2150,7 @@ module KlaviyoAPI
|
|
2144
2150
|
# header parameters
|
2145
2151
|
header_params = opts[:header_params] || {}
|
2146
2152
|
# klaviyo api revision
|
2147
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2153
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2148
2154
|
# HTTP header 'Accept' (if needed)
|
2149
2155
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2150
2156
|
|
@@ -2158,7 +2164,7 @@ module KlaviyoAPI
|
|
2158
2164
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2159
2165
|
|
2160
2166
|
# auth_names
|
2161
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2167
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2162
2168
|
|
2163
2169
|
new_options = opts.merge(
|
2164
2170
|
:operation => :"CatalogsApi.get_catalog_item",
|
@@ -2180,12 +2186,12 @@ module KlaviyoAPI
|
|
2180
2186
|
# Get Catalog Items
|
2181
2187
|
# 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`
|
2182
2188
|
# @param [Hash] opts the optional parameters
|
2183
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
2184
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
2185
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
2186
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
2187
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
2188
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
2189
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2190
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2191
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
2192
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
2193
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2194
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2189
2195
|
# @return [Hash<String, Object>]
|
2190
2196
|
def get_catalog_items(opts = {})
|
2191
2197
|
data, _status_code, _headers = get_catalog_items_with_http_info(opts)
|
@@ -2195,12 +2201,12 @@ module KlaviyoAPI
|
|
2195
2201
|
# Get Catalog Items
|
2196
2202
|
# 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`
|
2197
2203
|
# @param [Hash] opts the optional parameters
|
2198
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
2199
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
2200
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
2201
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
2202
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
2203
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
2204
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2205
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2206
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
2207
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
2208
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2209
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2204
2210
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2205
2211
|
def get_catalog_items_with_http_info(opts = {})
|
2206
2212
|
if @api_client.config.debugging
|
@@ -2237,7 +2243,7 @@ module KlaviyoAPI
|
|
2237
2243
|
# header parameters
|
2238
2244
|
header_params = opts[:header_params] || {}
|
2239
2245
|
# klaviyo api revision
|
2240
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2246
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2241
2247
|
# HTTP header 'Accept' (if needed)
|
2242
2248
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2243
2249
|
|
@@ -2251,7 +2257,7 @@ module KlaviyoAPI
|
|
2251
2257
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2252
2258
|
|
2253
2259
|
# auth_names
|
2254
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2260
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2255
2261
|
|
2256
2262
|
new_options = opts.merge(
|
2257
2263
|
:operation => :"CatalogsApi.get_catalog_items",
|
@@ -2274,7 +2280,7 @@ module KlaviyoAPI
|
|
2274
2280
|
# 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`
|
2275
2281
|
# @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`.
|
2276
2282
|
# @param [Hash] opts the optional parameters
|
2277
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
2283
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2278
2284
|
# @return [Hash<String, Object>]
|
2279
2285
|
def get_catalog_variant(id, opts = {})
|
2280
2286
|
data, _status_code, _headers = get_catalog_variant_with_http_info(id, opts)
|
@@ -2285,7 +2291,7 @@ module KlaviyoAPI
|
|
2285
2291
|
# 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`
|
2286
2292
|
# @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`.
|
2287
2293
|
# @param [Hash] opts the optional parameters
|
2288
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
2294
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2289
2295
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2290
2296
|
def get_catalog_variant_with_http_info(id, opts = {})
|
2291
2297
|
if @api_client.config.debugging
|
@@ -2309,7 +2315,7 @@ module KlaviyoAPI
|
|
2309
2315
|
# header parameters
|
2310
2316
|
header_params = opts[:header_params] || {}
|
2311
2317
|
# klaviyo api revision
|
2312
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2318
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2313
2319
|
# HTTP header 'Accept' (if needed)
|
2314
2320
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2315
2321
|
|
@@ -2323,7 +2329,7 @@ module KlaviyoAPI
|
|
2323
2329
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2324
2330
|
|
2325
2331
|
# auth_names
|
2326
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2332
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2327
2333
|
|
2328
2334
|
new_options = opts.merge(
|
2329
2335
|
:operation => :"CatalogsApi.get_catalog_variant",
|
@@ -2345,10 +2351,10 @@ module KlaviyoAPI
|
|
2345
2351
|
# Get Catalog Variants
|
2346
2352
|
# 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`
|
2347
2353
|
# @param [Hash] opts the optional parameters
|
2348
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
2349
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
2350
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
2351
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
2354
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2355
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
2356
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2357
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2352
2358
|
# @return [Hash<String, Object>]
|
2353
2359
|
def get_catalog_variants(opts = {})
|
2354
2360
|
data, _status_code, _headers = get_catalog_variants_with_http_info(opts)
|
@@ -2358,10 +2364,10 @@ module KlaviyoAPI
|
|
2358
2364
|
# Get Catalog Variants
|
2359
2365
|
# 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`
|
2360
2366
|
# @param [Hash] opts the optional parameters
|
2361
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
2362
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
2363
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
2364
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
2367
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2368
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
2369
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2370
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2365
2371
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2366
2372
|
def get_catalog_variants_with_http_info(opts = {})
|
2367
2373
|
if @api_client.config.debugging
|
@@ -2388,7 +2394,7 @@ module KlaviyoAPI
|
|
2388
2394
|
# header parameters
|
2389
2395
|
header_params = opts[:header_params] || {}
|
2390
2396
|
# klaviyo api revision
|
2391
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2397
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2392
2398
|
# HTTP header 'Accept' (if needed)
|
2393
2399
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2394
2400
|
|
@@ -2402,7 +2408,7 @@ module KlaviyoAPI
|
|
2402
2408
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2403
2409
|
|
2404
2410
|
# auth_names
|
2405
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2411
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2406
2412
|
|
2407
2413
|
new_options = opts.merge(
|
2408
2414
|
:operation => :"CatalogsApi.get_catalog_variants",
|
@@ -2425,10 +2431,10 @@ module KlaviyoAPI
|
|
2425
2431
|
# 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`
|
2426
2432
|
# @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`.
|
2427
2433
|
# @param [Hash] opts the optional parameters
|
2428
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
2429
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
2430
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
2431
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
2434
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2435
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
2436
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2437
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2432
2438
|
# @return [Hash<String, Object>]
|
2433
2439
|
def get_categories_for_catalog_item(id, opts = {})
|
2434
2440
|
data, _status_code, _headers = get_categories_for_catalog_item_with_http_info(id, opts)
|
@@ -2442,10 +2448,10 @@ module KlaviyoAPI
|
|
2442
2448
|
# 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`
|
2443
2449
|
# @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`.
|
2444
2450
|
# @param [Hash] opts the optional parameters
|
2445
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
2446
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
2447
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
2448
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
2451
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2452
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
2453
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2454
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2449
2455
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2450
2456
|
def get_categories_for_catalog_item_with_http_info(id, opts = {})
|
2451
2457
|
if @api_client.config.debugging
|
@@ -2472,7 +2478,7 @@ module KlaviyoAPI
|
|
2472
2478
|
# header parameters
|
2473
2479
|
header_params = opts[:header_params] || {}
|
2474
2480
|
# klaviyo api revision
|
2475
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2481
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2476
2482
|
# HTTP header 'Accept' (if needed)
|
2477
2483
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2478
2484
|
|
@@ -2486,7 +2492,7 @@ module KlaviyoAPI
|
|
2486
2492
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2487
2493
|
|
2488
2494
|
# auth_names
|
2489
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2495
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2490
2496
|
|
2491
2497
|
new_options = opts.merge(
|
2492
2498
|
:operation => :"CatalogsApi.get_categories_for_catalog_item",
|
@@ -2509,10 +2515,12 @@ module KlaviyoAPI
|
|
2509
2515
|
alias get_catalog_item_categories_with_http_info get_categories_for_catalog_item_with_http_info
|
2510
2516
|
|
2511
2517
|
# Get Category IDs for Catalog Item
|
2512
|
-
# Get all catalog categories that a particular item is in.
|
2518
|
+
# 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`
|
2513
2519
|
# @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`.
|
2514
2520
|
# @param [Hash] opts the optional parameters
|
2515
|
-
# @option opts [String] :
|
2521
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
2522
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2523
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2516
2524
|
# @return [Hash<String, Object>]
|
2517
2525
|
def get_category_ids_for_catalog_item(id, opts = {})
|
2518
2526
|
data, _status_code, _headers = get_category_ids_for_catalog_item_with_http_info(id, opts)
|
@@ -2523,30 +2531,34 @@ module KlaviyoAPI
|
|
2523
2531
|
alias get_catalog_item_relationships_categories get_category_ids_for_catalog_item
|
2524
2532
|
|
2525
2533
|
# Get Category IDs for Catalog Item
|
2526
|
-
# Get all catalog categories that a particular item is in.
|
2534
|
+
# 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`
|
2527
2535
|
# @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`.
|
2528
2536
|
# @param [Hash] opts the optional parameters
|
2529
|
-
# @option opts [String] :
|
2537
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
2538
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2539
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2530
2540
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2531
2541
|
def get_category_ids_for_catalog_item_with_http_info(id, opts = {})
|
2532
2542
|
if @api_client.config.debugging
|
2533
2543
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_category_ids_for_catalog_item ...'
|
2534
2544
|
end
|
2535
|
-
|
2536
|
-
if @api_client.config.client_side_validation &&
|
2537
|
-
fail ArgumentError, "
|
2545
|
+
allowable_values = ["created", "-created"]
|
2546
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2547
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2538
2548
|
end
|
2539
2549
|
# resource path
|
2540
2550
|
local_var_path = '/api/catalog-items/{id}/relationships/categories'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
2541
2551
|
|
2542
2552
|
# query parameters
|
2543
2553
|
query_params = opts[:query_params] || {}
|
2554
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
2544
2555
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
2556
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2545
2557
|
|
2546
2558
|
# header parameters
|
2547
2559
|
header_params = opts[:header_params] || {}
|
2548
2560
|
# klaviyo api revision
|
2549
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2561
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2550
2562
|
# HTTP header 'Accept' (if needed)
|
2551
2563
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2552
2564
|
|
@@ -2560,7 +2572,7 @@ module KlaviyoAPI
|
|
2560
2572
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2561
2573
|
|
2562
2574
|
# auth_names
|
2563
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2575
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2564
2576
|
|
2565
2577
|
new_options = opts.merge(
|
2566
2578
|
:operation => :"CatalogsApi.get_category_ids_for_catalog_item",
|
@@ -2586,9 +2598,9 @@ module KlaviyoAPI
|
|
2586
2598
|
# 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`
|
2587
2599
|
# @param job_id [String] ID of the job to retrieve.
|
2588
2600
|
# @param [Hash] opts the optional parameters
|
2589
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
2590
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
2591
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
2601
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2602
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2603
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
2592
2604
|
# @return [Hash<String, Object>]
|
2593
2605
|
def get_create_categories_job(job_id, opts = {})
|
2594
2606
|
data, _status_code, _headers = get_create_categories_job_with_http_info(job_id, opts)
|
@@ -2602,9 +2614,9 @@ module KlaviyoAPI
|
|
2602
2614
|
# 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`
|
2603
2615
|
# @param job_id [String] ID of the job to retrieve.
|
2604
2616
|
# @param [Hash] opts the optional parameters
|
2605
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
2606
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
2607
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
2617
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2618
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2619
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
2608
2620
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2609
2621
|
def get_create_categories_job_with_http_info(job_id, opts = {})
|
2610
2622
|
if @api_client.config.debugging
|
@@ -2638,7 +2650,7 @@ module KlaviyoAPI
|
|
2638
2650
|
# header parameters
|
2639
2651
|
header_params = opts[:header_params] || {}
|
2640
2652
|
# klaviyo api revision
|
2641
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2653
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2642
2654
|
# HTTP header 'Accept' (if needed)
|
2643
2655
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2644
2656
|
|
@@ -2652,7 +2664,7 @@ module KlaviyoAPI
|
|
2652
2664
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2653
2665
|
|
2654
2666
|
# auth_names
|
2655
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2667
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2656
2668
|
|
2657
2669
|
new_options = opts.merge(
|
2658
2670
|
:operation => :"CatalogsApi.get_create_categories_job",
|
@@ -2677,9 +2689,9 @@ module KlaviyoAPI
|
|
2677
2689
|
# Get Create Categories Jobs
|
2678
2690
|
# 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`
|
2679
2691
|
# @param [Hash] opts the optional parameters
|
2680
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
2681
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
2682
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
2692
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2693
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2694
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2683
2695
|
# @return [Hash<String, Object>]
|
2684
2696
|
def get_create_categories_jobs(opts = {})
|
2685
2697
|
data, _status_code, _headers = get_create_categories_jobs_with_http_info(opts)
|
@@ -2692,9 +2704,9 @@ module KlaviyoAPI
|
|
2692
2704
|
# Get Create Categories Jobs
|
2693
2705
|
# 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`
|
2694
2706
|
# @param [Hash] opts the optional parameters
|
2695
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
2696
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
2697
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
2707
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2708
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2709
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2698
2710
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2699
2711
|
def get_create_categories_jobs_with_http_info(opts = {})
|
2700
2712
|
if @api_client.config.debugging
|
@@ -2716,7 +2728,7 @@ module KlaviyoAPI
|
|
2716
2728
|
# header parameters
|
2717
2729
|
header_params = opts[:header_params] || {}
|
2718
2730
|
# klaviyo api revision
|
2719
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2731
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2720
2732
|
# HTTP header 'Accept' (if needed)
|
2721
2733
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2722
2734
|
|
@@ -2730,7 +2742,7 @@ module KlaviyoAPI
|
|
2730
2742
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2731
2743
|
|
2732
2744
|
# auth_names
|
2733
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2745
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2734
2746
|
|
2735
2747
|
new_options = opts.merge(
|
2736
2748
|
:operation => :"CatalogsApi.get_create_categories_jobs",
|
@@ -2756,9 +2768,9 @@ module KlaviyoAPI
|
|
2756
2768
|
# Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2757
2769
|
# @param job_id [String] ID of the job to retrieve.
|
2758
2770
|
# @param [Hash] opts the optional parameters
|
2759
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
2760
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
2761
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
2771
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2772
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2773
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
2762
2774
|
# @return [Hash<String, Object>]
|
2763
2775
|
def get_create_variants_job(job_id, opts = {})
|
2764
2776
|
data, _status_code, _headers = get_create_variants_job_with_http_info(job_id, opts)
|
@@ -2772,9 +2784,9 @@ module KlaviyoAPI
|
|
2772
2784
|
# Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2773
2785
|
# @param job_id [String] ID of the job to retrieve.
|
2774
2786
|
# @param [Hash] opts the optional parameters
|
2775
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
2776
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
2777
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
2787
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2788
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2789
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
2778
2790
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2779
2791
|
def get_create_variants_job_with_http_info(job_id, opts = {})
|
2780
2792
|
if @api_client.config.debugging
|
@@ -2808,7 +2820,7 @@ module KlaviyoAPI
|
|
2808
2820
|
# header parameters
|
2809
2821
|
header_params = opts[:header_params] || {}
|
2810
2822
|
# klaviyo api revision
|
2811
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2823
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2812
2824
|
# HTTP header 'Accept' (if needed)
|
2813
2825
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2814
2826
|
|
@@ -2822,7 +2834,7 @@ module KlaviyoAPI
|
|
2822
2834
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2823
2835
|
|
2824
2836
|
# auth_names
|
2825
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2837
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2826
2838
|
|
2827
2839
|
new_options = opts.merge(
|
2828
2840
|
:operation => :"CatalogsApi.get_create_variants_job",
|
@@ -2847,9 +2859,9 @@ module KlaviyoAPI
|
|
2847
2859
|
# Get Create Variants Jobs
|
2848
2860
|
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2849
2861
|
# @param [Hash] opts the optional parameters
|
2850
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
2851
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
2852
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
2862
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2863
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2864
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2853
2865
|
# @return [Hash<String, Object>]
|
2854
2866
|
def get_create_variants_jobs(opts = {})
|
2855
2867
|
data, _status_code, _headers = get_create_variants_jobs_with_http_info(opts)
|
@@ -2862,9 +2874,9 @@ module KlaviyoAPI
|
|
2862
2874
|
# Get Create Variants Jobs
|
2863
2875
|
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2864
2876
|
# @param [Hash] opts the optional parameters
|
2865
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
2866
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
2867
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
2877
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2878
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2879
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2868
2880
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2869
2881
|
def get_create_variants_jobs_with_http_info(opts = {})
|
2870
2882
|
if @api_client.config.debugging
|
@@ -2886,7 +2898,7 @@ module KlaviyoAPI
|
|
2886
2898
|
# header parameters
|
2887
2899
|
header_params = opts[:header_params] || {}
|
2888
2900
|
# klaviyo api revision
|
2889
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2901
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2890
2902
|
# HTTP header 'Accept' (if needed)
|
2891
2903
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2892
2904
|
|
@@ -2900,7 +2912,7 @@ module KlaviyoAPI
|
|
2900
2912
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2901
2913
|
|
2902
2914
|
# auth_names
|
2903
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2915
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2904
2916
|
|
2905
2917
|
new_options = opts.merge(
|
2906
2918
|
:operation => :"CatalogsApi.get_create_variants_jobs",
|
@@ -2926,7 +2938,7 @@ module KlaviyoAPI
|
|
2926
2938
|
# 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`
|
2927
2939
|
# @param job_id [String] ID of the job to retrieve.
|
2928
2940
|
# @param [Hash] opts the optional parameters
|
2929
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
2941
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2930
2942
|
# @return [Hash<String, Object>]
|
2931
2943
|
def get_delete_categories_job(job_id, opts = {})
|
2932
2944
|
data, _status_code, _headers = get_delete_categories_job_with_http_info(job_id, opts)
|
@@ -2940,7 +2952,7 @@ module KlaviyoAPI
|
|
2940
2952
|
# Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2941
2953
|
# @param job_id [String] ID of the job to retrieve.
|
2942
2954
|
# @param [Hash] opts the optional parameters
|
2943
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
2955
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2944
2956
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2945
2957
|
def get_delete_categories_job_with_http_info(job_id, opts = {})
|
2946
2958
|
if @api_client.config.debugging
|
@@ -2964,7 +2976,7 @@ module KlaviyoAPI
|
|
2964
2976
|
# header parameters
|
2965
2977
|
header_params = opts[:header_params] || {}
|
2966
2978
|
# klaviyo api revision
|
2967
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2979
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2968
2980
|
# HTTP header 'Accept' (if needed)
|
2969
2981
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2970
2982
|
|
@@ -2978,7 +2990,7 @@ module KlaviyoAPI
|
|
2978
2990
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2979
2991
|
|
2980
2992
|
# auth_names
|
2981
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2993
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2982
2994
|
|
2983
2995
|
new_options = opts.merge(
|
2984
2996
|
:operation => :"CatalogsApi.get_delete_categories_job",
|
@@ -3003,9 +3015,9 @@ module KlaviyoAPI
|
|
3003
3015
|
# Get Delete Categories Jobs
|
3004
3016
|
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3005
3017
|
# @param [Hash] opts the optional parameters
|
3006
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
3007
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
3008
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
3018
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3019
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
3020
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3009
3021
|
# @return [Hash<String, Object>]
|
3010
3022
|
def get_delete_categories_jobs(opts = {})
|
3011
3023
|
data, _status_code, _headers = get_delete_categories_jobs_with_http_info(opts)
|
@@ -3018,9 +3030,9 @@ module KlaviyoAPI
|
|
3018
3030
|
# Get Delete Categories Jobs
|
3019
3031
|
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3020
3032
|
# @param [Hash] opts the optional parameters
|
3021
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
3022
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
3023
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
3033
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3034
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
3035
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3024
3036
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3025
3037
|
def get_delete_categories_jobs_with_http_info(opts = {})
|
3026
3038
|
if @api_client.config.debugging
|
@@ -3042,7 +3054,7 @@ module KlaviyoAPI
|
|
3042
3054
|
# header parameters
|
3043
3055
|
header_params = opts[:header_params] || {}
|
3044
3056
|
# klaviyo api revision
|
3045
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
3057
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3046
3058
|
# HTTP header 'Accept' (if needed)
|
3047
3059
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3048
3060
|
|
@@ -3056,7 +3068,7 @@ module KlaviyoAPI
|
|
3056
3068
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
3057
3069
|
|
3058
3070
|
# auth_names
|
3059
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
3071
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3060
3072
|
|
3061
3073
|
new_options = opts.merge(
|
3062
3074
|
:operation => :"CatalogsApi.get_delete_categories_jobs",
|
@@ -3082,7 +3094,7 @@ module KlaviyoAPI
|
|
3082
3094
|
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3083
3095
|
# @param job_id [String] ID of the job to retrieve.
|
3084
3096
|
# @param [Hash] opts the optional parameters
|
3085
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
3097
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3086
3098
|
# @return [Hash<String, Object>]
|
3087
3099
|
def get_delete_variants_job(job_id, opts = {})
|
3088
3100
|
data, _status_code, _headers = get_delete_variants_job_with_http_info(job_id, opts)
|
@@ -3096,7 +3108,7 @@ module KlaviyoAPI
|
|
3096
3108
|
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3097
3109
|
# @param job_id [String] ID of the job to retrieve.
|
3098
3110
|
# @param [Hash] opts the optional parameters
|
3099
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
3111
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3100
3112
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3101
3113
|
def get_delete_variants_job_with_http_info(job_id, opts = {})
|
3102
3114
|
if @api_client.config.debugging
|
@@ -3120,7 +3132,7 @@ module KlaviyoAPI
|
|
3120
3132
|
# header parameters
|
3121
3133
|
header_params = opts[:header_params] || {}
|
3122
3134
|
# klaviyo api revision
|
3123
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
3135
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3124
3136
|
# HTTP header 'Accept' (if needed)
|
3125
3137
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3126
3138
|
|
@@ -3134,7 +3146,7 @@ module KlaviyoAPI
|
|
3134
3146
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
3135
3147
|
|
3136
3148
|
# auth_names
|
3137
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
3149
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3138
3150
|
|
3139
3151
|
new_options = opts.merge(
|
3140
3152
|
:operation => :"CatalogsApi.get_delete_variants_job",
|
@@ -3159,9 +3171,9 @@ module KlaviyoAPI
|
|
3159
3171
|
# Get Delete Variants Jobs
|
3160
3172
|
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3161
3173
|
# @param [Hash] opts the optional parameters
|
3162
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
3163
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
3164
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
3174
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3175
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
3176
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3165
3177
|
# @return [Hash<String, Object>]
|
3166
3178
|
def get_delete_variants_jobs(opts = {})
|
3167
3179
|
data, _status_code, _headers = get_delete_variants_jobs_with_http_info(opts)
|
@@ -3174,9 +3186,9 @@ module KlaviyoAPI
|
|
3174
3186
|
# Get Delete Variants Jobs
|
3175
3187
|
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3176
3188
|
# @param [Hash] opts the optional parameters
|
3177
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
3178
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
3179
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
3189
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3190
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
3191
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3180
3192
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3181
3193
|
def get_delete_variants_jobs_with_http_info(opts = {})
|
3182
3194
|
if @api_client.config.debugging
|
@@ -3198,7 +3210,7 @@ module KlaviyoAPI
|
|
3198
3210
|
# header parameters
|
3199
3211
|
header_params = opts[:header_params] || {}
|
3200
3212
|
# klaviyo api revision
|
3201
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
3213
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3202
3214
|
# HTTP header 'Accept' (if needed)
|
3203
3215
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3204
3216
|
|
@@ -3212,7 +3224,7 @@ module KlaviyoAPI
|
|
3212
3224
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
3213
3225
|
|
3214
3226
|
# auth_names
|
3215
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
3227
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3216
3228
|
|
3217
3229
|
new_options = opts.merge(
|
3218
3230
|
:operation => :"CatalogsApi.get_delete_variants_jobs",
|
@@ -3235,10 +3247,12 @@ module KlaviyoAPI
|
|
3235
3247
|
alias get_catalog_variant_bulk_delete_jobs_with_http_info get_delete_variants_jobs_with_http_info
|
3236
3248
|
|
3237
3249
|
# Get Item IDs for Catalog Category
|
3238
|
-
# Get all items in the given category ID.
|
3250
|
+
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3239
3251
|
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3240
3252
|
# @param [Hash] opts the optional parameters
|
3241
|
-
# @option opts [String] :
|
3253
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3254
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3255
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
3242
3256
|
# @return [Hash<String, Object>]
|
3243
3257
|
def get_item_ids_for_catalog_category(id, opts = {})
|
3244
3258
|
data, _status_code, _headers = get_item_ids_for_catalog_category_with_http_info(id, opts)
|
@@ -3249,30 +3263,34 @@ module KlaviyoAPI
|
|
3249
3263
|
alias get_catalog_category_relationships_items get_item_ids_for_catalog_category
|
3250
3264
|
|
3251
3265
|
# Get Item IDs for Catalog Category
|
3252
|
-
# Get all items in the given category ID.
|
3266
|
+
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3253
3267
|
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3254
3268
|
# @param [Hash] opts the optional parameters
|
3255
|
-
# @option opts [String] :
|
3269
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3270
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3271
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
3256
3272
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3257
3273
|
def get_item_ids_for_catalog_category_with_http_info(id, opts = {})
|
3258
3274
|
if @api_client.config.debugging
|
3259
3275
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_item_ids_for_catalog_category ...'
|
3260
3276
|
end
|
3261
|
-
|
3262
|
-
if @api_client.config.client_side_validation &&
|
3263
|
-
fail ArgumentError, "
|
3277
|
+
allowable_values = ["created", "-created"]
|
3278
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
3279
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
3264
3280
|
end
|
3265
3281
|
# resource path
|
3266
3282
|
local_var_path = '/api/catalog-categories/{id}/relationships/items'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
3267
3283
|
|
3268
3284
|
# query parameters
|
3269
3285
|
query_params = opts[:query_params] || {}
|
3286
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
3270
3287
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
3288
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3271
3289
|
|
3272
3290
|
# header parameters
|
3273
3291
|
header_params = opts[:header_params] || {}
|
3274
3292
|
# klaviyo api revision
|
3275
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
3293
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3276
3294
|
# HTTP header 'Accept' (if needed)
|
3277
3295
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3278
3296
|
|
@@ -3286,7 +3304,7 @@ module KlaviyoAPI
|
|
3286
3304
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
3287
3305
|
|
3288
3306
|
# auth_names
|
3289
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
3307
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3290
3308
|
|
3291
3309
|
new_options = opts.merge(
|
3292
3310
|
:operation => :"CatalogsApi.get_item_ids_for_catalog_category",
|
@@ -3312,12 +3330,12 @@ module KlaviyoAPI
|
|
3312
3330
|
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3313
3331
|
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3314
3332
|
# @param [Hash] opts the optional parameters
|
3315
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
3316
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
3317
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
3318
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
3319
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
3320
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
3333
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3334
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3335
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3336
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
3337
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3338
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
3321
3339
|
# @return [Hash<String, Object>]
|
3322
3340
|
def get_items_for_catalog_category(id, opts = {})
|
3323
3341
|
data, _status_code, _headers = get_items_for_catalog_category_with_http_info(id, opts)
|
@@ -3331,12 +3349,12 @@ module KlaviyoAPI
|
|
3331
3349
|
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3332
3350
|
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3333
3351
|
# @param [Hash] opts the optional parameters
|
3334
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
3335
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
3336
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
3337
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
3338
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
3339
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
3352
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3353
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3354
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3355
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
3356
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3357
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
3340
3358
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3341
3359
|
def get_items_for_catalog_category_with_http_info(id, opts = {})
|
3342
3360
|
if @api_client.config.debugging
|
@@ -3373,7 +3391,7 @@ module KlaviyoAPI
|
|
3373
3391
|
# header parameters
|
3374
3392
|
header_params = opts[:header_params] || {}
|
3375
3393
|
# klaviyo api revision
|
3376
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
3394
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3377
3395
|
# HTTP header 'Accept' (if needed)
|
3378
3396
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3379
3397
|
|
@@ -3387,7 +3405,7 @@ module KlaviyoAPI
|
|
3387
3405
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
3388
3406
|
|
3389
3407
|
# auth_names
|
3390
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
3408
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3391
3409
|
|
3392
3410
|
new_options = opts.merge(
|
3393
3411
|
:operation => :"CatalogsApi.get_items_for_catalog_category",
|
@@ -3413,9 +3431,9 @@ module KlaviyoAPI
|
|
3413
3431
|
# Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3414
3432
|
# @param job_id [String] ID of the job to retrieve.
|
3415
3433
|
# @param [Hash] opts the optional parameters
|
3416
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
3417
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
3418
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
3434
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3435
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3436
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
3419
3437
|
# @return [Hash<String, Object>]
|
3420
3438
|
def get_update_categories_job(job_id, opts = {})
|
3421
3439
|
data, _status_code, _headers = get_update_categories_job_with_http_info(job_id, opts)
|
@@ -3429,9 +3447,9 @@ module KlaviyoAPI
|
|
3429
3447
|
# 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`
|
3430
3448
|
# @param job_id [String] ID of the job to retrieve.
|
3431
3449
|
# @param [Hash] opts the optional parameters
|
3432
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
3433
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
3434
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
3450
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3451
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3452
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
3435
3453
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3436
3454
|
def get_update_categories_job_with_http_info(job_id, opts = {})
|
3437
3455
|
if @api_client.config.debugging
|
@@ -3465,7 +3483,7 @@ module KlaviyoAPI
|
|
3465
3483
|
# header parameters
|
3466
3484
|
header_params = opts[:header_params] || {}
|
3467
3485
|
# klaviyo api revision
|
3468
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
3486
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3469
3487
|
# HTTP header 'Accept' (if needed)
|
3470
3488
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3471
3489
|
|
@@ -3479,7 +3497,7 @@ module KlaviyoAPI
|
|
3479
3497
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
3480
3498
|
|
3481
3499
|
# auth_names
|
3482
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
3500
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3483
3501
|
|
3484
3502
|
new_options = opts.merge(
|
3485
3503
|
:operation => :"CatalogsApi.get_update_categories_job",
|
@@ -3504,9 +3522,9 @@ module KlaviyoAPI
|
|
3504
3522
|
# Get Update Categories Jobs
|
3505
3523
|
# 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`
|
3506
3524
|
# @param [Hash] opts the optional parameters
|
3507
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
3508
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
3509
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
3525
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3526
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
3527
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3510
3528
|
# @return [Hash<String, Object>]
|
3511
3529
|
def get_update_categories_jobs(opts = {})
|
3512
3530
|
data, _status_code, _headers = get_update_categories_jobs_with_http_info(opts)
|
@@ -3519,9 +3537,9 @@ module KlaviyoAPI
|
|
3519
3537
|
# Get Update Categories Jobs
|
3520
3538
|
# 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`
|
3521
3539
|
# @param [Hash] opts the optional parameters
|
3522
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
3523
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
3524
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
3540
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3541
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
3542
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3525
3543
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3526
3544
|
def get_update_categories_jobs_with_http_info(opts = {})
|
3527
3545
|
if @api_client.config.debugging
|
@@ -3543,7 +3561,7 @@ module KlaviyoAPI
|
|
3543
3561
|
# header parameters
|
3544
3562
|
header_params = opts[:header_params] || {}
|
3545
3563
|
# klaviyo api revision
|
3546
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
3564
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3547
3565
|
# HTTP header 'Accept' (if needed)
|
3548
3566
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3549
3567
|
|
@@ -3557,7 +3575,7 @@ module KlaviyoAPI
|
|
3557
3575
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
3558
3576
|
|
3559
3577
|
# auth_names
|
3560
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
3578
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3561
3579
|
|
3562
3580
|
new_options = opts.merge(
|
3563
3581
|
:operation => :"CatalogsApi.get_update_categories_jobs",
|
@@ -3583,9 +3601,9 @@ module KlaviyoAPI
|
|
3583
3601
|
# Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3584
3602
|
# @param job_id [String] ID of the job to retrieve.
|
3585
3603
|
# @param [Hash] opts the optional parameters
|
3586
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
3587
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
3588
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
3604
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3605
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3606
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
3589
3607
|
# @return [Hash<String, Object>]
|
3590
3608
|
def get_update_variants_job(job_id, opts = {})
|
3591
3609
|
data, _status_code, _headers = get_update_variants_job_with_http_info(job_id, opts)
|
@@ -3599,9 +3617,9 @@ module KlaviyoAPI
|
|
3599
3617
|
# Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3600
3618
|
# @param job_id [String] ID of the job to retrieve.
|
3601
3619
|
# @param [Hash] opts the optional parameters
|
3602
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
3603
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
3604
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
3620
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3621
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3622
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
3605
3623
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3606
3624
|
def get_update_variants_job_with_http_info(job_id, opts = {})
|
3607
3625
|
if @api_client.config.debugging
|
@@ -3635,7 +3653,7 @@ module KlaviyoAPI
|
|
3635
3653
|
# header parameters
|
3636
3654
|
header_params = opts[:header_params] || {}
|
3637
3655
|
# klaviyo api revision
|
3638
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
3656
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3639
3657
|
# HTTP header 'Accept' (if needed)
|
3640
3658
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3641
3659
|
|
@@ -3649,7 +3667,7 @@ module KlaviyoAPI
|
|
3649
3667
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
3650
3668
|
|
3651
3669
|
# auth_names
|
3652
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
3670
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3653
3671
|
|
3654
3672
|
new_options = opts.merge(
|
3655
3673
|
:operation => :"CatalogsApi.get_update_variants_job",
|
@@ -3674,9 +3692,9 @@ module KlaviyoAPI
|
|
3674
3692
|
# Get Update Variants Jobs
|
3675
3693
|
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3676
3694
|
# @param [Hash] opts the optional parameters
|
3677
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
3678
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
3679
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
3695
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3696
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
3697
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3680
3698
|
# @return [Hash<String, Object>]
|
3681
3699
|
def get_update_variants_jobs(opts = {})
|
3682
3700
|
data, _status_code, _headers = get_update_variants_jobs_with_http_info(opts)
|
@@ -3689,9 +3707,9 @@ module KlaviyoAPI
|
|
3689
3707
|
# Get Update Variants Jobs
|
3690
3708
|
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3691
3709
|
# @param [Hash] opts the optional parameters
|
3692
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
3693
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
3694
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
3710
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3711
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
3712
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3695
3713
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3696
3714
|
def get_update_variants_jobs_with_http_info(opts = {})
|
3697
3715
|
if @api_client.config.debugging
|
@@ -3713,7 +3731,7 @@ module KlaviyoAPI
|
|
3713
3731
|
# header parameters
|
3714
3732
|
header_params = opts[:header_params] || {}
|
3715
3733
|
# klaviyo api revision
|
3716
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
3734
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3717
3735
|
# HTTP header 'Accept' (if needed)
|
3718
3736
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3719
3737
|
|
@@ -3727,7 +3745,7 @@ module KlaviyoAPI
|
|
3727
3745
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
3728
3746
|
|
3729
3747
|
# auth_names
|
3730
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
3748
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3731
3749
|
|
3732
3750
|
new_options = opts.merge(
|
3733
3751
|
:operation => :"CatalogsApi.get_update_variants_jobs",
|
@@ -3749,14 +3767,94 @@ module KlaviyoAPI
|
|
3749
3767
|
# alias of `get_update_variants_jobs_with_http_info`
|
3750
3768
|
alias get_catalog_variant_bulk_update_jobs_with_http_info get_update_variants_jobs_with_http_info
|
3751
3769
|
|
3770
|
+
# Get Variant IDs for Catalog Item
|
3771
|
+
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3772
|
+
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3773
|
+
# @param [Hash] opts the optional parameters
|
3774
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3775
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3776
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
3777
|
+
# @return [Hash<String, Object>]
|
3778
|
+
def get_variant_ids_for_catalog_item(id, opts = {})
|
3779
|
+
data, _status_code, _headers = get_variant_ids_for_catalog_item_with_http_info(id, opts)
|
3780
|
+
data
|
3781
|
+
end
|
3782
|
+
|
3783
|
+
# alias of `get_variant_ids_for_catalog_item`
|
3784
|
+
alias get_catalog_item_relationships_variants get_variant_ids_for_catalog_item
|
3785
|
+
|
3786
|
+
# Get Variant IDs for Catalog Item
|
3787
|
+
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3788
|
+
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3789
|
+
# @param [Hash] opts the optional parameters
|
3790
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3791
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3792
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
3793
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3794
|
+
def get_variant_ids_for_catalog_item_with_http_info(id, opts = {})
|
3795
|
+
if @api_client.config.debugging
|
3796
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_variant_ids_for_catalog_item ...'
|
3797
|
+
end
|
3798
|
+
allowable_values = ["created", "-created"]
|
3799
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
3800
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
3801
|
+
end
|
3802
|
+
# resource path
|
3803
|
+
local_var_path = '/api/catalog-items/{id}/relationships/variants'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
3804
|
+
|
3805
|
+
# query parameters
|
3806
|
+
query_params = opts[:query_params] || {}
|
3807
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
3808
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
3809
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3810
|
+
|
3811
|
+
# header parameters
|
3812
|
+
header_params = opts[:header_params] || {}
|
3813
|
+
# klaviyo api revision
|
3814
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3815
|
+
# HTTP header 'Accept' (if needed)
|
3816
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3817
|
+
|
3818
|
+
# form parameters
|
3819
|
+
form_params = opts[:form_params] || {}
|
3820
|
+
|
3821
|
+
# http body (model)
|
3822
|
+
post_body = opts[:debug_body]
|
3823
|
+
|
3824
|
+
# return_type
|
3825
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
3826
|
+
|
3827
|
+
# auth_names
|
3828
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3829
|
+
|
3830
|
+
new_options = opts.merge(
|
3831
|
+
:operation => :"CatalogsApi.get_variant_ids_for_catalog_item",
|
3832
|
+
:header_params => header_params,
|
3833
|
+
:query_params => query_params,
|
3834
|
+
:form_params => form_params,
|
3835
|
+
:body => post_body,
|
3836
|
+
:auth_names => auth_names,
|
3837
|
+
:return_type => return_type
|
3838
|
+
)
|
3839
|
+
|
3840
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3841
|
+
if @api_client.config.debugging
|
3842
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_variant_ids_for_catalog_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3843
|
+
end
|
3844
|
+
return data, status_code, headers
|
3845
|
+
end
|
3846
|
+
|
3847
|
+
# alias of `get_variant_ids_for_catalog_item_with_http_info`
|
3848
|
+
alias get_catalog_item_relationships_variants_with_http_info get_variant_ids_for_catalog_item_with_http_info
|
3849
|
+
|
3752
3850
|
# Get Variants for Catalog Item
|
3753
3851
|
# 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`
|
3754
3852
|
# @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`.
|
3755
3853
|
# @param [Hash] opts the optional parameters
|
3756
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
3757
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
3758
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
3759
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
3854
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3855
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3856
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3857
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
3760
3858
|
# @return [Hash<String, Object>]
|
3761
3859
|
def get_variants_for_catalog_item(id, opts = {})
|
3762
3860
|
data, _status_code, _headers = get_variants_for_catalog_item_with_http_info(id, opts)
|
@@ -3770,10 +3868,10 @@ module KlaviyoAPI
|
|
3770
3868
|
# 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`
|
3771
3869
|
# @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`.
|
3772
3870
|
# @param [Hash] opts the optional parameters
|
3773
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
3774
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
3775
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
3776
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
3871
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
3872
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3873
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3874
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
3777
3875
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3778
3876
|
def get_variants_for_catalog_item_with_http_info(id, opts = {})
|
3779
3877
|
if @api_client.config.debugging
|
@@ -3800,7 +3898,7 @@ module KlaviyoAPI
|
|
3800
3898
|
# header parameters
|
3801
3899
|
header_params = opts[:header_params] || {}
|
3802
3900
|
# klaviyo api revision
|
3803
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
3901
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3804
3902
|
# HTTP header 'Accept' (if needed)
|
3805
3903
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3806
3904
|
|
@@ -3814,7 +3912,7 @@ module KlaviyoAPI
|
|
3814
3912
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
3815
3913
|
|
3816
3914
|
# auth_names
|
3817
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
3915
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3818
3916
|
|
3819
3917
|
new_options = opts.merge(
|
3820
3918
|
:operation => :"CatalogsApi.get_variants_for_catalog_item",
|
@@ -3877,7 +3975,7 @@ module KlaviyoAPI
|
|
3877
3975
|
# header parameters
|
3878
3976
|
header_params = opts[:header_params] || {}
|
3879
3977
|
# klaviyo api revision
|
3880
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
3978
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3881
3979
|
# HTTP header 'Accept' (if needed)
|
3882
3980
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3883
3981
|
# HTTP header 'Content-Type'
|
@@ -3896,7 +3994,7 @@ module KlaviyoAPI
|
|
3896
3994
|
return_type = opts[:debug_return_type]
|
3897
3995
|
|
3898
3996
|
# auth_names
|
3899
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
3997
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3900
3998
|
|
3901
3999
|
new_options = opts.merge(
|
3902
4000
|
:operation => :"CatalogsApi.remove_categories_from_catalog_item",
|
@@ -3959,7 +4057,7 @@ module KlaviyoAPI
|
|
3959
4057
|
# header parameters
|
3960
4058
|
header_params = opts[:header_params] || {}
|
3961
4059
|
# klaviyo api revision
|
3962
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
4060
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
3963
4061
|
# HTTP header 'Accept' (if needed)
|
3964
4062
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3965
4063
|
# HTTP header 'Content-Type'
|
@@ -3978,7 +4076,7 @@ module KlaviyoAPI
|
|
3978
4076
|
return_type = opts[:debug_return_type]
|
3979
4077
|
|
3980
4078
|
# auth_names
|
3981
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
4079
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3982
4080
|
|
3983
4081
|
new_options = opts.merge(
|
3984
4082
|
:operation => :"CatalogsApi.remove_items_from_catalog_category",
|
@@ -4038,7 +4136,7 @@ module KlaviyoAPI
|
|
4038
4136
|
# header parameters
|
4039
4137
|
header_params = opts[:header_params] || {}
|
4040
4138
|
# klaviyo api revision
|
4041
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
4139
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
4042
4140
|
# HTTP header 'Accept' (if needed)
|
4043
4141
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
4044
4142
|
# HTTP header 'Content-Type'
|
@@ -4057,7 +4155,7 @@ module KlaviyoAPI
|
|
4057
4155
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
4058
4156
|
|
4059
4157
|
# auth_names
|
4060
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
4158
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
4061
4159
|
|
4062
4160
|
new_options = opts.merge(
|
4063
4161
|
:operation => :"CatalogsApi.update_catalog_category",
|
@@ -4114,7 +4212,7 @@ module KlaviyoAPI
|
|
4114
4212
|
# header parameters
|
4115
4213
|
header_params = opts[:header_params] || {}
|
4116
4214
|
# klaviyo api revision
|
4117
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
4215
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
4118
4216
|
# HTTP header 'Accept' (if needed)
|
4119
4217
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
4120
4218
|
# HTTP header 'Content-Type'
|
@@ -4133,7 +4231,7 @@ module KlaviyoAPI
|
|
4133
4231
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
4134
4232
|
|
4135
4233
|
# auth_names
|
4136
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
4234
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
4137
4235
|
|
4138
4236
|
new_options = opts.merge(
|
4139
4237
|
:operation => :"CatalogsApi.update_catalog_item",
|
@@ -4190,7 +4288,7 @@ module KlaviyoAPI
|
|
4190
4288
|
# header parameters
|
4191
4289
|
header_params = opts[:header_params] || {}
|
4192
4290
|
# klaviyo api revision
|
4193
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
4291
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
4194
4292
|
# HTTP header 'Accept' (if needed)
|
4195
4293
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
4196
4294
|
# HTTP header 'Content-Type'
|
@@ -4209,7 +4307,7 @@ module KlaviyoAPI
|
|
4209
4307
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
4210
4308
|
|
4211
4309
|
# auth_names
|
4212
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
4310
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
4213
4311
|
|
4214
4312
|
new_options = opts.merge(
|
4215
4313
|
:operation => :"CatalogsApi.update_catalog_variant",
|
@@ -4269,7 +4367,7 @@ module KlaviyoAPI
|
|
4269
4367
|
# header parameters
|
4270
4368
|
header_params = opts[:header_params] || {}
|
4271
4369
|
# klaviyo api revision
|
4272
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
4370
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
4273
4371
|
# HTTP header 'Accept' (if needed)
|
4274
4372
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
4275
4373
|
# HTTP header 'Content-Type'
|
@@ -4288,7 +4386,7 @@ module KlaviyoAPI
|
|
4288
4386
|
return_type = opts[:debug_return_type]
|
4289
4387
|
|
4290
4388
|
# auth_names
|
4291
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
4389
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
4292
4390
|
|
4293
4391
|
new_options = opts.merge(
|
4294
4392
|
:operation => :"CatalogsApi.update_categories_for_catalog_item",
|
@@ -4351,7 +4449,7 @@ module KlaviyoAPI
|
|
4351
4449
|
# header parameters
|
4352
4450
|
header_params = opts[:header_params] || {}
|
4353
4451
|
# klaviyo api revision
|
4354
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
4452
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
4355
4453
|
# HTTP header 'Accept' (if needed)
|
4356
4454
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
4357
4455
|
# HTTP header 'Content-Type'
|
@@ -4370,7 +4468,7 @@ module KlaviyoAPI
|
|
4370
4468
|
return_type = opts[:debug_return_type]
|
4371
4469
|
|
4372
4470
|
# auth_names
|
4373
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
4471
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
4374
4472
|
|
4375
4473
|
new_options = opts.merge(
|
4376
4474
|
:operation => :"CatalogsApi.update_items_for_catalog_category",
|