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
data/README.md
CHANGED
@@ -1,12 +1,12 @@
|
|
1
1
|
# Klaviyo Ruby SDK
|
2
2
|
|
3
|
-
- SDK version:
|
4
|
-
- API revision: 2023-
|
3
|
+
- SDK version: 3.0.0
|
4
|
+
- API revision: 2023-06-15
|
5
5
|
|
6
6
|
## Helpful Resources
|
7
7
|
|
8
|
-
- [API Reference](https://developers.klaviyo.com/en/v2023-
|
9
|
-
- [API Guides](https://developers.klaviyo.com/en/v2023-
|
8
|
+
- [API Reference](https://developers.klaviyo.com/en/v2023-06-15/reference)
|
9
|
+
- [API Guides](https://developers.klaviyo.com/en/v2023-06-15/docs)
|
10
10
|
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)
|
11
11
|
|
12
12
|
## Design & Approach
|
@@ -19,15 +19,15 @@ This SDK is organized into the following resources:
|
|
19
19
|
|
20
20
|
|
21
21
|
|
22
|
-
-
|
22
|
+
- Accounts
|
23
23
|
|
24
24
|
|
25
25
|
|
26
|
-
-
|
26
|
+
- Campaigns
|
27
27
|
|
28
28
|
|
29
29
|
|
30
|
-
-
|
30
|
+
- Catalogs
|
31
31
|
|
32
32
|
|
33
33
|
|
@@ -68,10 +68,10 @@ This SDK is organized into the following resources:
|
|
68
68
|
|
69
69
|
|
70
70
|
|
71
|
-
|
71
|
+
## Installation
|
72
72
|
|
73
73
|
|
74
|
-
|
74
|
+
### Build
|
75
75
|
|
76
76
|
To build the Ruby code into a gem:
|
77
77
|
|
@@ -82,13 +82,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
82
82
|
Then install the gem locally:
|
83
83
|
|
84
84
|
```shell
|
85
|
-
gem install ./klaviyo-api-sdk-
|
85
|
+
gem install ./klaviyo-api-sdk-3.0.0.gem
|
86
86
|
```
|
87
87
|
|
88
88
|
|
89
89
|
Finally add this to the Gemfile:
|
90
90
|
|
91
|
-
gem 'klaviyo-api-sdk', '~>
|
91
|
+
gem 'klaviyo-api-sdk', '~> 3.0.0'
|
92
92
|
|
93
93
|
To install directly from rubygems:
|
94
94
|
|
@@ -96,7 +96,7 @@ To install directly from rubygems:
|
|
96
96
|
gem install klaviyo-api-sdk
|
97
97
|
```
|
98
98
|
|
99
|
-
|
99
|
+
## Usage Example
|
100
100
|
|
101
101
|
### To load the gem
|
102
102
|
|
@@ -132,7 +132,7 @@ begin
|
|
132
132
|
end
|
133
133
|
```
|
134
134
|
|
135
|
-
|
135
|
+
## Error Handling
|
136
136
|
|
137
137
|
This SDK throws an `ApiException` error when the server returns a non-`2XX` response.
|
138
138
|
```ruby
|
@@ -143,25 +143,19 @@ rescue KlaviyoAPI::ApiError => e
|
|
143
143
|
end
|
144
144
|
```
|
145
145
|
|
146
|
-
# Comprehensive list of Operations & Parameters
|
147
|
-
|
148
|
-
_**NOTE:**_
|
149
|
-
- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2023-02-22/reference/get_events).
|
150
|
-
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
151
|
-
- Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.
|
152
|
-
|
153
146
|
## Method signatures
|
154
147
|
- `get` operations can be passed an optional `opts` object (e.g. `get_list_profiles(opts)`).
|
155
148
|
`opts` describes the available options for fetching data (some operations only support a subset of these or none).
|
156
149
|
i.e.
|
157
150
|
```ruby
|
158
151
|
opts = {
|
159
|
-
include: ['variants'],
|
160
|
-
sort: '-created',
|
161
|
-
filter: 'equals(published,false)',
|
162
|
-
page_cursor: 'page_cursor_example',
|
163
|
-
fields_catalog_item: ['external_id','title'],
|
164
|
-
fields_catalog_variant: ['external_id','title']
|
152
|
+
include: ['variants'], # includes
|
153
|
+
sort: '-created', # sorting
|
154
|
+
filter: 'equals(published,false)', # filters
|
155
|
+
page_cursor: 'page_cursor_example', # cursor pagination
|
156
|
+
fields_catalog_item: ['external_id','title'], # sparse fieldset
|
157
|
+
fields_catalog_variant: ['external_id','title'], # sparse fieldset
|
158
|
+
additional_fields_profile: ['predictive_analytics'], # for endpoints that support predictive analytics such as `get_profile`
|
165
159
|
}
|
166
160
|
```
|
167
161
|
**Note, for parameters that use square brackets such as `page[cursor]` or `fields[catalog-item]` ruby will replace the square brackets `[]` with `_` underscores.
|
@@ -184,6 +178,304 @@ body = {
|
|
184
178
|
KlaviyoAPI::Catalogs.create_catalog_item(body)
|
185
179
|
```
|
186
180
|
|
181
|
+
## Optional Parameters and Json Api Features
|
182
|
+
|
183
|
+
Here we will go over
|
184
|
+
|
185
|
+
- Pagination
|
186
|
+
- Page size
|
187
|
+
- Additional Fields
|
188
|
+
- Filtering
|
189
|
+
- Sparse Fields
|
190
|
+
- Sorting
|
191
|
+
- Relationships
|
192
|
+
|
193
|
+
### Quick rule
|
194
|
+
|
195
|
+
As a reminder, the optional parameters are named slightly different from how you would make the call without the SDK docs, query parameter names have variables that make bad Ruby names like
|
196
|
+
`page[cursor]` are transformed to `page_cursor`.
|
197
|
+
|
198
|
+
### Cursor based Pagination
|
199
|
+
|
200
|
+
All the endpoints that return list of results use cursor base pagination.
|
201
|
+
|
202
|
+
Obtain the cursor value from the call you want to get the next page for, then pass it under the `page_cursor` optional parameter. The page cursor looks like `WzE2NDA5OTUyMDAsICIzYzRjeXdGTndadyIsIHRydWVd`.
|
203
|
+
|
204
|
+
If you were using the api directly you would pass the cursor like:
|
205
|
+
|
206
|
+
```
|
207
|
+
https://a.klaviyo.com/api/profiles/?page[cursor]=WzE2NTcyMTM4NjQsICIzc042NjRyeHo0ciIsIHRydWVd
|
208
|
+
```
|
209
|
+
|
210
|
+
The same call in the sdk the call would look like this:
|
211
|
+
|
212
|
+
```ruby
|
213
|
+
opts = {
|
214
|
+
page_cursor: 'WzE2NTcyMTM4NjQsICIzc042NjRyeHo0ciIsIHRydWVd',
|
215
|
+
}
|
216
|
+
|
217
|
+
response = KlaviyoAPI::Profiles.get_profiles(opts)
|
218
|
+
```
|
219
|
+
|
220
|
+
You get the cursor for the next page from `response[:links][:next]` returns the entire url of the next call but the sdk will accept the entire link and use only the relevant cursor.
|
221
|
+
|
222
|
+
Here is an example of getting the second next and passing in the page cursor:
|
223
|
+
|
224
|
+
```ruby
|
225
|
+
opts = {
|
226
|
+
page_cursor: response[:links][:next], # previous response
|
227
|
+
}
|
228
|
+
|
229
|
+
response = KlaviyoAPI::Profiles.get_profiles(opts)
|
230
|
+
```
|
231
|
+
|
232
|
+
There are more page cursors than just next, check the endpoint's docs or the response type but often there is `first`, `last`, `next` and `prev`.
|
233
|
+
|
234
|
+
### Page Size
|
235
|
+
Some endpoint you can get a larger or smaller page size by using the `page_size` parameter.
|
236
|
+
|
237
|
+
if you were hitting the api directly this would look like
|
238
|
+
|
239
|
+
```
|
240
|
+
https://a.klaviyo.com/api/profiles/?page[size]=20
|
241
|
+
```
|
242
|
+
|
243
|
+
In the SDK this looks like:
|
244
|
+
|
245
|
+
```ruby
|
246
|
+
opts = {
|
247
|
+
page_size: 20,
|
248
|
+
}
|
249
|
+
|
250
|
+
response = KlaviyoAPI::Profiles.get_profiles(opts)
|
251
|
+
```
|
252
|
+
|
253
|
+
### Additional Fields
|
254
|
+
|
255
|
+
Additional fields are used to populate part of the response that would be null otherwise.
|
256
|
+
For the `getProfile` endpoint you can pass in a request to get the predictive analytics of the profile. Using the `additional_fields` parameter often will change the rate limit of the endpoint so be sure to keep an eye on your usage.
|
257
|
+
|
258
|
+
The url would look like:
|
259
|
+
```
|
260
|
+
https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/?additional-fields[profile]=predictive_analytics
|
261
|
+
```
|
262
|
+
|
263
|
+
The SDK equivalent is:
|
264
|
+
|
265
|
+
```ruby
|
266
|
+
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
|
267
|
+
opts = {
|
268
|
+
additional_fields_profile: ["predictive_analytics"]
|
269
|
+
}
|
270
|
+
|
271
|
+
response = KlaviyoAPI::Profiles.get_profile(profile_id, opts)
|
272
|
+
|
273
|
+
# If your profile has enough information for predictive analytis it will populate
|
274
|
+
pp(response[:data][:attributes][:predictive_analytics])
|
275
|
+
```
|
276
|
+
|
277
|
+
### Filtering
|
278
|
+
|
279
|
+
Filter by passing the filter as a string as under the optional parameter `filter`.
|
280
|
+
|
281
|
+
Read more about formatting your filter strings in our [developer documentation](https://developers.klaviyo.com/en/v2023-02-22/docs/filtering_)
|
282
|
+
|
283
|
+
Here is an example of a filter string for results between two date times: `less-than(updated,2023-04-26T00:00:00Z),greater-than(updated,2023-04-19T00:00:00Z)`
|
284
|
+
|
285
|
+
Here is a code example filter for profiles with the matching emails:
|
286
|
+
|
287
|
+
```
|
288
|
+
https://a.klaviyo.com/api/profiles/?filter=any(email,["henry.chan@klaviyo-demo.com","amanda.das@klaviyo-demo.com"]
|
289
|
+
```
|
290
|
+
For the sdk:
|
291
|
+
```ruby
|
292
|
+
opts = {
|
293
|
+
filter: 'any(email,["henry.chan@klaviyo-demo.com","amanda.das@klaviyo-demo.com"])'
|
294
|
+
}
|
295
|
+
|
296
|
+
response = KlaviyoAPI::Profiles.get_profiles(opts)
|
297
|
+
```
|
298
|
+
|
299
|
+
### Sparse Fields
|
300
|
+
|
301
|
+
If you only want a specific subset of data from a specific query you can use sparse fields to request only the specific properties.
|
302
|
+
The SDK expands the optional sparse fields into their own option, where you can pass a list of the desired items to include.
|
303
|
+
|
304
|
+
To get a list of event properties the URL your would use is:
|
305
|
+
```
|
306
|
+
https://a.klaviyo.com/api/events/?fields[event]=event_properties
|
307
|
+
```
|
308
|
+
|
309
|
+
In the SDK you would use
|
310
|
+
|
311
|
+
```ruby
|
312
|
+
opts = {
|
313
|
+
fields_event: ["event_properties"]
|
314
|
+
}
|
315
|
+
|
316
|
+
response = KlaviyoAPI::Events.get_events(opts)
|
317
|
+
```
|
318
|
+
|
319
|
+
### Sorting
|
320
|
+
|
321
|
+
Your can request the results of specific endpoints to be ordered by a given parameter. The direction of the sort can swapped by adding a `-` in front of the sort key.
|
322
|
+
For example `datetime` will be ascending while `-datetime` will be descending.
|
323
|
+
|
324
|
+
If you are unsure about the available sort fields you can always check the documentation for the endpoint you are using.
|
325
|
+
For a comprehensive list that links to the documentation for each function check the Endpoints section below.
|
326
|
+
|
327
|
+
Get events sorted by oldest to newest datetime.
|
328
|
+
```
|
329
|
+
https://a.klaviyo.com/api/events/?sort=-datetime
|
330
|
+
```
|
331
|
+
and via the sdk
|
332
|
+
|
333
|
+
```ruby
|
334
|
+
opts = {
|
335
|
+
sort: '-datetime'
|
336
|
+
}
|
337
|
+
|
338
|
+
response = KlaviyoAPI::Events.get_events(opts)
|
339
|
+
```
|
340
|
+
|
341
|
+
### Includes
|
342
|
+
|
343
|
+
How to add additional information to your API response via additional-fields and the `includes` parameter.
|
344
|
+
This allows you to get information about two or more objects from a single api call.
|
345
|
+
Using the `includes` parameter often changes the rate limit of the endpoint so be sure to take note.
|
346
|
+
|
347
|
+
Using the URl to get profile information and the information about the lists the profile is in:
|
348
|
+
|
349
|
+
```
|
350
|
+
https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/?include=lists
|
351
|
+
```
|
352
|
+
|
353
|
+
In the sdk:
|
354
|
+
|
355
|
+
```ruby
|
356
|
+
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
|
357
|
+
opts = {
|
358
|
+
include: ["lists"]
|
359
|
+
}
|
360
|
+
|
361
|
+
response = KlaviyoAPI::Profiles.get_profile(profile_id,opts)
|
362
|
+
|
363
|
+
# Profile information is accessed the same way with
|
364
|
+
pp(response[:data])
|
365
|
+
# Lists related to the profile with be accessible via the included array
|
366
|
+
pp(response[:included])
|
367
|
+
```
|
368
|
+
|
369
|
+
*Note about sparse fields and relationships:* you can request only specific fields of the included object as well.
|
370
|
+
|
371
|
+
```ruby
|
372
|
+
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
|
373
|
+
opts = {
|
374
|
+
fields_list: ["name"],
|
375
|
+
include: ["lists"]
|
376
|
+
}
|
377
|
+
|
378
|
+
response = KlaviyoAPI::Profiles.get_profile(profile_id,opts)
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
# Profile information is accessed the same way with
|
383
|
+
pp(response[:data])
|
384
|
+
# Lists related to the profile with be accessible via the included array
|
385
|
+
pp(response[:included])
|
386
|
+
```
|
387
|
+
|
388
|
+
### Relationships
|
389
|
+
|
390
|
+
The Klaviyo Api has a series of endpoints to expose the relationships between your different Klaviyo Items. You can read more about relationships in [our documentation](https://developers.klaviyo.com/en/v2023-02-22/docs/relationships_).
|
391
|
+
|
392
|
+
Here are some use cases and their examples:
|
393
|
+
|
394
|
+
How to get the list memberships for a profile with the given profile ID.
|
395
|
+
|
396
|
+
Via the URL:
|
397
|
+
|
398
|
+
```
|
399
|
+
https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/relationships/lists/
|
400
|
+
```
|
401
|
+
|
402
|
+
and for the SDK:
|
403
|
+
|
404
|
+
```ruby
|
405
|
+
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
|
406
|
+
|
407
|
+
response = KlaviyoAPI::Profiles.get_profile_relationships_lists(profile_id)
|
408
|
+
```
|
409
|
+
|
410
|
+
For another example:
|
411
|
+
|
412
|
+
Get all campaigns associated with the given `tag_id`.
|
413
|
+
|
414
|
+
the URL:
|
415
|
+
|
416
|
+
```
|
417
|
+
https://a.klaviyo.com/api/tags/9c8db7a0-5ab5-4e3c-9a37-a3224fd14382/relationships/campaigns/
|
418
|
+
```
|
419
|
+
|
420
|
+
Through the SDK:
|
421
|
+
|
422
|
+
```ruby
|
423
|
+
tag_id = '9c8db7a0-5ab5-4e3c-9a37-a3224fd14382'
|
424
|
+
|
425
|
+
response = KlaviyoAPI::Tags.get_tag_relationships_campaigns(tag_id)
|
426
|
+
```
|
427
|
+
### Combining
|
428
|
+
|
429
|
+
You can use any combination of the features outlines above in conjunction with one another.
|
430
|
+
|
431
|
+
#### Get events associated with a specific metric, then return just the event properties sorted by oldest to newest datetime.
|
432
|
+
|
433
|
+
```
|
434
|
+
https://a.klaviyo.com/api/events/?fields[event]=event_properties&filter=equals(metric_id,"URDbLg")&sort=-datetime
|
435
|
+
```
|
436
|
+
or
|
437
|
+
```ruby
|
438
|
+
opts = {
|
439
|
+
filter: 'equals(metric_id,"URDbLg")',
|
440
|
+
fields_event: ["event_properties"]
|
441
|
+
}
|
442
|
+
|
443
|
+
response = KlaviyoAPI::Events.get_events(opts)
|
444
|
+
```
|
445
|
+
|
446
|
+
|
447
|
+
## Comprehensive list of Operations & Parameters
|
448
|
+
|
449
|
+
_**NOTE:**_
|
450
|
+
- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2023-06-15/reference/get_events).
|
451
|
+
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
452
|
+
- Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.
|
453
|
+
|
454
|
+
|
455
|
+
|
456
|
+
|
457
|
+
|
458
|
+
|
459
|
+
## Accounts
|
460
|
+
|
461
|
+
|
462
|
+
#### [Get Account](https://developers.klaviyo.com/en/v2023-06-15/reference/get_account)
|
463
|
+
|
464
|
+
```ruby
|
465
|
+
KlaviyoAPI::Accounts.get_account(id, opts)
|
466
|
+
```
|
467
|
+
|
468
|
+
|
469
|
+
|
470
|
+
|
471
|
+
|
472
|
+
#### [Get Accounts](https://developers.klaviyo.com/en/v2023-06-15/reference/get_accounts)
|
473
|
+
|
474
|
+
```ruby
|
475
|
+
KlaviyoAPI::Accounts.get_accounts(opts)
|
476
|
+
```
|
477
|
+
|
478
|
+
|
187
479
|
|
188
480
|
|
189
481
|
|
@@ -191,7 +483,7 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
191
483
|
## Campaigns
|
192
484
|
|
193
485
|
|
194
|
-
#### [Create Campaign](https://developers.klaviyo.com/en/v2023-
|
486
|
+
#### [Create Campaign](https://developers.klaviyo.com/en/v2023-06-15/reference/create_campaign)
|
195
487
|
|
196
488
|
```ruby
|
197
489
|
KlaviyoAPI::Campaigns.create_campaign(body)
|
@@ -201,7 +493,7 @@ KlaviyoAPI::Campaigns.create_campaign(body)
|
|
201
493
|
|
202
494
|
|
203
495
|
|
204
|
-
#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2023-
|
496
|
+
#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2023-06-15/reference/create_campaign_clone)
|
205
497
|
|
206
498
|
```ruby
|
207
499
|
KlaviyoAPI::Campaigns.create_campaign_clone(body)
|
@@ -211,7 +503,7 @@ KlaviyoAPI::Campaigns.create_campaign_clone(body)
|
|
211
503
|
|
212
504
|
|
213
505
|
|
214
|
-
#### [
|
506
|
+
#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2023-06-15/reference/create_campaign_message_assign_template)
|
215
507
|
|
216
508
|
```ruby
|
217
509
|
KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
|
@@ -221,7 +513,7 @@ KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
|
|
221
513
|
|
222
514
|
|
223
515
|
|
224
|
-
#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-
|
516
|
+
#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-06-15/reference/create_campaign_recipient_estimation_job)
|
225
517
|
|
226
518
|
```ruby
|
227
519
|
KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
|
@@ -231,7 +523,7 @@ KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
|
|
231
523
|
|
232
524
|
|
233
525
|
|
234
|
-
#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2023-
|
526
|
+
#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2023-06-15/reference/create_campaign_send_job)
|
235
527
|
|
236
528
|
```ruby
|
237
529
|
KlaviyoAPI::Campaigns.create_campaign_send_job(body)
|
@@ -241,7 +533,7 @@ KlaviyoAPI::Campaigns.create_campaign_send_job(body)
|
|
241
533
|
|
242
534
|
|
243
535
|
|
244
|
-
#### [Delete Campaign](https://developers.klaviyo.com/en/v2023-
|
536
|
+
#### [Delete Campaign](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_campaign)
|
245
537
|
|
246
538
|
```ruby
|
247
539
|
KlaviyoAPI::Campaigns.delete_campaign(id)
|
@@ -251,7 +543,7 @@ KlaviyoAPI::Campaigns.delete_campaign(id)
|
|
251
543
|
|
252
544
|
|
253
545
|
|
254
|
-
#### [Get Campaign](https://developers.klaviyo.com/en/v2023-
|
546
|
+
#### [Get Campaign](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign)
|
255
547
|
|
256
548
|
```ruby
|
257
549
|
KlaviyoAPI::Campaigns.get_campaign(id, opts)
|
@@ -261,7 +553,7 @@ KlaviyoAPI::Campaigns.get_campaign(id, opts)
|
|
261
553
|
|
262
554
|
|
263
555
|
|
264
|
-
#### [Get Campaign Message](https://developers.klaviyo.com/en/v2023-
|
556
|
+
#### [Get Campaign Message](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign_message)
|
265
557
|
|
266
558
|
```ruby
|
267
559
|
KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
|
@@ -271,7 +563,7 @@ KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
|
|
271
563
|
|
272
564
|
|
273
565
|
|
274
|
-
#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2023-
|
566
|
+
#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign_recipient_estimation)
|
275
567
|
|
276
568
|
```ruby
|
277
569
|
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
|
@@ -281,7 +573,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
|
|
281
573
|
|
282
574
|
|
283
575
|
|
284
|
-
#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-
|
576
|
+
#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign_recipient_estimation_job)
|
285
577
|
|
286
578
|
```ruby
|
287
579
|
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
|
@@ -291,17 +583,17 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
|
|
291
583
|
|
292
584
|
|
293
585
|
|
294
|
-
#### [Get Campaign Relationships](https://developers.klaviyo.com/en/v2023-
|
586
|
+
#### [Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign_relationships_tags)
|
295
587
|
|
296
588
|
```ruby
|
297
|
-
KlaviyoAPI::Campaigns.
|
589
|
+
KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
|
298
590
|
```
|
299
591
|
|
300
592
|
|
301
593
|
|
302
594
|
|
303
595
|
|
304
|
-
#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2023-
|
596
|
+
#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign_send_job)
|
305
597
|
|
306
598
|
```ruby
|
307
599
|
KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
@@ -311,17 +603,17 @@ KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
|
311
603
|
|
312
604
|
|
313
605
|
|
314
|
-
#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2023-
|
606
|
+
#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign_tags)
|
315
607
|
|
316
608
|
```ruby
|
317
|
-
KlaviyoAPI::Campaigns.get_campaign_tags(
|
609
|
+
KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
|
318
610
|
```
|
319
611
|
|
320
612
|
|
321
613
|
|
322
614
|
|
323
615
|
|
324
|
-
#### [Get Campaigns](https://developers.klaviyo.com/en/v2023-
|
616
|
+
#### [Get Campaigns](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaigns)
|
325
617
|
|
326
618
|
```ruby
|
327
619
|
KlaviyoAPI::Campaigns.get_campaigns(opts)
|
@@ -331,7 +623,7 @@ KlaviyoAPI::Campaigns.get_campaigns(opts)
|
|
331
623
|
|
332
624
|
|
333
625
|
|
334
|
-
#### [Update Campaign](https://developers.klaviyo.com/en/v2023-
|
626
|
+
#### [Update Campaign](https://developers.klaviyo.com/en/v2023-06-15/reference/update_campaign)
|
335
627
|
|
336
628
|
```ruby
|
337
629
|
KlaviyoAPI::Campaigns.update_campaign(id, body)
|
@@ -341,7 +633,7 @@ KlaviyoAPI::Campaigns.update_campaign(id, body)
|
|
341
633
|
|
342
634
|
|
343
635
|
|
344
|
-
#### [Update Campaign Message](https://developers.klaviyo.com/en/v2023-
|
636
|
+
#### [Update Campaign Message](https://developers.klaviyo.com/en/v2023-06-15/reference/update_campaign_message)
|
345
637
|
|
346
638
|
```ruby
|
347
639
|
KlaviyoAPI::Campaigns.update_campaign_message(id, body)
|
@@ -351,7 +643,7 @@ KlaviyoAPI::Campaigns.update_campaign_message(id, body)
|
|
351
643
|
|
352
644
|
|
353
645
|
|
354
|
-
#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2023-
|
646
|
+
#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2023-06-15/reference/update_campaign_send_job)
|
355
647
|
|
356
648
|
```ruby
|
357
649
|
KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
|
@@ -365,7 +657,7 @@ KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
|
|
365
657
|
## Catalogs
|
366
658
|
|
367
659
|
|
368
|
-
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2023-
|
660
|
+
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2023-06-15/reference/create_catalog_category)
|
369
661
|
|
370
662
|
```ruby
|
371
663
|
KlaviyoAPI::Catalogs.create_catalog_category(body)
|
@@ -375,17 +667,17 @@ KlaviyoAPI::Catalogs.create_catalog_category(body)
|
|
375
667
|
|
376
668
|
|
377
669
|
|
378
|
-
#### [Create Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-
|
670
|
+
#### [Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-06-15/reference/create_catalog_category_relationships_items)
|
379
671
|
|
380
672
|
```ruby
|
381
|
-
KlaviyoAPI::Catalogs.
|
673
|
+
KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
|
382
674
|
```
|
383
675
|
|
384
676
|
|
385
677
|
|
386
678
|
|
387
679
|
|
388
|
-
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2023-
|
680
|
+
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2023-06-15/reference/create_catalog_item)
|
389
681
|
|
390
682
|
```ruby
|
391
683
|
KlaviyoAPI::Catalogs.create_catalog_item(body)
|
@@ -395,17 +687,17 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
395
687
|
|
396
688
|
|
397
689
|
|
398
|
-
#### [Create Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-
|
690
|
+
#### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-06-15/reference/create_catalog_item_relationships_categories)
|
399
691
|
|
400
692
|
```ruby
|
401
|
-
KlaviyoAPI::Catalogs.
|
693
|
+
KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
|
402
694
|
```
|
403
695
|
|
404
696
|
|
405
697
|
|
406
698
|
|
407
699
|
|
408
|
-
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2023-
|
700
|
+
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2023-06-15/reference/create_catalog_variant)
|
409
701
|
|
410
702
|
```ruby
|
411
703
|
KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
@@ -415,7 +707,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
|
415
707
|
|
416
708
|
|
417
709
|
|
418
|
-
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2023-
|
710
|
+
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_catalog_category)
|
419
711
|
|
420
712
|
```ruby
|
421
713
|
KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
@@ -425,17 +717,17 @@ KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
|
425
717
|
|
426
718
|
|
427
719
|
|
428
|
-
#### [Delete Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-
|
720
|
+
#### [Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_catalog_category_relationships_items)
|
429
721
|
|
430
722
|
```ruby
|
431
|
-
KlaviyoAPI::Catalogs.
|
723
|
+
KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
|
432
724
|
```
|
433
725
|
|
434
726
|
|
435
727
|
|
436
728
|
|
437
729
|
|
438
|
-
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2023-
|
730
|
+
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_catalog_item)
|
439
731
|
|
440
732
|
```ruby
|
441
733
|
KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
@@ -445,17 +737,17 @@ KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
|
445
737
|
|
446
738
|
|
447
739
|
|
448
|
-
#### [Delete Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-
|
740
|
+
#### [Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_catalog_item_relationships_categories)
|
449
741
|
|
450
742
|
```ruby
|
451
|
-
KlaviyoAPI::Catalogs.
|
743
|
+
KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
|
452
744
|
```
|
453
745
|
|
454
746
|
|
455
747
|
|
456
748
|
|
457
749
|
|
458
|
-
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-
|
750
|
+
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_catalog_variant)
|
459
751
|
|
460
752
|
```ruby
|
461
753
|
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
@@ -465,7 +757,7 @@ KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
|
465
757
|
|
466
758
|
|
467
759
|
|
468
|
-
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2023-
|
760
|
+
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_categories)
|
469
761
|
|
470
762
|
```ruby
|
471
763
|
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
@@ -475,7 +767,7 @@ KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
|
475
767
|
|
476
768
|
|
477
769
|
|
478
|
-
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2023-
|
770
|
+
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_category)
|
479
771
|
|
480
772
|
```ruby
|
481
773
|
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
@@ -485,27 +777,27 @@ KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
|
485
777
|
|
486
778
|
|
487
779
|
|
488
|
-
#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-
|
780
|
+
#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_category_items)
|
489
781
|
|
490
782
|
```ruby
|
491
|
-
KlaviyoAPI::Catalogs.get_catalog_category_items(
|
783
|
+
KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts)
|
492
784
|
```
|
493
785
|
|
494
786
|
|
495
787
|
|
496
788
|
|
497
789
|
|
498
|
-
#### [Get Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-
|
790
|
+
#### [Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_category_relationships_items)
|
499
791
|
|
500
792
|
```ruby
|
501
|
-
KlaviyoAPI::Catalogs.
|
793
|
+
KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
|
502
794
|
```
|
503
795
|
|
504
796
|
|
505
797
|
|
506
798
|
|
507
799
|
|
508
|
-
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2023-
|
800
|
+
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_item)
|
509
801
|
|
510
802
|
```ruby
|
511
803
|
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
@@ -515,37 +807,37 @@ KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
|
515
807
|
|
516
808
|
|
517
809
|
|
518
|
-
#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-
|
810
|
+
#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_item_categories)
|
519
811
|
|
520
812
|
```ruby
|
521
|
-
KlaviyoAPI::Catalogs.get_catalog_item_categories(
|
813
|
+
KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts)
|
522
814
|
```
|
523
815
|
|
524
816
|
|
525
817
|
|
526
818
|
|
527
819
|
|
528
|
-
#### [Get Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-
|
820
|
+
#### [Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_item_relationships_categories)
|
529
821
|
|
530
822
|
```ruby
|
531
|
-
KlaviyoAPI::Catalogs.
|
823
|
+
KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
|
532
824
|
```
|
533
825
|
|
534
826
|
|
535
827
|
|
536
828
|
|
537
829
|
|
538
|
-
#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-
|
830
|
+
#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_item_variants)
|
539
831
|
|
540
832
|
```ruby
|
541
|
-
KlaviyoAPI::Catalogs.get_catalog_item_variants(
|
833
|
+
KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts)
|
542
834
|
```
|
543
835
|
|
544
836
|
|
545
837
|
|
546
838
|
|
547
839
|
|
548
|
-
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2023-
|
840
|
+
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_items)
|
549
841
|
|
550
842
|
```ruby
|
551
843
|
KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
@@ -555,7 +847,7 @@ KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
|
555
847
|
|
556
848
|
|
557
849
|
|
558
|
-
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2023-
|
850
|
+
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_variant)
|
559
851
|
|
560
852
|
```ruby
|
561
853
|
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
@@ -565,7 +857,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
|
565
857
|
|
566
858
|
|
567
859
|
|
568
|
-
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2023-
|
860
|
+
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_variants)
|
569
861
|
|
570
862
|
```ruby
|
571
863
|
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
@@ -575,7 +867,7 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
|
575
867
|
|
576
868
|
|
577
869
|
|
578
|
-
#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2023-
|
870
|
+
#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_create_categories_job)
|
579
871
|
|
580
872
|
```ruby
|
581
873
|
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
@@ -585,7 +877,7 @@ KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
|
585
877
|
|
586
878
|
|
587
879
|
|
588
|
-
#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-
|
880
|
+
#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_create_categories_jobs)
|
589
881
|
|
590
882
|
```ruby
|
591
883
|
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
@@ -595,7 +887,7 @@ KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
|
595
887
|
|
596
888
|
|
597
889
|
|
598
|
-
#### [Get Create Items Job](https://developers.klaviyo.com/en/v2023-
|
890
|
+
#### [Get Create Items Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_create_items_job)
|
599
891
|
|
600
892
|
```ruby
|
601
893
|
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
@@ -605,7 +897,7 @@ KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
|
605
897
|
|
606
898
|
|
607
899
|
|
608
|
-
#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-
|
900
|
+
#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_create_items_jobs)
|
609
901
|
|
610
902
|
```ruby
|
611
903
|
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
@@ -615,7 +907,7 @@ KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
|
615
907
|
|
616
908
|
|
617
909
|
|
618
|
-
#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2023-
|
910
|
+
#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_create_variants_job)
|
619
911
|
|
620
912
|
```ruby
|
621
913
|
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
@@ -625,7 +917,7 @@ KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
|
625
917
|
|
626
918
|
|
627
919
|
|
628
|
-
#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-
|
920
|
+
#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_create_variants_jobs)
|
629
921
|
|
630
922
|
```ruby
|
631
923
|
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
@@ -635,7 +927,7 @@ KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
|
635
927
|
|
636
928
|
|
637
929
|
|
638
|
-
#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-
|
930
|
+
#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_delete_categories_job)
|
639
931
|
|
640
932
|
```ruby
|
641
933
|
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
@@ -645,7 +937,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
|
645
937
|
|
646
938
|
|
647
939
|
|
648
|
-
#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-
|
940
|
+
#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_delete_categories_jobs)
|
649
941
|
|
650
942
|
```ruby
|
651
943
|
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
@@ -655,7 +947,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
|
655
947
|
|
656
948
|
|
657
949
|
|
658
|
-
#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2023-
|
950
|
+
#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_delete_items_job)
|
659
951
|
|
660
952
|
```ruby
|
661
953
|
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
@@ -665,7 +957,7 @@ KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
|
665
957
|
|
666
958
|
|
667
959
|
|
668
|
-
#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-
|
960
|
+
#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_delete_items_jobs)
|
669
961
|
|
670
962
|
```ruby
|
671
963
|
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
@@ -675,7 +967,7 @@ KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
|
675
967
|
|
676
968
|
|
677
969
|
|
678
|
-
#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-
|
970
|
+
#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_delete_variants_job)
|
679
971
|
|
680
972
|
```ruby
|
681
973
|
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
@@ -685,7 +977,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
|
685
977
|
|
686
978
|
|
687
979
|
|
688
|
-
#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-
|
980
|
+
#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_delete_variants_jobs)
|
689
981
|
|
690
982
|
```ruby
|
691
983
|
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
@@ -695,7 +987,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
|
695
987
|
|
696
988
|
|
697
989
|
|
698
|
-
#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2023-
|
990
|
+
#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_update_categories_job)
|
699
991
|
|
700
992
|
```ruby
|
701
993
|
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
@@ -705,7 +997,7 @@ KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
|
705
997
|
|
706
998
|
|
707
999
|
|
708
|
-
#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-
|
1000
|
+
#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_update_categories_jobs)
|
709
1001
|
|
710
1002
|
```ruby
|
711
1003
|
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
@@ -715,7 +1007,7 @@ KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
|
715
1007
|
|
716
1008
|
|
717
1009
|
|
718
|
-
#### [Get Update Items Job](https://developers.klaviyo.com/en/v2023-
|
1010
|
+
#### [Get Update Items Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_update_items_job)
|
719
1011
|
|
720
1012
|
```ruby
|
721
1013
|
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
@@ -725,7 +1017,7 @@ KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
|
725
1017
|
|
726
1018
|
|
727
1019
|
|
728
|
-
#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-
|
1020
|
+
#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_update_items_jobs)
|
729
1021
|
|
730
1022
|
```ruby
|
731
1023
|
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
@@ -735,7 +1027,7 @@ KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
|
735
1027
|
|
736
1028
|
|
737
1029
|
|
738
|
-
#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2023-
|
1030
|
+
#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_update_variants_job)
|
739
1031
|
|
740
1032
|
```ruby
|
741
1033
|
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
@@ -745,7 +1037,7 @@ KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
|
745
1037
|
|
746
1038
|
|
747
1039
|
|
748
|
-
#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-
|
1040
|
+
#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_update_variants_jobs)
|
749
1041
|
|
750
1042
|
```ruby
|
751
1043
|
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
@@ -755,7 +1047,7 @@ KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
|
755
1047
|
|
756
1048
|
|
757
1049
|
|
758
|
-
#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-
|
1050
|
+
#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_create_categories_job)
|
759
1051
|
|
760
1052
|
```ruby
|
761
1053
|
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
@@ -765,7 +1057,7 @@ KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
|
765
1057
|
|
766
1058
|
|
767
1059
|
|
768
|
-
#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-
|
1060
|
+
#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_create_items_job)
|
769
1061
|
|
770
1062
|
```ruby
|
771
1063
|
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
@@ -775,7 +1067,7 @@ KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
|
775
1067
|
|
776
1068
|
|
777
1069
|
|
778
|
-
#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-
|
1070
|
+
#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_create_variants_job)
|
779
1071
|
|
780
1072
|
```ruby
|
781
1073
|
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
@@ -785,7 +1077,7 @@ KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
|
785
1077
|
|
786
1078
|
|
787
1079
|
|
788
|
-
#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-
|
1080
|
+
#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_delete_categories_job)
|
789
1081
|
|
790
1082
|
```ruby
|
791
1083
|
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
@@ -795,7 +1087,7 @@ KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
|
795
1087
|
|
796
1088
|
|
797
1089
|
|
798
|
-
#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-
|
1090
|
+
#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_delete_items_job)
|
799
1091
|
|
800
1092
|
```ruby
|
801
1093
|
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
@@ -805,7 +1097,7 @@ KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
|
805
1097
|
|
806
1098
|
|
807
1099
|
|
808
|
-
#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-
|
1100
|
+
#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_delete_variants_job)
|
809
1101
|
|
810
1102
|
```ruby
|
811
1103
|
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
@@ -815,7 +1107,7 @@ KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
|
815
1107
|
|
816
1108
|
|
817
1109
|
|
818
|
-
#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-
|
1110
|
+
#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_update_categories_job)
|
819
1111
|
|
820
1112
|
```ruby
|
821
1113
|
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
@@ -825,7 +1117,7 @@ KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
|
825
1117
|
|
826
1118
|
|
827
1119
|
|
828
|
-
#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-
|
1120
|
+
#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_update_items_job)
|
829
1121
|
|
830
1122
|
```ruby
|
831
1123
|
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
@@ -835,7 +1127,7 @@ KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
|
835
1127
|
|
836
1128
|
|
837
1129
|
|
838
|
-
#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-
|
1130
|
+
#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_update_variants_job)
|
839
1131
|
|
840
1132
|
```ruby
|
841
1133
|
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
@@ -845,7 +1137,7 @@ KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
|
845
1137
|
|
846
1138
|
|
847
1139
|
|
848
|
-
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2023-
|
1140
|
+
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2023-06-15/reference/update_catalog_category)
|
849
1141
|
|
850
1142
|
```ruby
|
851
1143
|
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
@@ -855,17 +1147,17 @@ KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
|
855
1147
|
|
856
1148
|
|
857
1149
|
|
858
|
-
#### [Update Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-
|
1150
|
+
#### [Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-06-15/reference/update_catalog_category_relationships_items)
|
859
1151
|
|
860
1152
|
```ruby
|
861
|
-
KlaviyoAPI::Catalogs.
|
1153
|
+
KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
|
862
1154
|
```
|
863
1155
|
|
864
1156
|
|
865
1157
|
|
866
1158
|
|
867
1159
|
|
868
|
-
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2023-
|
1160
|
+
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2023-06-15/reference/update_catalog_item)
|
869
1161
|
|
870
1162
|
```ruby
|
871
1163
|
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
@@ -875,17 +1167,17 @@ KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
|
875
1167
|
|
876
1168
|
|
877
1169
|
|
878
|
-
#### [Update Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-
|
1170
|
+
#### [Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-06-15/reference/update_catalog_item_relationships_categories)
|
879
1171
|
|
880
1172
|
```ruby
|
881
|
-
KlaviyoAPI::Catalogs.
|
1173
|
+
KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
|
882
1174
|
```
|
883
1175
|
|
884
1176
|
|
885
1177
|
|
886
1178
|
|
887
1179
|
|
888
|
-
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2023-
|
1180
|
+
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2023-06-15/reference/update_catalog_variant)
|
889
1181
|
|
890
1182
|
```ruby
|
891
1183
|
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
@@ -896,232 +1188,228 @@ KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
|
896
1188
|
|
897
1189
|
|
898
1190
|
|
899
|
-
##
|
1191
|
+
## Data Privacy
|
900
1192
|
|
901
1193
|
|
902
|
-
#### [
|
1194
|
+
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2023-06-15/reference/request_profile_deletion)
|
903
1195
|
|
904
1196
|
```ruby
|
905
|
-
KlaviyoAPI::
|
1197
|
+
KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
|
906
1198
|
```
|
907
1199
|
|
908
1200
|
|
909
1201
|
|
910
1202
|
|
911
1203
|
|
912
|
-
|
1204
|
+
|
1205
|
+
## Events
|
1206
|
+
|
1207
|
+
|
1208
|
+
#### [Create Event](https://developers.klaviyo.com/en/v2023-06-15/reference/create_event)
|
913
1209
|
|
914
1210
|
```ruby
|
915
|
-
KlaviyoAPI::
|
1211
|
+
KlaviyoAPI::Events.create_event(body)
|
916
1212
|
```
|
917
1213
|
|
918
1214
|
|
919
1215
|
|
920
1216
|
|
921
1217
|
|
922
|
-
#### [
|
1218
|
+
#### [Get Event](https://developers.klaviyo.com/en/v2023-06-15/reference/get_event)
|
923
1219
|
|
924
1220
|
```ruby
|
925
|
-
KlaviyoAPI::
|
1221
|
+
KlaviyoAPI::Events.get_event(id, opts)
|
926
1222
|
```
|
927
1223
|
|
928
1224
|
|
929
1225
|
|
930
1226
|
|
931
1227
|
|
932
|
-
|
933
|
-
## Data Privacy
|
934
|
-
|
935
|
-
|
936
|
-
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2023-02-22/reference/request_profile_deletion)
|
1228
|
+
#### [Get Event Metrics](https://developers.klaviyo.com/en/v2023-06-15/reference/get_event_metrics)
|
937
1229
|
|
938
1230
|
```ruby
|
939
|
-
KlaviyoAPI::
|
1231
|
+
KlaviyoAPI::Events.get_event_metrics(id, opts)
|
940
1232
|
```
|
941
1233
|
|
942
1234
|
|
943
1235
|
|
944
1236
|
|
945
1237
|
|
946
|
-
|
947
|
-
## Events
|
948
|
-
|
949
|
-
|
950
|
-
#### [Create Event](https://developers.klaviyo.com/en/v2023-02-22/reference/create_event)
|
1238
|
+
#### [Get Event Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_event_profiles)
|
951
1239
|
|
952
1240
|
```ruby
|
953
|
-
KlaviyoAPI::Events.
|
1241
|
+
KlaviyoAPI::Events.get_event_profiles(id, opts)
|
954
1242
|
```
|
955
1243
|
|
956
1244
|
|
957
1245
|
|
958
1246
|
|
959
1247
|
|
960
|
-
#### [Get Event](https://developers.klaviyo.com/en/v2023-
|
1248
|
+
#### [Get Event Relationships Metrics](https://developers.klaviyo.com/en/v2023-06-15/reference/get_event_relationships_metrics)
|
961
1249
|
|
962
1250
|
```ruby
|
963
|
-
KlaviyoAPI::Events.
|
1251
|
+
KlaviyoAPI::Events.get_event_relationships_metrics(id)
|
964
1252
|
```
|
965
1253
|
|
966
1254
|
|
967
1255
|
|
968
1256
|
|
969
1257
|
|
970
|
-
#### [Get Event
|
1258
|
+
#### [Get Event Relationships Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_event_relationships_profiles)
|
971
1259
|
|
972
1260
|
```ruby
|
973
|
-
KlaviyoAPI::Events.
|
1261
|
+
KlaviyoAPI::Events.get_event_relationships_profiles(id)
|
974
1262
|
```
|
975
1263
|
|
976
1264
|
|
977
1265
|
|
978
1266
|
|
979
1267
|
|
980
|
-
#### [Get
|
1268
|
+
#### [Get Events](https://developers.klaviyo.com/en/v2023-06-15/reference/get_events)
|
981
1269
|
|
982
1270
|
```ruby
|
983
|
-
KlaviyoAPI::Events.
|
1271
|
+
KlaviyoAPI::Events.get_events(opts)
|
984
1272
|
```
|
985
1273
|
|
986
1274
|
|
987
1275
|
|
988
1276
|
|
989
1277
|
|
990
|
-
|
1278
|
+
|
1279
|
+
## Flows
|
1280
|
+
|
1281
|
+
|
1282
|
+
#### [Get Flow](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow)
|
991
1283
|
|
992
1284
|
```ruby
|
993
|
-
KlaviyoAPI::
|
1285
|
+
KlaviyoAPI::Flows.get_flow(id, opts)
|
994
1286
|
```
|
995
1287
|
|
996
1288
|
|
997
1289
|
|
998
1290
|
|
999
1291
|
|
1000
|
-
#### [Get
|
1292
|
+
#### [Get Flow Action](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_action)
|
1001
1293
|
|
1002
1294
|
```ruby
|
1003
|
-
KlaviyoAPI::
|
1295
|
+
KlaviyoAPI::Flows.get_flow_action(id, opts)
|
1004
1296
|
```
|
1005
1297
|
|
1006
1298
|
|
1007
1299
|
|
1008
1300
|
|
1009
1301
|
|
1010
|
-
|
1011
|
-
## Flows
|
1012
|
-
|
1013
|
-
|
1014
|
-
#### [Get Flow](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow)
|
1302
|
+
#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_action_flow)
|
1015
1303
|
|
1016
1304
|
```ruby
|
1017
|
-
KlaviyoAPI::Flows.
|
1305
|
+
KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
|
1018
1306
|
```
|
1019
1307
|
|
1020
1308
|
|
1021
1309
|
|
1022
1310
|
|
1023
1311
|
|
1024
|
-
#### [Get Flow Action](https://developers.klaviyo.com/en/v2023-
|
1312
|
+
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_action_messages)
|
1025
1313
|
|
1026
1314
|
```ruby
|
1027
|
-
KlaviyoAPI::Flows.
|
1315
|
+
KlaviyoAPI::Flows.get_flow_action_messages(id, opts)
|
1028
1316
|
```
|
1029
1317
|
|
1030
1318
|
|
1031
1319
|
|
1032
1320
|
|
1033
1321
|
|
1034
|
-
#### [Get Flow
|
1322
|
+
#### [Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_action_relationships_flow)
|
1035
1323
|
|
1036
1324
|
```ruby
|
1037
|
-
KlaviyoAPI::Flows.
|
1325
|
+
KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
|
1038
1326
|
```
|
1039
1327
|
|
1040
1328
|
|
1041
1329
|
|
1042
1330
|
|
1043
1331
|
|
1044
|
-
#### [Get
|
1332
|
+
#### [Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_action_relationships_messages)
|
1045
1333
|
|
1046
1334
|
```ruby
|
1047
|
-
KlaviyoAPI::Flows.
|
1335
|
+
KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
|
1048
1336
|
```
|
1049
1337
|
|
1050
1338
|
|
1051
1339
|
|
1052
1340
|
|
1053
1341
|
|
1054
|
-
#### [Get Flow
|
1342
|
+
#### [Get Flow Actions For Flow](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_flow_actions)
|
1055
1343
|
|
1056
1344
|
```ruby
|
1057
|
-
KlaviyoAPI::Flows.
|
1345
|
+
KlaviyoAPI::Flows.get_flow_flow_actions(id, opts)
|
1058
1346
|
```
|
1059
1347
|
|
1060
1348
|
|
1061
1349
|
|
1062
1350
|
|
1063
1351
|
|
1064
|
-
#### [Get Flow
|
1352
|
+
#### [Get Flow Message](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_message)
|
1065
1353
|
|
1066
1354
|
```ruby
|
1067
|
-
KlaviyoAPI::Flows.
|
1355
|
+
KlaviyoAPI::Flows.get_flow_message(id, opts)
|
1068
1356
|
```
|
1069
1357
|
|
1070
1358
|
|
1071
1359
|
|
1072
1360
|
|
1073
1361
|
|
1074
|
-
#### [Get Flow Message](https://developers.klaviyo.com/en/v2023-
|
1362
|
+
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_message_action)
|
1075
1363
|
|
1076
1364
|
```ruby
|
1077
|
-
KlaviyoAPI::Flows.
|
1365
|
+
KlaviyoAPI::Flows.get_flow_message_action(id, opts)
|
1078
1366
|
```
|
1079
1367
|
|
1080
1368
|
|
1081
1369
|
|
1082
1370
|
|
1083
1371
|
|
1084
|
-
#### [Get Flow
|
1372
|
+
#### [Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_message_relationships_action)
|
1085
1373
|
|
1086
1374
|
```ruby
|
1087
|
-
KlaviyoAPI::Flows.
|
1375
|
+
KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
|
1088
1376
|
```
|
1089
1377
|
|
1090
1378
|
|
1091
1379
|
|
1092
1380
|
|
1093
1381
|
|
1094
|
-
#### [Get Flow
|
1382
|
+
#### [Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_relationships_flow_actions)
|
1095
1383
|
|
1096
1384
|
```ruby
|
1097
|
-
KlaviyoAPI::Flows.
|
1385
|
+
KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts)
|
1098
1386
|
```
|
1099
1387
|
|
1100
1388
|
|
1101
1389
|
|
1102
1390
|
|
1103
1391
|
|
1104
|
-
#### [Get Flow Relationships](https://developers.klaviyo.com/en/v2023-
|
1392
|
+
#### [Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_relationships_tags)
|
1105
1393
|
|
1106
1394
|
```ruby
|
1107
|
-
KlaviyoAPI::Flows.
|
1395
|
+
KlaviyoAPI::Flows.get_flow_relationships_tags(id)
|
1108
1396
|
```
|
1109
1397
|
|
1110
1398
|
|
1111
1399
|
|
1112
1400
|
|
1113
1401
|
|
1114
|
-
#### [Get Flow Tags](https://developers.klaviyo.com/en/v2023-
|
1402
|
+
#### [Get Flow Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_tags)
|
1115
1403
|
|
1116
1404
|
```ruby
|
1117
|
-
KlaviyoAPI::Flows.get_flow_tags(
|
1405
|
+
KlaviyoAPI::Flows.get_flow_tags(id, opts)
|
1118
1406
|
```
|
1119
1407
|
|
1120
1408
|
|
1121
1409
|
|
1122
1410
|
|
1123
1411
|
|
1124
|
-
#### [Get Flows](https://developers.klaviyo.com/en/v2023-
|
1412
|
+
#### [Get Flows](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flows)
|
1125
1413
|
|
1126
1414
|
```ruby
|
1127
1415
|
KlaviyoAPI::Flows.get_flows(opts)
|
@@ -1131,7 +1419,7 @@ KlaviyoAPI::Flows.get_flows(opts)
|
|
1131
1419
|
|
1132
1420
|
|
1133
1421
|
|
1134
|
-
#### [Update Flow Status](https://developers.klaviyo.com/en/v2023-
|
1422
|
+
#### [Update Flow Status](https://developers.klaviyo.com/en/v2023-06-15/reference/update_flow)
|
1135
1423
|
|
1136
1424
|
```ruby
|
1137
1425
|
KlaviyoAPI::Flows.update_flow(id, body)
|
@@ -1145,7 +1433,7 @@ KlaviyoAPI::Flows.update_flow(id, body)
|
|
1145
1433
|
## Lists
|
1146
1434
|
|
1147
1435
|
|
1148
|
-
#### [Create List](https://developers.klaviyo.com/en/v2023-
|
1436
|
+
#### [Create List](https://developers.klaviyo.com/en/v2023-06-15/reference/create_list)
|
1149
1437
|
|
1150
1438
|
```ruby
|
1151
1439
|
KlaviyoAPI::Lists.create_list(body)
|
@@ -1155,17 +1443,17 @@ KlaviyoAPI::Lists.create_list(body)
|
|
1155
1443
|
|
1156
1444
|
|
1157
1445
|
|
1158
|
-
#### [Add Profile
|
1446
|
+
#### [Add Profile To List](https://developers.klaviyo.com/en/v2023-06-15/reference/create_list_relationships)
|
1159
1447
|
|
1160
1448
|
```ruby
|
1161
|
-
KlaviyoAPI::Lists.create_list_relationships(id,
|
1449
|
+
KlaviyoAPI::Lists.create_list_relationships(id, body)
|
1162
1450
|
```
|
1163
1451
|
|
1164
1452
|
|
1165
1453
|
|
1166
1454
|
|
1167
1455
|
|
1168
|
-
#### [Delete List](https://developers.klaviyo.com/en/v2023-
|
1456
|
+
#### [Delete List](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_list)
|
1169
1457
|
|
1170
1458
|
```ruby
|
1171
1459
|
KlaviyoAPI::Lists.delete_list(id)
|
@@ -1175,17 +1463,17 @@ KlaviyoAPI::Lists.delete_list(id)
|
|
1175
1463
|
|
1176
1464
|
|
1177
1465
|
|
1178
|
-
#### [Remove Profile
|
1466
|
+
#### [Remove Profile From List](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_list_relationships)
|
1179
1467
|
|
1180
1468
|
```ruby
|
1181
|
-
KlaviyoAPI::Lists.delete_list_relationships(id,
|
1469
|
+
KlaviyoAPI::Lists.delete_list_relationships(id, body)
|
1182
1470
|
```
|
1183
1471
|
|
1184
1472
|
|
1185
1473
|
|
1186
1474
|
|
1187
1475
|
|
1188
|
-
#### [Get List](https://developers.klaviyo.com/en/v2023-
|
1476
|
+
#### [Get List](https://developers.klaviyo.com/en/v2023-06-15/reference/get_list)
|
1189
1477
|
|
1190
1478
|
```ruby
|
1191
1479
|
KlaviyoAPI::Lists.get_list(id, opts)
|
@@ -1195,37 +1483,47 @@ KlaviyoAPI::Lists.get_list(id, opts)
|
|
1195
1483
|
|
1196
1484
|
|
1197
1485
|
|
1198
|
-
#### [Get List Profiles](https://developers.klaviyo.com/en/v2023-
|
1486
|
+
#### [Get List Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_list_profiles)
|
1199
1487
|
|
1200
1488
|
```ruby
|
1201
|
-
KlaviyoAPI::Lists.get_list_profiles(
|
1489
|
+
KlaviyoAPI::Lists.get_list_profiles(id, opts)
|
1202
1490
|
```
|
1203
1491
|
|
1204
1492
|
|
1205
1493
|
|
1206
1494
|
|
1207
1495
|
|
1208
|
-
#### [Get List Relationships](https://developers.klaviyo.com/en/v2023-
|
1496
|
+
#### [Get List Relationships Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_list_relationships_profiles)
|
1209
1497
|
|
1210
1498
|
```ruby
|
1211
|
-
KlaviyoAPI::Lists.
|
1499
|
+
KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
|
1212
1500
|
```
|
1213
1501
|
|
1214
1502
|
|
1215
1503
|
|
1216
1504
|
|
1217
1505
|
|
1218
|
-
#### [Get List Tags](https://developers.klaviyo.com/en/v2023-
|
1506
|
+
#### [Get List Relationships Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_list_relationships_tags)
|
1219
1507
|
|
1220
1508
|
```ruby
|
1221
|
-
KlaviyoAPI::Lists.
|
1509
|
+
KlaviyoAPI::Lists.get_list_relationships_tags(id)
|
1222
1510
|
```
|
1223
1511
|
|
1224
1512
|
|
1225
1513
|
|
1226
1514
|
|
1227
1515
|
|
1228
|
-
#### [Get
|
1516
|
+
#### [Get List Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_list_tags)
|
1517
|
+
|
1518
|
+
```ruby
|
1519
|
+
KlaviyoAPI::Lists.get_list_tags(id, opts)
|
1520
|
+
```
|
1521
|
+
|
1522
|
+
|
1523
|
+
|
1524
|
+
|
1525
|
+
|
1526
|
+
#### [Get Lists](https://developers.klaviyo.com/en/v2023-06-15/reference/get_lists)
|
1229
1527
|
|
1230
1528
|
```ruby
|
1231
1529
|
KlaviyoAPI::Lists.get_lists(opts)
|
@@ -1235,7 +1533,7 @@ KlaviyoAPI::Lists.get_lists(opts)
|
|
1235
1533
|
|
1236
1534
|
|
1237
1535
|
|
1238
|
-
#### [Update List](https://developers.klaviyo.com/en/v2023-
|
1536
|
+
#### [Update List](https://developers.klaviyo.com/en/v2023-06-15/reference/update_list)
|
1239
1537
|
|
1240
1538
|
```ruby
|
1241
1539
|
KlaviyoAPI::Lists.update_list(id, body)
|
@@ -1249,7 +1547,7 @@ KlaviyoAPI::Lists.update_list(id, body)
|
|
1249
1547
|
## Metrics
|
1250
1548
|
|
1251
1549
|
|
1252
|
-
#### [Get Metric](https://developers.klaviyo.com/en/v2023-
|
1550
|
+
#### [Get Metric](https://developers.klaviyo.com/en/v2023-06-15/reference/get_metric)
|
1253
1551
|
|
1254
1552
|
```ruby
|
1255
1553
|
KlaviyoAPI::Metrics.get_metric(id, opts)
|
@@ -1259,7 +1557,7 @@ KlaviyoAPI::Metrics.get_metric(id, opts)
|
|
1259
1557
|
|
1260
1558
|
|
1261
1559
|
|
1262
|
-
#### [Get Metrics](https://developers.klaviyo.com/en/v2023-
|
1560
|
+
#### [Get Metrics](https://developers.klaviyo.com/en/v2023-06-15/reference/get_metrics)
|
1263
1561
|
|
1264
1562
|
```ruby
|
1265
1563
|
KlaviyoAPI::Metrics.get_metrics(opts)
|
@@ -1269,7 +1567,7 @@ KlaviyoAPI::Metrics.get_metrics(opts)
|
|
1269
1567
|
|
1270
1568
|
|
1271
1569
|
|
1272
|
-
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-
|
1570
|
+
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-06-15/reference/query_metric_aggregates)
|
1273
1571
|
|
1274
1572
|
```ruby
|
1275
1573
|
KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
@@ -1283,7 +1581,7 @@ KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
|
1283
1581
|
## Profiles
|
1284
1582
|
|
1285
1583
|
|
1286
|
-
#### [Create Profile](https://developers.klaviyo.com/en/v2023-
|
1584
|
+
#### [Create Profile](https://developers.klaviyo.com/en/v2023-06-15/reference/create_profile)
|
1287
1585
|
|
1288
1586
|
```ruby
|
1289
1587
|
KlaviyoAPI::Profiles.create_profile(body)
|
@@ -1293,7 +1591,7 @@ KlaviyoAPI::Profiles.create_profile(body)
|
|
1293
1591
|
|
1294
1592
|
|
1295
1593
|
|
1296
|
-
#### [Get Profile](https://developers.klaviyo.com/en/v2023-
|
1594
|
+
#### [Get Profile](https://developers.klaviyo.com/en/v2023-06-15/reference/get_profile)
|
1297
1595
|
|
1298
1596
|
```ruby
|
1299
1597
|
KlaviyoAPI::Profiles.get_profile(id, opts)
|
@@ -1303,37 +1601,47 @@ KlaviyoAPI::Profiles.get_profile(id, opts)
|
|
1303
1601
|
|
1304
1602
|
|
1305
1603
|
|
1306
|
-
#### [Get Profile Lists](https://developers.klaviyo.com/en/v2023-
|
1604
|
+
#### [Get Profile Lists](https://developers.klaviyo.com/en/v2023-06-15/reference/get_profile_lists)
|
1605
|
+
|
1606
|
+
```ruby
|
1607
|
+
KlaviyoAPI::Profiles.get_profile_lists(id, opts)
|
1608
|
+
```
|
1609
|
+
|
1610
|
+
|
1611
|
+
|
1612
|
+
|
1613
|
+
|
1614
|
+
#### [Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2023-06-15/reference/get_profile_relationships_lists)
|
1307
1615
|
|
1308
1616
|
```ruby
|
1309
|
-
KlaviyoAPI::Profiles.
|
1617
|
+
KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
|
1310
1618
|
```
|
1311
1619
|
|
1312
1620
|
|
1313
1621
|
|
1314
1622
|
|
1315
1623
|
|
1316
|
-
#### [Get Profile Relationships](https://developers.klaviyo.com/en/v2023-
|
1624
|
+
#### [Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2023-06-15/reference/get_profile_relationships_segments)
|
1317
1625
|
|
1318
1626
|
```ruby
|
1319
|
-
KlaviyoAPI::Profiles.
|
1627
|
+
KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
|
1320
1628
|
```
|
1321
1629
|
|
1322
1630
|
|
1323
1631
|
|
1324
1632
|
|
1325
1633
|
|
1326
|
-
#### [Get Profile Segments](https://developers.klaviyo.com/en/v2023-
|
1634
|
+
#### [Get Profile Segments](https://developers.klaviyo.com/en/v2023-06-15/reference/get_profile_segments)
|
1327
1635
|
|
1328
1636
|
```ruby
|
1329
|
-
KlaviyoAPI::Profiles.get_profile_segments(
|
1637
|
+
KlaviyoAPI::Profiles.get_profile_segments(id, opts)
|
1330
1638
|
```
|
1331
1639
|
|
1332
1640
|
|
1333
1641
|
|
1334
1642
|
|
1335
1643
|
|
1336
|
-
#### [Get Profiles](https://developers.klaviyo.com/en/v2023-
|
1644
|
+
#### [Get Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_profiles)
|
1337
1645
|
|
1338
1646
|
```ruby
|
1339
1647
|
KlaviyoAPI::Profiles.get_profiles(opts)
|
@@ -1343,7 +1651,7 @@ KlaviyoAPI::Profiles.get_profiles(opts)
|
|
1343
1651
|
|
1344
1652
|
|
1345
1653
|
|
1346
|
-
#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2023-
|
1654
|
+
#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/subscribe_profiles)
|
1347
1655
|
|
1348
1656
|
```ruby
|
1349
1657
|
KlaviyoAPI::Profiles.subscribe_profiles(body)
|
@@ -1353,7 +1661,7 @@ KlaviyoAPI::Profiles.subscribe_profiles(body)
|
|
1353
1661
|
|
1354
1662
|
|
1355
1663
|
|
1356
|
-
#### [Suppress Profiles](https://developers.klaviyo.com/en/v2023-
|
1664
|
+
#### [Suppress Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/suppress_profiles)
|
1357
1665
|
|
1358
1666
|
```ruby
|
1359
1667
|
KlaviyoAPI::Profiles.suppress_profiles(body)
|
@@ -1363,7 +1671,7 @@ KlaviyoAPI::Profiles.suppress_profiles(body)
|
|
1363
1671
|
|
1364
1672
|
|
1365
1673
|
|
1366
|
-
#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-
|
1674
|
+
#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/unsubscribe_profiles)
|
1367
1675
|
|
1368
1676
|
```ruby
|
1369
1677
|
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
@@ -1373,7 +1681,7 @@ KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
|
1373
1681
|
|
1374
1682
|
|
1375
1683
|
|
1376
|
-
#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-
|
1684
|
+
#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/unsuppress_profiles)
|
1377
1685
|
|
1378
1686
|
```ruby
|
1379
1687
|
KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
@@ -1383,7 +1691,7 @@ KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
|
1383
1691
|
|
1384
1692
|
|
1385
1693
|
|
1386
|
-
#### [Update Profile](https://developers.klaviyo.com/en/v2023-
|
1694
|
+
#### [Update Profile](https://developers.klaviyo.com/en/v2023-06-15/reference/update_profile)
|
1387
1695
|
|
1388
1696
|
```ruby
|
1389
1697
|
KlaviyoAPI::Profiles.update_profile(id, body)
|
@@ -1397,7 +1705,7 @@ KlaviyoAPI::Profiles.update_profile(id, body)
|
|
1397
1705
|
## Segments
|
1398
1706
|
|
1399
1707
|
|
1400
|
-
#### [Get Segment](https://developers.klaviyo.com/en/v2023-
|
1708
|
+
#### [Get Segment](https://developers.klaviyo.com/en/v2023-06-15/reference/get_segment)
|
1401
1709
|
|
1402
1710
|
```ruby
|
1403
1711
|
KlaviyoAPI::Segments.get_segment(id, opts)
|
@@ -1407,37 +1715,47 @@ KlaviyoAPI::Segments.get_segment(id, opts)
|
|
1407
1715
|
|
1408
1716
|
|
1409
1717
|
|
1410
|
-
#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2023-
|
1718
|
+
#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_segment_profiles)
|
1719
|
+
|
1720
|
+
```ruby
|
1721
|
+
KlaviyoAPI::Segments.get_segment_profiles(id, opts)
|
1722
|
+
```
|
1723
|
+
|
1724
|
+
|
1725
|
+
|
1726
|
+
|
1727
|
+
|
1728
|
+
#### [Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_segment_relationships_profiles)
|
1411
1729
|
|
1412
1730
|
```ruby
|
1413
|
-
KlaviyoAPI::Segments.
|
1731
|
+
KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
|
1414
1732
|
```
|
1415
1733
|
|
1416
1734
|
|
1417
1735
|
|
1418
1736
|
|
1419
1737
|
|
1420
|
-
#### [Get Segment Relationships](https://developers.klaviyo.com/en/v2023-
|
1738
|
+
#### [Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_segment_relationships_tags)
|
1421
1739
|
|
1422
1740
|
```ruby
|
1423
|
-
KlaviyoAPI::Segments.
|
1741
|
+
KlaviyoAPI::Segments.get_segment_relationships_tags(id)
|
1424
1742
|
```
|
1425
1743
|
|
1426
1744
|
|
1427
1745
|
|
1428
1746
|
|
1429
1747
|
|
1430
|
-
#### [Get Segment Tags](https://developers.klaviyo.com/en/v2023-
|
1748
|
+
#### [Get Segment Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_segment_tags)
|
1431
1749
|
|
1432
1750
|
```ruby
|
1433
|
-
KlaviyoAPI::Segments.get_segment_tags(
|
1751
|
+
KlaviyoAPI::Segments.get_segment_tags(id, opts)
|
1434
1752
|
```
|
1435
1753
|
|
1436
1754
|
|
1437
1755
|
|
1438
1756
|
|
1439
1757
|
|
1440
|
-
#### [Get Segments](https://developers.klaviyo.com/en/v2023-
|
1758
|
+
#### [Get Segments](https://developers.klaviyo.com/en/v2023-06-15/reference/get_segments)
|
1441
1759
|
|
1442
1760
|
```ruby
|
1443
1761
|
KlaviyoAPI::Segments.get_segments(opts)
|
@@ -1447,7 +1765,7 @@ KlaviyoAPI::Segments.get_segments(opts)
|
|
1447
1765
|
|
1448
1766
|
|
1449
1767
|
|
1450
|
-
#### [Update Segment](https://developers.klaviyo.com/en/v2023-
|
1768
|
+
#### [Update Segment](https://developers.klaviyo.com/en/v2023-06-15/reference/update_segment)
|
1451
1769
|
|
1452
1770
|
```ruby
|
1453
1771
|
KlaviyoAPI::Segments.update_segment(id, body)
|
@@ -1461,7 +1779,7 @@ KlaviyoAPI::Segments.update_segment(id, body)
|
|
1461
1779
|
## Tags
|
1462
1780
|
|
1463
1781
|
|
1464
|
-
#### [Create Tag](https://developers.klaviyo.com/en/v2023-
|
1782
|
+
#### [Create Tag](https://developers.klaviyo.com/en/v2023-06-15/reference/create_tag)
|
1465
1783
|
|
1466
1784
|
```ruby
|
1467
1785
|
KlaviyoAPI::Tags.create_tag(body)
|
@@ -1471,7 +1789,7 @@ KlaviyoAPI::Tags.create_tag(body)
|
|
1471
1789
|
|
1472
1790
|
|
1473
1791
|
|
1474
|
-
#### [Create Tag Group](https://developers.klaviyo.com/en/v2023-
|
1792
|
+
#### [Create Tag Group](https://developers.klaviyo.com/en/v2023-06-15/reference/create_tag_group)
|
1475
1793
|
|
1476
1794
|
```ruby
|
1477
1795
|
KlaviyoAPI::Tags.create_tag_group(body)
|
@@ -1481,17 +1799,47 @@ KlaviyoAPI::Tags.create_tag_group(body)
|
|
1481
1799
|
|
1482
1800
|
|
1483
1801
|
|
1484
|
-
#### [Create Tag Relationships](https://developers.klaviyo.com/en/v2023-
|
1802
|
+
#### [Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-06-15/reference/create_tag_relationships_campaigns)
|
1485
1803
|
|
1486
1804
|
```ruby
|
1487
|
-
KlaviyoAPI::Tags.
|
1805
|
+
KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
|
1488
1806
|
```
|
1489
1807
|
|
1490
1808
|
|
1491
1809
|
|
1492
1810
|
|
1493
1811
|
|
1494
|
-
#### [
|
1812
|
+
#### [Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-06-15/reference/create_tag_relationships_flows)
|
1813
|
+
|
1814
|
+
```ruby
|
1815
|
+
KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
|
1816
|
+
```
|
1817
|
+
|
1818
|
+
|
1819
|
+
|
1820
|
+
|
1821
|
+
|
1822
|
+
#### [Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-06-15/reference/create_tag_relationships_lists)
|
1823
|
+
|
1824
|
+
```ruby
|
1825
|
+
KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
|
1826
|
+
```
|
1827
|
+
|
1828
|
+
|
1829
|
+
|
1830
|
+
|
1831
|
+
|
1832
|
+
#### [Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-06-15/reference/create_tag_relationships_segments)
|
1833
|
+
|
1834
|
+
```ruby
|
1835
|
+
KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
|
1836
|
+
```
|
1837
|
+
|
1838
|
+
|
1839
|
+
|
1840
|
+
|
1841
|
+
|
1842
|
+
#### [Delete Tag](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_tag)
|
1495
1843
|
|
1496
1844
|
```ruby
|
1497
1845
|
KlaviyoAPI::Tags.delete_tag(id)
|
@@ -1501,7 +1849,7 @@ KlaviyoAPI::Tags.delete_tag(id)
|
|
1501
1849
|
|
1502
1850
|
|
1503
1851
|
|
1504
|
-
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2023-
|
1852
|
+
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_tag_group)
|
1505
1853
|
|
1506
1854
|
```ruby
|
1507
1855
|
KlaviyoAPI::Tags.delete_tag_group(id)
|
@@ -1511,17 +1859,47 @@ KlaviyoAPI::Tags.delete_tag_group(id)
|
|
1511
1859
|
|
1512
1860
|
|
1513
1861
|
|
1514
|
-
#### [Delete Tag Relationships](https://developers.klaviyo.com/en/v2023-
|
1862
|
+
#### [Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_tag_relationships_campaigns)
|
1863
|
+
|
1864
|
+
```ruby
|
1865
|
+
KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
|
1866
|
+
```
|
1867
|
+
|
1868
|
+
|
1869
|
+
|
1870
|
+
|
1871
|
+
|
1872
|
+
#### [Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_tag_relationships_flows)
|
1873
|
+
|
1874
|
+
```ruby
|
1875
|
+
KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
|
1876
|
+
```
|
1877
|
+
|
1878
|
+
|
1879
|
+
|
1880
|
+
|
1881
|
+
|
1882
|
+
#### [Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_tag_relationships_lists)
|
1883
|
+
|
1884
|
+
```ruby
|
1885
|
+
KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
|
1886
|
+
```
|
1887
|
+
|
1888
|
+
|
1889
|
+
|
1890
|
+
|
1891
|
+
|
1892
|
+
#### [Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_tag_relationships_segments)
|
1515
1893
|
|
1516
1894
|
```ruby
|
1517
|
-
KlaviyoAPI::Tags.
|
1895
|
+
KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
|
1518
1896
|
```
|
1519
1897
|
|
1520
1898
|
|
1521
1899
|
|
1522
1900
|
|
1523
1901
|
|
1524
|
-
#### [Get Tag](https://developers.klaviyo.com/en/v2023-
|
1902
|
+
#### [Get Tag](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag)
|
1525
1903
|
|
1526
1904
|
```ruby
|
1527
1905
|
KlaviyoAPI::Tags.get_tag(id, opts)
|
@@ -1531,7 +1909,7 @@ KlaviyoAPI::Tags.get_tag(id, opts)
|
|
1531
1909
|
|
1532
1910
|
|
1533
1911
|
|
1534
|
-
#### [Get Tag Group](https://developers.klaviyo.com/en/v2023-
|
1912
|
+
#### [Get Tag Group](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_group)
|
1535
1913
|
|
1536
1914
|
```ruby
|
1537
1915
|
KlaviyoAPI::Tags.get_tag_group(id, opts)
|
@@ -1541,17 +1919,17 @@ KlaviyoAPI::Tags.get_tag_group(id, opts)
|
|
1541
1919
|
|
1542
1920
|
|
1543
1921
|
|
1544
|
-
#### [Get Tag Group Relationships](https://developers.klaviyo.com/en/v2023-
|
1922
|
+
#### [Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_group_relationships_tags)
|
1545
1923
|
|
1546
1924
|
```ruby
|
1547
|
-
KlaviyoAPI::Tags.
|
1925
|
+
KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
|
1548
1926
|
```
|
1549
1927
|
|
1550
1928
|
|
1551
1929
|
|
1552
1930
|
|
1553
1931
|
|
1554
|
-
#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-
|
1932
|
+
#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_group_tags)
|
1555
1933
|
|
1556
1934
|
```ruby
|
1557
1935
|
KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
|
@@ -1561,7 +1939,7 @@ KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
|
|
1561
1939
|
|
1562
1940
|
|
1563
1941
|
|
1564
|
-
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2023-
|
1942
|
+
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_groups)
|
1565
1943
|
|
1566
1944
|
```ruby
|
1567
1945
|
KlaviyoAPI::Tags.get_tag_groups(opts)
|
@@ -1571,17 +1949,57 @@ KlaviyoAPI::Tags.get_tag_groups(opts)
|
|
1571
1949
|
|
1572
1950
|
|
1573
1951
|
|
1574
|
-
#### [Get Tag Relationships](https://developers.klaviyo.com/en/v2023-
|
1952
|
+
#### [Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_relationships_campaigns)
|
1575
1953
|
|
1576
1954
|
```ruby
|
1577
|
-
KlaviyoAPI::Tags.
|
1955
|
+
KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
|
1578
1956
|
```
|
1579
1957
|
|
1580
1958
|
|
1581
1959
|
|
1582
1960
|
|
1583
1961
|
|
1584
|
-
#### [Get Tag
|
1962
|
+
#### [Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_relationships_flows)
|
1963
|
+
|
1964
|
+
```ruby
|
1965
|
+
KlaviyoAPI::Tags.get_tag_relationships_flows(id)
|
1966
|
+
```
|
1967
|
+
|
1968
|
+
|
1969
|
+
|
1970
|
+
|
1971
|
+
|
1972
|
+
#### [Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_relationships_lists)
|
1973
|
+
|
1974
|
+
```ruby
|
1975
|
+
KlaviyoAPI::Tags.get_tag_relationships_lists(id)
|
1976
|
+
```
|
1977
|
+
|
1978
|
+
|
1979
|
+
|
1980
|
+
|
1981
|
+
|
1982
|
+
#### [Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_relationships_segments)
|
1983
|
+
|
1984
|
+
```ruby
|
1985
|
+
KlaviyoAPI::Tags.get_tag_relationships_segments(id)
|
1986
|
+
```
|
1987
|
+
|
1988
|
+
|
1989
|
+
|
1990
|
+
|
1991
|
+
|
1992
|
+
#### [Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_relationships_tag_group)
|
1993
|
+
|
1994
|
+
```ruby
|
1995
|
+
KlaviyoAPI::Tags.get_tag_relationships_tag_group(id)
|
1996
|
+
```
|
1997
|
+
|
1998
|
+
|
1999
|
+
|
2000
|
+
|
2001
|
+
|
2002
|
+
#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_tag_group)
|
1585
2003
|
|
1586
2004
|
```ruby
|
1587
2005
|
KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
|
@@ -1591,7 +2009,7 @@ KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
|
|
1591
2009
|
|
1592
2010
|
|
1593
2011
|
|
1594
|
-
#### [Get Tags](https://developers.klaviyo.com/en/v2023-
|
2012
|
+
#### [Get Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tags)
|
1595
2013
|
|
1596
2014
|
```ruby
|
1597
2015
|
KlaviyoAPI::Tags.get_tags(opts)
|
@@ -1601,7 +2019,7 @@ KlaviyoAPI::Tags.get_tags(opts)
|
|
1601
2019
|
|
1602
2020
|
|
1603
2021
|
|
1604
|
-
#### [Update Tag](https://developers.klaviyo.com/en/v2023-
|
2022
|
+
#### [Update Tag](https://developers.klaviyo.com/en/v2023-06-15/reference/update_tag)
|
1605
2023
|
|
1606
2024
|
```ruby
|
1607
2025
|
KlaviyoAPI::Tags.update_tag(id, body)
|
@@ -1611,7 +2029,7 @@ KlaviyoAPI::Tags.update_tag(id, body)
|
|
1611
2029
|
|
1612
2030
|
|
1613
2031
|
|
1614
|
-
#### [Update Tag Group](https://developers.klaviyo.com/en/v2023-
|
2032
|
+
#### [Update Tag Group](https://developers.klaviyo.com/en/v2023-06-15/reference/update_tag_group)
|
1615
2033
|
|
1616
2034
|
```ruby
|
1617
2035
|
KlaviyoAPI::Tags.update_tag_group(id, body)
|
@@ -1625,7 +2043,7 @@ KlaviyoAPI::Tags.update_tag_group(id, body)
|
|
1625
2043
|
## Templates
|
1626
2044
|
|
1627
2045
|
|
1628
|
-
#### [Create Template](https://developers.klaviyo.com/en/v2023-
|
2046
|
+
#### [Create Template](https://developers.klaviyo.com/en/v2023-06-15/reference/create_template)
|
1629
2047
|
|
1630
2048
|
```ruby
|
1631
2049
|
KlaviyoAPI::Templates.create_template(body)
|
@@ -1635,7 +2053,7 @@ KlaviyoAPI::Templates.create_template(body)
|
|
1635
2053
|
|
1636
2054
|
|
1637
2055
|
|
1638
|
-
#### [Create Template Clone](https://developers.klaviyo.com/en/v2023-
|
2056
|
+
#### [Create Template Clone](https://developers.klaviyo.com/en/v2023-06-15/reference/create_template_clone)
|
1639
2057
|
|
1640
2058
|
```ruby
|
1641
2059
|
KlaviyoAPI::Templates.create_template_clone(body)
|
@@ -1645,7 +2063,7 @@ KlaviyoAPI::Templates.create_template_clone(body)
|
|
1645
2063
|
|
1646
2064
|
|
1647
2065
|
|
1648
|
-
#### [Create Template Render](https://developers.klaviyo.com/en/v2023-
|
2066
|
+
#### [Create Template Render](https://developers.klaviyo.com/en/v2023-06-15/reference/create_template_render)
|
1649
2067
|
|
1650
2068
|
```ruby
|
1651
2069
|
KlaviyoAPI::Templates.create_template_render(body)
|
@@ -1655,7 +2073,7 @@ KlaviyoAPI::Templates.create_template_render(body)
|
|
1655
2073
|
|
1656
2074
|
|
1657
2075
|
|
1658
|
-
#### [Delete Template](https://developers.klaviyo.com/en/v2023-
|
2076
|
+
#### [Delete Template](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_template)
|
1659
2077
|
|
1660
2078
|
```ruby
|
1661
2079
|
KlaviyoAPI::Templates.delete_template(id)
|
@@ -1665,7 +2083,7 @@ KlaviyoAPI::Templates.delete_template(id)
|
|
1665
2083
|
|
1666
2084
|
|
1667
2085
|
|
1668
|
-
#### [Get Template](https://developers.klaviyo.com/en/v2023-
|
2086
|
+
#### [Get Template](https://developers.klaviyo.com/en/v2023-06-15/reference/get_template)
|
1669
2087
|
|
1670
2088
|
```ruby
|
1671
2089
|
KlaviyoAPI::Templates.get_template(id, opts)
|
@@ -1675,7 +2093,7 @@ KlaviyoAPI::Templates.get_template(id, opts)
|
|
1675
2093
|
|
1676
2094
|
|
1677
2095
|
|
1678
|
-
#### [Get Templates](https://developers.klaviyo.com/en/v2023-
|
2096
|
+
#### [Get Templates](https://developers.klaviyo.com/en/v2023-06-15/reference/get_templates)
|
1679
2097
|
|
1680
2098
|
```ruby
|
1681
2099
|
KlaviyoAPI::Templates.get_templates(opts)
|
@@ -1685,7 +2103,7 @@ KlaviyoAPI::Templates.get_templates(opts)
|
|
1685
2103
|
|
1686
2104
|
|
1687
2105
|
|
1688
|
-
#### [Update Template](https://developers.klaviyo.com/en/v2023-
|
2106
|
+
#### [Update Template](https://developers.klaviyo.com/en/v2023-06-15/reference/update_template)
|
1689
2107
|
|
1690
2108
|
```ruby
|
1691
2109
|
KlaviyoAPI::Templates.update_template(id, body)
|
@@ -1699,12 +2117,10 @@ KlaviyoAPI::Templates.update_template(id, body)
|
|
1699
2117
|
|
1700
2118
|
## Per Request API key
|
1701
2119
|
```ruby
|
1702
|
-
|
2120
|
+
response = KlaviyoAPI::Catalogs.get_catalog_items({
|
1703
2121
|
header_params: {
|
1704
2122
|
'Authorization': 'Klaviyo-API-Key your-api-key',
|
1705
2123
|
},
|
1706
2124
|
debug_auth_names: []
|
1707
|
-
}
|
1708
|
-
|
1709
|
-
response = KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
2125
|
+
})
|
1710
2126
|
```
|