klaviyo-api-sdk 1.2.0 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +24 -0
- data/README.md +654 -238
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +160 -0
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +101 -107
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +461 -549
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +132 -71
- data/lib/klaviyo-api-sdk/api/flows_api.rb +368 -206
- data/lib/klaviyo-api-sdk/api/lists_api.rb +172 -122
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +18 -18
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +173 -94
- data/lib/klaviyo-api-sdk/api/segments_api.rb +148 -76
- data/lib/klaviyo-api-sdk/api/tags_api.rb +932 -260
- data/lib/klaviyo-api-sdk/api/templates_api.rb +32 -32
- 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/campaign_clone_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{campaign_clone_query_as_sub_resource_attributes.rb → campaign_clone_query_resource_object_attributes.rb} +18 -18
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_as_sub_resource_attributes.rb → campaign_create_query_resource_object_attributes.rb} +38 -38
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_assign_template_query_as_sub_resource_attributes.rb → campaign_message_assign_template_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_as_sub_resource_attributes.rb → campaign_message_partial_update_query_resource_object_attributes.rb} +17 -17
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/{campaign_partial_update_query_as_sub_resource_attributes.rb → campaign_partial_update_query_resource_object_attributes.rb} +30 -30
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb → campaign_recipient_estimation_job_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner_source.rb → campaign_send_job_create_query_resource_object.rb} +27 -17
- data/lib/klaviyo-api-sdk/models/{campaign_send_job_create_query_as_sub_resource_attributes.rb → campaign_send_job_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/{campaign_send_job_partial_update_query_as_sub_resource_attributes.rb → campaign_send_job_partial_update_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{catalog_category_create_job_create_query_as_sub_resource_attributes.rb → catalog_category_create_job_create_query_resource_object_attributes.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{list_create_query_as_sub_resource.rb → catalog_category_create_query_resource_object.rb} +27 -52
- data/lib/klaviyo-api-sdk/models/{catalog_category_create_query_as_sub_resource_attributes.rb → catalog_category_create_query_resource_object_attributes.rb} +20 -20
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{catalog_category_delete_job_create_query_as_sub_resource_attributes.rb → catalog_category_delete_job_create_query_resource_object_attributes.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{catalog_category_update_job_create_query_as_sub_resource_attributes.rb → catalog_category_update_job_create_query_resource_object_attributes.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{tag_create_query_as_sub_resource.rb → catalog_category_update_query_resource_object.rb} +37 -47
- data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_as_sub_resource_attributes.rb → catalog_category_update_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_as_sub_resource_relationships.rb → catalog_category_update_query_resource_object_relationships.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_as_sub_resource_relationships_categories.rb → catalog_category_update_query_resource_object_relationships_items.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb → catalog_category_update_query_resource_object_relationships_items_data_inner.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb → catalog_item_category_op_data_inner.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{catalog_item_create_job_create_query_as_sub_resource_attributes.rb → catalog_item_create_job_create_query_resource_object_attributes.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_as_sub_resource_attributes.rb → catalog_item_create_query_resource_object_attributes.rb} +74 -74
- data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_as_sub_resource_relationships.rb → catalog_item_create_query_resource_object_relationships.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_as_sub_resource_relationships_items.rb → catalog_item_create_query_resource_object_relationships_categories.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{catalog_item_delete_job_create_query_as_sub_resource_attributes.rb → catalog_item_delete_job_create_query_resource_object_attributes.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{catalog_item_update_job_create_query_as_sub_resource_attributes.rb → catalog_item_update_job_create_query_resource_object_attributes.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +262 -0
- data/lib/klaviyo-api-sdk/models/{catalog_item_update_query_as_sub_resource_attributes.rb → catalog_item_update_query_resource_object_attributes.rb} +46 -46
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_job_create_query_as_sub_resource_attributes.rb → catalog_variant_create_job_create_query_resource_object_attributes.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{event_create_query_as_sub_resource.rb → catalog_variant_create_query_resource_object.rb} +27 -52
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_as_sub_resource_attributes.rb → catalog_variant_create_query_resource_object_attributes.rb} +117 -117
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb → catalog_variant_delete_job_create_query_resource_object_attributes.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{catalog_variant_update_job_create_query_as_sub_resource_attributes.rb → catalog_variant_update_job_create_query_resource_object_attributes.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{campaign_send_job_create_query_as_sub_resource.rb → catalog_variant_update_query_resource_object.rb} +29 -48
- data/lib/klaviyo-api-sdk/models/{catalog_variant_update_query_as_sub_resource_attributes.rb → catalog_variant_update_query_resource_object_attributes.rb} +63 -53
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +30 -30
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb → data_privacy_create_deletion_job_query_resource_object_attributes.rb} +18 -18
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{event_create_query_as_sub_resource_attributes.rb → event_create_query_resource_object_attributes.rb} +19 -19
- data/lib/klaviyo-api-sdk/models/event_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/{flow_update_query_as_sub_resource_attributes.rb → flow_update_query_resource_object_attributes.rb} +5 -4
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response.rb → get_create_variants_jobs5_xx_response.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner.rb → get_create_variants_jobs5_xx_response_errors_inner.rb} +40 -40
- data/lib/klaviyo-api-sdk/models/{get_catalog_items4_xx_response_errors_inner_source.rb → get_create_variants_jobs5_xx_response_errors_inner_source.rb} +17 -17
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{sms_message_content.rb → list_create_query_resource_object.rb} +23 -23
- data/lib/klaviyo-api-sdk/models/{segment_partial_update_query_as_sub_resource_attributes.rb → list_create_query_resource_object_attributes.rb} +5 -4
- data/lib/klaviyo-api-sdk/models/list_enum.rb +36 -0
- 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 +2 -2
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{v2_template_render_query_as_sub_resource.rb → metric_aggregate_query_resource_object.rb} +30 -13
- data/lib/klaviyo-api-sdk/models/{metric_aggregate_query_as_sub_resource_attributes.rb → metric_aggregate_query_resource_object_attributes.rb} +70 -70
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{included_profiles_attributes.rb → profile_create_query_resource_object_attributes.rb} +36 -75
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
- 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_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/{profile_create_query_as_sub_resource_attributes.rb → profile_partial_update_query_resource_object_attributes.rb} +48 -48
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{tag_update_query_as_sub_resource_attributes.rb → segment_partial_update_query_resource_object_attributes.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription.rb +15 -15
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{subscription_create_job_create_query_as_sub_resource_attributes.rb → subscription_create_job_create_query_resource_object_attributes.rb} +26 -26
- data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{suppression_create_job_create_query_as_sub_resource_attributes.rb → suppression_create_job_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_tag_op.rb → tag_campaign_op.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{campaign_tag_op_data_inner.rb → tag_campaign_op_data_inner.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{utm_param_info.rb → tag_create_query_resource_object.rb} +23 -23
- data/lib/klaviyo-api-sdk/models/{tag_create_query_as_sub_resource_attributes.rb → tag_create_query_resource_object_attributes.rb} +18 -18
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/{onsite_profile_create_query.rb → tag_flow_op.rb} +8 -6
- data/lib/klaviyo-api-sdk/models/{catalog_item_delete_query_as_sub_resource.rb → tag_flow_op_data_inner.rb} +6 -7
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{tag_group_create_query_as_sub_resource_attributes.rb → tag_group_create_query_resource_object_attributes.rb} +17 -17
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/{tag_group_update_query_as_sub_resource_attributes.rb → tag_group_update_query_resource_object_attributes.rb} +17 -17
- data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query.rb → tag_list_op.rb} +8 -6
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +272 -0
- 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 +2 -2
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/{list_create_query_as_sub_resource_attributes.rb → tag_update_query_resource_object_attributes.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{template_clone_query_as_sub_resource_attributes.rb → template_clone_query_resource_object_attributes.rb} +20 -20
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{template_create_query_as_sub_resource_attributes.rb → template_create_query_resource_object_attributes.rb} +35 -35
- data/lib/klaviyo-api-sdk/models/template_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{template_render_query_as_sub_resource_attributes.rb → template_render_query_resource_object_attributes.rb} +20 -20
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/{template_update_query_as_sub_resource_attributes.rb → template_update_query_resource_object_attributes.rb} +19 -19
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +15 -15
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_as_sub_resource_attributes.rb → unsubscription_create_job_create_query_resource_object_attributes.rb} +21 -21
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_as_sub_resource_attributes.rb → unsuppression_create_job_create_query_resource_object_attributes.rb} +4 -4
- 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 +137 -143
- metadata +139 -609
- data/Gemfile +0 -9
- data/Rakefile +0 -10
- data/docs/AudiencesSubObject.md +0 -20
- data/docs/CampaignCloneQuery.md +0 -18
- data/docs/CampaignCloneQueryAsSubResource.md +0 -20
- data/docs/CampaignCloneQueryAsSubResourceAttributes.md +0 -20
- data/docs/CampaignCreateQuery.md +0 -18
- data/docs/CampaignCreateQueryAsSubResource.md +0 -20
- data/docs/CampaignCreateQueryAsSubResourceAttributes.md +0 -28
- data/docs/CampaignMessageAssignTemplateQuery.md +0 -18
- data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +0 -20
- data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +0 -20
- data/docs/CampaignMessagePartialUpdateQuery.md +0 -18
- data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +0 -22
- data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +0 -20
- data/docs/CampaignPartialUpdateQuery.md +0 -18
- data/docs/CampaignPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +0 -26
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +0 -18
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +0 -20
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CampaignSendJobCreateQuery.md +0 -18
- data/docs/CampaignSendJobCreateQueryAsSubResource.md +0 -20
- data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CampaignSendJobPartialUpdateQuery.md +0 -18
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CampaignTagOp.md +0 -18
- data/docs/CampaignTagOpDataInner.md +0 -20
- data/docs/CampaignsApi.md +0 -1277
- data/docs/CatalogCategoryCreateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateQueryAsSubResource.md +0 -22
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +0 -24
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryItemOp.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryUpdateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +0 -24
- data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemCategoryOp.md +0 -18
- data/docs/CatalogItemCreateJobCreateQuery.md +0 -18
- data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemCreateQuery.md +0 -18
- data/docs/CatalogItemCreateQueryAsSubResource.md +0 -22
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +0 -40
- data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md +0 -18
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md +0 -18
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemDeleteQueryAsSubResource.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemUpdateQuery.md +0 -18
- data/docs/CatalogItemUpdateQueryAsSubResource.md +0 -24
- data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +0 -34
- data/docs/CatalogJobErrorPayload.md +0 -26
- data/docs/CatalogVariantCreateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogVariantCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateQueryAsSubResource.md +0 -22
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +0 -46
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md +0 -18
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md +0 -18
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogVariantUpdateQuery.md +0 -18
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +0 -22
- data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +0 -38
- data/docs/CatalogsApi.md +0 -4048
- data/docs/ClientApi.md +0 -205
- data/docs/ContentSubObject.md +0 -28
- data/docs/DataPrivacyApi.md +0 -78
- data/docs/DataPrivacyCreateDeletionJobQuery.md +0 -18
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +0 -20
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +0 -22
- data/docs/EmailMessageContent.md +0 -24
- data/docs/EmailTrackingOptions.md +0 -24
- data/docs/ErrorSource.md +0 -18
- data/docs/EventCreateQuery.md +0 -18
- data/docs/EventCreateQueryAsSubResource.md +0 -20
- data/docs/EventCreateQueryAsSubResourceAttributes.md +0 -28
- data/docs/EventsApi.md +0 -472
- data/docs/FlowUpdateQuery.md +0 -18
- data/docs/FlowUpdateQueryAsSubResource.md +0 -22
- data/docs/FlowUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/FlowsApi.md +0 -1029
- data/docs/GetCampaigns4XXResponse.md +0 -18
- data/docs/GetCampaigns4XXResponseErrorsInner.md +0 -26
- data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +0 -20
- data/docs/GetCatalogItems4XXResponse.md +0 -18
- data/docs/GetCatalogItems4XXResponseErrorsInner.md +0 -26
- data/docs/GetCatalogItems4XXResponseErrorsInnerSource.md +0 -20
- data/docs/IncludedCategories.md +0 -24
- data/docs/IncludedCategoriesAttributes.md +0 -22
- data/docs/IncludedFlowAction.md +0 -24
- data/docs/IncludedFlowActions.md +0 -24
- data/docs/IncludedFlowActionsAttributes.md +0 -32
- data/docs/IncludedFlowActionsAttributesTrackingOptions.md +0 -49
- data/docs/IncludedFlowMessages.md +0 -24
- data/docs/IncludedFlowMessagesAttributes.md +0 -26
- data/docs/IncludedFlowMessagesAttributesContent.md +0 -49
- data/docs/IncludedFlows.md +0 -24
- data/docs/IncludedFlowsAttributes.md +0 -28
- data/docs/IncludedItems.md +0 -24
- data/docs/IncludedItemsAttributes.md +0 -40
- data/docs/IncludedLists.md +0 -24
- data/docs/IncludedListsAttributes.md +0 -22
- data/docs/IncludedMetrics.md +0 -24
- data/docs/IncludedMetricsAttributes.md +0 -24
- data/docs/IncludedProfiles.md +0 -24
- data/docs/IncludedProfilesAttributes.md +0 -44
- data/docs/IncludedSegments.md +0 -24
- data/docs/IncludedSegmentsAttributes.md +0 -22
- data/docs/IncludedTags.md +0 -24
- data/docs/IncludedVariants.md +0 -24
- data/docs/IncludedVariantsAttributes.md +0 -46
- data/docs/IncludedVariantsLinks.md +0 -18
- data/docs/ListCreateQuery.md +0 -18
- data/docs/ListCreateQueryAsSubResource.md +0 -20
- data/docs/ListCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/ListMembersAddQuery.md +0 -18
- data/docs/ListMembersAddQueryDataInner.md +0 -20
- data/docs/ListMembersDeleteQuery.md +0 -18
- data/docs/ListPartialUpdateQuery.md +0 -18
- data/docs/ListPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/ListsApi.md +0 -762
- data/docs/MetricAggregateQuery.md +0 -18
- data/docs/MetricAggregateQueryAsSubResource.md +0 -20
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +0 -36
- data/docs/MetricAggregateRowDTO.md +0 -20
- data/docs/MetricCreateQuery.md +0 -20
- data/docs/MetricsApi.md +0 -233
- data/docs/OnsiteProfileCreateQuery.md +0 -18
- data/docs/OnsiteProfileCreateQueryAsSubResource.md +0 -22
- data/docs/OnsiteProfileMeta.md +0 -18
- data/docs/OnsiteProfileMetaIdentifiers.md +0 -28
- data/docs/OnsiteSubscriptionCreateQuery.md +0 -18
- data/docs/OnsiteSubscriptionCreateQueryAsSubResource.md +0 -20
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +0 -26
- data/docs/ProfileCreateQuery.md +0 -18
- data/docs/ProfileCreateQueryAsSubResource.md +0 -20
- data/docs/ProfileCreateQueryAsSubResourceAttributes.md +0 -38
- data/docs/ProfileLocation.md +0 -34
- data/docs/ProfileLocationLatitude.md +0 -49
- data/docs/ProfileLocationLongitude.md +0 -49
- data/docs/ProfilePartialUpdateQuery.md +0 -18
- data/docs/ProfilePartialUpdateQueryAsSubResource.md +0 -22
- data/docs/ProfilesApi.md +0 -825
- data/docs/SMSMessageContent.md +0 -20
- data/docs/SMSRenderOptions.md +0 -24
- data/docs/SMSTrackingOptions.md +0 -20
- data/docs/STOScheduleOptions.md +0 -18
- data/docs/SegmentPartialUpdateQuery.md +0 -18
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/SegmentsApi.md +0 -469
- data/docs/SendOptions.md +0 -20
- data/docs/SendOptionsSubObject.md +0 -18
- data/docs/SendStrategySubObject.md +0 -24
- data/docs/SendTimeSubObject.md +0 -20
- data/docs/StaticScheduleOptions.md +0 -22
- data/docs/Subscription.md +0 -24
- data/docs/SubscriptionChannels.md +0 -20
- data/docs/SubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/SubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
- data/docs/Suppression.md +0 -18
- data/docs/SuppressionCreateJobCreateQuery.md +0 -18
- data/docs/SuppressionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/TagCreateQuery.md +0 -18
- data/docs/TagCreateQueryAsSubResource.md +0 -20
- data/docs/TagCreateQueryAsSubResourceAttributes.md +0 -20
- data/docs/TagGroupCreateQuery.md +0 -18
- data/docs/TagGroupCreateQueryAsSubResource.md +0 -20
- data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +0 -20
- data/docs/TagGroupUpdateQuery.md +0 -18
- data/docs/TagGroupUpdateQueryAsSubResource.md +0 -22
- data/docs/TagGroupUpdateQueryAsSubResourceAttributes.md +0 -20
- data/docs/TagSegmentOp.md +0 -18
- data/docs/TagSegmentOpDataInner.md +0 -20
- data/docs/TagUpdateQuery.md +0 -18
- data/docs/TagUpdateQueryAsSubResource.md +0 -22
- data/docs/TagUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/TagsApi.md +0 -1205
- data/docs/TemplateCloneQuery.md +0 -18
- data/docs/TemplateCloneQueryAsSubResource.md +0 -20
- data/docs/TemplateCloneQueryAsSubResourceAttributes.md +0 -22
- data/docs/TemplateCreateQuery.md +0 -18
- data/docs/TemplateCreateQueryAsSubResource.md +0 -20
- data/docs/TemplateCreateQueryAsSubResourceAttributes.md +0 -32
- data/docs/TemplateRenderQuery.md +0 -18
- data/docs/TemplateRenderQueryAsSubResource.md +0 -20
- data/docs/TemplateRenderQueryAsSubResourceAttributes.md +0 -22
- data/docs/TemplateUpdateQuery.md +0 -18
- data/docs/TemplateUpdateQueryAsSubResource.md +0 -22
- data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +0 -30
- data/docs/TemplatesApi.md +0 -525
- data/docs/ThrottledScheduleOptions.md +0 -20
- data/docs/TrackingOptionsSubObject.md +0 -24
- data/docs/UTMParamsSubObject.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
- data/docs/UnsuppressionCreateJobCreateQuery.md +0 -18
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/UtmParamInfo.md +0 -20
- data/docs/V2TemplateRenderQueryAsSubResource.md +0 -18
- data/git_push.sh +0 -57
- data/lib/klaviyo-api-sdk/api/client_api.rb +0 -249
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +0 -273
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +0 -296
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +0 -296
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +0 -284
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +0 -273
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +0 -266
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +0 -268
- data/lib/klaviyo-api-sdk/models/error_source.rb +0 -227
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +0 -226
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +0 -275
- data/lib/klaviyo-api-sdk/models/included_categories.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +0 -282
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +0 -105
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +0 -270
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +0 -105
- data/lib/klaviyo-api-sdk/models/included_flows.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +0 -264
- data/lib/klaviyo-api-sdk/models/included_items.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +0 -332
- data/lib/klaviyo-api-sdk/models/included_lists.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +0 -250
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_segments.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/included_tags.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_variants.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +0 -396
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +0 -224
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +0 -242
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +0 -269
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +0 -265
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/send_options.rb +0 -238
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +0 -240
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +0 -266
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +0 -240
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +0 -272
- data/spec/api/campaigns_api_spec.rb +0 -284
- data/spec/api/catalogs_api_spec.rb +0 -759
- data/spec/api/client_api_spec.rb +0 -74
- data/spec/api/data_privacy_api_spec.rb +0 -47
- data/spec/api/events_api_spec.rb +0 -120
- data/spec/api/flows_api_spec.rb +0 -220
- data/spec/api/lists_api_spec.rb +0 -169
- data/spec/api/metrics_api_spec.rb +0 -74
- data/spec/api/profiles_api_spec.rb +0 -178
- data/spec/api/segments_api_spec.rb +0 -117
- data/spec/api/tags_api_spec.rb +0 -245
- data/spec/api/templates_api_spec.rb +0 -126
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/audiences_sub_object_spec.rb +0 -40
- data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_clone_query_spec.rb +0 -34
- data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +0 -64
- data/spec/models/campaign_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_create_query_spec.rb +0 -34
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_message_assign_template_query_spec.rb +0 -34
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/campaign_message_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +0 -58
- data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/campaign_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_send_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_tag_op_data_inner_spec.rb +0 -44
- data/spec/models/campaign_tag_op_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +0 -56
- data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_category_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_item_op_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +0 -56
- data/spec/models/catalog_category_update_query_spec.rb +0 -34
- data/spec/models/catalog_item_category_op_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +0 -98
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_item_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +0 -76
- data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +0 -56
- data/spec/models/catalog_item_update_query_spec.rb +0 -34
- data/spec/models/catalog_job_error_payload_spec.rb +0 -58
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +0 -126
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_variant_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +0 -98
- data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_variant_update_query_spec.rb +0 -34
- data/spec/models/content_sub_object_spec.rb +0 -64
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +0 -34
- data/spec/models/email_message_content_spec.rb +0 -52
- data/spec/models/email_tracking_options_spec.rb +0 -52
- data/spec/models/error_source_spec.rb +0 -34
- data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +0 -64
- data/spec/models/event_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/event_create_query_spec.rb +0 -34
- data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/flow_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/flow_update_query_spec.rb +0 -34
- data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +0 -40
- data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +0 -58
- data/spec/models/get_campaigns4_xx_response_spec.rb +0 -34
- data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +0 -40
- data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +0 -58
- data/spec/models/get_catalog_items4_xx_response_spec.rb +0 -34
- data/spec/models/included_categories_attributes_spec.rb +0 -46
- data/spec/models/included_categories_spec.rb +0 -56
- data/spec/models/included_flow_action_spec.rb +0 -56
- data/spec/models/included_flow_actions_attributes_spec.rb +0 -76
- data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +0 -31
- data/spec/models/included_flow_actions_spec.rb +0 -56
- data/spec/models/included_flow_messages_attributes_content_spec.rb +0 -31
- data/spec/models/included_flow_messages_attributes_spec.rb +0 -58
- data/spec/models/included_flow_messages_spec.rb +0 -56
- data/spec/models/included_flows_attributes_spec.rb +0 -64
- data/spec/models/included_flows_spec.rb +0 -56
- data/spec/models/included_items_attributes_spec.rb +0 -94
- data/spec/models/included_items_spec.rb +0 -56
- data/spec/models/included_lists_attributes_spec.rb +0 -46
- data/spec/models/included_lists_spec.rb +0 -56
- data/spec/models/included_metrics_attributes_spec.rb +0 -52
- data/spec/models/included_metrics_spec.rb +0 -56
- data/spec/models/included_profiles_attributes_spec.rb +0 -112
- data/spec/models/included_profiles_spec.rb +0 -56
- data/spec/models/included_segments_attributes_spec.rb +0 -46
- data/spec/models/included_segments_spec.rb +0 -56
- data/spec/models/included_tags_spec.rb +0 -56
- data/spec/models/included_variants_attributes_spec.rb +0 -122
- data/spec/models/included_variants_links_spec.rb +0 -34
- data/spec/models/included_variants_spec.rb +0 -56
- data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/list_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/list_create_query_spec.rb +0 -34
- data/spec/models/list_members_add_query_data_inner_spec.rb +0 -44
- data/spec/models/list_members_add_query_spec.rb +0 -34
- data/spec/models/list_members_delete_query_spec.rb +0 -34
- data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/list_partial_update_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +0 -104
- data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/metric_aggregate_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_row_dto_spec.rb +0 -40
- data/spec/models/metric_create_query_spec.rb +0 -40
- data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/onsite_profile_create_query_spec.rb +0 -34
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +0 -64
- data/spec/models/onsite_profile_meta_spec.rb +0 -34
- data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +0 -58
- data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/onsite_subscription_create_query_spec.rb +0 -34
- data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +0 -94
- data/spec/models/profile_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/profile_create_query_spec.rb +0 -34
- data/spec/models/profile_location_latitude_spec.rb +0 -31
- data/spec/models/profile_location_longitude_spec.rb +0 -31
- data/spec/models/profile_location_spec.rb +0 -82
- data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/profile_partial_update_query_spec.rb +0 -34
- data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/segment_partial_update_query_spec.rb +0 -34
- data/spec/models/send_options_spec.rb +0 -40
- data/spec/models/send_options_sub_object_spec.rb +0 -40
- data/spec/models/send_strategy_sub_object_spec.rb +0 -46
- data/spec/models/send_time_sub_object_spec.rb +0 -40
- data/spec/models/sms_message_content_spec.rb +0 -40
- data/spec/models/sms_render_options_spec.rb +0 -52
- data/spec/models/sms_tracking_options_spec.rb +0 -40
- data/spec/models/static_schedule_options_spec.rb +0 -46
- data/spec/models/sto_schedule_options_spec.rb +0 -34
- data/spec/models/subscription_channels_spec.rb +0 -48
- data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/subscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/subscription_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/suppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/suppression_spec.rb +0 -34
- data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/tag_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/tag_create_query_spec.rb +0 -34
- data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/tag_group_create_query_spec.rb +0 -34
- data/spec/models/tag_group_update_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/tag_group_update_query_spec.rb +0 -34
- data/spec/models/tag_segment_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_segment_op_spec.rb +0 -34
- data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/tag_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/tag_update_query_spec.rb +0 -34
- data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/template_clone_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/template_clone_query_spec.rb +0 -34
- data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +0 -58
- data/spec/models/template_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/template_create_query_spec.rb +0 -34
- data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/template_render_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/template_render_query_spec.rb +0 -34
- data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +0 -52
- data/spec/models/template_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/template_update_query_spec.rb +0 -34
- data/spec/models/throttled_schedule_options_spec.rb +0 -40
- data/spec/models/tracking_options_sub_object_spec.rb +0 -52
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/unsubscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/unsuppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/utm_param_info_spec.rb +0 -40
- data/spec/models/utm_params_sub_object_spec.rb +0 -40
- data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +0 -34
- data/spec/spec_helper.rb +0 -111
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogItemUpdateJobCreateQuery
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**CatalogItemUpdateJobCreateQueryAsSubResource**](CatalogItemUpdateJobCreateQueryAsSubResource.md) | | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogItemUpdateJobCreateQuery.new(
|
15
|
-
data: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,20 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogItemUpdateJobCreateQueryAsSubResource
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **String** | | |
|
8
|
-
| **attributes** | [**CatalogItemUpdateJobCreateQueryAsSubResourceAttributes**](CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md) | | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'klaviyo-api-sdk'
|
14
|
-
|
15
|
-
instance = KlaviyoAPI::CatalogItemUpdateJobCreateQueryAsSubResource.new(
|
16
|
-
type: null,
|
17
|
-
attributes: null
|
18
|
-
)
|
19
|
-
```
|
20
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogItemUpdateJobCreateQueryAsSubResourceAttributes
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **items** | [**Array<CatalogItemUpdateQueryAsSubResource>**](CatalogItemUpdateQueryAsSubResource.md) | Array of catalog items to update. | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.new(
|
15
|
-
items: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogItemUpdateQuery
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**CatalogItemUpdateQueryAsSubResource**](CatalogItemUpdateQueryAsSubResource.md) | | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogItemUpdateQuery.new(
|
15
|
-
data: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,24 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogItemUpdateQueryAsSubResource
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **String** | | |
|
8
|
-
| **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`. | |
|
9
|
-
| **attributes** | [**CatalogItemUpdateQueryAsSubResourceAttributes**](CatalogItemUpdateQueryAsSubResourceAttributes.md) | | |
|
10
|
-
| **relationships** | [**CatalogItemCreateQueryAsSubResourceRelationships**](CatalogItemCreateQueryAsSubResourceRelationships.md) | | [optional] |
|
11
|
-
|
12
|
-
## Example
|
13
|
-
|
14
|
-
```ruby
|
15
|
-
require 'klaviyo-api-sdk'
|
16
|
-
|
17
|
-
instance = KlaviyoAPI::CatalogItemUpdateQueryAsSubResource.new(
|
18
|
-
type: null,
|
19
|
-
id: $custom:::$default:::SAMPLE-DATA-ITEM-1,
|
20
|
-
attributes: null,
|
21
|
-
relationships: null
|
22
|
-
)
|
23
|
-
```
|
24
|
-
|
@@ -1,34 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogItemUpdateQueryAsSubResourceAttributes
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **title** | **String** | The title of the catalog item. | [optional] |
|
8
|
-
| **price** | **Float** | This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant). | [optional] |
|
9
|
-
| **description** | **String** | A description of the catalog item. | [optional] |
|
10
|
-
| **url** | **String** | URL pointing to the location of the catalog item on your website. | [optional] |
|
11
|
-
| **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item. | [optional] |
|
12
|
-
| **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item | [optional] |
|
13
|
-
| **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item. | [optional] |
|
14
|
-
| **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb. | [optional] |
|
15
|
-
| **published** | **Boolean** | Boolean value indicating whether the catalog item is published. | [optional] |
|
16
|
-
|
17
|
-
## Example
|
18
|
-
|
19
|
-
```ruby
|
20
|
-
require 'klaviyo-api-sdk'
|
21
|
-
|
22
|
-
instance = KlaviyoAPI::CatalogItemUpdateQueryAsSubResourceAttributes.new(
|
23
|
-
title: Ocean Blue Shirt (Sample),
|
24
|
-
price: 42,
|
25
|
-
description: A description of the catalog item.,
|
26
|
-
url: https://via.placeholder.com/150,
|
27
|
-
image_full_url: https://via.placeholder.com/300,
|
28
|
-
image_thumbnail_url: https://via.placeholder.com/150,
|
29
|
-
images: ["https://via.placeholder.com/150"],
|
30
|
-
custom_metadata: {"Top Pick":true},
|
31
|
-
published: true
|
32
|
-
)
|
33
|
-
```
|
34
|
-
|
@@ -1,26 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogJobErrorPayload
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | Unique identifier for the error. | |
|
8
|
-
| **code** | **String** | A code for classifying the error type. | |
|
9
|
-
| **title** | **String** | A high-level message about the error. | |
|
10
|
-
| **detail** | **String** | Specific details about the error. | |
|
11
|
-
| **source** | [**ErrorSource**](ErrorSource.md) | | |
|
12
|
-
|
13
|
-
## Example
|
14
|
-
|
15
|
-
```ruby
|
16
|
-
require 'klaviyo-api-sdk'
|
17
|
-
|
18
|
-
instance = KlaviyoAPI::CatalogJobErrorPayload.new(
|
19
|
-
id: e4eebb08-b055-4a6f-bb13-c8cb69c9eb94,
|
20
|
-
code: invalid,
|
21
|
-
title: Invalid input,
|
22
|
-
detail: The payload provided in the request is invalid.,
|
23
|
-
source: null
|
24
|
-
)
|
25
|
-
```
|
26
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantCreateJobCreateQuery
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**CatalogVariantCreateJobCreateQueryAsSubResource**](CatalogVariantCreateJobCreateQueryAsSubResource.md) | | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogVariantCreateJobCreateQuery.new(
|
15
|
-
data: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,20 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantCreateJobCreateQueryAsSubResource
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **String** | | |
|
8
|
-
| **attributes** | [**CatalogVariantCreateJobCreateQueryAsSubResourceAttributes**](CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md) | | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'klaviyo-api-sdk'
|
14
|
-
|
15
|
-
instance = KlaviyoAPI::CatalogVariantCreateJobCreateQueryAsSubResource.new(
|
16
|
-
type: null,
|
17
|
-
attributes: null
|
18
|
-
)
|
19
|
-
```
|
20
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantCreateJobCreateQueryAsSubResourceAttributes
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **variants** | [**Array<CatalogVariantCreateQueryAsSubResource>**](CatalogVariantCreateQueryAsSubResource.md) | Array of catalog variants to create. | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.new(
|
15
|
-
variants: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantCreateQuery
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**CatalogVariantCreateQueryAsSubResource**](CatalogVariantCreateQueryAsSubResource.md) | | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogVariantCreateQuery.new(
|
15
|
-
data: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,22 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantCreateQueryAsSubResource
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **String** | | |
|
8
|
-
| **attributes** | [**CatalogVariantCreateQueryAsSubResourceAttributes**](CatalogVariantCreateQueryAsSubResourceAttributes.md) | | |
|
9
|
-
| **relationships** | [**CatalogVariantCreateQueryAsSubResourceRelationships**](CatalogVariantCreateQueryAsSubResourceRelationships.md) | | [optional] |
|
10
|
-
|
11
|
-
## Example
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'klaviyo-api-sdk'
|
15
|
-
|
16
|
-
instance = KlaviyoAPI::CatalogVariantCreateQueryAsSubResource.new(
|
17
|
-
type: null,
|
18
|
-
attributes: null,
|
19
|
-
relationships: null
|
20
|
-
)
|
21
|
-
```
|
22
|
-
|
@@ -1,46 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **external_id** | **String** | The ID of the catalog item variant in an external system. | |
|
8
|
-
| **catalog_type** | **String** | The type of catalog. Currently only \"$default\" is supported. | [optional][default to '$default'] |
|
9
|
-
| **integration_type** | **String** | The integration type. Currently only \"$custom\" is supported. | [optional] |
|
10
|
-
| **title** | **String** | The title of the catalog item variant. | |
|
11
|
-
| **description** | **String** | A description of the catalog item variant. | |
|
12
|
-
| **sku** | **String** | The SKU of the catalog item variant. | |
|
13
|
-
| **inventory_policy** | **Integer** | This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity. | [optional] |
|
14
|
-
| **inventory_quantity** | **Float** | The quantity of the catalog item variant currently in stock. | |
|
15
|
-
| **price** | **Float** | This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item). | |
|
16
|
-
| **url** | **String** | URL pointing to the location of the catalog item variant on your website. | |
|
17
|
-
| **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item variant. | [optional] |
|
18
|
-
| **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item variant. | [optional] |
|
19
|
-
| **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item variant. | [optional] |
|
20
|
-
| **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb. | [optional] |
|
21
|
-
| **published** | **Boolean** | Boolean value indicating whether the catalog item variant is published. | [optional][default to true] |
|
22
|
-
|
23
|
-
## Example
|
24
|
-
|
25
|
-
```ruby
|
26
|
-
require 'klaviyo-api-sdk'
|
27
|
-
|
28
|
-
instance = KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes.new(
|
29
|
-
external_id: SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
|
30
|
-
catalog_type: $default,
|
31
|
-
integration_type: null,
|
32
|
-
title: Ocean Blue Shirt (Sample) Variant Medium,
|
33
|
-
description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
|
34
|
-
sku: OBS-MD,
|
35
|
-
inventory_policy: 25,
|
36
|
-
inventory_quantity: 25,
|
37
|
-
price: 42,
|
38
|
-
url: https://via.placeholder.com/150,
|
39
|
-
image_full_url: https://via.placeholder.com/300,
|
40
|
-
image_thumbnail_url: https://via.placeholder.com/150,
|
41
|
-
images: ["https://via.placeholder.com/150"],
|
42
|
-
custom_metadata: {"Top Pick":true},
|
43
|
-
published: true
|
44
|
-
)
|
45
|
-
```
|
46
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationships
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **items** | [**CatalogVariantCreateQueryAsSubResourceRelationshipsItems**](CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md) | | [optional] |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationships.new(
|
15
|
-
items: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItems
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**Array<CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner>**](CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md) | | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItems.new(
|
15
|
-
data: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,20 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **String** | | |
|
8
|
-
| **id** | **String** | | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'klaviyo-api-sdk'
|
14
|
-
|
15
|
-
instance = KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.new(
|
16
|
-
type: null,
|
17
|
-
id: null
|
18
|
-
)
|
19
|
-
```
|
20
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantDeleteJobCreateQuery
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**CatalogVariantDeleteJobCreateQueryAsSubResource**](CatalogVariantDeleteJobCreateQueryAsSubResource.md) | | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogVariantDeleteJobCreateQuery.new(
|
15
|
-
data: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,20 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantDeleteJobCreateQueryAsSubResource
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **String** | | |
|
8
|
-
| **attributes** | [**CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes**](CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md) | | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'klaviyo-api-sdk'
|
14
|
-
|
15
|
-
instance = KlaviyoAPI::CatalogVariantDeleteJobCreateQueryAsSubResource.new(
|
16
|
-
type: null,
|
17
|
-
attributes: null
|
18
|
-
)
|
19
|
-
```
|
20
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **variants** | [**Array<CatalogVariantDeleteQueryAsSubResource>**](CatalogVariantDeleteQueryAsSubResource.md) | Array of catalog variants to delete. | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.new(
|
15
|
-
variants: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,20 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantDeleteQueryAsSubResource
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **String** | | |
|
8
|
-
| **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`. | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'klaviyo-api-sdk'
|
14
|
-
|
15
|
-
instance = KlaviyoAPI::CatalogVariantDeleteQueryAsSubResource.new(
|
16
|
-
type: null,
|
17
|
-
id: $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM
|
18
|
-
)
|
19
|
-
```
|
20
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantUpdateJobCreateQuery
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**CatalogVariantUpdateJobCreateQueryAsSubResource**](CatalogVariantUpdateJobCreateQueryAsSubResource.md) | | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogVariantUpdateJobCreateQuery.new(
|
15
|
-
data: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,20 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantUpdateJobCreateQueryAsSubResource
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **String** | | |
|
8
|
-
| **attributes** | [**CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes**](CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md) | | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'klaviyo-api-sdk'
|
14
|
-
|
15
|
-
instance = KlaviyoAPI::CatalogVariantUpdateJobCreateQueryAsSubResource.new(
|
16
|
-
type: null,
|
17
|
-
attributes: null
|
18
|
-
)
|
19
|
-
```
|
20
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **variants** | [**Array<CatalogVariantUpdateQueryAsSubResource>**](CatalogVariantUpdateQueryAsSubResource.md) | Array of catalog variants to update. | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.new(
|
15
|
-
variants: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantUpdateQuery
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**CatalogVariantUpdateQueryAsSubResource**](CatalogVariantUpdateQueryAsSubResource.md) | | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'klaviyo-api-sdk'
|
13
|
-
|
14
|
-
instance = KlaviyoAPI::CatalogVariantUpdateQuery.new(
|
15
|
-
data: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,22 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantUpdateQueryAsSubResource
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **String** | | |
|
8
|
-
| **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`. | |
|
9
|
-
| **attributes** | [**CatalogVariantUpdateQueryAsSubResourceAttributes**](CatalogVariantUpdateQueryAsSubResourceAttributes.md) | | |
|
10
|
-
|
11
|
-
## Example
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'klaviyo-api-sdk'
|
15
|
-
|
16
|
-
instance = KlaviyoAPI::CatalogVariantUpdateQueryAsSubResource.new(
|
17
|
-
type: null,
|
18
|
-
id: $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
|
19
|
-
attributes: null
|
20
|
-
)
|
21
|
-
```
|
22
|
-
|
@@ -1,38 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::CatalogVariantUpdateQueryAsSubResourceAttributes
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **title** | **String** | The title of the catalog item variant. | [optional] |
|
8
|
-
| **description** | **String** | A description of the catalog item variant. | [optional] |
|
9
|
-
| **inventory_policy** | **Integer** | This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity. | [optional] |
|
10
|
-
| **inventory_quantity** | **Float** | The quantity of the catalog item variant currently in stock. | [optional] |
|
11
|
-
| **price** | **Float** | This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item). | [optional] |
|
12
|
-
| **url** | **String** | URL pointing to the location of the catalog item variant on your website. | [optional] |
|
13
|
-
| **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item variant. | [optional] |
|
14
|
-
| **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item variant. | [optional] |
|
15
|
-
| **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item variant. | [optional] |
|
16
|
-
| **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb. | [optional] |
|
17
|
-
| **published** | **Boolean** | Boolean value indicating whether the catalog item variant is published. | [optional] |
|
18
|
-
|
19
|
-
## Example
|
20
|
-
|
21
|
-
```ruby
|
22
|
-
require 'klaviyo-api-sdk'
|
23
|
-
|
24
|
-
instance = KlaviyoAPI::CatalogVariantUpdateQueryAsSubResourceAttributes.new(
|
25
|
-
title: Ocean Blue Shirt (Sample) Variant Medium,
|
26
|
-
description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
|
27
|
-
inventory_policy: 2,
|
28
|
-
inventory_quantity: 25,
|
29
|
-
price: 42,
|
30
|
-
url: https://via.placeholder.com/150,
|
31
|
-
image_full_url: https://via.placeholder.com/300,
|
32
|
-
image_thumbnail_url: https://via.placeholder.com/150,
|
33
|
-
images: ["https://via.placeholder.com/150"],
|
34
|
-
custom_metadata: {"Top Pick":true},
|
35
|
-
published: true
|
36
|
-
)
|
37
|
-
```
|
38
|
-
|