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
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2023-
|
6
|
+
The version of the OpenAPI document: 2023-06-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -20,7 +20,7 @@ module KlaviyoAPI
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Create Tag
|
23
|
-
# Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If the `tag_group_id` is not specified, the tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
23
|
+
# Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If the `tag_group_id` is not specified, the tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
24
24
|
# @param tag_create_query [TagCreateQuery]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [Hash<String, Object>]
|
@@ -30,7 +30,7 @@ module KlaviyoAPI
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Create Tag
|
33
|
-
# Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If the `tag_group_id` is not specified, the tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
33
|
+
# Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If the `tag_group_id` is not specified, the tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
34
34
|
# @param tag_create_query [TagCreateQuery]
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -51,7 +51,7 @@ module KlaviyoAPI
|
|
51
51
|
# header parameters
|
52
52
|
header_params = opts[:header_params] || {}
|
53
53
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
54
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
55
55
|
# HTTP header 'Accept' (if needed)
|
56
56
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
57
|
# HTTP header 'Content-Type'
|
@@ -90,7 +90,7 @@ module KlaviyoAPI
|
|
90
90
|
end
|
91
91
|
|
92
92
|
# Create Tag Group
|
93
|
-
# Create a tag group. An account cannot have more than **50** unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
93
|
+
# Create a tag group. An account cannot have more than **50** unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
94
94
|
# @param tag_group_create_query [TagGroupCreateQuery]
|
95
95
|
# @param [Hash] opts the optional parameters
|
96
96
|
# @return [Hash<String, Object>]
|
@@ -100,7 +100,7 @@ module KlaviyoAPI
|
|
100
100
|
end
|
101
101
|
|
102
102
|
# Create Tag Group
|
103
|
-
# Create a tag group. An account cannot have more than **50** unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
103
|
+
# Create a tag group. An account cannot have more than **50** unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
104
104
|
# @param tag_group_create_query [TagGroupCreateQuery]
|
105
105
|
# @param [Hash] opts the optional parameters
|
106
106
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -121,7 +121,7 @@ module KlaviyoAPI
|
|
121
121
|
# header parameters
|
122
122
|
header_params = opts[:header_params] || {}
|
123
123
|
# klaviyo api revision
|
124
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
124
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
125
125
|
# HTTP header 'Accept' (if needed)
|
126
126
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
127
127
|
# HTTP header 'Content-Type'
|
@@ -159,48 +159,699 @@ module KlaviyoAPI
|
|
159
159
|
return data, status_code, headers
|
160
160
|
end
|
161
161
|
|
162
|
-
# Create Tag Relationships
|
163
|
-
# Associate a tag with
|
162
|
+
# Create Tag Relationships Campaigns
|
163
|
+
# Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write`
|
164
|
+
# @param id [String]
|
165
|
+
# @param tag_campaign_op [TagCampaignOp]
|
166
|
+
# @param [Hash] opts the optional parameters
|
167
|
+
# @return [nil]
|
168
|
+
def create_tag_relationships_campaigns(id, tag_campaign_op, opts = {})
|
169
|
+
create_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts)
|
170
|
+
nil
|
171
|
+
end
|
172
|
+
|
173
|
+
# Create Tag Relationships Campaigns
|
174
|
+
# Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write`
|
175
|
+
# @param id [String]
|
176
|
+
# @param tag_campaign_op [TagCampaignOp]
|
177
|
+
# @param [Hash] opts the optional parameters
|
178
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
179
|
+
def create_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts = {})
|
180
|
+
if @api_client.config.debugging
|
181
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.create_tag_relationships_campaigns ...'
|
182
|
+
end
|
183
|
+
# verify the required parameter 'id' is set
|
184
|
+
if @api_client.config.client_side_validation && id.nil?
|
185
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.create_tag_relationships_campaigns"
|
186
|
+
end
|
187
|
+
# verify the required parameter 'tag_campaign_op' is set
|
188
|
+
if @api_client.config.client_side_validation && tag_campaign_op.nil?
|
189
|
+
fail ArgumentError, "Missing the required parameter 'tag_campaign_op' when calling TagsApi.create_tag_relationships_campaigns"
|
190
|
+
end
|
191
|
+
# resource path
|
192
|
+
local_var_path = '/api/tags/{id}/relationships/campaigns/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
193
|
+
|
194
|
+
# query parameters
|
195
|
+
query_params = opts[:query_params] || {}
|
196
|
+
|
197
|
+
# header parameters
|
198
|
+
header_params = opts[:header_params] || {}
|
199
|
+
# klaviyo api revision
|
200
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
201
|
+
# HTTP header 'Accept' (if needed)
|
202
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
203
|
+
# HTTP header 'Content-Type'
|
204
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
205
|
+
if !content_type.nil?
|
206
|
+
header_params['Content-Type'] = content_type
|
207
|
+
end
|
208
|
+
|
209
|
+
# form parameters
|
210
|
+
form_params = opts[:form_params] || {}
|
211
|
+
|
212
|
+
# http body (model)
|
213
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_campaign_op)
|
214
|
+
|
215
|
+
# return_type
|
216
|
+
return_type = opts[:debug_return_type]
|
217
|
+
|
218
|
+
# auth_names
|
219
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
220
|
+
|
221
|
+
new_options = opts.merge(
|
222
|
+
:operation => :"TagsApi.create_tag_relationships_campaigns",
|
223
|
+
:header_params => header_params,
|
224
|
+
:query_params => query_params,
|
225
|
+
:form_params => form_params,
|
226
|
+
:body => post_body,
|
227
|
+
:auth_names => auth_names,
|
228
|
+
:return_type => return_type
|
229
|
+
)
|
230
|
+
|
231
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
232
|
+
if @api_client.config.debugging
|
233
|
+
@api_client.config.logger.debug "API called: TagsApi#create_tag_relationships_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
234
|
+
end
|
235
|
+
return data, status_code, headers
|
236
|
+
end
|
237
|
+
|
238
|
+
# Create Tag Relationships Flows
|
239
|
+
# Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write`
|
240
|
+
# @param id [String]
|
241
|
+
# @param tag_flow_op [TagFlowOp]
|
242
|
+
# @param [Hash] opts the optional parameters
|
243
|
+
# @return [nil]
|
244
|
+
def create_tag_relationships_flows(id, tag_flow_op, opts = {})
|
245
|
+
create_tag_relationships_flows_with_http_info(id, tag_flow_op, opts)
|
246
|
+
nil
|
247
|
+
end
|
248
|
+
|
249
|
+
# Create Tag Relationships Flows
|
250
|
+
# Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write`
|
251
|
+
# @param id [String]
|
252
|
+
# @param tag_flow_op [TagFlowOp]
|
253
|
+
# @param [Hash] opts the optional parameters
|
254
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
255
|
+
def create_tag_relationships_flows_with_http_info(id, tag_flow_op, opts = {})
|
256
|
+
if @api_client.config.debugging
|
257
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.create_tag_relationships_flows ...'
|
258
|
+
end
|
259
|
+
# verify the required parameter 'id' is set
|
260
|
+
if @api_client.config.client_side_validation && id.nil?
|
261
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.create_tag_relationships_flows"
|
262
|
+
end
|
263
|
+
# verify the required parameter 'tag_flow_op' is set
|
264
|
+
if @api_client.config.client_side_validation && tag_flow_op.nil?
|
265
|
+
fail ArgumentError, "Missing the required parameter 'tag_flow_op' when calling TagsApi.create_tag_relationships_flows"
|
266
|
+
end
|
267
|
+
# resource path
|
268
|
+
local_var_path = '/api/tags/{id}/relationships/flows/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
269
|
+
|
270
|
+
# query parameters
|
271
|
+
query_params = opts[:query_params] || {}
|
272
|
+
|
273
|
+
# header parameters
|
274
|
+
header_params = opts[:header_params] || {}
|
275
|
+
# klaviyo api revision
|
276
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
277
|
+
# HTTP header 'Accept' (if needed)
|
278
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
279
|
+
# HTTP header 'Content-Type'
|
280
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
281
|
+
if !content_type.nil?
|
282
|
+
header_params['Content-Type'] = content_type
|
283
|
+
end
|
284
|
+
|
285
|
+
# form parameters
|
286
|
+
form_params = opts[:form_params] || {}
|
287
|
+
|
288
|
+
# http body (model)
|
289
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_flow_op)
|
290
|
+
|
291
|
+
# return_type
|
292
|
+
return_type = opts[:debug_return_type]
|
293
|
+
|
294
|
+
# auth_names
|
295
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
296
|
+
|
297
|
+
new_options = opts.merge(
|
298
|
+
:operation => :"TagsApi.create_tag_relationships_flows",
|
299
|
+
:header_params => header_params,
|
300
|
+
:query_params => query_params,
|
301
|
+
:form_params => form_params,
|
302
|
+
:body => post_body,
|
303
|
+
:auth_names => auth_names,
|
304
|
+
:return_type => return_type
|
305
|
+
)
|
306
|
+
|
307
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
308
|
+
if @api_client.config.debugging
|
309
|
+
@api_client.config.logger.debug "API called: TagsApi#create_tag_relationships_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
310
|
+
end
|
311
|
+
return data, status_code, headers
|
312
|
+
end
|
313
|
+
|
314
|
+
# Create Tag Relationships Lists
|
315
|
+
# Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:write` `tags:write`
|
316
|
+
# @param id [String]
|
317
|
+
# @param tag_list_op [TagListOp]
|
318
|
+
# @param [Hash] opts the optional parameters
|
319
|
+
# @return [nil]
|
320
|
+
def create_tag_relationships_lists(id, tag_list_op, opts = {})
|
321
|
+
create_tag_relationships_lists_with_http_info(id, tag_list_op, opts)
|
322
|
+
nil
|
323
|
+
end
|
324
|
+
|
325
|
+
# Create Tag Relationships Lists
|
326
|
+
# Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:write` `tags:write`
|
327
|
+
# @param id [String]
|
328
|
+
# @param tag_list_op [TagListOp]
|
329
|
+
# @param [Hash] opts the optional parameters
|
330
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
331
|
+
def create_tag_relationships_lists_with_http_info(id, tag_list_op, opts = {})
|
332
|
+
if @api_client.config.debugging
|
333
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.create_tag_relationships_lists ...'
|
334
|
+
end
|
335
|
+
# verify the required parameter 'id' is set
|
336
|
+
if @api_client.config.client_side_validation && id.nil?
|
337
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.create_tag_relationships_lists"
|
338
|
+
end
|
339
|
+
# verify the required parameter 'tag_list_op' is set
|
340
|
+
if @api_client.config.client_side_validation && tag_list_op.nil?
|
341
|
+
fail ArgumentError, "Missing the required parameter 'tag_list_op' when calling TagsApi.create_tag_relationships_lists"
|
342
|
+
end
|
343
|
+
# resource path
|
344
|
+
local_var_path = '/api/tags/{id}/relationships/lists/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
345
|
+
|
346
|
+
# query parameters
|
347
|
+
query_params = opts[:query_params] || {}
|
348
|
+
|
349
|
+
# header parameters
|
350
|
+
header_params = opts[:header_params] || {}
|
351
|
+
# klaviyo api revision
|
352
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
353
|
+
# HTTP header 'Accept' (if needed)
|
354
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
355
|
+
# HTTP header 'Content-Type'
|
356
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
357
|
+
if !content_type.nil?
|
358
|
+
header_params['Content-Type'] = content_type
|
359
|
+
end
|
360
|
+
|
361
|
+
# form parameters
|
362
|
+
form_params = opts[:form_params] || {}
|
363
|
+
|
364
|
+
# http body (model)
|
365
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_list_op)
|
366
|
+
|
367
|
+
# return_type
|
368
|
+
return_type = opts[:debug_return_type]
|
369
|
+
|
370
|
+
# auth_names
|
371
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
372
|
+
|
373
|
+
new_options = opts.merge(
|
374
|
+
:operation => :"TagsApi.create_tag_relationships_lists",
|
375
|
+
:header_params => header_params,
|
376
|
+
:query_params => query_params,
|
377
|
+
:form_params => form_params,
|
378
|
+
:body => post_body,
|
379
|
+
:auth_names => auth_names,
|
380
|
+
:return_type => return_type
|
381
|
+
)
|
382
|
+
|
383
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
384
|
+
if @api_client.config.debugging
|
385
|
+
@api_client.config.logger.debug "API called: TagsApi#create_tag_relationships_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
386
|
+
end
|
387
|
+
return data, status_code, headers
|
388
|
+
end
|
389
|
+
|
390
|
+
# Create Tag Relationships Segments
|
391
|
+
# Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write`
|
392
|
+
# @param id [String]
|
393
|
+
# @param tag_segment_op [TagSegmentOp]
|
394
|
+
# @param [Hash] opts the optional parameters
|
395
|
+
# @return [nil]
|
396
|
+
def create_tag_relationships_segments(id, tag_segment_op, opts = {})
|
397
|
+
create_tag_relationships_segments_with_http_info(id, tag_segment_op, opts)
|
398
|
+
nil
|
399
|
+
end
|
400
|
+
|
401
|
+
# Create Tag Relationships Segments
|
402
|
+
# Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write`
|
403
|
+
# @param id [String]
|
404
|
+
# @param tag_segment_op [TagSegmentOp]
|
405
|
+
# @param [Hash] opts the optional parameters
|
406
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
407
|
+
def create_tag_relationships_segments_with_http_info(id, tag_segment_op, opts = {})
|
408
|
+
if @api_client.config.debugging
|
409
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.create_tag_relationships_segments ...'
|
410
|
+
end
|
411
|
+
# verify the required parameter 'id' is set
|
412
|
+
if @api_client.config.client_side_validation && id.nil?
|
413
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.create_tag_relationships_segments"
|
414
|
+
end
|
415
|
+
# verify the required parameter 'tag_segment_op' is set
|
416
|
+
if @api_client.config.client_side_validation && tag_segment_op.nil?
|
417
|
+
fail ArgumentError, "Missing the required parameter 'tag_segment_op' when calling TagsApi.create_tag_relationships_segments"
|
418
|
+
end
|
419
|
+
# resource path
|
420
|
+
local_var_path = '/api/tags/{id}/relationships/segments/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
421
|
+
|
422
|
+
# query parameters
|
423
|
+
query_params = opts[:query_params] || {}
|
424
|
+
|
425
|
+
# header parameters
|
426
|
+
header_params = opts[:header_params] || {}
|
427
|
+
# klaviyo api revision
|
428
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
429
|
+
# HTTP header 'Accept' (if needed)
|
430
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
431
|
+
# HTTP header 'Content-Type'
|
432
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
433
|
+
if !content_type.nil?
|
434
|
+
header_params['Content-Type'] = content_type
|
435
|
+
end
|
436
|
+
|
437
|
+
# form parameters
|
438
|
+
form_params = opts[:form_params] || {}
|
439
|
+
|
440
|
+
# http body (model)
|
441
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_segment_op)
|
442
|
+
|
443
|
+
# return_type
|
444
|
+
return_type = opts[:debug_return_type]
|
445
|
+
|
446
|
+
# auth_names
|
447
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
448
|
+
|
449
|
+
new_options = opts.merge(
|
450
|
+
:operation => :"TagsApi.create_tag_relationships_segments",
|
451
|
+
:header_params => header_params,
|
452
|
+
:query_params => query_params,
|
453
|
+
:form_params => form_params,
|
454
|
+
:body => post_body,
|
455
|
+
:auth_names => auth_names,
|
456
|
+
:return_type => return_type
|
457
|
+
)
|
458
|
+
|
459
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
460
|
+
if @api_client.config.debugging
|
461
|
+
@api_client.config.logger.debug "API called: TagsApi#create_tag_relationships_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
462
|
+
end
|
463
|
+
return data, status_code, headers
|
464
|
+
end
|
465
|
+
|
466
|
+
# Delete Tag
|
467
|
+
# Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
468
|
+
# @param id [String] The Tag ID
|
469
|
+
# @param [Hash] opts the optional parameters
|
470
|
+
# @return [Hash<String, Object>]
|
471
|
+
def delete_tag(id, opts = {})
|
472
|
+
data, _status_code, _headers = delete_tag_with_http_info(id, opts)
|
473
|
+
data
|
474
|
+
end
|
475
|
+
|
476
|
+
# Delete Tag
|
477
|
+
# Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
478
|
+
# @param id [String] The Tag ID
|
479
|
+
# @param [Hash] opts the optional parameters
|
480
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
481
|
+
def delete_tag_with_http_info(id, opts = {})
|
482
|
+
if @api_client.config.debugging
|
483
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag ...'
|
484
|
+
end
|
485
|
+
# verify the required parameter 'id' is set
|
486
|
+
if @api_client.config.client_side_validation && id.nil?
|
487
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.delete_tag"
|
488
|
+
end
|
489
|
+
# resource path
|
490
|
+
local_var_path = '/api/tags/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
491
|
+
|
492
|
+
# query parameters
|
493
|
+
query_params = opts[:query_params] || {}
|
494
|
+
|
495
|
+
# header parameters
|
496
|
+
header_params = opts[:header_params] || {}
|
497
|
+
# klaviyo api revision
|
498
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
499
|
+
# HTTP header 'Accept' (if needed)
|
500
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
501
|
+
|
502
|
+
# form parameters
|
503
|
+
form_params = opts[:form_params] || {}
|
504
|
+
|
505
|
+
# http body (model)
|
506
|
+
post_body = opts[:debug_body]
|
507
|
+
|
508
|
+
# return_type
|
509
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
510
|
+
|
511
|
+
# auth_names
|
512
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
513
|
+
|
514
|
+
new_options = opts.merge(
|
515
|
+
:operation => :"TagsApi.delete_tag",
|
516
|
+
:header_params => header_params,
|
517
|
+
:query_params => query_params,
|
518
|
+
:form_params => form_params,
|
519
|
+
:body => post_body,
|
520
|
+
:auth_names => auth_names,
|
521
|
+
:return_type => return_type
|
522
|
+
)
|
523
|
+
|
524
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
525
|
+
if @api_client.config.debugging
|
526
|
+
@api_client.config.logger.debug "API called: TagsApi#delete_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
527
|
+
end
|
528
|
+
return data, status_code, headers
|
529
|
+
end
|
530
|
+
|
531
|
+
# Delete Tag Group
|
532
|
+
# Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
533
|
+
# @param id [String] The Tag Group ID
|
534
|
+
# @param [Hash] opts the optional parameters
|
535
|
+
# @return [Hash<String, Object>]
|
536
|
+
def delete_tag_group(id, opts = {})
|
537
|
+
data, _status_code, _headers = delete_tag_group_with_http_info(id, opts)
|
538
|
+
data
|
539
|
+
end
|
540
|
+
|
541
|
+
# Delete Tag Group
|
542
|
+
# Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
543
|
+
# @param id [String] The Tag Group ID
|
544
|
+
# @param [Hash] opts the optional parameters
|
545
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
546
|
+
def delete_tag_group_with_http_info(id, opts = {})
|
547
|
+
if @api_client.config.debugging
|
548
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_group ...'
|
549
|
+
end
|
550
|
+
# verify the required parameter 'id' is set
|
551
|
+
if @api_client.config.client_side_validation && id.nil?
|
552
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.delete_tag_group"
|
553
|
+
end
|
554
|
+
# resource path
|
555
|
+
local_var_path = '/api/tag-groups/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
556
|
+
|
557
|
+
# query parameters
|
558
|
+
query_params = opts[:query_params] || {}
|
559
|
+
|
560
|
+
# header parameters
|
561
|
+
header_params = opts[:header_params] || {}
|
562
|
+
# klaviyo api revision
|
563
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
564
|
+
# HTTP header 'Accept' (if needed)
|
565
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
566
|
+
|
567
|
+
# form parameters
|
568
|
+
form_params = opts[:form_params] || {}
|
569
|
+
|
570
|
+
# http body (model)
|
571
|
+
post_body = opts[:debug_body]
|
572
|
+
|
573
|
+
# return_type
|
574
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
575
|
+
|
576
|
+
# auth_names
|
577
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
578
|
+
|
579
|
+
new_options = opts.merge(
|
580
|
+
:operation => :"TagsApi.delete_tag_group",
|
581
|
+
:header_params => header_params,
|
582
|
+
:query_params => query_params,
|
583
|
+
:form_params => form_params,
|
584
|
+
:body => post_body,
|
585
|
+
:auth_names => auth_names,
|
586
|
+
:return_type => return_type
|
587
|
+
)
|
588
|
+
|
589
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
590
|
+
if @api_client.config.debugging
|
591
|
+
@api_client.config.logger.debug "API called: TagsApi#delete_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
592
|
+
end
|
593
|
+
return data, status_code, headers
|
594
|
+
end
|
595
|
+
|
596
|
+
# Delete Tag Relationships Campaigns
|
597
|
+
# Remove a tag's association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write`
|
598
|
+
# @param id [String]
|
599
|
+
# @param tag_campaign_op [TagCampaignOp]
|
600
|
+
# @param [Hash] opts the optional parameters
|
601
|
+
# @return [nil]
|
602
|
+
def delete_tag_relationships_campaigns(id, tag_campaign_op, opts = {})
|
603
|
+
delete_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts)
|
604
|
+
nil
|
605
|
+
end
|
606
|
+
|
607
|
+
# Delete Tag Relationships Campaigns
|
608
|
+
# Remove a tag's association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write`
|
609
|
+
# @param id [String]
|
610
|
+
# @param tag_campaign_op [TagCampaignOp]
|
611
|
+
# @param [Hash] opts the optional parameters
|
612
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
613
|
+
def delete_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts = {})
|
614
|
+
if @api_client.config.debugging
|
615
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_relationships_campaigns ...'
|
616
|
+
end
|
617
|
+
# verify the required parameter 'id' is set
|
618
|
+
if @api_client.config.client_side_validation && id.nil?
|
619
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.delete_tag_relationships_campaigns"
|
620
|
+
end
|
621
|
+
# verify the required parameter 'tag_campaign_op' is set
|
622
|
+
if @api_client.config.client_side_validation && tag_campaign_op.nil?
|
623
|
+
fail ArgumentError, "Missing the required parameter 'tag_campaign_op' when calling TagsApi.delete_tag_relationships_campaigns"
|
624
|
+
end
|
625
|
+
# resource path
|
626
|
+
local_var_path = '/api/tags/{id}/relationships/campaigns/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
627
|
+
|
628
|
+
# query parameters
|
629
|
+
query_params = opts[:query_params] || {}
|
630
|
+
|
631
|
+
# header parameters
|
632
|
+
header_params = opts[:header_params] || {}
|
633
|
+
# klaviyo api revision
|
634
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
635
|
+
# HTTP header 'Accept' (if needed)
|
636
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
637
|
+
# HTTP header 'Content-Type'
|
638
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
639
|
+
if !content_type.nil?
|
640
|
+
header_params['Content-Type'] = content_type
|
641
|
+
end
|
642
|
+
|
643
|
+
# form parameters
|
644
|
+
form_params = opts[:form_params] || {}
|
645
|
+
|
646
|
+
# http body (model)
|
647
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_campaign_op)
|
648
|
+
|
649
|
+
# return_type
|
650
|
+
return_type = opts[:debug_return_type]
|
651
|
+
|
652
|
+
# auth_names
|
653
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
654
|
+
|
655
|
+
new_options = opts.merge(
|
656
|
+
:operation => :"TagsApi.delete_tag_relationships_campaigns",
|
657
|
+
:header_params => header_params,
|
658
|
+
:query_params => query_params,
|
659
|
+
:form_params => form_params,
|
660
|
+
:body => post_body,
|
661
|
+
:auth_names => auth_names,
|
662
|
+
:return_type => return_type
|
663
|
+
)
|
664
|
+
|
665
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
666
|
+
if @api_client.config.debugging
|
667
|
+
@api_client.config.logger.debug "API called: TagsApi#delete_tag_relationships_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
668
|
+
end
|
669
|
+
return data, status_code, headers
|
670
|
+
end
|
671
|
+
|
672
|
+
# Delete Tag Relationships Flows
|
673
|
+
# Remove a tag's association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write`
|
674
|
+
# @param id [String]
|
675
|
+
# @param tag_flow_op [TagFlowOp]
|
676
|
+
# @param [Hash] opts the optional parameters
|
677
|
+
# @return [nil]
|
678
|
+
def delete_tag_relationships_flows(id, tag_flow_op, opts = {})
|
679
|
+
delete_tag_relationships_flows_with_http_info(id, tag_flow_op, opts)
|
680
|
+
nil
|
681
|
+
end
|
682
|
+
|
683
|
+
# Delete Tag Relationships Flows
|
684
|
+
# Remove a tag's association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write`
|
685
|
+
# @param id [String]
|
686
|
+
# @param tag_flow_op [TagFlowOp]
|
687
|
+
# @param [Hash] opts the optional parameters
|
688
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
689
|
+
def delete_tag_relationships_flows_with_http_info(id, tag_flow_op, opts = {})
|
690
|
+
if @api_client.config.debugging
|
691
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_relationships_flows ...'
|
692
|
+
end
|
693
|
+
# verify the required parameter 'id' is set
|
694
|
+
if @api_client.config.client_side_validation && id.nil?
|
695
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.delete_tag_relationships_flows"
|
696
|
+
end
|
697
|
+
# verify the required parameter 'tag_flow_op' is set
|
698
|
+
if @api_client.config.client_side_validation && tag_flow_op.nil?
|
699
|
+
fail ArgumentError, "Missing the required parameter 'tag_flow_op' when calling TagsApi.delete_tag_relationships_flows"
|
700
|
+
end
|
701
|
+
# resource path
|
702
|
+
local_var_path = '/api/tags/{id}/relationships/flows/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
703
|
+
|
704
|
+
# query parameters
|
705
|
+
query_params = opts[:query_params] || {}
|
706
|
+
|
707
|
+
# header parameters
|
708
|
+
header_params = opts[:header_params] || {}
|
709
|
+
# klaviyo api revision
|
710
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
711
|
+
# HTTP header 'Accept' (if needed)
|
712
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
713
|
+
# HTTP header 'Content-Type'
|
714
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
715
|
+
if !content_type.nil?
|
716
|
+
header_params['Content-Type'] = content_type
|
717
|
+
end
|
718
|
+
|
719
|
+
# form parameters
|
720
|
+
form_params = opts[:form_params] || {}
|
721
|
+
|
722
|
+
# http body (model)
|
723
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_flow_op)
|
724
|
+
|
725
|
+
# return_type
|
726
|
+
return_type = opts[:debug_return_type]
|
727
|
+
|
728
|
+
# auth_names
|
729
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
730
|
+
|
731
|
+
new_options = opts.merge(
|
732
|
+
:operation => :"TagsApi.delete_tag_relationships_flows",
|
733
|
+
:header_params => header_params,
|
734
|
+
:query_params => query_params,
|
735
|
+
:form_params => form_params,
|
736
|
+
:body => post_body,
|
737
|
+
:auth_names => auth_names,
|
738
|
+
:return_type => return_type
|
739
|
+
)
|
740
|
+
|
741
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
742
|
+
if @api_client.config.debugging
|
743
|
+
@api_client.config.logger.debug "API called: TagsApi#delete_tag_relationships_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
744
|
+
end
|
745
|
+
return data, status_code, headers
|
746
|
+
end
|
747
|
+
|
748
|
+
# Delete Tag Relationships Lists
|
749
|
+
# Remove a tag's association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:write` `tags:write`
|
750
|
+
# @param id [String]
|
751
|
+
# @param tag_list_op [TagListOp]
|
752
|
+
# @param [Hash] opts the optional parameters
|
753
|
+
# @return [nil]
|
754
|
+
def delete_tag_relationships_lists(id, tag_list_op, opts = {})
|
755
|
+
delete_tag_relationships_lists_with_http_info(id, tag_list_op, opts)
|
756
|
+
nil
|
757
|
+
end
|
758
|
+
|
759
|
+
# Delete Tag Relationships Lists
|
760
|
+
# Remove a tag's association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:write` `tags:write`
|
761
|
+
# @param id [String]
|
762
|
+
# @param tag_list_op [TagListOp]
|
763
|
+
# @param [Hash] opts the optional parameters
|
764
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
765
|
+
def delete_tag_relationships_lists_with_http_info(id, tag_list_op, opts = {})
|
766
|
+
if @api_client.config.debugging
|
767
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_relationships_lists ...'
|
768
|
+
end
|
769
|
+
# verify the required parameter 'id' is set
|
770
|
+
if @api_client.config.client_side_validation && id.nil?
|
771
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.delete_tag_relationships_lists"
|
772
|
+
end
|
773
|
+
# verify the required parameter 'tag_list_op' is set
|
774
|
+
if @api_client.config.client_side_validation && tag_list_op.nil?
|
775
|
+
fail ArgumentError, "Missing the required parameter 'tag_list_op' when calling TagsApi.delete_tag_relationships_lists"
|
776
|
+
end
|
777
|
+
# resource path
|
778
|
+
local_var_path = '/api/tags/{id}/relationships/lists/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
779
|
+
|
780
|
+
# query parameters
|
781
|
+
query_params = opts[:query_params] || {}
|
782
|
+
|
783
|
+
# header parameters
|
784
|
+
header_params = opts[:header_params] || {}
|
785
|
+
# klaviyo api revision
|
786
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
787
|
+
# HTTP header 'Accept' (if needed)
|
788
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
789
|
+
# HTTP header 'Content-Type'
|
790
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
791
|
+
if !content_type.nil?
|
792
|
+
header_params['Content-Type'] = content_type
|
793
|
+
end
|
794
|
+
|
795
|
+
# form parameters
|
796
|
+
form_params = opts[:form_params] || {}
|
797
|
+
|
798
|
+
# http body (model)
|
799
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_list_op)
|
800
|
+
|
801
|
+
# return_type
|
802
|
+
return_type = opts[:debug_return_type]
|
803
|
+
|
804
|
+
# auth_names
|
805
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
806
|
+
|
807
|
+
new_options = opts.merge(
|
808
|
+
:operation => :"TagsApi.delete_tag_relationships_lists",
|
809
|
+
:header_params => header_params,
|
810
|
+
:query_params => query_params,
|
811
|
+
:form_params => form_params,
|
812
|
+
:body => post_body,
|
813
|
+
:auth_names => auth_names,
|
814
|
+
:return_type => return_type
|
815
|
+
)
|
816
|
+
|
817
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
818
|
+
if @api_client.config.debugging
|
819
|
+
@api_client.config.logger.debug "API called: TagsApi#delete_tag_relationships_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
820
|
+
end
|
821
|
+
return data, status_code, headers
|
822
|
+
end
|
823
|
+
|
824
|
+
# Delete Tag Relationships Segments
|
825
|
+
# Remove a tag's association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write`
|
164
826
|
# @param id [String]
|
165
|
-
# @param related_resource [String]
|
166
827
|
# @param tag_segment_op [TagSegmentOp]
|
167
828
|
# @param [Hash] opts the optional parameters
|
168
829
|
# @return [nil]
|
169
|
-
def
|
170
|
-
|
830
|
+
def delete_tag_relationships_segments(id, tag_segment_op, opts = {})
|
831
|
+
delete_tag_relationships_segments_with_http_info(id, tag_segment_op, opts)
|
171
832
|
nil
|
172
833
|
end
|
173
834
|
|
174
|
-
#
|
175
|
-
#
|
835
|
+
# Delete Tag Relationships Segments
|
836
|
+
# Remove a tag's association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write`
|
176
837
|
# @param id [String]
|
177
|
-
# @param related_resource [String]
|
178
838
|
# @param tag_segment_op [TagSegmentOp]
|
179
839
|
# @param [Hash] opts the optional parameters
|
180
840
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
181
|
-
def
|
841
|
+
def delete_tag_relationships_segments_with_http_info(id, tag_segment_op, opts = {})
|
182
842
|
if @api_client.config.debugging
|
183
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
843
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_relationships_segments ...'
|
184
844
|
end
|
185
845
|
# verify the required parameter 'id' is set
|
186
846
|
if @api_client.config.client_side_validation && id.nil?
|
187
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
188
|
-
end
|
189
|
-
# verify the required parameter 'related_resource' is set
|
190
|
-
if @api_client.config.client_side_validation && related_resource.nil?
|
191
|
-
fail ArgumentError, "Missing the required parameter 'related_resource' when calling TagsApi.create_tag_relationships"
|
192
|
-
end
|
193
|
-
# verify enum value
|
194
|
-
allowable_values = ["flows", "lists", "segments", "tag-groups"]
|
195
|
-
if @api_client.config.client_side_validation && !allowable_values.include?(related_resource)
|
196
|
-
fail ArgumentError, "invalid value for \"related_resource\", must be one of #{allowable_values}"
|
847
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.delete_tag_relationships_segments"
|
197
848
|
end
|
198
849
|
# verify the required parameter 'tag_segment_op' is set
|
199
850
|
if @api_client.config.client_side_validation && tag_segment_op.nil?
|
200
|
-
fail ArgumentError, "Missing the required parameter 'tag_segment_op' when calling TagsApi.
|
851
|
+
fail ArgumentError, "Missing the required parameter 'tag_segment_op' when calling TagsApi.delete_tag_relationships_segments"
|
201
852
|
end
|
202
853
|
# resource path
|
203
|
-
local_var_path = '/api/tags/{id}/relationships/
|
854
|
+
local_var_path = '/api/tags/{id}/relationships/segments/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
204
855
|
|
205
856
|
# query parameters
|
206
857
|
query_params = opts[:query_params] || {}
|
@@ -208,7 +859,7 @@ module KlaviyoAPI
|
|
208
859
|
# header parameters
|
209
860
|
header_params = opts[:header_params] || {}
|
210
861
|
# klaviyo api revision
|
211
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
862
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
212
863
|
# HTTP header 'Accept' (if needed)
|
213
864
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
214
865
|
# HTTP header 'Content-Type'
|
@@ -230,7 +881,7 @@ module KlaviyoAPI
|
|
230
881
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
231
882
|
|
232
883
|
new_options = opts.merge(
|
233
|
-
:operation => :"TagsApi.
|
884
|
+
:operation => :"TagsApi.delete_tag_relationships_segments",
|
234
885
|
:header_params => header_params,
|
235
886
|
:query_params => query_params,
|
236
887
|
:form_params => form_params,
|
@@ -239,46 +890,53 @@ module KlaviyoAPI
|
|
239
890
|
:return_type => return_type
|
240
891
|
)
|
241
892
|
|
242
|
-
data, status_code, headers = @api_client.call_api(:
|
893
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
243
894
|
if @api_client.config.debugging
|
244
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
895
|
+
@api_client.config.logger.debug "API called: TagsApi#delete_tag_relationships_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
245
896
|
end
|
246
897
|
return data, status_code, headers
|
247
898
|
end
|
248
899
|
|
249
|
-
#
|
250
|
-
#
|
900
|
+
# Get Tag
|
901
|
+
# Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
251
902
|
# @param id [String] The Tag ID
|
252
903
|
# @param [Hash] opts the optional parameters
|
904
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
253
905
|
# @return [Hash<String, Object>]
|
254
|
-
def
|
255
|
-
data, _status_code, _headers =
|
906
|
+
def get_tag(id, opts = {})
|
907
|
+
data, _status_code, _headers = get_tag_with_http_info(id, opts)
|
256
908
|
data
|
257
909
|
end
|
258
910
|
|
259
|
-
#
|
260
|
-
#
|
911
|
+
# Get Tag
|
912
|
+
# Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
261
913
|
# @param id [String] The Tag ID
|
262
914
|
# @param [Hash] opts the optional parameters
|
915
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
263
916
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
264
|
-
def
|
917
|
+
def get_tag_with_http_info(id, opts = {})
|
265
918
|
if @api_client.config.debugging
|
266
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
919
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag ...'
|
267
920
|
end
|
268
921
|
# verify the required parameter 'id' is set
|
269
922
|
if @api_client.config.client_side_validation && id.nil?
|
270
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
923
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag"
|
924
|
+
end
|
925
|
+
allowable_values = ["name"]
|
926
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
927
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
271
928
|
end
|
272
929
|
# resource path
|
273
930
|
local_var_path = '/api/tags/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
274
931
|
|
275
932
|
# query parameters
|
276
933
|
query_params = opts[:query_params] || {}
|
934
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
277
935
|
|
278
936
|
# header parameters
|
279
937
|
header_params = opts[:header_params] || {}
|
280
938
|
# klaviyo api revision
|
281
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
939
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
282
940
|
# HTTP header 'Accept' (if needed)
|
283
941
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
284
942
|
|
@@ -295,7 +953,7 @@ module KlaviyoAPI
|
|
295
953
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
296
954
|
|
297
955
|
new_options = opts.merge(
|
298
|
-
:operation => :"TagsApi.
|
956
|
+
:operation => :"TagsApi.get_tag",
|
299
957
|
:header_params => header_params,
|
300
958
|
:query_params => query_params,
|
301
959
|
:form_params => form_params,
|
@@ -304,46 +962,53 @@ module KlaviyoAPI
|
|
304
962
|
:return_type => return_type
|
305
963
|
)
|
306
964
|
|
307
|
-
data, status_code, headers = @api_client.call_api(:
|
965
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
308
966
|
if @api_client.config.debugging
|
309
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
967
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
310
968
|
end
|
311
969
|
return data, status_code, headers
|
312
970
|
end
|
313
971
|
|
314
|
-
#
|
315
|
-
#
|
972
|
+
# Get Tag Group
|
973
|
+
# Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
316
974
|
# @param id [String] The Tag Group ID
|
317
975
|
# @param [Hash] opts the optional parameters
|
976
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
318
977
|
# @return [Hash<String, Object>]
|
319
|
-
def
|
320
|
-
data, _status_code, _headers =
|
978
|
+
def get_tag_group(id, opts = {})
|
979
|
+
data, _status_code, _headers = get_tag_group_with_http_info(id, opts)
|
321
980
|
data
|
322
981
|
end
|
323
982
|
|
324
|
-
#
|
325
|
-
#
|
983
|
+
# Get Tag Group
|
984
|
+
# Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
326
985
|
# @param id [String] The Tag Group ID
|
327
986
|
# @param [Hash] opts the optional parameters
|
987
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
328
988
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
329
|
-
def
|
989
|
+
def get_tag_group_with_http_info(id, opts = {})
|
330
990
|
if @api_client.config.debugging
|
331
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
991
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group ...'
|
332
992
|
end
|
333
993
|
# verify the required parameter 'id' is set
|
334
994
|
if @api_client.config.client_side_validation && id.nil?
|
335
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
995
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_group"
|
996
|
+
end
|
997
|
+
allowable_values = ["name", "exclusive", "default"]
|
998
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
999
|
+
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
336
1000
|
end
|
337
1001
|
# resource path
|
338
1002
|
local_var_path = '/api/tag-groups/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
339
1003
|
|
340
1004
|
# query parameters
|
341
1005
|
query_params = opts[:query_params] || {}
|
1006
|
+
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
342
1007
|
|
343
1008
|
# header parameters
|
344
1009
|
header_params = opts[:header_params] || {}
|
345
1010
|
# klaviyo api revision
|
346
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1011
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
347
1012
|
# HTTP header 'Accept' (if needed)
|
348
1013
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
349
1014
|
|
@@ -360,7 +1025,7 @@ module KlaviyoAPI
|
|
360
1025
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
361
1026
|
|
362
1027
|
new_options = opts.merge(
|
363
|
-
:operation => :"TagsApi.
|
1028
|
+
:operation => :"TagsApi.get_tag_group",
|
364
1029
|
:header_params => header_params,
|
365
1030
|
:query_params => query_params,
|
366
1031
|
:form_params => form_params,
|
@@ -369,55 +1034,38 @@ module KlaviyoAPI
|
|
369
1034
|
:return_type => return_type
|
370
1035
|
)
|
371
1036
|
|
372
|
-
data, status_code, headers = @api_client.call_api(:
|
1037
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
373
1038
|
if @api_client.config.debugging
|
374
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1039
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
375
1040
|
end
|
376
1041
|
return data, status_code, headers
|
377
1042
|
end
|
378
1043
|
|
379
|
-
#
|
380
|
-
#
|
1044
|
+
# Get Tag Group Relationships Tags
|
1045
|
+
# Returns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
381
1046
|
# @param id [String]
|
382
|
-
# @param related_resource [String]
|
383
|
-
# @param tag_segment_op [TagSegmentOp]
|
384
1047
|
# @param [Hash] opts the optional parameters
|
385
|
-
# @return [
|
386
|
-
def
|
387
|
-
|
388
|
-
|
1048
|
+
# @return [Hash<String, Object>]
|
1049
|
+
def get_tag_group_relationships_tags(id, opts = {})
|
1050
|
+
data, _status_code, _headers = get_tag_group_relationships_tags_with_http_info(id, opts)
|
1051
|
+
data
|
389
1052
|
end
|
390
1053
|
|
391
|
-
#
|
392
|
-
#
|
1054
|
+
# Get Tag Group Relationships Tags
|
1055
|
+
# Returns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
393
1056
|
# @param id [String]
|
394
|
-
# @param related_resource [String]
|
395
|
-
# @param tag_segment_op [TagSegmentOp]
|
396
1057
|
# @param [Hash] opts the optional parameters
|
397
|
-
# @return [Array<(
|
398
|
-
def
|
1058
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1059
|
+
def get_tag_group_relationships_tags_with_http_info(id, opts = {})
|
399
1060
|
if @api_client.config.debugging
|
400
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1061
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group_relationships_tags ...'
|
401
1062
|
end
|
402
1063
|
# verify the required parameter 'id' is set
|
403
1064
|
if @api_client.config.client_side_validation && id.nil?
|
404
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
405
|
-
end
|
406
|
-
# verify the required parameter 'related_resource' is set
|
407
|
-
if @api_client.config.client_side_validation && related_resource.nil?
|
408
|
-
fail ArgumentError, "Missing the required parameter 'related_resource' when calling TagsApi.delete_tag_relationships"
|
409
|
-
end
|
410
|
-
# verify enum value
|
411
|
-
allowable_values = ["flows", "lists", "segments", "tag-groups"]
|
412
|
-
if @api_client.config.client_side_validation && !allowable_values.include?(related_resource)
|
413
|
-
fail ArgumentError, "invalid value for \"related_resource\", must be one of #{allowable_values}"
|
414
|
-
end
|
415
|
-
# verify the required parameter 'tag_segment_op' is set
|
416
|
-
if @api_client.config.client_side_validation && tag_segment_op.nil?
|
417
|
-
fail ArgumentError, "Missing the required parameter 'tag_segment_op' when calling TagsApi.delete_tag_relationships"
|
1065
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_group_relationships_tags"
|
418
1066
|
end
|
419
1067
|
# resource path
|
420
|
-
local_var_path = '/api/
|
1068
|
+
local_var_path = '/api/tag-groups/{id}/relationships/tags/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
421
1069
|
|
422
1070
|
# query parameters
|
423
1071
|
query_params = opts[:query_params] || {}
|
@@ -425,29 +1073,24 @@ module KlaviyoAPI
|
|
425
1073
|
# header parameters
|
426
1074
|
header_params = opts[:header_params] || {}
|
427
1075
|
# klaviyo api revision
|
428
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1076
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
429
1077
|
# HTTP header 'Accept' (if needed)
|
430
1078
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
431
|
-
# HTTP header 'Content-Type'
|
432
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
433
|
-
if !content_type.nil?
|
434
|
-
header_params['Content-Type'] = content_type
|
435
|
-
end
|
436
1079
|
|
437
1080
|
# form parameters
|
438
1081
|
form_params = opts[:form_params] || {}
|
439
1082
|
|
440
1083
|
# http body (model)
|
441
|
-
post_body = opts[:debug_body]
|
1084
|
+
post_body = opts[:debug_body]
|
442
1085
|
|
443
1086
|
# return_type
|
444
|
-
return_type = opts[:debug_return_type]
|
1087
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
445
1088
|
|
446
1089
|
# auth_names
|
447
1090
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
448
1091
|
|
449
1092
|
new_options = opts.merge(
|
450
|
-
:operation => :"TagsApi.
|
1093
|
+
:operation => :"TagsApi.get_tag_group_relationships_tags",
|
451
1094
|
:header_params => header_params,
|
452
1095
|
:query_params => query_params,
|
453
1096
|
:form_params => form_params,
|
@@ -456,44 +1099,44 @@ module KlaviyoAPI
|
|
456
1099
|
:return_type => return_type
|
457
1100
|
)
|
458
1101
|
|
459
|
-
data, status_code, headers = @api_client.call_api(:
|
1102
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
460
1103
|
if @api_client.config.debugging
|
461
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1104
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_group_relationships_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
462
1105
|
end
|
463
1106
|
return data, status_code, headers
|
464
1107
|
end
|
465
1108
|
|
466
|
-
# Get Tag
|
467
|
-
#
|
468
|
-
# @param id [String]
|
1109
|
+
# Get Tag Group Tags
|
1110
|
+
# Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1111
|
+
# @param id [String]
|
469
1112
|
# @param [Hash] opts the optional parameters
|
470
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
1113
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
471
1114
|
# @return [Hash<String, Object>]
|
472
|
-
def
|
473
|
-
data, _status_code, _headers =
|
1115
|
+
def get_tag_group_tags(id, opts = {})
|
1116
|
+
data, _status_code, _headers = get_tag_group_tags_with_http_info(id, opts)
|
474
1117
|
data
|
475
1118
|
end
|
476
1119
|
|
477
|
-
# Get Tag
|
478
|
-
#
|
479
|
-
# @param id [String]
|
1120
|
+
# Get Tag Group Tags
|
1121
|
+
# Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1122
|
+
# @param id [String]
|
480
1123
|
# @param [Hash] opts the optional parameters
|
481
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
1124
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
482
1125
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
483
|
-
def
|
1126
|
+
def get_tag_group_tags_with_http_info(id, opts = {})
|
484
1127
|
if @api_client.config.debugging
|
485
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1128
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group_tags ...'
|
486
1129
|
end
|
487
1130
|
# verify the required parameter 'id' is set
|
488
1131
|
if @api_client.config.client_side_validation && id.nil?
|
489
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
1132
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_group_tags"
|
490
1133
|
end
|
491
1134
|
allowable_values = ["name"]
|
492
1135
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
493
1136
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
494
1137
|
end
|
495
1138
|
# resource path
|
496
|
-
local_var_path = '/api/
|
1139
|
+
local_var_path = '/api/tag-groups/{id}/tags/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
497
1140
|
|
498
1141
|
# query parameters
|
499
1142
|
query_params = opts[:query_params] || {}
|
@@ -502,7 +1145,7 @@ module KlaviyoAPI
|
|
502
1145
|
# header parameters
|
503
1146
|
header_params = opts[:header_params] || {}
|
504
1147
|
# klaviyo api revision
|
505
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1148
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
506
1149
|
# HTTP header 'Accept' (if needed)
|
507
1150
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
508
1151
|
|
@@ -519,7 +1162,7 @@ module KlaviyoAPI
|
|
519
1162
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
520
1163
|
|
521
1164
|
new_options = opts.merge(
|
522
|
-
:operation => :"TagsApi.
|
1165
|
+
:operation => :"TagsApi.get_tag_group_tags",
|
523
1166
|
:header_params => header_params,
|
524
1167
|
:query_params => query_params,
|
525
1168
|
:form_params => form_params,
|
@@ -530,51 +1173,58 @@ module KlaviyoAPI
|
|
530
1173
|
|
531
1174
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
532
1175
|
if @api_client.config.debugging
|
533
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1176
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_group_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
534
1177
|
end
|
535
1178
|
return data, status_code, headers
|
536
1179
|
end
|
537
1180
|
|
538
|
-
# Get Tag
|
539
|
-
#
|
540
|
-
# @param id [String] The Tag Group ID
|
1181
|
+
# Get Tag Groups
|
1182
|
+
# List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
541
1183
|
# @param [Hash] opts the optional parameters
|
542
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1184
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1185
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
1186
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1187
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
543
1188
|
# @return [Hash<String, Object>]
|
544
|
-
def
|
545
|
-
data, _status_code, _headers =
|
1189
|
+
def get_tag_groups(opts = {})
|
1190
|
+
data, _status_code, _headers = get_tag_groups_with_http_info(opts)
|
546
1191
|
data
|
547
1192
|
end
|
548
1193
|
|
549
|
-
# Get Tag
|
550
|
-
#
|
551
|
-
# @param id [String] The Tag Group ID
|
1194
|
+
# Get Tag Groups
|
1195
|
+
# List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
552
1196
|
# @param [Hash] opts the optional parameters
|
553
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1197
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1198
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
1199
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1200
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
554
1201
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
555
|
-
def
|
1202
|
+
def get_tag_groups_with_http_info(opts = {})
|
556
1203
|
if @api_client.config.debugging
|
557
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
558
|
-
end
|
559
|
-
# verify the required parameter 'id' is set
|
560
|
-
if @api_client.config.client_side_validation && id.nil?
|
561
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_group"
|
1204
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_groups ...'
|
562
1205
|
end
|
563
1206
|
allowable_values = ["name", "exclusive", "default"]
|
564
1207
|
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
565
1208
|
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
566
1209
|
end
|
1210
|
+
allowable_values = ["id", "-id", "name", "-name"]
|
1211
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1212
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1213
|
+
end
|
567
1214
|
# resource path
|
568
|
-
local_var_path = '/api/tag-groups/
|
1215
|
+
local_var_path = '/api/tag-groups/'
|
569
1216
|
|
570
1217
|
# query parameters
|
571
1218
|
query_params = opts[:query_params] || {}
|
572
1219
|
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
1220
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1221
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1222
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
573
1223
|
|
574
1224
|
# header parameters
|
575
1225
|
header_params = opts[:header_params] || {}
|
576
1226
|
# klaviyo api revision
|
577
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1227
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
578
1228
|
# HTTP header 'Accept' (if needed)
|
579
1229
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
580
1230
|
|
@@ -591,7 +1241,7 @@ module KlaviyoAPI
|
|
591
1241
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
592
1242
|
|
593
1243
|
new_options = opts.merge(
|
594
|
-
:operation => :"TagsApi.
|
1244
|
+
:operation => :"TagsApi.get_tag_groups",
|
595
1245
|
:header_params => header_params,
|
596
1246
|
:query_params => query_params,
|
597
1247
|
:form_params => form_params,
|
@@ -602,47 +1252,36 @@ module KlaviyoAPI
|
|
602
1252
|
|
603
1253
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
604
1254
|
if @api_client.config.debugging
|
605
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1255
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
606
1256
|
end
|
607
1257
|
return data, status_code, headers
|
608
1258
|
end
|
609
1259
|
|
610
|
-
# Get Tag
|
611
|
-
#
|
1260
|
+
# Get Tag Relationships Campaigns
|
1261
|
+
# Returns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
612
1262
|
# @param id [String]
|
613
|
-
# @param related_resource [String]
|
614
1263
|
# @param [Hash] opts the optional parameters
|
615
1264
|
# @return [Hash<String, Object>]
|
616
|
-
def
|
617
|
-
data, _status_code, _headers =
|
1265
|
+
def get_tag_relationships_campaigns(id, opts = {})
|
1266
|
+
data, _status_code, _headers = get_tag_relationships_campaigns_with_http_info(id, opts)
|
618
1267
|
data
|
619
1268
|
end
|
620
1269
|
|
621
|
-
# Get Tag
|
622
|
-
#
|
1270
|
+
# Get Tag Relationships Campaigns
|
1271
|
+
# Returns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
623
1272
|
# @param id [String]
|
624
|
-
# @param related_resource [String]
|
625
1273
|
# @param [Hash] opts the optional parameters
|
626
1274
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
627
|
-
def
|
1275
|
+
def get_tag_relationships_campaigns_with_http_info(id, opts = {})
|
628
1276
|
if @api_client.config.debugging
|
629
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1277
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_relationships_campaigns ...'
|
630
1278
|
end
|
631
1279
|
# verify the required parameter 'id' is set
|
632
1280
|
if @api_client.config.client_side_validation && id.nil?
|
633
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
634
|
-
end
|
635
|
-
# verify the required parameter 'related_resource' is set
|
636
|
-
if @api_client.config.client_side_validation && related_resource.nil?
|
637
|
-
fail ArgumentError, "Missing the required parameter 'related_resource' when calling TagsApi.get_tag_group_relationships"
|
638
|
-
end
|
639
|
-
# verify enum value
|
640
|
-
allowable_values = ["tags"]
|
641
|
-
if @api_client.config.client_side_validation && !allowable_values.include?(related_resource)
|
642
|
-
fail ArgumentError, "invalid value for \"related_resource\", must be one of #{allowable_values}"
|
1281
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_relationships_campaigns"
|
643
1282
|
end
|
644
1283
|
# resource path
|
645
|
-
local_var_path = '/api/
|
1284
|
+
local_var_path = '/api/tags/{id}/relationships/campaigns/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
646
1285
|
|
647
1286
|
# query parameters
|
648
1287
|
query_params = opts[:query_params] || {}
|
@@ -650,7 +1289,7 @@ module KlaviyoAPI
|
|
650
1289
|
# header parameters
|
651
1290
|
header_params = opts[:header_params] || {}
|
652
1291
|
# klaviyo api revision
|
653
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1292
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
654
1293
|
# HTTP header 'Accept' (if needed)
|
655
1294
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
656
1295
|
|
@@ -667,7 +1306,7 @@ module KlaviyoAPI
|
|
667
1306
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
668
1307
|
|
669
1308
|
new_options = opts.merge(
|
670
|
-
:operation => :"TagsApi.
|
1309
|
+
:operation => :"TagsApi.get_tag_relationships_campaigns",
|
671
1310
|
:header_params => header_params,
|
672
1311
|
:query_params => query_params,
|
673
1312
|
:form_params => form_params,
|
@@ -678,51 +1317,44 @@ module KlaviyoAPI
|
|
678
1317
|
|
679
1318
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
680
1319
|
if @api_client.config.debugging
|
681
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1320
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_relationships_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
682
1321
|
end
|
683
1322
|
return data, status_code, headers
|
684
1323
|
end
|
685
1324
|
|
686
|
-
# Get Tag
|
687
|
-
#
|
688
|
-
# @param id [String]
|
1325
|
+
# Get Tag Relationships Flows
|
1326
|
+
# Returns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
1327
|
+
# @param id [String]
|
689
1328
|
# @param [Hash] opts the optional parameters
|
690
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
691
1329
|
# @return [Hash<String, Object>]
|
692
|
-
def
|
693
|
-
data, _status_code, _headers =
|
1330
|
+
def get_tag_relationships_flows(id, opts = {})
|
1331
|
+
data, _status_code, _headers = get_tag_relationships_flows_with_http_info(id, opts)
|
694
1332
|
data
|
695
1333
|
end
|
696
1334
|
|
697
|
-
# Get Tag
|
698
|
-
#
|
699
|
-
# @param id [String]
|
1335
|
+
# Get Tag Relationships Flows
|
1336
|
+
# Returns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
1337
|
+
# @param id [String]
|
700
1338
|
# @param [Hash] opts the optional parameters
|
701
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
702
1339
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
703
|
-
def
|
1340
|
+
def get_tag_relationships_flows_with_http_info(id, opts = {})
|
704
1341
|
if @api_client.config.debugging
|
705
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1342
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_relationships_flows ...'
|
706
1343
|
end
|
707
1344
|
# verify the required parameter 'id' is set
|
708
1345
|
if @api_client.config.client_side_validation && id.nil?
|
709
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
710
|
-
end
|
711
|
-
allowable_values = ["name"]
|
712
|
-
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
713
|
-
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1346
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_relationships_flows"
|
714
1347
|
end
|
715
1348
|
# resource path
|
716
|
-
local_var_path = '/api/
|
1349
|
+
local_var_path = '/api/tags/{id}/relationships/flows/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
717
1350
|
|
718
1351
|
# query parameters
|
719
1352
|
query_params = opts[:query_params] || {}
|
720
|
-
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
721
1353
|
|
722
1354
|
# header parameters
|
723
1355
|
header_params = opts[:header_params] || {}
|
724
1356
|
# klaviyo api revision
|
725
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1357
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
726
1358
|
# HTTP header 'Accept' (if needed)
|
727
1359
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
728
1360
|
|
@@ -739,7 +1371,7 @@ module KlaviyoAPI
|
|
739
1371
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
740
1372
|
|
741
1373
|
new_options = opts.merge(
|
742
|
-
:operation => :"TagsApi.
|
1374
|
+
:operation => :"TagsApi.get_tag_relationships_flows",
|
743
1375
|
:header_params => header_params,
|
744
1376
|
:query_params => query_params,
|
745
1377
|
:form_params => form_params,
|
@@ -750,58 +1382,44 @@ module KlaviyoAPI
|
|
750
1382
|
|
751
1383
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
752
1384
|
if @api_client.config.debugging
|
753
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1385
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_relationships_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
754
1386
|
end
|
755
1387
|
return data, status_code, headers
|
756
1388
|
end
|
757
1389
|
|
758
|
-
# Get Tag
|
759
|
-
#
|
1390
|
+
# Get Tag Relationships Lists
|
1391
|
+
# Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:read` `tags:read`
|
1392
|
+
# @param id [String]
|
760
1393
|
# @param [Hash] opts the optional parameters
|
761
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
762
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
763
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
764
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
765
1394
|
# @return [Hash<String, Object>]
|
766
|
-
def
|
767
|
-
data, _status_code, _headers =
|
1395
|
+
def get_tag_relationships_lists(id, opts = {})
|
1396
|
+
data, _status_code, _headers = get_tag_relationships_lists_with_http_info(id, opts)
|
768
1397
|
data
|
769
1398
|
end
|
770
1399
|
|
771
|
-
# Get Tag
|
772
|
-
#
|
1400
|
+
# Get Tag Relationships Lists
|
1401
|
+
# Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:read` `tags:read`
|
1402
|
+
# @param id [String]
|
773
1403
|
# @param [Hash] opts the optional parameters
|
774
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
775
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
776
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
777
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
778
1404
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
779
|
-
def
|
1405
|
+
def get_tag_relationships_lists_with_http_info(id, opts = {})
|
780
1406
|
if @api_client.config.debugging
|
781
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
782
|
-
end
|
783
|
-
allowable_values = ["name", "exclusive", "default"]
|
784
|
-
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
785
|
-
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
1407
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_relationships_lists ...'
|
786
1408
|
end
|
787
|
-
|
788
|
-
if @api_client.config.client_side_validation &&
|
789
|
-
fail ArgumentError, "
|
1409
|
+
# verify the required parameter 'id' is set
|
1410
|
+
if @api_client.config.client_side_validation && id.nil?
|
1411
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_relationships_lists"
|
790
1412
|
end
|
791
1413
|
# resource path
|
792
|
-
local_var_path = '/api/
|
1414
|
+
local_var_path = '/api/tags/{id}/relationships/lists/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
793
1415
|
|
794
1416
|
# query parameters
|
795
1417
|
query_params = opts[:query_params] || {}
|
796
|
-
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
797
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
798
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
799
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
800
1418
|
|
801
1419
|
# header parameters
|
802
1420
|
header_params = opts[:header_params] || {}
|
803
1421
|
# klaviyo api revision
|
804
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1422
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
805
1423
|
# HTTP header 'Accept' (if needed)
|
806
1424
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
807
1425
|
|
@@ -818,7 +1436,7 @@ module KlaviyoAPI
|
|
818
1436
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
819
1437
|
|
820
1438
|
new_options = opts.merge(
|
821
|
-
:operation => :"TagsApi.
|
1439
|
+
:operation => :"TagsApi.get_tag_relationships_lists",
|
822
1440
|
:header_params => header_params,
|
823
1441
|
:query_params => query_params,
|
824
1442
|
:form_params => form_params,
|
@@ -829,47 +1447,101 @@ module KlaviyoAPI
|
|
829
1447
|
|
830
1448
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
831
1449
|
if @api_client.config.debugging
|
832
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1450
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_relationships_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
833
1451
|
end
|
834
1452
|
return data, status_code, headers
|
835
1453
|
end
|
836
1454
|
|
837
|
-
# Get Tag Relationships
|
838
|
-
#
|
1455
|
+
# Get Tag Relationships Segments
|
1456
|
+
# Returns the IDs of all segments associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
|
839
1457
|
# @param id [String]
|
840
|
-
# @param related_resource [String]
|
841
1458
|
# @param [Hash] opts the optional parameters
|
842
1459
|
# @return [Hash<String, Object>]
|
843
|
-
def
|
844
|
-
data, _status_code, _headers =
|
1460
|
+
def get_tag_relationships_segments(id, opts = {})
|
1461
|
+
data, _status_code, _headers = get_tag_relationships_segments_with_http_info(id, opts)
|
845
1462
|
data
|
846
1463
|
end
|
847
1464
|
|
848
|
-
# Get Tag Relationships
|
849
|
-
#
|
1465
|
+
# Get Tag Relationships Segments
|
1466
|
+
# Returns the IDs of all segments associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
|
850
1467
|
# @param id [String]
|
851
|
-
# @param related_resource [String]
|
852
1468
|
# @param [Hash] opts the optional parameters
|
853
1469
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
854
|
-
def
|
1470
|
+
def get_tag_relationships_segments_with_http_info(id, opts = {})
|
855
1471
|
if @api_client.config.debugging
|
856
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1472
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_relationships_segments ...'
|
857
1473
|
end
|
858
1474
|
# verify the required parameter 'id' is set
|
859
1475
|
if @api_client.config.client_side_validation && id.nil?
|
860
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
1476
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_relationships_segments"
|
1477
|
+
end
|
1478
|
+
# resource path
|
1479
|
+
local_var_path = '/api/tags/{id}/relationships/segments/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1480
|
+
|
1481
|
+
# query parameters
|
1482
|
+
query_params = opts[:query_params] || {}
|
1483
|
+
|
1484
|
+
# header parameters
|
1485
|
+
header_params = opts[:header_params] || {}
|
1486
|
+
# klaviyo api revision
|
1487
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1488
|
+
# HTTP header 'Accept' (if needed)
|
1489
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1490
|
+
|
1491
|
+
# form parameters
|
1492
|
+
form_params = opts[:form_params] || {}
|
1493
|
+
|
1494
|
+
# http body (model)
|
1495
|
+
post_body = opts[:debug_body]
|
1496
|
+
|
1497
|
+
# return_type
|
1498
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1499
|
+
|
1500
|
+
# auth_names
|
1501
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1502
|
+
|
1503
|
+
new_options = opts.merge(
|
1504
|
+
:operation => :"TagsApi.get_tag_relationships_segments",
|
1505
|
+
:header_params => header_params,
|
1506
|
+
:query_params => query_params,
|
1507
|
+
:form_params => form_params,
|
1508
|
+
:body => post_body,
|
1509
|
+
:auth_names => auth_names,
|
1510
|
+
:return_type => return_type
|
1511
|
+
)
|
1512
|
+
|
1513
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1514
|
+
if @api_client.config.debugging
|
1515
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_relationships_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
861
1516
|
end
|
862
|
-
|
863
|
-
|
864
|
-
|
1517
|
+
return data, status_code, headers
|
1518
|
+
end
|
1519
|
+
|
1520
|
+
# Get Tag Relationships Tag Group
|
1521
|
+
# Returns the ids of all tag groups related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1522
|
+
# @param id [String]
|
1523
|
+
# @param [Hash] opts the optional parameters
|
1524
|
+
# @return [Hash<String, Object>]
|
1525
|
+
def get_tag_relationships_tag_group(id, opts = {})
|
1526
|
+
data, _status_code, _headers = get_tag_relationships_tag_group_with_http_info(id, opts)
|
1527
|
+
data
|
1528
|
+
end
|
1529
|
+
|
1530
|
+
# Get Tag Relationships Tag Group
|
1531
|
+
# Returns the ids of all tag groups related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1532
|
+
# @param id [String]
|
1533
|
+
# @param [Hash] opts the optional parameters
|
1534
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1535
|
+
def get_tag_relationships_tag_group_with_http_info(id, opts = {})
|
1536
|
+
if @api_client.config.debugging
|
1537
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_relationships_tag_group ...'
|
865
1538
|
end
|
866
|
-
# verify
|
867
|
-
|
868
|
-
|
869
|
-
fail ArgumentError, "invalid value for \"related_resource\", must be one of #{allowable_values}"
|
1539
|
+
# verify the required parameter 'id' is set
|
1540
|
+
if @api_client.config.client_side_validation && id.nil?
|
1541
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_relationships_tag_group"
|
870
1542
|
end
|
871
1543
|
# resource path
|
872
|
-
local_var_path = '/api/tags/{id}/relationships/
|
1544
|
+
local_var_path = '/api/tags/{id}/relationships/tag-group/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
873
1545
|
|
874
1546
|
# query parameters
|
875
1547
|
query_params = opts[:query_params] || {}
|
@@ -877,7 +1549,7 @@ module KlaviyoAPI
|
|
877
1549
|
# header parameters
|
878
1550
|
header_params = opts[:header_params] || {}
|
879
1551
|
# klaviyo api revision
|
880
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1552
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
881
1553
|
# HTTP header 'Accept' (if needed)
|
882
1554
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
883
1555
|
|
@@ -894,7 +1566,7 @@ module KlaviyoAPI
|
|
894
1566
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
895
1567
|
|
896
1568
|
new_options = opts.merge(
|
897
|
-
:operation => :"TagsApi.
|
1569
|
+
:operation => :"TagsApi.get_tag_relationships_tag_group",
|
898
1570
|
:header_params => header_params,
|
899
1571
|
:query_params => query_params,
|
900
1572
|
:form_params => form_params,
|
@@ -905,16 +1577,16 @@ module KlaviyoAPI
|
|
905
1577
|
|
906
1578
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
907
1579
|
if @api_client.config.debugging
|
908
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1580
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_relationships_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
909
1581
|
end
|
910
1582
|
return data, status_code, headers
|
911
1583
|
end
|
912
1584
|
|
913
1585
|
# Get Tag Tag Group
|
914
|
-
# Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
915
|
-
# @param id [String]
|
1586
|
+
# Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1587
|
+
# @param id [String]
|
916
1588
|
# @param [Hash] opts the optional parameters
|
917
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1589
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
918
1590
|
# @return [Hash<String, Object>]
|
919
1591
|
def get_tag_tag_group(id, opts = {})
|
920
1592
|
data, _status_code, _headers = get_tag_tag_group_with_http_info(id, opts)
|
@@ -922,10 +1594,10 @@ module KlaviyoAPI
|
|
922
1594
|
end
|
923
1595
|
|
924
1596
|
# Get Tag Tag Group
|
925
|
-
# Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
926
|
-
# @param id [String]
|
1597
|
+
# Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1598
|
+
# @param id [String]
|
927
1599
|
# @param [Hash] opts the optional parameters
|
928
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1600
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
929
1601
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
930
1602
|
def get_tag_tag_group_with_http_info(id, opts = {})
|
931
1603
|
if @api_client.config.debugging
|
@@ -949,7 +1621,7 @@ module KlaviyoAPI
|
|
949
1621
|
# header parameters
|
950
1622
|
header_params = opts[:header_params] || {}
|
951
1623
|
# klaviyo api revision
|
952
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1624
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
953
1625
|
# HTTP header 'Accept' (if needed)
|
954
1626
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
955
1627
|
|
@@ -983,12 +1655,12 @@ module KlaviyoAPI
|
|
983
1655
|
end
|
984
1656
|
|
985
1657
|
# Get Tags
|
986
|
-
# List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1658
|
+
# List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
987
1659
|
# @param [Hash] opts the optional parameters
|
988
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
989
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
990
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
991
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1660
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1661
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
1662
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1663
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
992
1664
|
# @return [Hash<String, Object>]
|
993
1665
|
def get_tags(opts = {})
|
994
1666
|
data, _status_code, _headers = get_tags_with_http_info(opts)
|
@@ -996,12 +1668,12 @@ module KlaviyoAPI
|
|
996
1668
|
end
|
997
1669
|
|
998
1670
|
# Get Tags
|
999
|
-
# List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1671
|
+
# List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1000
1672
|
# @param [Hash] opts the optional parameters
|
1001
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
1002
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1003
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1004
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1673
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1674
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
1675
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1676
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
1005
1677
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1006
1678
|
def get_tags_with_http_info(opts = {})
|
1007
1679
|
if @api_client.config.debugging
|
@@ -1028,7 +1700,7 @@ module KlaviyoAPI
|
|
1028
1700
|
# header parameters
|
1029
1701
|
header_params = opts[:header_params] || {}
|
1030
1702
|
# klaviyo api revision
|
1031
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1703
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1032
1704
|
# HTTP header 'Accept' (if needed)
|
1033
1705
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1034
1706
|
|
@@ -1062,7 +1734,7 @@ module KlaviyoAPI
|
|
1062
1734
|
end
|
1063
1735
|
|
1064
1736
|
# Update Tag
|
1065
|
-
# Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1737
|
+
# Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
1066
1738
|
# @param id [String] The Tag ID
|
1067
1739
|
# @param tag_update_query [TagUpdateQuery]
|
1068
1740
|
# @param [Hash] opts the optional parameters
|
@@ -1073,7 +1745,7 @@ module KlaviyoAPI
|
|
1073
1745
|
end
|
1074
1746
|
|
1075
1747
|
# Update Tag
|
1076
|
-
# Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1748
|
+
# Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
1077
1749
|
# @param id [String] The Tag ID
|
1078
1750
|
# @param tag_update_query [TagUpdateQuery]
|
1079
1751
|
# @param [Hash] opts the optional parameters
|
@@ -1099,7 +1771,7 @@ module KlaviyoAPI
|
|
1099
1771
|
# header parameters
|
1100
1772
|
header_params = opts[:header_params] || {}
|
1101
1773
|
# klaviyo api revision
|
1102
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1774
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1103
1775
|
# HTTP header 'Accept' (if needed)
|
1104
1776
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1105
1777
|
# HTTP header 'Content-Type'
|
@@ -1138,7 +1810,7 @@ module KlaviyoAPI
|
|
1138
1810
|
end
|
1139
1811
|
|
1140
1812
|
# Update Tag Group
|
1141
|
-
# Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1813
|
+
# Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
1142
1814
|
# @param id [String] The Tag Group ID
|
1143
1815
|
# @param tag_group_update_query [TagGroupUpdateQuery]
|
1144
1816
|
# @param [Hash] opts the optional parameters
|
@@ -1149,7 +1821,7 @@ module KlaviyoAPI
|
|
1149
1821
|
end
|
1150
1822
|
|
1151
1823
|
# Update Tag Group
|
1152
|
-
# Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1824
|
+
# Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
1153
1825
|
# @param id [String] The Tag Group ID
|
1154
1826
|
# @param tag_group_update_query [TagGroupUpdateQuery]
|
1155
1827
|
# @param [Hash] opts the optional parameters
|
@@ -1175,7 +1847,7 @@ module KlaviyoAPI
|
|
1175
1847
|
# header parameters
|
1176
1848
|
header_params = opts[:header_params] || {}
|
1177
1849
|
# klaviyo api revision
|
1178
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1850
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1179
1851
|
# HTTP header 'Accept' (if needed)
|
1180
1852
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1181
1853
|
# HTTP header 'Content-Type'
|