klaviyo-api-sdk 3.0.0 → 4.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 +33 -7
- data/README.md +243 -173
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +7 -7
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +528 -57
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +290 -220
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +92 -92
- data/lib/klaviyo-api-sdk/api/flows_api.rb +105 -94
- data/lib/klaviyo-api-sdk/api/lists_api.rb +75 -40
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +57 -57
- data/lib/klaviyo-api-sdk/api/segments_api.rb +71 -36
- data/lib/klaviyo-api-sdk/api/tags_api.rb +91 -63
- data/lib/klaviyo-api-sdk/api/templates_api.rb +25 -25
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{profile_unsuppression_bulk_create_job_enum.rb → back_in_stock_subscription_enum.rb} +5 -5
- 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 +16 -22
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +227 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +106 -0
- 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 +11 -2
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +5 -20
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object.rb → campaign_message_create_query_resource_object.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +253 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +12 -3
- 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 +3 -3
- 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_create_query_resource_object_attributes.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_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +227 -0
- 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 +3 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +227 -0
- 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_category_update_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships_items_data_inner.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_category_op_data_inner.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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +227 -0
- 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 +3 -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_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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +227 -0
- 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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +227 -0
- 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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +227 -0
- 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 +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +224 -0
- 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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +227 -0
- 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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +227 -0
- 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/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 +13 -29
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +224 -0
- 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 +248 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/{content_sub_object.rb → email_content_sub_object.rb} +19 -39
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +220 -0
- data/lib/klaviyo-api-sdk/models/{tracking_options_sub_object.rb → email_tracking_options_sub_object.rb} +18 -18
- data/lib/klaviyo-api-sdk/models/{event_create_query.rb → event_create_query_v2.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object.rb → event_create_query_v2_resource_object.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object_attributes.rb → event_create_query_v2_resource_object_attributes.rb} +6 -7
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.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/get_create_variants_jobs5_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_create_variants_jobs5_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_create_variants_jobs5_xx_response_errors_inner_source.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_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/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 +3 -6
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object.rb → metric_create_query_resource_object.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/{metric_create_query.rb → metric_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{profile_unsubscription_bulk_create_job_enum.rb → metric_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +257 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +328 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +219 -0
- 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_identifier_dto_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +249 -0
- 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_meta.rb +219 -0
- data/lib/klaviyo-api-sdk/models/{tag_create_query_resource_object_attributes.rb → profile_meta_patch_properties.rb} +28 -24
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +106 -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 +11 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/{subscription.rb → profile_subscription_create_query_resource_object_attributes.rb} +17 -27
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +230 -0
- 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 +36 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{suppression.rb → profile_suppression_create_query_resource_object_attributes.rb} +5 -10
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +220 -0
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +261 -0
- 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/send_strategy_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query.rb → server_bis_subscription_create_query.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object_attributes.rb → server_bis_subscription_create_query_resource_object_attributes.rb} +46 -32
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +224 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +220 -0
- data/lib/klaviyo-api-sdk/models/{send_options_sub_object.rb → sms_send_options_sub_object.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object_attributes.rb → sms_tracking_options_sub_object.rb} +23 -18
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.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 +11 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +14 -32
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query.rb → subscription_delete_job_create_query.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +272 -0
- 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 +11 -14
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
- 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 +12 -3
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +272 -0
- 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/tag_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +2 -14
- 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 -14
- 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 +2 -14
- 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 +5 -17
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +81 -19
- metadata +82 -20
@@ -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: 2023-
|
6
|
+
The version of the OpenAPI document: 2023-07-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -19,6 +19,76 @@ module KlaviyoAPI
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Create Back In Stock Subscription
|
23
|
+
# Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details. This endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:write` `profiles:write`
|
24
|
+
# @param server_bis_subscription_create_query [ServerBISSubscriptionCreateQuery]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [nil]
|
27
|
+
def create_back_in_stock_subscription(server_bis_subscription_create_query, opts = {})
|
28
|
+
create_back_in_stock_subscription_with_http_info(server_bis_subscription_create_query, opts)
|
29
|
+
nil
|
30
|
+
end
|
31
|
+
|
32
|
+
# Create Back In Stock Subscription
|
33
|
+
# Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details. This endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:write` `profiles:write`
|
34
|
+
# @param server_bis_subscription_create_query [ServerBISSubscriptionCreateQuery]
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
37
|
+
def create_back_in_stock_subscription_with_http_info(server_bis_subscription_create_query, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.create_back_in_stock_subscription ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'server_bis_subscription_create_query' is set
|
42
|
+
if @api_client.config.client_side_validation && server_bis_subscription_create_query.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'server_bis_subscription_create_query' when calling CatalogsApi.create_back_in_stock_subscription"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/api/back-in-stock-subscriptions/'
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# klaviyo api revision
|
54
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
55
|
+
# HTTP header 'Accept' (if needed)
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
|
+
# HTTP header 'Content-Type'
|
58
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
59
|
+
if !content_type.nil?
|
60
|
+
header_params['Content-Type'] = content_type
|
61
|
+
end
|
62
|
+
|
63
|
+
# form parameters
|
64
|
+
form_params = opts[:form_params] || {}
|
65
|
+
|
66
|
+
# http body (model)
|
67
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(server_bis_subscription_create_query)
|
68
|
+
|
69
|
+
# return_type
|
70
|
+
return_type = opts[:debug_return_type]
|
71
|
+
|
72
|
+
# auth_names
|
73
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
74
|
+
|
75
|
+
new_options = opts.merge(
|
76
|
+
:operation => :"CatalogsApi.create_back_in_stock_subscription",
|
77
|
+
:header_params => header_params,
|
78
|
+
:query_params => query_params,
|
79
|
+
:form_params => form_params,
|
80
|
+
:body => post_body,
|
81
|
+
:auth_names => auth_names,
|
82
|
+
:return_type => return_type
|
83
|
+
)
|
84
|
+
|
85
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
86
|
+
if @api_client.config.debugging
|
87
|
+
@api_client.config.logger.debug "API called: CatalogsApi#create_back_in_stock_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
88
|
+
end
|
89
|
+
return data, status_code, headers
|
90
|
+
end
|
91
|
+
|
22
92
|
# Create Catalog Category
|
23
93
|
# Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
24
94
|
# @param catalog_category_create_query [CatalogCategoryCreateQuery]
|
@@ -51,7 +121,7 @@ module KlaviyoAPI
|
|
51
121
|
# header parameters
|
52
122
|
header_params = opts[:header_params] || {}
|
53
123
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
124
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
55
125
|
# HTTP header 'Accept' (if needed)
|
56
126
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
127
|
# HTTP header 'Content-Type'
|
@@ -127,7 +197,7 @@ module KlaviyoAPI
|
|
127
197
|
# header parameters
|
128
198
|
header_params = opts[:header_params] || {}
|
129
199
|
# klaviyo api revision
|
130
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
200
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
131
201
|
# HTTP header 'Accept' (if needed)
|
132
202
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
133
203
|
# HTTP header 'Content-Type'
|
@@ -197,7 +267,7 @@ module KlaviyoAPI
|
|
197
267
|
# header parameters
|
198
268
|
header_params = opts[:header_params] || {}
|
199
269
|
# klaviyo api revision
|
200
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
270
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
201
271
|
# HTTP header 'Accept' (if needed)
|
202
272
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
203
273
|
# HTTP header 'Content-Type'
|
@@ -273,7 +343,7 @@ module KlaviyoAPI
|
|
273
343
|
# header parameters
|
274
344
|
header_params = opts[:header_params] || {}
|
275
345
|
# klaviyo api revision
|
276
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
346
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
277
347
|
# HTTP header 'Accept' (if needed)
|
278
348
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
279
349
|
# HTTP header 'Content-Type'
|
@@ -343,7 +413,7 @@ module KlaviyoAPI
|
|
343
413
|
# header parameters
|
344
414
|
header_params = opts[:header_params] || {}
|
345
415
|
# klaviyo api revision
|
346
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
416
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
347
417
|
# HTTP header 'Accept' (if needed)
|
348
418
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
349
419
|
# HTTP header 'Content-Type'
|
@@ -413,7 +483,7 @@ module KlaviyoAPI
|
|
413
483
|
# header parameters
|
414
484
|
header_params = opts[:header_params] || {}
|
415
485
|
# klaviyo api revision
|
416
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
486
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
417
487
|
# HTTP header 'Accept' (if needed)
|
418
488
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
419
489
|
|
@@ -484,7 +554,7 @@ module KlaviyoAPI
|
|
484
554
|
# header parameters
|
485
555
|
header_params = opts[:header_params] || {}
|
486
556
|
# klaviyo api revision
|
487
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
557
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
488
558
|
# HTTP header 'Accept' (if needed)
|
489
559
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
490
560
|
# HTTP header 'Content-Type'
|
@@ -554,7 +624,7 @@ module KlaviyoAPI
|
|
554
624
|
# header parameters
|
555
625
|
header_params = opts[:header_params] || {}
|
556
626
|
# klaviyo api revision
|
557
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
627
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
558
628
|
# HTTP header 'Accept' (if needed)
|
559
629
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
560
630
|
|
@@ -625,7 +695,7 @@ module KlaviyoAPI
|
|
625
695
|
# header parameters
|
626
696
|
header_params = opts[:header_params] || {}
|
627
697
|
# klaviyo api revision
|
628
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
698
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
629
699
|
# HTTP header 'Accept' (if needed)
|
630
700
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
631
701
|
# HTTP header 'Content-Type'
|
@@ -695,7 +765,7 @@ module KlaviyoAPI
|
|
695
765
|
# header parameters
|
696
766
|
header_params = opts[:header_params] || {}
|
697
767
|
# klaviyo api revision
|
698
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
768
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
699
769
|
# HTTP header 'Accept' (if needed)
|
700
770
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
701
771
|
|
@@ -731,10 +801,10 @@ module KlaviyoAPI
|
|
731
801
|
# Get Catalog Categories
|
732
802
|
# Get all catalog categories in an account. 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`
|
733
803
|
# @param [Hash] opts the optional parameters
|
734
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
735
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
736
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
737
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
804
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
805
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
806
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
807
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
738
808
|
# @return [Hash<String, Object>]
|
739
809
|
def get_catalog_categories(opts = {})
|
740
810
|
data, _status_code, _headers = get_catalog_categories_with_http_info(opts)
|
@@ -744,10 +814,10 @@ module KlaviyoAPI
|
|
744
814
|
# Get Catalog Categories
|
745
815
|
# Get all catalog categories in an account. 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`
|
746
816
|
# @param [Hash] opts the optional parameters
|
747
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
748
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
749
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
750
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
817
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
818
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
819
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
820
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
751
821
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
752
822
|
def get_catalog_categories_with_http_info(opts = {})
|
753
823
|
if @api_client.config.debugging
|
@@ -774,7 +844,7 @@ module KlaviyoAPI
|
|
774
844
|
# header parameters
|
775
845
|
header_params = opts[:header_params] || {}
|
776
846
|
# klaviyo api revision
|
777
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
847
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
778
848
|
# HTTP header 'Accept' (if needed)
|
779
849
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
780
850
|
|
@@ -811,7 +881,7 @@ module KlaviyoAPI
|
|
811
881
|
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
812
882
|
# @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`.
|
813
883
|
# @param [Hash] opts the optional parameters
|
814
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
884
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
815
885
|
# @return [Hash<String, Object>]
|
816
886
|
def get_catalog_category(id, opts = {})
|
817
887
|
data, _status_code, _headers = get_catalog_category_with_http_info(id, opts)
|
@@ -822,7 +892,7 @@ module KlaviyoAPI
|
|
822
892
|
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
823
893
|
# @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`.
|
824
894
|
# @param [Hash] opts the optional parameters
|
825
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
895
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
826
896
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
827
897
|
def get_catalog_category_with_http_info(id, opts = {})
|
828
898
|
if @api_client.config.debugging
|
@@ -846,7 +916,7 @@ module KlaviyoAPI
|
|
846
916
|
# header parameters
|
847
917
|
header_params = opts[:header_params] || {}
|
848
918
|
# klaviyo api revision
|
849
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
919
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
850
920
|
# HTTP header 'Accept' (if needed)
|
851
921
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
852
922
|
|
@@ -883,12 +953,12 @@ module KlaviyoAPI
|
|
883
953
|
# 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` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
884
954
|
# @param id [String]
|
885
955
|
# @param [Hash] opts the optional parameters
|
886
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
887
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
888
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
889
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
890
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
891
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
956
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
957
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
958
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
959
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
960
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
961
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
892
962
|
# @return [Hash<String, Object>]
|
893
963
|
def get_catalog_category_items(id, opts = {})
|
894
964
|
data, _status_code, _headers = get_catalog_category_items_with_http_info(id, opts)
|
@@ -899,12 +969,12 @@ module KlaviyoAPI
|
|
899
969
|
# 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` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
900
970
|
# @param id [String]
|
901
971
|
# @param [Hash] opts the optional parameters
|
902
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
903
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
904
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
905
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
906
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
907
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
972
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
973
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
974
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
975
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
976
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
977
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
908
978
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
909
979
|
def get_catalog_category_items_with_http_info(id, opts = {})
|
910
980
|
if @api_client.config.debugging
|
@@ -945,7 +1015,7 @@ module KlaviyoAPI
|
|
945
1015
|
# header parameters
|
946
1016
|
header_params = opts[:header_params] || {}
|
947
1017
|
# klaviyo api revision
|
948
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1018
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
949
1019
|
# HTTP header 'Accept' (if needed)
|
950
1020
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
951
1021
|
|
@@ -982,7 +1052,7 @@ module KlaviyoAPI
|
|
982
1052
|
# 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`
|
983
1053
|
# @param id [String]
|
984
1054
|
# @param [Hash] opts the optional parameters
|
985
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1055
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
986
1056
|
# @return [Hash<String, Object>]
|
987
1057
|
def get_catalog_category_relationships_items(id, opts = {})
|
988
1058
|
data, _status_code, _headers = get_catalog_category_relationships_items_with_http_info(id, opts)
|
@@ -993,7 +1063,7 @@ module KlaviyoAPI
|
|
993
1063
|
# 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`
|
994
1064
|
# @param id [String]
|
995
1065
|
# @param [Hash] opts the optional parameters
|
996
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1066
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
997
1067
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
998
1068
|
def get_catalog_category_relationships_items_with_http_info(id, opts = {})
|
999
1069
|
if @api_client.config.debugging
|
@@ -1013,7 +1083,7 @@ module KlaviyoAPI
|
|
1013
1083
|
# header parameters
|
1014
1084
|
header_params = opts[:header_params] || {}
|
1015
1085
|
# klaviyo api revision
|
1016
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1086
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1017
1087
|
# HTTP header 'Accept' (if needed)
|
1018
1088
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1019
1089
|
|
@@ -1050,9 +1120,9 @@ module KlaviyoAPI
|
|
1050
1120
|
# Get a specific catalog item with the given item ID. Include parameters 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`
|
1051
1121
|
# @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`.
|
1052
1122
|
# @param [Hash] opts the optional parameters
|
1053
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
1054
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1055
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1123
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1124
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1125
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1056
1126
|
# @return [Hash<String, Object>]
|
1057
1127
|
def get_catalog_item(id, opts = {})
|
1058
1128
|
data, _status_code, _headers = get_catalog_item_with_http_info(id, opts)
|
@@ -1063,9 +1133,9 @@ module KlaviyoAPI
|
|
1063
1133
|
# Get a specific catalog item with the given item ID. Include parameters 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`
|
1064
1134
|
# @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`.
|
1065
1135
|
# @param [Hash] opts the optional parameters
|
1066
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
1067
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1068
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1136
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1137
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1138
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1069
1139
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1070
1140
|
def get_catalog_item_with_http_info(id, opts = {})
|
1071
1141
|
if @api_client.config.debugging
|
@@ -1099,7 +1169,7 @@ module KlaviyoAPI
|
|
1099
1169
|
# header parameters
|
1100
1170
|
header_params = opts[:header_params] || {}
|
1101
1171
|
# klaviyo api revision
|
1102
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1172
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1103
1173
|
# HTTP header 'Accept' (if needed)
|
1104
1174
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1105
1175
|
|
@@ -1136,10 +1206,10 @@ module KlaviyoAPI
|
|
1136
1206
|
# 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`
|
1137
1207
|
# @param id [String]
|
1138
1208
|
# @param [Hash] opts the optional parameters
|
1139
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
1140
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1141
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1142
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1209
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1210
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
1211
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1212
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1143
1213
|
# @return [Hash<String, Object>]
|
1144
1214
|
def get_catalog_item_categories(id, opts = {})
|
1145
1215
|
data, _status_code, _headers = get_catalog_item_categories_with_http_info(id, opts)
|
@@ -1150,10 +1220,10 @@ module KlaviyoAPI
|
|
1150
1220
|
# 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`
|
1151
1221
|
# @param id [String]
|
1152
1222
|
# @param [Hash] opts the optional parameters
|
1153
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
1154
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1155
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1156
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1223
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1224
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
1225
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1226
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1157
1227
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1158
1228
|
def get_catalog_item_categories_with_http_info(id, opts = {})
|
1159
1229
|
if @api_client.config.debugging
|
@@ -1184,7 +1254,7 @@ module KlaviyoAPI
|
|
1184
1254
|
# header parameters
|
1185
1255
|
header_params = opts[:header_params] || {}
|
1186
1256
|
# klaviyo api revision
|
1187
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1257
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1188
1258
|
# HTTP header 'Accept' (if needed)
|
1189
1259
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1190
1260
|
|
@@ -1221,7 +1291,7 @@ module KlaviyoAPI
|
|
1221
1291
|
# 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`
|
1222
1292
|
# @param id [String]
|
1223
1293
|
# @param [Hash] opts the optional parameters
|
1224
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1294
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1225
1295
|
# @return [Hash<String, Object>]
|
1226
1296
|
def get_catalog_item_relationships_categories(id, opts = {})
|
1227
1297
|
data, _status_code, _headers = get_catalog_item_relationships_categories_with_http_info(id, opts)
|
@@ -1232,7 +1302,7 @@ module KlaviyoAPI
|
|
1232
1302
|
# 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`
|
1233
1303
|
# @param id [String]
|
1234
1304
|
# @param [Hash] opts the optional parameters
|
1235
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1305
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1236
1306
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1237
1307
|
def get_catalog_item_relationships_categories_with_http_info(id, opts = {})
|
1238
1308
|
if @api_client.config.debugging
|
@@ -1252,7 +1322,7 @@ module KlaviyoAPI
|
|
1252
1322
|
# header parameters
|
1253
1323
|
header_params = opts[:header_params] || {}
|
1254
1324
|
# klaviyo api revision
|
1255
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1325
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1256
1326
|
# HTTP header 'Accept' (if needed)
|
1257
1327
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1258
1328
|
|
@@ -1289,10 +1359,10 @@ module KlaviyoAPI
|
|
1289
1359
|
# 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`
|
1290
1360
|
# @param id [String]
|
1291
1361
|
# @param [Hash] opts the optional parameters
|
1292
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1293
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1294
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1295
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1362
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1363
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1364
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1365
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1296
1366
|
# @return [Hash<String, Object>]
|
1297
1367
|
def get_catalog_item_variants(id, opts = {})
|
1298
1368
|
data, _status_code, _headers = get_catalog_item_variants_with_http_info(id, opts)
|
@@ -1303,10 +1373,10 @@ module KlaviyoAPI
|
|
1303
1373
|
# 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`
|
1304
1374
|
# @param id [String]
|
1305
1375
|
# @param [Hash] opts the optional parameters
|
1306
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1307
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1308
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1309
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1376
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1377
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1378
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1379
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1310
1380
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1311
1381
|
def get_catalog_item_variants_with_http_info(id, opts = {})
|
1312
1382
|
if @api_client.config.debugging
|
@@ -1337,7 +1407,7 @@ module KlaviyoAPI
|
|
1337
1407
|
# header parameters
|
1338
1408
|
header_params = opts[:header_params] || {}
|
1339
1409
|
# klaviyo api revision
|
1340
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1410
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1341
1411
|
# HTTP header 'Accept' (if needed)
|
1342
1412
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1343
1413
|
|
@@ -1373,12 +1443,12 @@ module KlaviyoAPI
|
|
1373
1443
|
# Get Catalog Items
|
1374
1444
|
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1375
1445
|
# @param [Hash] opts the optional parameters
|
1376
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
1377
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1378
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1379
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1380
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1381
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1446
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1447
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1448
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1449
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1450
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1451
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1382
1452
|
# @return [Hash<String, Object>]
|
1383
1453
|
def get_catalog_items(opts = {})
|
1384
1454
|
data, _status_code, _headers = get_catalog_items_with_http_info(opts)
|
@@ -1388,12 +1458,12 @@ module KlaviyoAPI
|
|
1388
1458
|
# Get Catalog Items
|
1389
1459
|
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1390
1460
|
# @param [Hash] opts the optional parameters
|
1391
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
1392
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1393
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1394
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1395
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1396
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1461
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1462
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1463
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1464
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1465
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1466
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1397
1467
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1398
1468
|
def get_catalog_items_with_http_info(opts = {})
|
1399
1469
|
if @api_client.config.debugging
|
@@ -1430,7 +1500,7 @@ module KlaviyoAPI
|
|
1430
1500
|
# header parameters
|
1431
1501
|
header_params = opts[:header_params] || {}
|
1432
1502
|
# klaviyo api revision
|
1433
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1503
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1434
1504
|
# HTTP header 'Accept' (if needed)
|
1435
1505
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1436
1506
|
|
@@ -1467,7 +1537,7 @@ module KlaviyoAPI
|
|
1467
1537
|
# 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`
|
1468
1538
|
# @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`.
|
1469
1539
|
# @param [Hash] opts the optional parameters
|
1470
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1540
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1471
1541
|
# @return [Hash<String, Object>]
|
1472
1542
|
def get_catalog_variant(id, opts = {})
|
1473
1543
|
data, _status_code, _headers = get_catalog_variant_with_http_info(id, opts)
|
@@ -1478,7 +1548,7 @@ module KlaviyoAPI
|
|
1478
1548
|
# 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`
|
1479
1549
|
# @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`.
|
1480
1550
|
# @param [Hash] opts the optional parameters
|
1481
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1551
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1482
1552
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1483
1553
|
def get_catalog_variant_with_http_info(id, opts = {})
|
1484
1554
|
if @api_client.config.debugging
|
@@ -1502,7 +1572,7 @@ module KlaviyoAPI
|
|
1502
1572
|
# header parameters
|
1503
1573
|
header_params = opts[:header_params] || {}
|
1504
1574
|
# klaviyo api revision
|
1505
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1575
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1506
1576
|
# HTTP header 'Accept' (if needed)
|
1507
1577
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1508
1578
|
|
@@ -1538,10 +1608,10 @@ module KlaviyoAPI
|
|
1538
1608
|
# Get Catalog Variants
|
1539
1609
|
# Get all variants in an account. 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`
|
1540
1610
|
# @param [Hash] opts the optional parameters
|
1541
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1542
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1543
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1544
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1611
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1612
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1613
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1614
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1545
1615
|
# @return [Hash<String, Object>]
|
1546
1616
|
def get_catalog_variants(opts = {})
|
1547
1617
|
data, _status_code, _headers = get_catalog_variants_with_http_info(opts)
|
@@ -1551,10 +1621,10 @@ module KlaviyoAPI
|
|
1551
1621
|
# Get Catalog Variants
|
1552
1622
|
# Get all variants in an account. 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`
|
1553
1623
|
# @param [Hash] opts the optional parameters
|
1554
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1555
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1556
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1557
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1624
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1625
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1626
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1627
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1558
1628
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1559
1629
|
def get_catalog_variants_with_http_info(opts = {})
|
1560
1630
|
if @api_client.config.debugging
|
@@ -1581,7 +1651,7 @@ module KlaviyoAPI
|
|
1581
1651
|
# header parameters
|
1582
1652
|
header_params = opts[:header_params] || {}
|
1583
1653
|
# klaviyo api revision
|
1584
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1654
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1585
1655
|
# HTTP header 'Accept' (if needed)
|
1586
1656
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1587
1657
|
|
@@ -1618,9 +1688,9 @@ module KlaviyoAPI
|
|
1618
1688
|
# 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`
|
1619
1689
|
# @param job_id [String] ID of the job to retrieve.
|
1620
1690
|
# @param [Hash] opts the optional parameters
|
1621
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1622
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
1623
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1691
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1692
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1693
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1624
1694
|
# @return [Hash<String, Object>]
|
1625
1695
|
def get_create_categories_job(job_id, opts = {})
|
1626
1696
|
data, _status_code, _headers = get_create_categories_job_with_http_info(job_id, opts)
|
@@ -1631,9 +1701,9 @@ module KlaviyoAPI
|
|
1631
1701
|
# 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`
|
1632
1702
|
# @param job_id [String] ID of the job to retrieve.
|
1633
1703
|
# @param [Hash] opts the optional parameters
|
1634
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1635
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
1636
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1704
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1705
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1706
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1637
1707
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1638
1708
|
def get_create_categories_job_with_http_info(job_id, opts = {})
|
1639
1709
|
if @api_client.config.debugging
|
@@ -1667,7 +1737,7 @@ module KlaviyoAPI
|
|
1667
1737
|
# header parameters
|
1668
1738
|
header_params = opts[:header_params] || {}
|
1669
1739
|
# klaviyo api revision
|
1670
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1740
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1671
1741
|
# HTTP header 'Accept' (if needed)
|
1672
1742
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1673
1743
|
|
@@ -1703,9 +1773,9 @@ module KlaviyoAPI
|
|
1703
1773
|
# Get Create Categories Jobs
|
1704
1774
|
# 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`
|
1705
1775
|
# @param [Hash] opts the optional parameters
|
1706
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1707
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1708
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1776
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1777
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1778
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1709
1779
|
# @return [Hash<String, Object>]
|
1710
1780
|
def get_create_categories_jobs(opts = {})
|
1711
1781
|
data, _status_code, _headers = get_create_categories_jobs_with_http_info(opts)
|
@@ -1715,9 +1785,9 @@ module KlaviyoAPI
|
|
1715
1785
|
# Get Create Categories Jobs
|
1716
1786
|
# 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`
|
1717
1787
|
# @param [Hash] opts the optional parameters
|
1718
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1719
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1720
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1788
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1789
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1790
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1721
1791
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1722
1792
|
def get_create_categories_jobs_with_http_info(opts = {})
|
1723
1793
|
if @api_client.config.debugging
|
@@ -1739,7 +1809,7 @@ module KlaviyoAPI
|
|
1739
1809
|
# header parameters
|
1740
1810
|
header_params = opts[:header_params] || {}
|
1741
1811
|
# klaviyo api revision
|
1742
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1812
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1743
1813
|
# HTTP header 'Accept' (if needed)
|
1744
1814
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1745
1815
|
|
@@ -1776,9 +1846,9 @@ module KlaviyoAPI
|
|
1776
1846
|
# 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`
|
1777
1847
|
# @param job_id [String] ID of the job to retrieve.
|
1778
1848
|
# @param [Hash] opts the optional parameters
|
1779
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1780
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
1781
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1849
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1850
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1851
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1782
1852
|
# @return [Hash<String, Object>]
|
1783
1853
|
def get_create_items_job(job_id, opts = {})
|
1784
1854
|
data, _status_code, _headers = get_create_items_job_with_http_info(job_id, opts)
|
@@ -1789,9 +1859,9 @@ module KlaviyoAPI
|
|
1789
1859
|
# 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`
|
1790
1860
|
# @param job_id [String] ID of the job to retrieve.
|
1791
1861
|
# @param [Hash] opts the optional parameters
|
1792
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1793
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
1794
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1862
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1863
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1864
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1795
1865
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1796
1866
|
def get_create_items_job_with_http_info(job_id, opts = {})
|
1797
1867
|
if @api_client.config.debugging
|
@@ -1825,7 +1895,7 @@ module KlaviyoAPI
|
|
1825
1895
|
# header parameters
|
1826
1896
|
header_params = opts[:header_params] || {}
|
1827
1897
|
# klaviyo api revision
|
1828
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1898
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1829
1899
|
# HTTP header 'Accept' (if needed)
|
1830
1900
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1831
1901
|
|
@@ -1861,9 +1931,9 @@ module KlaviyoAPI
|
|
1861
1931
|
# Get Create Items Jobs
|
1862
1932
|
# 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`
|
1863
1933
|
# @param [Hash] opts the optional parameters
|
1864
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1865
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1866
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1934
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1935
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1936
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1867
1937
|
# @return [Hash<String, Object>]
|
1868
1938
|
def get_create_items_jobs(opts = {})
|
1869
1939
|
data, _status_code, _headers = get_create_items_jobs_with_http_info(opts)
|
@@ -1873,9 +1943,9 @@ module KlaviyoAPI
|
|
1873
1943
|
# Get Create Items Jobs
|
1874
1944
|
# 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`
|
1875
1945
|
# @param [Hash] opts the optional parameters
|
1876
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1877
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1878
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1946
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1947
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1948
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1879
1949
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1880
1950
|
def get_create_items_jobs_with_http_info(opts = {})
|
1881
1951
|
if @api_client.config.debugging
|
@@ -1897,7 +1967,7 @@ module KlaviyoAPI
|
|
1897
1967
|
# header parameters
|
1898
1968
|
header_params = opts[:header_params] || {}
|
1899
1969
|
# klaviyo api revision
|
1900
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1970
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1901
1971
|
# HTTP header 'Accept' (if needed)
|
1902
1972
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1903
1973
|
|
@@ -1934,9 +2004,9 @@ module KlaviyoAPI
|
|
1934
2004
|
# 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`
|
1935
2005
|
# @param job_id [String] ID of the job to retrieve.
|
1936
2006
|
# @param [Hash] opts the optional parameters
|
1937
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1938
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1939
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2007
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2008
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2009
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1940
2010
|
# @return [Hash<String, Object>]
|
1941
2011
|
def get_create_variants_job(job_id, opts = {})
|
1942
2012
|
data, _status_code, _headers = get_create_variants_job_with_http_info(job_id, opts)
|
@@ -1947,9 +2017,9 @@ module KlaviyoAPI
|
|
1947
2017
|
# 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`
|
1948
2018
|
# @param job_id [String] ID of the job to retrieve.
|
1949
2019
|
# @param [Hash] opts the optional parameters
|
1950
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1951
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1952
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2020
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2021
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2022
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1953
2023
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1954
2024
|
def get_create_variants_job_with_http_info(job_id, opts = {})
|
1955
2025
|
if @api_client.config.debugging
|
@@ -1983,7 +2053,7 @@ module KlaviyoAPI
|
|
1983
2053
|
# header parameters
|
1984
2054
|
header_params = opts[:header_params] || {}
|
1985
2055
|
# klaviyo api revision
|
1986
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2056
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1987
2057
|
# HTTP header 'Accept' (if needed)
|
1988
2058
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1989
2059
|
|
@@ -2019,9 +2089,9 @@ module KlaviyoAPI
|
|
2019
2089
|
# Get Create Variants Jobs
|
2020
2090
|
# 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`
|
2021
2091
|
# @param [Hash] opts the optional parameters
|
2022
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2023
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2024
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2092
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2093
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2094
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2025
2095
|
# @return [Hash<String, Object>]
|
2026
2096
|
def get_create_variants_jobs(opts = {})
|
2027
2097
|
data, _status_code, _headers = get_create_variants_jobs_with_http_info(opts)
|
@@ -2031,9 +2101,9 @@ module KlaviyoAPI
|
|
2031
2101
|
# Get Create Variants Jobs
|
2032
2102
|
# 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`
|
2033
2103
|
# @param [Hash] opts the optional parameters
|
2034
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2035
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2036
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2104
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2105
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2106
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2037
2107
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2038
2108
|
def get_create_variants_jobs_with_http_info(opts = {})
|
2039
2109
|
if @api_client.config.debugging
|
@@ -2055,7 +2125,7 @@ module KlaviyoAPI
|
|
2055
2125
|
# header parameters
|
2056
2126
|
header_params = opts[:header_params] || {}
|
2057
2127
|
# klaviyo api revision
|
2058
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2128
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2059
2129
|
# HTTP header 'Accept' (if needed)
|
2060
2130
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2061
2131
|
|
@@ -2092,7 +2162,7 @@ module KlaviyoAPI
|
|
2092
2162
|
# 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`
|
2093
2163
|
# @param job_id [String] ID of the job to retrieve.
|
2094
2164
|
# @param [Hash] opts the optional parameters
|
2095
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2165
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2096
2166
|
# @return [Hash<String, Object>]
|
2097
2167
|
def get_delete_categories_job(job_id, opts = {})
|
2098
2168
|
data, _status_code, _headers = get_delete_categories_job_with_http_info(job_id, opts)
|
@@ -2103,7 +2173,7 @@ module KlaviyoAPI
|
|
2103
2173
|
# 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`
|
2104
2174
|
# @param job_id [String] ID of the job to retrieve.
|
2105
2175
|
# @param [Hash] opts the optional parameters
|
2106
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2176
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2107
2177
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2108
2178
|
def get_delete_categories_job_with_http_info(job_id, opts = {})
|
2109
2179
|
if @api_client.config.debugging
|
@@ -2127,7 +2197,7 @@ module KlaviyoAPI
|
|
2127
2197
|
# header parameters
|
2128
2198
|
header_params = opts[:header_params] || {}
|
2129
2199
|
# klaviyo api revision
|
2130
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2200
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2131
2201
|
# HTTP header 'Accept' (if needed)
|
2132
2202
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2133
2203
|
|
@@ -2163,9 +2233,9 @@ module KlaviyoAPI
|
|
2163
2233
|
# Get Delete Categories Jobs
|
2164
2234
|
# 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`
|
2165
2235
|
# @param [Hash] opts the optional parameters
|
2166
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2167
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2168
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2236
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2237
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2238
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2169
2239
|
# @return [Hash<String, Object>]
|
2170
2240
|
def get_delete_categories_jobs(opts = {})
|
2171
2241
|
data, _status_code, _headers = get_delete_categories_jobs_with_http_info(opts)
|
@@ -2175,9 +2245,9 @@ module KlaviyoAPI
|
|
2175
2245
|
# Get Delete Categories Jobs
|
2176
2246
|
# 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`
|
2177
2247
|
# @param [Hash] opts the optional parameters
|
2178
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2179
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2180
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2248
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2249
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2250
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2181
2251
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2182
2252
|
def get_delete_categories_jobs_with_http_info(opts = {})
|
2183
2253
|
if @api_client.config.debugging
|
@@ -2199,7 +2269,7 @@ module KlaviyoAPI
|
|
2199
2269
|
# header parameters
|
2200
2270
|
header_params = opts[:header_params] || {}
|
2201
2271
|
# klaviyo api revision
|
2202
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2272
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2203
2273
|
# HTTP header 'Accept' (if needed)
|
2204
2274
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2205
2275
|
|
@@ -2236,7 +2306,7 @@ module KlaviyoAPI
|
|
2236
2306
|
# 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`
|
2237
2307
|
# @param job_id [String] ID of the job to retrieve.
|
2238
2308
|
# @param [Hash] opts the optional parameters
|
2239
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2309
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2240
2310
|
# @return [Hash<String, Object>]
|
2241
2311
|
def get_delete_items_job(job_id, opts = {})
|
2242
2312
|
data, _status_code, _headers = get_delete_items_job_with_http_info(job_id, opts)
|
@@ -2247,7 +2317,7 @@ module KlaviyoAPI
|
|
2247
2317
|
# 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`
|
2248
2318
|
# @param job_id [String] ID of the job to retrieve.
|
2249
2319
|
# @param [Hash] opts the optional parameters
|
2250
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2320
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2251
2321
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2252
2322
|
def get_delete_items_job_with_http_info(job_id, opts = {})
|
2253
2323
|
if @api_client.config.debugging
|
@@ -2271,7 +2341,7 @@ module KlaviyoAPI
|
|
2271
2341
|
# header parameters
|
2272
2342
|
header_params = opts[:header_params] || {}
|
2273
2343
|
# klaviyo api revision
|
2274
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2344
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2275
2345
|
# HTTP header 'Accept' (if needed)
|
2276
2346
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2277
2347
|
|
@@ -2307,9 +2377,9 @@ module KlaviyoAPI
|
|
2307
2377
|
# Get Delete Items Jobs
|
2308
2378
|
# 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`
|
2309
2379
|
# @param [Hash] opts the optional parameters
|
2310
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2311
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2312
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2380
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2381
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2382
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2313
2383
|
# @return [Hash<String, Object>]
|
2314
2384
|
def get_delete_items_jobs(opts = {})
|
2315
2385
|
data, _status_code, _headers = get_delete_items_jobs_with_http_info(opts)
|
@@ -2319,9 +2389,9 @@ module KlaviyoAPI
|
|
2319
2389
|
# Get Delete Items Jobs
|
2320
2390
|
# 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`
|
2321
2391
|
# @param [Hash] opts the optional parameters
|
2322
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2323
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2324
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2392
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2393
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2394
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2325
2395
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2326
2396
|
def get_delete_items_jobs_with_http_info(opts = {})
|
2327
2397
|
if @api_client.config.debugging
|
@@ -2343,7 +2413,7 @@ module KlaviyoAPI
|
|
2343
2413
|
# header parameters
|
2344
2414
|
header_params = opts[:header_params] || {}
|
2345
2415
|
# klaviyo api revision
|
2346
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2416
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2347
2417
|
# HTTP header 'Accept' (if needed)
|
2348
2418
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2349
2419
|
|
@@ -2380,7 +2450,7 @@ module KlaviyoAPI
|
|
2380
2450
|
# 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`
|
2381
2451
|
# @param job_id [String] ID of the job to retrieve.
|
2382
2452
|
# @param [Hash] opts the optional parameters
|
2383
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2453
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2384
2454
|
# @return [Hash<String, Object>]
|
2385
2455
|
def get_delete_variants_job(job_id, opts = {})
|
2386
2456
|
data, _status_code, _headers = get_delete_variants_job_with_http_info(job_id, opts)
|
@@ -2391,7 +2461,7 @@ module KlaviyoAPI
|
|
2391
2461
|
# 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`
|
2392
2462
|
# @param job_id [String] ID of the job to retrieve.
|
2393
2463
|
# @param [Hash] opts the optional parameters
|
2394
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2464
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2395
2465
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2396
2466
|
def get_delete_variants_job_with_http_info(job_id, opts = {})
|
2397
2467
|
if @api_client.config.debugging
|
@@ -2415,7 +2485,7 @@ module KlaviyoAPI
|
|
2415
2485
|
# header parameters
|
2416
2486
|
header_params = opts[:header_params] || {}
|
2417
2487
|
# klaviyo api revision
|
2418
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2488
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2419
2489
|
# HTTP header 'Accept' (if needed)
|
2420
2490
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2421
2491
|
|
@@ -2451,9 +2521,9 @@ module KlaviyoAPI
|
|
2451
2521
|
# Get Delete Variants Jobs
|
2452
2522
|
# 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`
|
2453
2523
|
# @param [Hash] opts the optional parameters
|
2454
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2455
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2456
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2524
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2525
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2526
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2457
2527
|
# @return [Hash<String, Object>]
|
2458
2528
|
def get_delete_variants_jobs(opts = {})
|
2459
2529
|
data, _status_code, _headers = get_delete_variants_jobs_with_http_info(opts)
|
@@ -2463,9 +2533,9 @@ module KlaviyoAPI
|
|
2463
2533
|
# Get Delete Variants Jobs
|
2464
2534
|
# 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`
|
2465
2535
|
# @param [Hash] opts the optional parameters
|
2466
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2467
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2468
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2536
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2537
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2538
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2469
2539
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2470
2540
|
def get_delete_variants_jobs_with_http_info(opts = {})
|
2471
2541
|
if @api_client.config.debugging
|
@@ -2487,7 +2557,7 @@ module KlaviyoAPI
|
|
2487
2557
|
# header parameters
|
2488
2558
|
header_params = opts[:header_params] || {}
|
2489
2559
|
# klaviyo api revision
|
2490
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2560
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2491
2561
|
# HTTP header 'Accept' (if needed)
|
2492
2562
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2493
2563
|
|
@@ -2524,9 +2594,9 @@ module KlaviyoAPI
|
|
2524
2594
|
# 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`
|
2525
2595
|
# @param job_id [String] ID of the job to retrieve.
|
2526
2596
|
# @param [Hash] opts the optional parameters
|
2527
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2528
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
2529
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2597
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2598
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2599
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
2530
2600
|
# @return [Hash<String, Object>]
|
2531
2601
|
def get_update_categories_job(job_id, opts = {})
|
2532
2602
|
data, _status_code, _headers = get_update_categories_job_with_http_info(job_id, opts)
|
@@ -2537,9 +2607,9 @@ module KlaviyoAPI
|
|
2537
2607
|
# 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`
|
2538
2608
|
# @param job_id [String] ID of the job to retrieve.
|
2539
2609
|
# @param [Hash] opts the optional parameters
|
2540
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2541
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
2542
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2610
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2611
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2612
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
2543
2613
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2544
2614
|
def get_update_categories_job_with_http_info(job_id, opts = {})
|
2545
2615
|
if @api_client.config.debugging
|
@@ -2573,7 +2643,7 @@ module KlaviyoAPI
|
|
2573
2643
|
# header parameters
|
2574
2644
|
header_params = opts[:header_params] || {}
|
2575
2645
|
# klaviyo api revision
|
2576
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2646
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2577
2647
|
# HTTP header 'Accept' (if needed)
|
2578
2648
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2579
2649
|
|
@@ -2609,9 +2679,9 @@ module KlaviyoAPI
|
|
2609
2679
|
# Get Update Categories Jobs
|
2610
2680
|
# 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`
|
2611
2681
|
# @param [Hash] opts the optional parameters
|
2612
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2613
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2614
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2682
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2683
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2684
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2615
2685
|
# @return [Hash<String, Object>]
|
2616
2686
|
def get_update_categories_jobs(opts = {})
|
2617
2687
|
data, _status_code, _headers = get_update_categories_jobs_with_http_info(opts)
|
@@ -2621,9 +2691,9 @@ module KlaviyoAPI
|
|
2621
2691
|
# Get Update Categories Jobs
|
2622
2692
|
# 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`
|
2623
2693
|
# @param [Hash] opts the optional parameters
|
2624
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2625
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2626
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2694
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2695
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2696
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2627
2697
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2628
2698
|
def get_update_categories_jobs_with_http_info(opts = {})
|
2629
2699
|
if @api_client.config.debugging
|
@@ -2645,7 +2715,7 @@ module KlaviyoAPI
|
|
2645
2715
|
# header parameters
|
2646
2716
|
header_params = opts[:header_params] || {}
|
2647
2717
|
# klaviyo api revision
|
2648
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2718
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2649
2719
|
# HTTP header 'Accept' (if needed)
|
2650
2720
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2651
2721
|
|
@@ -2682,9 +2752,9 @@ module KlaviyoAPI
|
|
2682
2752
|
# 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`
|
2683
2753
|
# @param job_id [String] ID of the job to retrieve.
|
2684
2754
|
# @param [Hash] opts the optional parameters
|
2685
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2686
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
2687
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2755
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2756
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2757
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
2688
2758
|
# @return [Hash<String, Object>]
|
2689
2759
|
def get_update_items_job(job_id, opts = {})
|
2690
2760
|
data, _status_code, _headers = get_update_items_job_with_http_info(job_id, opts)
|
@@ -2695,9 +2765,9 @@ module KlaviyoAPI
|
|
2695
2765
|
# 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`
|
2696
2766
|
# @param job_id [String] ID of the job to retrieve.
|
2697
2767
|
# @param [Hash] opts the optional parameters
|
2698
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2699
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
2700
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2768
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2769
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2770
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
2701
2771
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2702
2772
|
def get_update_items_job_with_http_info(job_id, opts = {})
|
2703
2773
|
if @api_client.config.debugging
|
@@ -2731,7 +2801,7 @@ module KlaviyoAPI
|
|
2731
2801
|
# header parameters
|
2732
2802
|
header_params = opts[:header_params] || {}
|
2733
2803
|
# klaviyo api revision
|
2734
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2804
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2735
2805
|
# HTTP header 'Accept' (if needed)
|
2736
2806
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2737
2807
|
|
@@ -2767,9 +2837,9 @@ module KlaviyoAPI
|
|
2767
2837
|
# Get Update Items Jobs
|
2768
2838
|
# 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`
|
2769
2839
|
# @param [Hash] opts the optional parameters
|
2770
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2771
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2772
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2840
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2841
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2842
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2773
2843
|
# @return [Hash<String, Object>]
|
2774
2844
|
def get_update_items_jobs(opts = {})
|
2775
2845
|
data, _status_code, _headers = get_update_items_jobs_with_http_info(opts)
|
@@ -2779,9 +2849,9 @@ module KlaviyoAPI
|
|
2779
2849
|
# Get Update Items Jobs
|
2780
2850
|
# 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`
|
2781
2851
|
# @param [Hash] opts the optional parameters
|
2782
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2783
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2784
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2852
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2853
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2854
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2785
2855
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2786
2856
|
def get_update_items_jobs_with_http_info(opts = {})
|
2787
2857
|
if @api_client.config.debugging
|
@@ -2803,7 +2873,7 @@ module KlaviyoAPI
|
|
2803
2873
|
# header parameters
|
2804
2874
|
header_params = opts[:header_params] || {}
|
2805
2875
|
# klaviyo api revision
|
2806
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2876
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2807
2877
|
# HTTP header 'Accept' (if needed)
|
2808
2878
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2809
2879
|
|
@@ -2840,9 +2910,9 @@ module KlaviyoAPI
|
|
2840
2910
|
# 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`
|
2841
2911
|
# @param job_id [String] ID of the job to retrieve.
|
2842
2912
|
# @param [Hash] opts the optional parameters
|
2843
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2844
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
2845
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2913
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2914
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2915
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
2846
2916
|
# @return [Hash<String, Object>]
|
2847
2917
|
def get_update_variants_job(job_id, opts = {})
|
2848
2918
|
data, _status_code, _headers = get_update_variants_job_with_http_info(job_id, opts)
|
@@ -2853,9 +2923,9 @@ module KlaviyoAPI
|
|
2853
2923
|
# 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`
|
2854
2924
|
# @param job_id [String] ID of the job to retrieve.
|
2855
2925
|
# @param [Hash] opts the optional parameters
|
2856
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2857
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
2858
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2926
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2927
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2928
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
2859
2929
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2860
2930
|
def get_update_variants_job_with_http_info(job_id, opts = {})
|
2861
2931
|
if @api_client.config.debugging
|
@@ -2889,7 +2959,7 @@ module KlaviyoAPI
|
|
2889
2959
|
# header parameters
|
2890
2960
|
header_params = opts[:header_params] || {}
|
2891
2961
|
# klaviyo api revision
|
2892
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2962
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2893
2963
|
# HTTP header 'Accept' (if needed)
|
2894
2964
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2895
2965
|
|
@@ -2925,9 +2995,9 @@ module KlaviyoAPI
|
|
2925
2995
|
# Get Update Variants Jobs
|
2926
2996
|
# 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`
|
2927
2997
|
# @param [Hash] opts the optional parameters
|
2928
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2929
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2930
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2998
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
2999
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
3000
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2931
3001
|
# @return [Hash<String, Object>]
|
2932
3002
|
def get_update_variants_jobs(opts = {})
|
2933
3003
|
data, _status_code, _headers = get_update_variants_jobs_with_http_info(opts)
|
@@ -2937,9 +3007,9 @@ module KlaviyoAPI
|
|
2937
3007
|
# Get Update Variants Jobs
|
2938
3008
|
# 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`
|
2939
3009
|
# @param [Hash] opts the optional parameters
|
2940
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2941
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2942
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
3010
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
3011
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
3012
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
2943
3013
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2944
3014
|
def get_update_variants_jobs_with_http_info(opts = {})
|
2945
3015
|
if @api_client.config.debugging
|
@@ -2961,7 +3031,7 @@ module KlaviyoAPI
|
|
2961
3031
|
# header parameters
|
2962
3032
|
header_params = opts[:header_params] || {}
|
2963
3033
|
# klaviyo api revision
|
2964
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3034
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
2965
3035
|
# HTTP header 'Accept' (if needed)
|
2966
3036
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2967
3037
|
|
@@ -3026,7 +3096,7 @@ module KlaviyoAPI
|
|
3026
3096
|
# header parameters
|
3027
3097
|
header_params = opts[:header_params] || {}
|
3028
3098
|
# klaviyo api revision
|
3029
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3099
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3030
3100
|
# HTTP header 'Accept' (if needed)
|
3031
3101
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3032
3102
|
# HTTP header 'Content-Type'
|
@@ -3096,7 +3166,7 @@ module KlaviyoAPI
|
|
3096
3166
|
# header parameters
|
3097
3167
|
header_params = opts[:header_params] || {}
|
3098
3168
|
# klaviyo api revision
|
3099
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3169
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3100
3170
|
# HTTP header 'Accept' (if needed)
|
3101
3171
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3102
3172
|
# HTTP header 'Content-Type'
|
@@ -3166,7 +3236,7 @@ module KlaviyoAPI
|
|
3166
3236
|
# header parameters
|
3167
3237
|
header_params = opts[:header_params] || {}
|
3168
3238
|
# klaviyo api revision
|
3169
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3239
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3170
3240
|
# HTTP header 'Accept' (if needed)
|
3171
3241
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3172
3242
|
# HTTP header 'Content-Type'
|
@@ -3236,7 +3306,7 @@ module KlaviyoAPI
|
|
3236
3306
|
# header parameters
|
3237
3307
|
header_params = opts[:header_params] || {}
|
3238
3308
|
# klaviyo api revision
|
3239
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3309
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3240
3310
|
# HTTP header 'Accept' (if needed)
|
3241
3311
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3242
3312
|
# HTTP header 'Content-Type'
|
@@ -3306,7 +3376,7 @@ module KlaviyoAPI
|
|
3306
3376
|
# header parameters
|
3307
3377
|
header_params = opts[:header_params] || {}
|
3308
3378
|
# klaviyo api revision
|
3309
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3379
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3310
3380
|
# HTTP header 'Accept' (if needed)
|
3311
3381
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3312
3382
|
# HTTP header 'Content-Type'
|
@@ -3376,7 +3446,7 @@ module KlaviyoAPI
|
|
3376
3446
|
# header parameters
|
3377
3447
|
header_params = opts[:header_params] || {}
|
3378
3448
|
# klaviyo api revision
|
3379
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3449
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3380
3450
|
# HTTP header 'Accept' (if needed)
|
3381
3451
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3382
3452
|
# HTTP header 'Content-Type'
|
@@ -3446,7 +3516,7 @@ module KlaviyoAPI
|
|
3446
3516
|
# header parameters
|
3447
3517
|
header_params = opts[:header_params] || {}
|
3448
3518
|
# klaviyo api revision
|
3449
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3519
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3450
3520
|
# HTTP header 'Accept' (if needed)
|
3451
3521
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3452
3522
|
# HTTP header 'Content-Type'
|
@@ -3516,7 +3586,7 @@ module KlaviyoAPI
|
|
3516
3586
|
# header parameters
|
3517
3587
|
header_params = opts[:header_params] || {}
|
3518
3588
|
# klaviyo api revision
|
3519
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3589
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3520
3590
|
# HTTP header 'Accept' (if needed)
|
3521
3591
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3522
3592
|
# HTTP header 'Content-Type'
|
@@ -3586,7 +3656,7 @@ module KlaviyoAPI
|
|
3586
3656
|
# header parameters
|
3587
3657
|
header_params = opts[:header_params] || {}
|
3588
3658
|
# klaviyo api revision
|
3589
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3659
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3590
3660
|
# HTTP header 'Accept' (if needed)
|
3591
3661
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3592
3662
|
# HTTP header 'Content-Type'
|
@@ -3662,7 +3732,7 @@ module KlaviyoAPI
|
|
3662
3732
|
# header parameters
|
3663
3733
|
header_params = opts[:header_params] || {}
|
3664
3734
|
# klaviyo api revision
|
3665
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3735
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3666
3736
|
# HTTP header 'Accept' (if needed)
|
3667
3737
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3668
3738
|
# HTTP header 'Content-Type'
|
@@ -3738,7 +3808,7 @@ module KlaviyoAPI
|
|
3738
3808
|
# header parameters
|
3739
3809
|
header_params = opts[:header_params] || {}
|
3740
3810
|
# klaviyo api revision
|
3741
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3811
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3742
3812
|
# HTTP header 'Accept' (if needed)
|
3743
3813
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3744
3814
|
# HTTP header 'Content-Type'
|
@@ -3814,7 +3884,7 @@ module KlaviyoAPI
|
|
3814
3884
|
# header parameters
|
3815
3885
|
header_params = opts[:header_params] || {}
|
3816
3886
|
# klaviyo api revision
|
3817
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3887
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3818
3888
|
# HTTP header 'Accept' (if needed)
|
3819
3889
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3820
3890
|
# HTTP header 'Content-Type'
|
@@ -3890,7 +3960,7 @@ module KlaviyoAPI
|
|
3890
3960
|
# header parameters
|
3891
3961
|
header_params = opts[:header_params] || {}
|
3892
3962
|
# klaviyo api revision
|
3893
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3963
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3894
3964
|
# HTTP header 'Accept' (if needed)
|
3895
3965
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3896
3966
|
# HTTP header 'Content-Type'
|
@@ -3966,7 +4036,7 @@ module KlaviyoAPI
|
|
3966
4036
|
# header parameters
|
3967
4037
|
header_params = opts[:header_params] || {}
|
3968
4038
|
# klaviyo api revision
|
3969
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
4039
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
3970
4040
|
# HTTP header 'Accept' (if needed)
|
3971
4041
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3972
4042
|
# HTTP header 'Content-Type'
|