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 List
|
23
|
-
# Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
23
|
+
# Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
24
24
|
# @param list_create_query [ListCreateQuery]
|
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 List
|
33
|
-
# Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
33
|
+
# Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
34
34
|
# @param list_create_query [ListCreateQuery]
|
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'
|
@@ -89,26 +89,24 @@ module KlaviyoAPI
|
|
89
89
|
return data, status_code, headers
|
90
90
|
end
|
91
91
|
|
92
|
-
# Add Profile
|
93
|
-
# Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
92
|
+
# Add Profile To List
|
93
|
+
# Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write` `profiles:write`
|
94
94
|
# @param id [String]
|
95
|
-
# @param related_resource [String]
|
96
95
|
# @param list_members_add_query [ListMembersAddQuery]
|
97
96
|
# @param [Hash] opts the optional parameters
|
98
97
|
# @return [nil]
|
99
|
-
def create_list_relationships(id,
|
100
|
-
create_list_relationships_with_http_info(id,
|
98
|
+
def create_list_relationships(id, list_members_add_query, opts = {})
|
99
|
+
create_list_relationships_with_http_info(id, list_members_add_query, opts)
|
101
100
|
nil
|
102
101
|
end
|
103
102
|
|
104
|
-
# Add Profile
|
105
|
-
# Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
103
|
+
# Add Profile To List
|
104
|
+
# Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write` `profiles:write`
|
106
105
|
# @param id [String]
|
107
|
-
# @param related_resource [String]
|
108
106
|
# @param list_members_add_query [ListMembersAddQuery]
|
109
107
|
# @param [Hash] opts the optional parameters
|
110
108
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
111
|
-
def create_list_relationships_with_http_info(id,
|
109
|
+
def create_list_relationships_with_http_info(id, list_members_add_query, opts = {})
|
112
110
|
if @api_client.config.debugging
|
113
111
|
@api_client.config.logger.debug 'Calling API: ListsApi.create_list_relationships ...'
|
114
112
|
end
|
@@ -116,21 +114,12 @@ module KlaviyoAPI
|
|
116
114
|
if @api_client.config.client_side_validation && id.nil?
|
117
115
|
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.create_list_relationships"
|
118
116
|
end
|
119
|
-
# verify the required parameter 'related_resource' is set
|
120
|
-
if @api_client.config.client_side_validation && related_resource.nil?
|
121
|
-
fail ArgumentError, "Missing the required parameter 'related_resource' when calling ListsApi.create_list_relationships"
|
122
|
-
end
|
123
|
-
# verify enum value
|
124
|
-
allowable_values = ["profiles", "tags"]
|
125
|
-
if @api_client.config.client_side_validation && !allowable_values.include?(related_resource)
|
126
|
-
fail ArgumentError, "invalid value for \"related_resource\", must be one of #{allowable_values}"
|
127
|
-
end
|
128
117
|
# verify the required parameter 'list_members_add_query' is set
|
129
118
|
if @api_client.config.client_side_validation && list_members_add_query.nil?
|
130
119
|
fail ArgumentError, "Missing the required parameter 'list_members_add_query' when calling ListsApi.create_list_relationships"
|
131
120
|
end
|
132
121
|
# resource path
|
133
|
-
local_var_path = '/api/lists/{id}/relationships/
|
122
|
+
local_var_path = '/api/lists/{id}/relationships/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
134
123
|
|
135
124
|
# query parameters
|
136
125
|
query_params = opts[:query_params] || {}
|
@@ -138,7 +127,7 @@ module KlaviyoAPI
|
|
138
127
|
# header parameters
|
139
128
|
header_params = opts[:header_params] || {}
|
140
129
|
# klaviyo api revision
|
141
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
130
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
142
131
|
# HTTP header 'Accept' (if needed)
|
143
132
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
144
133
|
# HTTP header 'Content-Type'
|
@@ -177,7 +166,7 @@ module KlaviyoAPI
|
|
177
166
|
end
|
178
167
|
|
179
168
|
# Delete List
|
180
|
-
# Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
169
|
+
# Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
181
170
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
182
171
|
# @param [Hash] opts the optional parameters
|
183
172
|
# @return [nil]
|
@@ -187,7 +176,7 @@ module KlaviyoAPI
|
|
187
176
|
end
|
188
177
|
|
189
178
|
# Delete List
|
190
|
-
# Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
179
|
+
# Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
191
180
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
192
181
|
# @param [Hash] opts the optional parameters
|
193
182
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -208,7 +197,7 @@ module KlaviyoAPI
|
|
208
197
|
# header parameters
|
209
198
|
header_params = opts[:header_params] || {}
|
210
199
|
# klaviyo api revision
|
211
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
200
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
212
201
|
# HTTP header 'Accept' (if needed)
|
213
202
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
214
203
|
|
@@ -241,26 +230,24 @@ module KlaviyoAPI
|
|
241
230
|
return data, status_code, headers
|
242
231
|
end
|
243
232
|
|
244
|
-
# Remove Profile
|
245
|
-
# Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
233
|
+
# Remove Profile From List
|
234
|
+
# Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write` `profiles:write`
|
246
235
|
# @param id [String]
|
247
|
-
# @param related_resource [String]
|
248
236
|
# @param list_members_delete_query [ListMembersDeleteQuery]
|
249
237
|
# @param [Hash] opts the optional parameters
|
250
238
|
# @return [nil]
|
251
|
-
def delete_list_relationships(id,
|
252
|
-
delete_list_relationships_with_http_info(id,
|
239
|
+
def delete_list_relationships(id, list_members_delete_query, opts = {})
|
240
|
+
delete_list_relationships_with_http_info(id, list_members_delete_query, opts)
|
253
241
|
nil
|
254
242
|
end
|
255
243
|
|
256
|
-
# Remove Profile
|
257
|
-
# Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
244
|
+
# Remove Profile From List
|
245
|
+
# Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write` `profiles:write`
|
258
246
|
# @param id [String]
|
259
|
-
# @param related_resource [String]
|
260
247
|
# @param list_members_delete_query [ListMembersDeleteQuery]
|
261
248
|
# @param [Hash] opts the optional parameters
|
262
249
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
263
|
-
def delete_list_relationships_with_http_info(id,
|
250
|
+
def delete_list_relationships_with_http_info(id, list_members_delete_query, opts = {})
|
264
251
|
if @api_client.config.debugging
|
265
252
|
@api_client.config.logger.debug 'Calling API: ListsApi.delete_list_relationships ...'
|
266
253
|
end
|
@@ -268,21 +255,12 @@ module KlaviyoAPI
|
|
268
255
|
if @api_client.config.client_side_validation && id.nil?
|
269
256
|
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.delete_list_relationships"
|
270
257
|
end
|
271
|
-
# verify the required parameter 'related_resource' is set
|
272
|
-
if @api_client.config.client_side_validation && related_resource.nil?
|
273
|
-
fail ArgumentError, "Missing the required parameter 'related_resource' when calling ListsApi.delete_list_relationships"
|
274
|
-
end
|
275
|
-
# verify enum value
|
276
|
-
allowable_values = ["profiles", "tags"]
|
277
|
-
if @api_client.config.client_side_validation && !allowable_values.include?(related_resource)
|
278
|
-
fail ArgumentError, "invalid value for \"related_resource\", must be one of #{allowable_values}"
|
279
|
-
end
|
280
258
|
# verify the required parameter 'list_members_delete_query' is set
|
281
259
|
if @api_client.config.client_side_validation && list_members_delete_query.nil?
|
282
260
|
fail ArgumentError, "Missing the required parameter 'list_members_delete_query' when calling ListsApi.delete_list_relationships"
|
283
261
|
end
|
284
262
|
# resource path
|
285
|
-
local_var_path = '/api/lists/{id}/relationships/
|
263
|
+
local_var_path = '/api/lists/{id}/relationships/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
286
264
|
|
287
265
|
# query parameters
|
288
266
|
query_params = opts[:query_params] || {}
|
@@ -290,7 +268,7 @@ module KlaviyoAPI
|
|
290
268
|
# header parameters
|
291
269
|
header_params = opts[:header_params] || {}
|
292
270
|
# klaviyo api revision
|
293
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
271
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
294
272
|
# HTTP header 'Accept' (if needed)
|
295
273
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
296
274
|
# HTTP header 'Content-Type'
|
@@ -329,10 +307,10 @@ module KlaviyoAPI
|
|
329
307
|
end
|
330
308
|
|
331
309
|
# Get List
|
332
|
-
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
310
|
+
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
333
311
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
334
312
|
# @param [Hash] opts the optional parameters
|
335
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
313
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
336
314
|
# @return [Hash<String, Object>]
|
337
315
|
def get_list(id, opts = {})
|
338
316
|
data, _status_code, _headers = get_list_with_http_info(id, opts)
|
@@ -340,10 +318,10 @@ module KlaviyoAPI
|
|
340
318
|
end
|
341
319
|
|
342
320
|
# Get List
|
343
|
-
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
321
|
+
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
344
322
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
345
323
|
# @param [Hash] opts the optional parameters
|
346
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
324
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
347
325
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
348
326
|
def get_list_with_http_info(id, opts = {})
|
349
327
|
if @api_client.config.debugging
|
@@ -367,7 +345,7 @@ module KlaviyoAPI
|
|
367
345
|
# header parameters
|
368
346
|
header_params = opts[:header_params] || {}
|
369
347
|
# klaviyo api revision
|
370
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
348
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
371
349
|
# HTTP header 'Accept' (if needed)
|
372
350
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
373
351
|
|
@@ -401,51 +379,69 @@ module KlaviyoAPI
|
|
401
379
|
end
|
402
380
|
|
403
381
|
# Get List Profiles
|
404
|
-
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields
|
405
|
-
# @param
|
382
|
+
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read` `profiles:read`
|
383
|
+
# @param id [String]
|
406
384
|
# @param [Hash] opts the optional parameters
|
407
|
-
# @option opts [Array<String>] :
|
408
|
-
# @option opts [String] :
|
409
|
-
# @option opts [String] :
|
385
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
386
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
387
|
+
# @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>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
|
388
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
389
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
410
390
|
# @return [Hash<String, Object>]
|
411
|
-
def get_list_profiles(
|
412
|
-
data, _status_code, _headers = get_list_profiles_with_http_info(
|
391
|
+
def get_list_profiles(id, opts = {})
|
392
|
+
data, _status_code, _headers = get_list_profiles_with_http_info(id, opts)
|
413
393
|
data
|
414
394
|
end
|
415
395
|
|
416
396
|
# Get List Profiles
|
417
|
-
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields
|
418
|
-
# @param
|
397
|
+
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read` `profiles:read`
|
398
|
+
# @param id [String]
|
419
399
|
# @param [Hash] opts the optional parameters
|
420
|
-
# @option opts [Array<String>] :
|
421
|
-
# @option opts [String] :
|
422
|
-
# @option opts [String] :
|
400
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
401
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
402
|
+
# @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>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
|
403
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
404
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
423
405
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
424
|
-
def get_list_profiles_with_http_info(
|
406
|
+
def get_list_profiles_with_http_info(id, opts = {})
|
425
407
|
if @api_client.config.debugging
|
426
408
|
@api_client.config.logger.debug 'Calling API: ListsApi.get_list_profiles ...'
|
427
409
|
end
|
428
|
-
# verify the required parameter '
|
429
|
-
if @api_client.config.client_side_validation &&
|
430
|
-
fail ArgumentError, "Missing the required parameter '
|
410
|
+
# verify the required parameter 'id' is set
|
411
|
+
if @api_client.config.client_side_validation && id.nil?
|
412
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.get_list_profiles"
|
413
|
+
end
|
414
|
+
allowable_values = ["predictive_analytics"]
|
415
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
416
|
+
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
431
417
|
end
|
432
|
-
allowable_values = ["email", "phone_number", "external_id", "
|
418
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.suppressions.reason", "subscriptions.email.marketing.suppressions.timestamp", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.list_suppressions.list_id", "subscriptions.email.marketing.list_suppressions.reason", "subscriptions.email.marketing.list_suppressions.timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
433
419
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
434
420
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
435
421
|
end
|
422
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
423
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ListsApi.get_list_profiles, must be smaller than or equal to 100.'
|
424
|
+
end
|
425
|
+
|
426
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
427
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ListsApi.get_list_profiles, must be greater than or equal to 1.'
|
428
|
+
end
|
429
|
+
|
436
430
|
# resource path
|
437
|
-
local_var_path = '/api/lists/{
|
431
|
+
local_var_path = '/api/lists/{id}/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
438
432
|
|
439
433
|
# query parameters
|
440
434
|
query_params = opts[:query_params] || {}
|
435
|
+
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
441
436
|
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
442
437
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
443
438
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
439
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
444
440
|
|
445
441
|
# header parameters
|
446
442
|
header_params = opts[:header_params] || {}
|
447
443
|
# klaviyo api revision
|
448
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
444
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
449
445
|
# HTTP header 'Accept' (if needed)
|
450
446
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
451
447
|
|
@@ -478,53 +474,107 @@ module KlaviyoAPI
|
|
478
474
|
return data, status_code, headers
|
479
475
|
end
|
480
476
|
|
481
|
-
# Get List Relationships
|
482
|
-
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID
|
477
|
+
# Get List Relationships Profiles
|
478
|
+
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read` `profiles:read`
|
483
479
|
# @param id [String]
|
484
|
-
# @param related_resource [String]
|
485
480
|
# @param [Hash] opts the optional parameters
|
486
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
481
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
487
482
|
# @return [Hash<String, Object>]
|
488
|
-
def
|
489
|
-
data, _status_code, _headers =
|
483
|
+
def get_list_relationships_profiles(id, opts = {})
|
484
|
+
data, _status_code, _headers = get_list_relationships_profiles_with_http_info(id, opts)
|
490
485
|
data
|
491
486
|
end
|
492
487
|
|
493
|
-
# Get List Relationships
|
494
|
-
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID
|
488
|
+
# Get List Relationships Profiles
|
489
|
+
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read` `profiles:read`
|
495
490
|
# @param id [String]
|
496
|
-
# @param related_resource [String]
|
497
491
|
# @param [Hash] opts the optional parameters
|
498
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
492
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
499
493
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
500
|
-
def
|
494
|
+
def get_list_relationships_profiles_with_http_info(id, opts = {})
|
501
495
|
if @api_client.config.debugging
|
502
|
-
@api_client.config.logger.debug 'Calling API: ListsApi.
|
496
|
+
@api_client.config.logger.debug 'Calling API: ListsApi.get_list_relationships_profiles ...'
|
503
497
|
end
|
504
498
|
# verify the required parameter 'id' is set
|
505
499
|
if @api_client.config.client_side_validation && id.nil?
|
506
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.
|
500
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.get_list_relationships_profiles"
|
507
501
|
end
|
508
|
-
#
|
509
|
-
|
510
|
-
|
502
|
+
# resource path
|
503
|
+
local_var_path = '/api/lists/{id}/relationships/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
504
|
+
|
505
|
+
# query parameters
|
506
|
+
query_params = opts[:query_params] || {}
|
507
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
508
|
+
|
509
|
+
# header parameters
|
510
|
+
header_params = opts[:header_params] || {}
|
511
|
+
# klaviyo api revision
|
512
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
513
|
+
# HTTP header 'Accept' (if needed)
|
514
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
515
|
+
|
516
|
+
# form parameters
|
517
|
+
form_params = opts[:form_params] || {}
|
518
|
+
|
519
|
+
# http body (model)
|
520
|
+
post_body = opts[:debug_body]
|
521
|
+
|
522
|
+
# return_type
|
523
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
524
|
+
|
525
|
+
# auth_names
|
526
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
527
|
+
|
528
|
+
new_options = opts.merge(
|
529
|
+
:operation => :"ListsApi.get_list_relationships_profiles",
|
530
|
+
:header_params => header_params,
|
531
|
+
:query_params => query_params,
|
532
|
+
:form_params => form_params,
|
533
|
+
:body => post_body,
|
534
|
+
:auth_names => auth_names,
|
535
|
+
:return_type => return_type
|
536
|
+
)
|
537
|
+
|
538
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
539
|
+
if @api_client.config.debugging
|
540
|
+
@api_client.config.logger.debug "API called: ListsApi#get_list_relationships_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
541
|
+
end
|
542
|
+
return data, status_code, headers
|
543
|
+
end
|
544
|
+
|
545
|
+
# Get List Relationships Tags
|
546
|
+
# Returns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:read` `tags:read`
|
547
|
+
# @param id [String]
|
548
|
+
# @param [Hash] opts the optional parameters
|
549
|
+
# @return [Hash<String, Object>]
|
550
|
+
def get_list_relationships_tags(id, opts = {})
|
551
|
+
data, _status_code, _headers = get_list_relationships_tags_with_http_info(id, opts)
|
552
|
+
data
|
553
|
+
end
|
554
|
+
|
555
|
+
# Get List Relationships Tags
|
556
|
+
# Returns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:read` `tags:read`
|
557
|
+
# @param id [String]
|
558
|
+
# @param [Hash] opts the optional parameters
|
559
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
560
|
+
def get_list_relationships_tags_with_http_info(id, opts = {})
|
561
|
+
if @api_client.config.debugging
|
562
|
+
@api_client.config.logger.debug 'Calling API: ListsApi.get_list_relationships_tags ...'
|
511
563
|
end
|
512
|
-
# verify
|
513
|
-
|
514
|
-
|
515
|
-
fail ArgumentError, "invalid value for \"related_resource\", must be one of #{allowable_values}"
|
564
|
+
# verify the required parameter 'id' is set
|
565
|
+
if @api_client.config.client_side_validation && id.nil?
|
566
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.get_list_relationships_tags"
|
516
567
|
end
|
517
568
|
# resource path
|
518
|
-
local_var_path = '/api/lists/{id}/relationships/
|
569
|
+
local_var_path = '/api/lists/{id}/relationships/tags/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
519
570
|
|
520
571
|
# query parameters
|
521
572
|
query_params = opts[:query_params] || {}
|
522
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
523
573
|
|
524
574
|
# header parameters
|
525
575
|
header_params = opts[:header_params] || {}
|
526
576
|
# klaviyo api revision
|
527
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
577
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
528
578
|
# HTTP header 'Accept' (if needed)
|
529
579
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
530
580
|
|
@@ -541,7 +591,7 @@ module KlaviyoAPI
|
|
541
591
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
542
592
|
|
543
593
|
new_options = opts.merge(
|
544
|
-
:operation => :"ListsApi.
|
594
|
+
:operation => :"ListsApi.get_list_relationships_tags",
|
545
595
|
:header_params => header_params,
|
546
596
|
:query_params => query_params,
|
547
597
|
:form_params => form_params,
|
@@ -552,42 +602,42 @@ module KlaviyoAPI
|
|
552
602
|
|
553
603
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
554
604
|
if @api_client.config.debugging
|
555
|
-
@api_client.config.logger.debug "API called: ListsApi#
|
605
|
+
@api_client.config.logger.debug "API called: ListsApi#get_list_relationships_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
556
606
|
end
|
557
607
|
return data, status_code, headers
|
558
608
|
end
|
559
609
|
|
560
610
|
# Get List Tags
|
561
|
-
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
562
|
-
# @param
|
611
|
+
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:read` `tags:read`
|
612
|
+
# @param id [String]
|
563
613
|
# @param [Hash] opts the optional parameters
|
564
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
614
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
565
615
|
# @return [Hash<String, Object>]
|
566
|
-
def get_list_tags(
|
567
|
-
data, _status_code, _headers = get_list_tags_with_http_info(
|
616
|
+
def get_list_tags(id, opts = {})
|
617
|
+
data, _status_code, _headers = get_list_tags_with_http_info(id, opts)
|
568
618
|
data
|
569
619
|
end
|
570
620
|
|
571
621
|
# Get List Tags
|
572
|
-
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
573
|
-
# @param
|
622
|
+
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:read` `tags:read`
|
623
|
+
# @param id [String]
|
574
624
|
# @param [Hash] opts the optional parameters
|
575
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
625
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
576
626
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
577
|
-
def get_list_tags_with_http_info(
|
627
|
+
def get_list_tags_with_http_info(id, opts = {})
|
578
628
|
if @api_client.config.debugging
|
579
629
|
@api_client.config.logger.debug 'Calling API: ListsApi.get_list_tags ...'
|
580
630
|
end
|
581
|
-
# verify the required parameter '
|
582
|
-
if @api_client.config.client_side_validation &&
|
583
|
-
fail ArgumentError, "Missing the required parameter '
|
631
|
+
# verify the required parameter 'id' is set
|
632
|
+
if @api_client.config.client_side_validation && id.nil?
|
633
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.get_list_tags"
|
584
634
|
end
|
585
635
|
allowable_values = ["name"]
|
586
636
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
587
637
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
588
638
|
end
|
589
639
|
# resource path
|
590
|
-
local_var_path = '/api/lists/{
|
640
|
+
local_var_path = '/api/lists/{id}/tags/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
591
641
|
|
592
642
|
# query parameters
|
593
643
|
query_params = opts[:query_params] || {}
|
@@ -596,7 +646,7 @@ module KlaviyoAPI
|
|
596
646
|
# header parameters
|
597
647
|
header_params = opts[:header_params] || {}
|
598
648
|
# klaviyo api revision
|
599
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
649
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
600
650
|
# HTTP header 'Accept' (if needed)
|
601
651
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
602
652
|
|
@@ -630,11 +680,11 @@ module KlaviyoAPI
|
|
630
680
|
end
|
631
681
|
|
632
682
|
# Get Lists
|
633
|
-
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
683
|
+
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read`
|
634
684
|
# @param [Hash] opts the optional parameters
|
635
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
636
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
637
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
685
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
686
|
+
# @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`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
|
687
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
638
688
|
# @return [Hash<String, Object>]
|
639
689
|
def get_lists(opts = {})
|
640
690
|
data, _status_code, _headers = get_lists_with_http_info(opts)
|
@@ -642,11 +692,11 @@ module KlaviyoAPI
|
|
642
692
|
end
|
643
693
|
|
644
694
|
# Get Lists
|
645
|
-
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
695
|
+
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read`
|
646
696
|
# @param [Hash] opts the optional parameters
|
647
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
648
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
649
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
697
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
698
|
+
# @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`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
|
699
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
650
700
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
651
701
|
def get_lists_with_http_info(opts = {})
|
652
702
|
if @api_client.config.debugging
|
@@ -668,7 +718,7 @@ module KlaviyoAPI
|
|
668
718
|
# header parameters
|
669
719
|
header_params = opts[:header_params] || {}
|
670
720
|
# klaviyo api revision
|
671
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
721
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
672
722
|
# HTTP header 'Accept' (if needed)
|
673
723
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
674
724
|
|
@@ -702,7 +752,7 @@ module KlaviyoAPI
|
|
702
752
|
end
|
703
753
|
|
704
754
|
# Update List
|
705
|
-
# Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
755
|
+
# Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
706
756
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
707
757
|
# @param list_partial_update_query [ListPartialUpdateQuery]
|
708
758
|
# @param [Hash] opts the optional parameters
|
@@ -713,7 +763,7 @@ module KlaviyoAPI
|
|
713
763
|
end
|
714
764
|
|
715
765
|
# Update List
|
716
|
-
# Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
766
|
+
# Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
717
767
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
718
768
|
# @param list_partial_update_query [ListPartialUpdateQuery]
|
719
769
|
# @param [Hash] opts the optional parameters
|
@@ -739,7 +789,7 @@ module KlaviyoAPI
|
|
739
789
|
# header parameters
|
740
790
|
header_params = opts[:header_params] || {}
|
741
791
|
# klaviyo api revision
|
742
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
792
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
743
793
|
# HTTP header 'Accept' (if needed)
|
744
794
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
745
795
|
# HTTP header 'Content-Type'
|