klaviyo-api-sdk 2.0.0 → 4.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 +91 -0
- data/README.md +562 -235
- 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 +569 -98
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +427 -357
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +108 -108
- data/lib/klaviyo-api-sdk/api/flows_api.rb +229 -163
- data/lib/klaviyo-api-sdk/api/lists_api.rb +117 -74
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +18 -18
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +108 -114
- data/lib/klaviyo-api-sdk/api/segments_api.rb +105 -62
- data/lib/klaviyo-api-sdk/api/tags_api.rb +145 -117
- data/lib/klaviyo-api-sdk/api/templates_api.rb +39 -39
- 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/{subscription_enum.rb → back_in_stock_subscription_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +32 -38
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +227 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +25 -16
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +5 -20
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object.rb → campaign_message_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{collection_links.rb → campaign_message_create_query_resource_object_attributes.rb} +34 -41
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +23 -14
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +18 -16
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships_items.rb +226 -0
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_update_query_resource_object_relationships_items_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_resource_object_relationships_categories_data_inner.rb → catalog_item_category_op_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +72 -70
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +43 -43
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +115 -113
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +8 -8
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items.rb → catalog_variant_create_query_resource_object_relationships_item.rb} +6 -8
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +57 -57
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +13 -29
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/{content_sub_object.rb → email_content_sub_object.rb} +12 -32
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +220 -0
- data/lib/klaviyo-api-sdk/models/{tracking_options_sub_object.rb → email_tracking_options_sub_object.rb} +28 -28
- data/lib/klaviyo-api-sdk/models/{event_create_query.rb → event_create_query_v2.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object.rb → event_create_query_v2_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object_attributes.rb → event_create_query_v2_resource_object_attributes.rb} +21 -22
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query.rb → event_create_query_v2_resource_object_attributes_metric.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{onsite_profile_create_query.rb → event_create_query_v2_resource_object_attributes_profile.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- 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_campaigns4_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 +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +64 -67
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object.rb → metric_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{metric_create_query.rb → metric_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +29 -19
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +55 -45
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +8 -13
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +39 -39
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/{onsite_profile_meta_identifiers.rb → profile_identifier_dto_resource_object_attributes.rb} +18 -38
- 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/{object_links.rb → profile_meta.rb} +11 -16
- data/lib/klaviyo-api-sdk/models/{sms_message_content.rb → profile_meta_patch_properties.rb} +28 -27
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +106 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +28 -19
- data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query_resource_object_attributes.rb → profile_partial_update_query_resource_object_attributes.rb} +92 -39
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{flow_action_enum.rb → profile_subscription_bulk_delete_job_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/{subscription.rb → profile_subscription_create_query_resource_object_attributes.rb} +18 -28
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{campaign_recipient_estimation_enum.rb → profile_suppression_bulk_delete_job_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query_resource_object.rb → profile_suppression_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{suppression.rb → profile_suppression_create_query_resource_object_attributes.rb} +5 -10
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{subscriptions.rb → profile_suppression_delete_query_resource_object_attributes.rb} +9 -17
- data/lib/klaviyo-api-sdk/models/{sms_render_options.rb → render_options_sub_object.rb} +32 -37
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query.rb → server_bis_subscription_create_query.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object_attributes.rb → server_bis_subscription_create_query_resource_object_attributes.rb} +46 -32
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +224 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/{sms_channel.rb → sms_content_sub_object_create.rb} +12 -11
- data/lib/klaviyo-api-sdk/models/{send_options_sub_object.rb → sms_send_options_sub_object.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{sms_tracking_options.rb → sms_tracking_options_sub_object.rb} +19 -27
- 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_channels.rb +17 -17
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +25 -16
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +14 -32
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +11 -14
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query.rb → suppression_delete_job_create_query.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{error_source.rb → suppression_delete_job_create_query_resource_object_attributes.rb} +14 -17
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +25 -16
- data/lib/klaviyo-api-sdk/models/{email_channel.rb → tag_create_query_resource_object_relationships.rb} +11 -11
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +5 -17
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +23 -35
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +5 -17
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -28
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
- 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 +85 -59
- metadata +91 -571
- data/Gemfile +0 -9
- data/Rakefile +0 -10
- data/docs/AudiencesSubObject.md +0 -20
- data/docs/CampaignCloneQuery.md +0 -18
- data/docs/CampaignCloneQueryResourceObject.md +0 -20
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignCreateQuery.md +0 -18
- data/docs/CampaignCreateQueryResourceObject.md +0 -20
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/CampaignEnum.md +0 -15
- data/docs/CampaignMessageAssignTemplateQuery.md +0 -18
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +0 -20
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignMessageEnum.md +0 -15
- data/docs/CampaignMessagePartialUpdateQuery.md +0 -18
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignPartialUpdateQuery.md +0 -18
- data/docs/CampaignPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +0 -26
- data/docs/CampaignRecipientEstimationEnum.md +0 -15
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +0 -18
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignRecipientEstimationJobEnum.md +0 -15
- data/docs/CampaignSendJobCreateQuery.md +0 -18
- data/docs/CampaignSendJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignSendJobEnum.md +0 -15
- data/docs/CampaignSendJobPartialUpdateQuery.md +0 -18
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignsApi.md +0 -1275
- data/docs/CatalogCategoryBulkCreateJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogCategoryCreateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateQueryResourceObject.md +0 -22
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +0 -24
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryEnum.md +0 -15
- data/docs/CatalogCategoryItemOp.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryUpdateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemBulkCreateJobEnum.md +0 -15
- data/docs/CatalogItemBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogItemBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogItemCategoryOp.md +0 -18
- data/docs/CatalogItemCreateJobCreateQuery.md +0 -18
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemCreateQuery.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObject.md +0 -22
- data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogItemEnum.md +0 -15
- data/docs/CatalogItemUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemUpdateQuery.md +0 -18
- data/docs/CatalogItemUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +0 -34
- data/docs/CatalogJobErrorPayload.md +0 -26
- data/docs/CatalogVariantBulkCreateJobEnum.md +0 -15
- data/docs/CatalogVariantBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogVariantBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogVariantCreateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +0 -46
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItems.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogVariantEnum.md +0 -15
- data/docs/CatalogVariantUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantUpdateQuery.md +0 -18
- data/docs/CatalogVariantUpdateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogsApi.md +0 -4032
- data/docs/ClientApi.md +0 -205
- data/docs/CollectionLinks.md +0 -26
- data/docs/ContentSubObject.md +0 -28
- data/docs/DataPrivacyApi.md +0 -78
- data/docs/DataPrivacyCreateDeletionJobQuery.md +0 -18
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +0 -20
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +0 -22
- data/docs/DataPrivacyDeletionJobEnum.md +0 -15
- data/docs/EmailChannel.md +0 -18
- data/docs/EmailMarketing.md +0 -32
- data/docs/EmailMarketingListSuppression.md +0 -22
- data/docs/EmailMarketingSuppression.md +0 -20
- 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/EventCreateQueryResourceObject.md +0 -20
- data/docs/EventCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/EventEnum.md +0 -15
- data/docs/EventsApi.md +0 -544
- data/docs/FlowActionEnum.md +0 -15
- data/docs/FlowEnum.md +0 -15
- data/docs/FlowMessageEnum.md +0 -15
- data/docs/FlowUpdateQuery.md +0 -18
- data/docs/FlowUpdateQueryResourceObject.md +0 -22
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/FlowsApi.md +0 -1173
- data/docs/GetCampaigns4XXResponse.md +0 -18
- data/docs/GetCampaigns4XXResponseErrorsInner.md +0 -26
- data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +0 -20
- data/docs/ListCreateQuery.md +0 -18
- data/docs/ListCreateQueryResourceObject.md +0 -20
- data/docs/ListCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/ListEnum.md +0 -15
- 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/ListPartialUpdateQueryResourceObject.md +0 -22
- data/docs/ListsApi.md +0 -832
- data/docs/MetricAggregateEnum.md +0 -15
- data/docs/MetricAggregateQuery.md +0 -18
- data/docs/MetricAggregateQueryResourceObject.md +0 -20
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +0 -36
- data/docs/MetricAggregateRowDTO.md +0 -20
- data/docs/MetricCreateQuery.md +0 -20
- data/docs/MetricEnum.md +0 -15
- data/docs/MetricsApi.md +0 -233
- data/docs/ObjectLinks.md +0 -18
- data/docs/OnsiteProfileCreateQuery.md +0 -18
- data/docs/OnsiteProfileCreateQueryResourceObject.md +0 -22
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +0 -38
- data/docs/OnsiteProfileMeta.md +0 -18
- data/docs/OnsiteProfileMetaIdentifiers.md +0 -28
- data/docs/OnsiteSubscriptionCreateQuery.md +0 -18
- data/docs/OnsiteSubscriptionCreateQueryResourceObject.md +0 -20
- data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md +0 -26
- data/docs/PredictiveAnalytics.md +0 -34
- data/docs/ProfileAggregateEnum.md +0 -15
- data/docs/ProfileCreateQuery.md +0 -18
- data/docs/ProfileCreateQueryResourceObject.md +0 -20
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +0 -36
- data/docs/ProfileEnum.md +0 -15
- 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/ProfilePartialUpdateQueryResourceObject.md +0 -22
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileUnsubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileUnsuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfilesApi.md +0 -909
- data/docs/SMSChannel.md +0 -18
- data/docs/SMSMarketing.md +0 -24
- 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/SegmentEnum.md +0 -15
- data/docs/SegmentPartialUpdateQuery.md +0 -18
- data/docs/SegmentPartialUpdateQueryResourceObject.md +0 -22
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/SegmentsApi.md +0 -543
- 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/SubscriptionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/SubscriptionEnum.md +0 -15
- data/docs/Subscriptions.md +0 -20
- data/docs/Suppression.md +0 -18
- data/docs/SuppressionCreateJobCreateQuery.md +0 -18
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagCampaignOp.md +0 -18
- data/docs/TagCampaignOpDataInner.md +0 -20
- data/docs/TagCreateQuery.md +0 -18
- data/docs/TagCreateQueryResourceObject.md +0 -20
- data/docs/TagCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagEnum.md +0 -15
- data/docs/TagFlowOp.md +0 -18
- data/docs/TagFlowOpDataInner.md +0 -20
- data/docs/TagGroupCreateQuery.md +0 -18
- data/docs/TagGroupCreateQueryResourceObject.md +0 -20
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagGroupEnum.md +0 -15
- data/docs/TagGroupUpdateQuery.md +0 -18
- data/docs/TagGroupUpdateQueryResourceObject.md +0 -22
- data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagListOp.md +0 -18
- data/docs/TagListOpDataInner.md +0 -20
- data/docs/TagSegmentOp.md +0 -18
- data/docs/TagSegmentOpDataInner.md +0 -20
- data/docs/TagUpdateQuery.md +0 -18
- data/docs/TagUpdateQueryResourceObject.md +0 -22
- data/docs/TagUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagsApi.md +0 -1923
- data/docs/TemplateCloneQuery.md +0 -18
- data/docs/TemplateCloneQueryResourceObject.md +0 -20
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +0 -22
- data/docs/TemplateCreateQuery.md +0 -18
- data/docs/TemplateCreateQueryResourceObject.md +0 -20
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +0 -32
- data/docs/TemplateEnum.md +0 -15
- data/docs/TemplateRenderQuery.md +0 -18
- data/docs/TemplateRenderQueryResourceObject.md +0 -20
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +0 -22
- data/docs/TemplateUpdateQuery.md +0 -18
- data/docs/TemplateUpdateQueryResourceObject.md +0 -22
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +0 -30
- data/docs/TemplatesApi.md +0 -525
- data/docs/TestApiAnalyticsSampleEnum.md +0 -15
- data/docs/TestListEnum.md +0 -15
- 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/UnsubscriptionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/UnsuppressionCreateJobCreateQuery.md +0 -18
- data/docs/UnsuppressionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/UnsuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/UtmParamInfo.md +0 -20
- data/git_push.sh +0 -57
- data/lib/klaviyo-api-sdk/api/client_api.rb +0 -249
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +0 -284
- data/lib/klaviyo-api-sdk/models/email_marketing.rb +0 -298
- data/lib/klaviyo-api-sdk/models/email_marketing_list_suppression.rb +0 -255
- data/lib/klaviyo-api-sdk/models/email_marketing_suppression.rb +0 -240
- 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/flow_message_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +0 -242
- data/lib/klaviyo-api-sdk/models/predictive_analytics.rb +0 -300
- data/lib/klaviyo-api-sdk/models/profile_aggregate_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +0 -36
- 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_marketing.rb +0 -270
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +0 -235
- data/lib/klaviyo-api-sdk/models/test_api_analytics_sample_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/test_list_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +0 -238
- data/spec/api/campaigns_api_spec.rb +0 -255
- data/spec/api/catalogs_api_spec.rb +0 -751
- 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 -132
- data/spec/api/flows_api_spec.rb +0 -247
- data/spec/api/lists_api_spec.rb +0 -180
- data/spec/api/metrics_api_spec.rb +0 -74
- data/spec/api/profiles_api_spec.rb +0 -194
- data/spec/api/segments_api_spec.rb +0 -130
- data/spec/api/tags_api_spec.rb +0 -367
- data/spec/api/templates_api_spec.rb +0 -124
- 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_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_clone_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_clone_query_spec.rb +0 -34
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/campaign_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_create_query_spec.rb +0 -34
- data/spec/models/campaign_enum_spec.rb +0 -28
- data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_spec.rb +0 -34
- data/spec/models/campaign_message_enum_spec.rb +0 -28
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_message_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_enum_spec.rb +0 -28
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_send_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_send_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +0 -34
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +0 -56
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_category_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_enum_spec.rb +0 -28
- data/spec/models/catalog_category_item_op_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_category_update_query_spec.rb +0 -34
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_category_op_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_item_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_enum_spec.rb +0 -28
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +0 -82
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +0 -52
- 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_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +0 -126
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_data_inner_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_update_query_spec.rb +0 -34
- data/spec/models/collection_links_spec.rb +0 -58
- data/spec/models/content_sub_object_spec.rb +0 -64
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +0 -40
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +0 -34
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +0 -28
- data/spec/models/email_channel_spec.rb +0 -34
- data/spec/models/email_marketing_list_suppression_spec.rb +0 -46
- data/spec/models/email_marketing_spec.rb +0 -76
- data/spec/models/email_marketing_suppression_spec.rb +0 -40
- 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_resource_object_attributes_spec.rb +0 -64
- data/spec/models/event_create_query_resource_object_spec.rb +0 -40
- data/spec/models/event_create_query_spec.rb +0 -34
- data/spec/models/event_enum_spec.rb +0 -28
- data/spec/models/flow_action_enum_spec.rb +0 -28
- data/spec/models/flow_enum_spec.rb +0 -28
- data/spec/models/flow_message_enum_spec.rb +0 -28
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/flow_update_query_resource_object_spec.rb +0 -46
- 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/list_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/list_create_query_resource_object_spec.rb +0 -40
- data/spec/models/list_create_query_spec.rb +0 -34
- data/spec/models/list_enum_spec.rb +0 -28
- 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_resource_object_spec.rb +0 -46
- data/spec/models/list_partial_update_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_enum_spec.rb +0 -28
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +0 -40
- 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/metric_enum_spec.rb +0 -28
- data/spec/models/object_links_spec.rb +0 -34
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +0 -94
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +0 -46
- 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_resource_object_attributes_spec.rb +0 -58
- data/spec/models/onsite_subscription_create_query_resource_object_spec.rb +0 -40
- data/spec/models/onsite_subscription_create_query_spec.rb +0 -34
- data/spec/models/predictive_analytics_spec.rb +0 -82
- data/spec/models/profile_aggregate_enum_spec.rb +0 -28
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +0 -88
- data/spec/models/profile_create_query_resource_object_spec.rb +0 -40
- data/spec/models/profile_create_query_spec.rb +0 -34
- data/spec/models/profile_enum_spec.rb +0 -28
- 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_resource_object_spec.rb +0 -46
- data/spec/models/profile_partial_update_query_spec.rb +0 -34
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_unsubscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_unsuppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/segment_enum_spec.rb +0 -28
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +0 -46
- 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 -34
- data/spec/models/send_strategy_sub_object_spec.rb +0 -52
- data/spec/models/send_time_sub_object_spec.rb +0 -40
- data/spec/models/sms_channel_spec.rb +0 -34
- data/spec/models/sms_marketing_spec.rb +0 -52
- 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_resource_object_attributes_spec.rb +0 -46
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/subscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/subscription_enum_spec.rb +0 -28
- data/spec/models/subscription_spec.rb +0 -52
- data/spec/models/subscriptions_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/suppression_spec.rb +0 -34
- data/spec/models/tag_campaign_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_campaign_op_spec.rb +0 -34
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_create_query_spec.rb +0 -34
- data/spec/models/tag_enum_spec.rb +0 -28
- data/spec/models/tag_flow_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_flow_op_spec.rb +0 -34
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_group_create_query_spec.rb +0 -34
- data/spec/models/tag_group_enum_spec.rb +0 -28
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_group_update_query_spec.rb +0 -34
- data/spec/models/tag_list_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_list_op_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_resource_object_attributes_spec.rb +0 -34
- data/spec/models/tag_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_update_query_spec.rb +0 -34
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_clone_query_resource_object_spec.rb +0 -40
- data/spec/models/template_clone_query_spec.rb +0 -34
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/template_create_query_resource_object_spec.rb +0 -40
- data/spec/models/template_create_query_spec.rb +0 -34
- data/spec/models/template_enum_spec.rb +0 -28
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_render_query_resource_object_spec.rb +0 -40
- data/spec/models/template_render_query_spec.rb +0 -34
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +0 -52
- data/spec/models/template_update_query_resource_object_spec.rb +0 -46
- data/spec/models/template_update_query_spec.rb +0 -34
- data/spec/models/test_api_analytics_sample_enum_spec.rb +0 -28
- data/spec/models/test_list_enum_spec.rb +0 -28
- 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_resource_object_attributes_spec.rb +0 -46
- data/spec/models/unsubscription_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/unsubscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_resource_object_spec.rb +0 -40
- 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/spec_helper.rb +0 -111
data/docs/ListsApi.md
DELETED
@@ -1,832 +0,0 @@
|
|
1
|
-
# KlaviyoAPI::ListsApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://a.klaviyo.com*
|
4
|
-
|
5
|
-
| Method | HTTP request | Description |
|
6
|
-
| ------ | ------------ | ----------- |
|
7
|
-
| [**create_list**](ListsApi.md#create_list) | **POST** /api/lists/ | Create List |
|
8
|
-
| [**create_list_relationships**](ListsApi.md#create_list_relationships) | **POST** /api/lists/{id}/relationships/profiles/ | Add Profile To List |
|
9
|
-
| [**delete_list**](ListsApi.md#delete_list) | **DELETE** /api/lists/{id}/ | Delete List |
|
10
|
-
| [**delete_list_relationships**](ListsApi.md#delete_list_relationships) | **DELETE** /api/lists/{id}/relationships/profiles/ | Remove Profile From List |
|
11
|
-
| [**get_list**](ListsApi.md#get_list) | **GET** /api/lists/{id}/ | Get List |
|
12
|
-
| [**get_list_profiles**](ListsApi.md#get_list_profiles) | **GET** /api/lists/{list_id}/profiles/ | Get List Profiles |
|
13
|
-
| [**get_list_relationships_profiles**](ListsApi.md#get_list_relationships_profiles) | **GET** /api/lists/{id}/relationships/profiles/ | Get List Relationships Profiles |
|
14
|
-
| [**get_list_relationships_tags**](ListsApi.md#get_list_relationships_tags) | **GET** /api/lists/{id}/relationships/tags/ | Get List Relationships Tags |
|
15
|
-
| [**get_list_tags**](ListsApi.md#get_list_tags) | **GET** /api/lists/{list_id}/tags/ | Get List Tags |
|
16
|
-
| [**get_lists**](ListsApi.md#get_lists) | **GET** /api/lists/ | Get Lists |
|
17
|
-
| [**update_list**](ListsApi.md#update_list) | **PATCH** /api/lists/{id}/ | Update List |
|
18
|
-
|
19
|
-
|
20
|
-
## create_list
|
21
|
-
|
22
|
-
> Hash<String, Object> create_list(list_create_query)
|
23
|
-
|
24
|
-
Create List
|
25
|
-
|
26
|
-
Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write`
|
27
|
-
|
28
|
-
### Examples
|
29
|
-
|
30
|
-
```ruby
|
31
|
-
require 'time'
|
32
|
-
require 'klaviyo-api-sdk'
|
33
|
-
# setup authorization
|
34
|
-
KlaviyoAPI.configure do |config|
|
35
|
-
# Configure API key authorization: Klaviyo-API-Key
|
36
|
-
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
37
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
38
|
-
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
39
|
-
end
|
40
|
-
|
41
|
-
api_instance = KlaviyoAPI::ListsApi.new
|
42
|
-
list_create_query = KlaviyoAPI::ListCreateQuery.new({data: KlaviyoAPI::ListCreateQueryResourceObject.new({type: KlaviyoAPI::ListEnum::LIST, attributes: KlaviyoAPI::ListCreateQueryResourceObjectAttributes.new({name: 'Newsletter'})})}) # ListCreateQuery |
|
43
|
-
|
44
|
-
begin
|
45
|
-
# Create List
|
46
|
-
result = api_instance.create_list(list_create_query)
|
47
|
-
p result
|
48
|
-
rescue KlaviyoAPI::ApiError => e
|
49
|
-
puts "Error when calling ListsApi->create_list: #{e}"
|
50
|
-
end
|
51
|
-
```
|
52
|
-
|
53
|
-
#### Using the create_list_with_http_info variant
|
54
|
-
|
55
|
-
This returns an Array which contains the response data, status code and headers.
|
56
|
-
|
57
|
-
> <Array(Hash<String, Object>, Integer, Hash)> create_list_with_http_info(list_create_query)
|
58
|
-
|
59
|
-
```ruby
|
60
|
-
begin
|
61
|
-
# Create List
|
62
|
-
data, status_code, headers = api_instance.create_list_with_http_info(list_create_query)
|
63
|
-
p status_code # => 2xx
|
64
|
-
p headers # => { ... }
|
65
|
-
p data # => Hash<String, Object>
|
66
|
-
rescue KlaviyoAPI::ApiError => e
|
67
|
-
puts "Error when calling ListsApi->create_list_with_http_info: #{e}"
|
68
|
-
end
|
69
|
-
```
|
70
|
-
|
71
|
-
### Parameters
|
72
|
-
|
73
|
-
| Name | Type | Description | Notes |
|
74
|
-
| ---- | ---- | ----------- | ----- |
|
75
|
-
| **list_create_query** | [**ListCreateQuery**](ListCreateQuery.md) | | |
|
76
|
-
|
77
|
-
### Return type
|
78
|
-
|
79
|
-
**Hash<String, Object>**
|
80
|
-
|
81
|
-
### Authorization
|
82
|
-
|
83
|
-
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
84
|
-
|
85
|
-
### HTTP request headers
|
86
|
-
|
87
|
-
- **Content-Type**: application/json
|
88
|
-
- **Accept**: application/json
|
89
|
-
|
90
|
-
|
91
|
-
## create_list_relationships
|
92
|
-
|
93
|
-
> create_list_relationships(id, list_members_add_query)
|
94
|
-
|
95
|
-
Add Profile To List
|
96
|
-
|
97
|
-
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`
|
98
|
-
|
99
|
-
### Examples
|
100
|
-
|
101
|
-
```ruby
|
102
|
-
require 'time'
|
103
|
-
require 'klaviyo-api-sdk'
|
104
|
-
# setup authorization
|
105
|
-
KlaviyoAPI.configure do |config|
|
106
|
-
# Configure API key authorization: Klaviyo-API-Key
|
107
|
-
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
108
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
109
|
-
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
110
|
-
end
|
111
|
-
|
112
|
-
api_instance = KlaviyoAPI::ListsApi.new
|
113
|
-
id = 'id_example' # String |
|
114
|
-
list_members_add_query = KlaviyoAPI::ListMembersAddQuery.new({data: [KlaviyoAPI::ListMembersAddQueryDataInner.new({type: 'profile', id: 'id_example'})]}) # ListMembersAddQuery |
|
115
|
-
|
116
|
-
begin
|
117
|
-
# Add Profile To List
|
118
|
-
api_instance.create_list_relationships(id, list_members_add_query)
|
119
|
-
rescue KlaviyoAPI::ApiError => e
|
120
|
-
puts "Error when calling ListsApi->create_list_relationships: #{e}"
|
121
|
-
end
|
122
|
-
```
|
123
|
-
|
124
|
-
#### Using the create_list_relationships_with_http_info variant
|
125
|
-
|
126
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
127
|
-
|
128
|
-
> <Array(nil, Integer, Hash)> create_list_relationships_with_http_info(id, list_members_add_query)
|
129
|
-
|
130
|
-
```ruby
|
131
|
-
begin
|
132
|
-
# Add Profile To List
|
133
|
-
data, status_code, headers = api_instance.create_list_relationships_with_http_info(id, list_members_add_query)
|
134
|
-
p status_code # => 2xx
|
135
|
-
p headers # => { ... }
|
136
|
-
p data # => nil
|
137
|
-
rescue KlaviyoAPI::ApiError => e
|
138
|
-
puts "Error when calling ListsApi->create_list_relationships_with_http_info: #{e}"
|
139
|
-
end
|
140
|
-
```
|
141
|
-
|
142
|
-
### Parameters
|
143
|
-
|
144
|
-
| Name | Type | Description | Notes |
|
145
|
-
| ---- | ---- | ----------- | ----- |
|
146
|
-
| **id** | **String** | | |
|
147
|
-
| **list_members_add_query** | [**ListMembersAddQuery**](ListMembersAddQuery.md) | | |
|
148
|
-
|
149
|
-
### Return type
|
150
|
-
|
151
|
-
nil (empty response body)
|
152
|
-
|
153
|
-
### Authorization
|
154
|
-
|
155
|
-
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
156
|
-
|
157
|
-
### HTTP request headers
|
158
|
-
|
159
|
-
- **Content-Type**: application/json
|
160
|
-
- **Accept**: application/json
|
161
|
-
|
162
|
-
|
163
|
-
## delete_list
|
164
|
-
|
165
|
-
> delete_list(id)
|
166
|
-
|
167
|
-
Delete List
|
168
|
-
|
169
|
-
Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write`
|
170
|
-
|
171
|
-
### Examples
|
172
|
-
|
173
|
-
```ruby
|
174
|
-
require 'time'
|
175
|
-
require 'klaviyo-api-sdk'
|
176
|
-
# setup authorization
|
177
|
-
KlaviyoAPI.configure do |config|
|
178
|
-
# Configure API key authorization: Klaviyo-API-Key
|
179
|
-
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
180
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
181
|
-
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
182
|
-
end
|
183
|
-
|
184
|
-
api_instance = KlaviyoAPI::ListsApi.new
|
185
|
-
id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
186
|
-
|
187
|
-
begin
|
188
|
-
# Delete List
|
189
|
-
api_instance.delete_list(id)
|
190
|
-
rescue KlaviyoAPI::ApiError => e
|
191
|
-
puts "Error when calling ListsApi->delete_list: #{e}"
|
192
|
-
end
|
193
|
-
```
|
194
|
-
|
195
|
-
#### Using the delete_list_with_http_info variant
|
196
|
-
|
197
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
198
|
-
|
199
|
-
> <Array(nil, Integer, Hash)> delete_list_with_http_info(id)
|
200
|
-
|
201
|
-
```ruby
|
202
|
-
begin
|
203
|
-
# Delete List
|
204
|
-
data, status_code, headers = api_instance.delete_list_with_http_info(id)
|
205
|
-
p status_code # => 2xx
|
206
|
-
p headers # => { ... }
|
207
|
-
p data # => nil
|
208
|
-
rescue KlaviyoAPI::ApiError => e
|
209
|
-
puts "Error when calling ListsApi->delete_list_with_http_info: #{e}"
|
210
|
-
end
|
211
|
-
```
|
212
|
-
|
213
|
-
### Parameters
|
214
|
-
|
215
|
-
| Name | Type | Description | Notes |
|
216
|
-
| ---- | ---- | ----------- | ----- |
|
217
|
-
| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
218
|
-
|
219
|
-
### Return type
|
220
|
-
|
221
|
-
nil (empty response body)
|
222
|
-
|
223
|
-
### Authorization
|
224
|
-
|
225
|
-
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
226
|
-
|
227
|
-
### HTTP request headers
|
228
|
-
|
229
|
-
- **Content-Type**: Not defined
|
230
|
-
- **Accept**: application/json
|
231
|
-
|
232
|
-
|
233
|
-
## delete_list_relationships
|
234
|
-
|
235
|
-
> delete_list_relationships(id, list_members_delete_query)
|
236
|
-
|
237
|
-
Remove Profile From List
|
238
|
-
|
239
|
-
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`
|
240
|
-
|
241
|
-
### Examples
|
242
|
-
|
243
|
-
```ruby
|
244
|
-
require 'time'
|
245
|
-
require 'klaviyo-api-sdk'
|
246
|
-
# setup authorization
|
247
|
-
KlaviyoAPI.configure do |config|
|
248
|
-
# Configure API key authorization: Klaviyo-API-Key
|
249
|
-
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
250
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
251
|
-
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
252
|
-
end
|
253
|
-
|
254
|
-
api_instance = KlaviyoAPI::ListsApi.new
|
255
|
-
id = 'id_example' # String |
|
256
|
-
list_members_delete_query = KlaviyoAPI::ListMembersDeleteQuery.new({data: [KlaviyoAPI::ListMembersAddQueryDataInner.new({type: 'profile', id: 'id_example'})]}) # ListMembersDeleteQuery |
|
257
|
-
|
258
|
-
begin
|
259
|
-
# Remove Profile From List
|
260
|
-
api_instance.delete_list_relationships(id, list_members_delete_query)
|
261
|
-
rescue KlaviyoAPI::ApiError => e
|
262
|
-
puts "Error when calling ListsApi->delete_list_relationships: #{e}"
|
263
|
-
end
|
264
|
-
```
|
265
|
-
|
266
|
-
#### Using the delete_list_relationships_with_http_info variant
|
267
|
-
|
268
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
269
|
-
|
270
|
-
> <Array(nil, Integer, Hash)> delete_list_relationships_with_http_info(id, list_members_delete_query)
|
271
|
-
|
272
|
-
```ruby
|
273
|
-
begin
|
274
|
-
# Remove Profile From List
|
275
|
-
data, status_code, headers = api_instance.delete_list_relationships_with_http_info(id, list_members_delete_query)
|
276
|
-
p status_code # => 2xx
|
277
|
-
p headers # => { ... }
|
278
|
-
p data # => nil
|
279
|
-
rescue KlaviyoAPI::ApiError => e
|
280
|
-
puts "Error when calling ListsApi->delete_list_relationships_with_http_info: #{e}"
|
281
|
-
end
|
282
|
-
```
|
283
|
-
|
284
|
-
### Parameters
|
285
|
-
|
286
|
-
| Name | Type | Description | Notes |
|
287
|
-
| ---- | ---- | ----------- | ----- |
|
288
|
-
| **id** | **String** | | |
|
289
|
-
| **list_members_delete_query** | [**ListMembersDeleteQuery**](ListMembersDeleteQuery.md) | | |
|
290
|
-
|
291
|
-
### Return type
|
292
|
-
|
293
|
-
nil (empty response body)
|
294
|
-
|
295
|
-
### Authorization
|
296
|
-
|
297
|
-
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
298
|
-
|
299
|
-
### HTTP request headers
|
300
|
-
|
301
|
-
- **Content-Type**: application/json
|
302
|
-
- **Accept**: application/json
|
303
|
-
|
304
|
-
|
305
|
-
## get_list
|
306
|
-
|
307
|
-
> Hash<String, Object> get_list(id, opts)
|
308
|
-
|
309
|
-
Get List
|
310
|
-
|
311
|
-
Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write`
|
312
|
-
|
313
|
-
### Examples
|
314
|
-
|
315
|
-
```ruby
|
316
|
-
require 'time'
|
317
|
-
require 'klaviyo-api-sdk'
|
318
|
-
# setup authorization
|
319
|
-
KlaviyoAPI.configure do |config|
|
320
|
-
# Configure API key authorization: Klaviyo-API-Key
|
321
|
-
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
322
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
323
|
-
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
324
|
-
end
|
325
|
-
|
326
|
-
api_instance = KlaviyoAPI::ListsApi.new
|
327
|
-
id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
328
|
-
opts = {
|
329
|
-
fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
330
|
-
}
|
331
|
-
|
332
|
-
begin
|
333
|
-
# Get List
|
334
|
-
result = api_instance.get_list(id, opts)
|
335
|
-
p result
|
336
|
-
rescue KlaviyoAPI::ApiError => e
|
337
|
-
puts "Error when calling ListsApi->get_list: #{e}"
|
338
|
-
end
|
339
|
-
```
|
340
|
-
|
341
|
-
#### Using the get_list_with_http_info variant
|
342
|
-
|
343
|
-
This returns an Array which contains the response data, status code and headers.
|
344
|
-
|
345
|
-
> <Array(Hash<String, Object>, Integer, Hash)> get_list_with_http_info(id, opts)
|
346
|
-
|
347
|
-
```ruby
|
348
|
-
begin
|
349
|
-
# Get List
|
350
|
-
data, status_code, headers = api_instance.get_list_with_http_info(id, opts)
|
351
|
-
p status_code # => 2xx
|
352
|
-
p headers # => { ... }
|
353
|
-
p data # => Hash<String, Object>
|
354
|
-
rescue KlaviyoAPI::ApiError => e
|
355
|
-
puts "Error when calling ListsApi->get_list_with_http_info: #{e}"
|
356
|
-
end
|
357
|
-
```
|
358
|
-
|
359
|
-
### Parameters
|
360
|
-
|
361
|
-
| Name | Type | Description | Notes |
|
362
|
-
| ---- | ---- | ----------- | ----- |
|
363
|
-
| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
364
|
-
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
365
|
-
|
366
|
-
### Return type
|
367
|
-
|
368
|
-
**Hash<String, Object>**
|
369
|
-
|
370
|
-
### Authorization
|
371
|
-
|
372
|
-
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
373
|
-
|
374
|
-
### HTTP request headers
|
375
|
-
|
376
|
-
- **Content-Type**: Not defined
|
377
|
-
- **Accept**: application/json
|
378
|
-
|
379
|
-
|
380
|
-
## get_list_profiles
|
381
|
-
|
382
|
-
> Hash<String, Object> get_list_profiles(list_id, opts)
|
383
|
-
|
384
|
-
Get List Profiles
|
385
|
-
|
386
|
-
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. You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read` `Profiles Read`
|
387
|
-
|
388
|
-
### Examples
|
389
|
-
|
390
|
-
```ruby
|
391
|
-
require 'time'
|
392
|
-
require 'klaviyo-api-sdk'
|
393
|
-
# setup authorization
|
394
|
-
KlaviyoAPI.configure do |config|
|
395
|
-
# Configure API key authorization: Klaviyo-API-Key
|
396
|
-
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
397
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
398
|
-
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
399
|
-
end
|
400
|
-
|
401
|
-
api_instance = KlaviyoAPI::ListsApi.new
|
402
|
-
list_id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
403
|
-
opts = {
|
404
|
-
additional_fields_profile: ['predictive_analytics'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
405
|
-
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
406
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
|
407
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
408
|
-
page_size: 56 # Integer | The number of results to return per page. Default = 20. Max = 100
|
409
|
-
}
|
410
|
-
|
411
|
-
begin
|
412
|
-
# Get List Profiles
|
413
|
-
result = api_instance.get_list_profiles(list_id, opts)
|
414
|
-
p result
|
415
|
-
rescue KlaviyoAPI::ApiError => e
|
416
|
-
puts "Error when calling ListsApi->get_list_profiles: #{e}"
|
417
|
-
end
|
418
|
-
```
|
419
|
-
|
420
|
-
#### Using the get_list_profiles_with_http_info variant
|
421
|
-
|
422
|
-
This returns an Array which contains the response data, status code and headers.
|
423
|
-
|
424
|
-
> <Array(Hash<String, Object>, Integer, Hash)> get_list_profiles_with_http_info(list_id, opts)
|
425
|
-
|
426
|
-
```ruby
|
427
|
-
begin
|
428
|
-
# Get List Profiles
|
429
|
-
data, status_code, headers = api_instance.get_list_profiles_with_http_info(list_id, opts)
|
430
|
-
p status_code # => 2xx
|
431
|
-
p headers # => { ... }
|
432
|
-
p data # => Hash<String, Object>
|
433
|
-
rescue KlaviyoAPI::ApiError => e
|
434
|
-
puts "Error when calling ListsApi->get_list_profiles_with_http_info: #{e}"
|
435
|
-
end
|
436
|
-
```
|
437
|
-
|
438
|
-
### Parameters
|
439
|
-
|
440
|
-
| Name | Type | Description | Notes |
|
441
|
-
| ---- | ---- | ----------- | ----- |
|
442
|
-
| **list_id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
443
|
-
| **additional_fields_profile** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'predictive_analytics' | [optional] |
|
444
|
-
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
445
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals` | [optional] |
|
446
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
447
|
-
| **page_size** | **Integer** | The number of results to return per page. Default = 20. Max = 100 | [optional] |
|
448
|
-
|
449
|
-
### Return type
|
450
|
-
|
451
|
-
**Hash<String, Object>**
|
452
|
-
|
453
|
-
### Authorization
|
454
|
-
|
455
|
-
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
456
|
-
|
457
|
-
### HTTP request headers
|
458
|
-
|
459
|
-
- **Content-Type**: Not defined
|
460
|
-
- **Accept**: application/json
|
461
|
-
|
462
|
-
|
463
|
-
## get_list_relationships_profiles
|
464
|
-
|
465
|
-
> Hash<String, Object> get_list_relationships_profiles(id, opts)
|
466
|
-
|
467
|
-
Get List Relationships Profiles
|
468
|
-
|
469
|
-
Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID. You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read` `Profiles Read`
|
470
|
-
|
471
|
-
### Examples
|
472
|
-
|
473
|
-
```ruby
|
474
|
-
require 'time'
|
475
|
-
require 'klaviyo-api-sdk'
|
476
|
-
# setup authorization
|
477
|
-
KlaviyoAPI.configure do |config|
|
478
|
-
# Configure API key authorization: Klaviyo-API-Key
|
479
|
-
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
480
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
481
|
-
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
482
|
-
end
|
483
|
-
|
484
|
-
api_instance = KlaviyoAPI::ListsApi.new
|
485
|
-
id = 'id_example' # String |
|
486
|
-
opts = {
|
487
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
488
|
-
}
|
489
|
-
|
490
|
-
begin
|
491
|
-
# Get List Relationships Profiles
|
492
|
-
result = api_instance.get_list_relationships_profiles(id, opts)
|
493
|
-
p result
|
494
|
-
rescue KlaviyoAPI::ApiError => e
|
495
|
-
puts "Error when calling ListsApi->get_list_relationships_profiles: #{e}"
|
496
|
-
end
|
497
|
-
```
|
498
|
-
|
499
|
-
#### Using the get_list_relationships_profiles_with_http_info variant
|
500
|
-
|
501
|
-
This returns an Array which contains the response data, status code and headers.
|
502
|
-
|
503
|
-
> <Array(Hash<String, Object>, Integer, Hash)> get_list_relationships_profiles_with_http_info(id, opts)
|
504
|
-
|
505
|
-
```ruby
|
506
|
-
begin
|
507
|
-
# Get List Relationships Profiles
|
508
|
-
data, status_code, headers = api_instance.get_list_relationships_profiles_with_http_info(id, opts)
|
509
|
-
p status_code # => 2xx
|
510
|
-
p headers # => { ... }
|
511
|
-
p data # => Hash<String, Object>
|
512
|
-
rescue KlaviyoAPI::ApiError => e
|
513
|
-
puts "Error when calling ListsApi->get_list_relationships_profiles_with_http_info: #{e}"
|
514
|
-
end
|
515
|
-
```
|
516
|
-
|
517
|
-
### Parameters
|
518
|
-
|
519
|
-
| Name | Type | Description | Notes |
|
520
|
-
| ---- | ---- | ----------- | ----- |
|
521
|
-
| **id** | **String** | | |
|
522
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
523
|
-
|
524
|
-
### Return type
|
525
|
-
|
526
|
-
**Hash<String, Object>**
|
527
|
-
|
528
|
-
### Authorization
|
529
|
-
|
530
|
-
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
531
|
-
|
532
|
-
### HTTP request headers
|
533
|
-
|
534
|
-
- **Content-Type**: Not defined
|
535
|
-
- **Accept**: application/json
|
536
|
-
|
537
|
-
|
538
|
-
## get_list_relationships_tags
|
539
|
-
|
540
|
-
> Hash<String, Object> get_list_relationships_tags(id)
|
541
|
-
|
542
|
-
Get List Relationships Tags
|
543
|
-
|
544
|
-
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`
|
545
|
-
|
546
|
-
### Examples
|
547
|
-
|
548
|
-
```ruby
|
549
|
-
require 'time'
|
550
|
-
require 'klaviyo-api-sdk'
|
551
|
-
# setup authorization
|
552
|
-
KlaviyoAPI.configure do |config|
|
553
|
-
# Configure API key authorization: Klaviyo-API-Key
|
554
|
-
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
555
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
556
|
-
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
557
|
-
end
|
558
|
-
|
559
|
-
api_instance = KlaviyoAPI::ListsApi.new
|
560
|
-
id = 'id_example' # String |
|
561
|
-
|
562
|
-
begin
|
563
|
-
# Get List Relationships Tags
|
564
|
-
result = api_instance.get_list_relationships_tags(id)
|
565
|
-
p result
|
566
|
-
rescue KlaviyoAPI::ApiError => e
|
567
|
-
puts "Error when calling ListsApi->get_list_relationships_tags: #{e}"
|
568
|
-
end
|
569
|
-
```
|
570
|
-
|
571
|
-
#### Using the get_list_relationships_tags_with_http_info variant
|
572
|
-
|
573
|
-
This returns an Array which contains the response data, status code and headers.
|
574
|
-
|
575
|
-
> <Array(Hash<String, Object>, Integer, Hash)> get_list_relationships_tags_with_http_info(id)
|
576
|
-
|
577
|
-
```ruby
|
578
|
-
begin
|
579
|
-
# Get List Relationships Tags
|
580
|
-
data, status_code, headers = api_instance.get_list_relationships_tags_with_http_info(id)
|
581
|
-
p status_code # => 2xx
|
582
|
-
p headers # => { ... }
|
583
|
-
p data # => Hash<String, Object>
|
584
|
-
rescue KlaviyoAPI::ApiError => e
|
585
|
-
puts "Error when calling ListsApi->get_list_relationships_tags_with_http_info: #{e}"
|
586
|
-
end
|
587
|
-
```
|
588
|
-
|
589
|
-
### Parameters
|
590
|
-
|
591
|
-
| Name | Type | Description | Notes |
|
592
|
-
| ---- | ---- | ----------- | ----- |
|
593
|
-
| **id** | **String** | | |
|
594
|
-
|
595
|
-
### Return type
|
596
|
-
|
597
|
-
**Hash<String, Object>**
|
598
|
-
|
599
|
-
### Authorization
|
600
|
-
|
601
|
-
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
602
|
-
|
603
|
-
### HTTP request headers
|
604
|
-
|
605
|
-
- **Content-Type**: Not defined
|
606
|
-
- **Accept**: application/json
|
607
|
-
|
608
|
-
|
609
|
-
## get_list_tags
|
610
|
-
|
611
|
-
> Hash<String, Object> get_list_tags(list_id, opts)
|
612
|
-
|
613
|
-
Get List Tags
|
614
|
-
|
615
|
-
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`
|
616
|
-
|
617
|
-
### Examples
|
618
|
-
|
619
|
-
```ruby
|
620
|
-
require 'time'
|
621
|
-
require 'klaviyo-api-sdk'
|
622
|
-
# setup authorization
|
623
|
-
KlaviyoAPI.configure do |config|
|
624
|
-
# Configure API key authorization: Klaviyo-API-Key
|
625
|
-
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
626
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
627
|
-
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
628
|
-
end
|
629
|
-
|
630
|
-
api_instance = KlaviyoAPI::ListsApi.new
|
631
|
-
list_id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
632
|
-
opts = {
|
633
|
-
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
634
|
-
}
|
635
|
-
|
636
|
-
begin
|
637
|
-
# Get List Tags
|
638
|
-
result = api_instance.get_list_tags(list_id, opts)
|
639
|
-
p result
|
640
|
-
rescue KlaviyoAPI::ApiError => e
|
641
|
-
puts "Error when calling ListsApi->get_list_tags: #{e}"
|
642
|
-
end
|
643
|
-
```
|
644
|
-
|
645
|
-
#### Using the get_list_tags_with_http_info variant
|
646
|
-
|
647
|
-
This returns an Array which contains the response data, status code and headers.
|
648
|
-
|
649
|
-
> <Array(Hash<String, Object>, Integer, Hash)> get_list_tags_with_http_info(list_id, opts)
|
650
|
-
|
651
|
-
```ruby
|
652
|
-
begin
|
653
|
-
# Get List Tags
|
654
|
-
data, status_code, headers = api_instance.get_list_tags_with_http_info(list_id, opts)
|
655
|
-
p status_code # => 2xx
|
656
|
-
p headers # => { ... }
|
657
|
-
p data # => Hash<String, Object>
|
658
|
-
rescue KlaviyoAPI::ApiError => e
|
659
|
-
puts "Error when calling ListsApi->get_list_tags_with_http_info: #{e}"
|
660
|
-
end
|
661
|
-
```
|
662
|
-
|
663
|
-
### Parameters
|
664
|
-
|
665
|
-
| Name | Type | Description | Notes |
|
666
|
-
| ---- | ---- | ----------- | ----- |
|
667
|
-
| **list_id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
668
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
669
|
-
|
670
|
-
### Return type
|
671
|
-
|
672
|
-
**Hash<String, Object>**
|
673
|
-
|
674
|
-
### Authorization
|
675
|
-
|
676
|
-
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
677
|
-
|
678
|
-
### HTTP request headers
|
679
|
-
|
680
|
-
- **Content-Type**: Not defined
|
681
|
-
- **Accept**: application/json
|
682
|
-
|
683
|
-
|
684
|
-
## get_lists
|
685
|
-
|
686
|
-
> Hash<String, Object> get_lists(opts)
|
687
|
-
|
688
|
-
Get Lists
|
689
|
-
|
690
|
-
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`
|
691
|
-
|
692
|
-
### Examples
|
693
|
-
|
694
|
-
```ruby
|
695
|
-
require 'time'
|
696
|
-
require 'klaviyo-api-sdk'
|
697
|
-
# setup authorization
|
698
|
-
KlaviyoAPI.configure do |config|
|
699
|
-
# Configure API key authorization: Klaviyo-API-Key
|
700
|
-
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
701
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
702
|
-
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
703
|
-
end
|
704
|
-
|
705
|
-
api_instance = KlaviyoAPI::ListsApi.new
|
706
|
-
opts = {
|
707
|
-
fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
708
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
|
709
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
710
|
-
}
|
711
|
-
|
712
|
-
begin
|
713
|
-
# Get Lists
|
714
|
-
result = api_instance.get_lists(opts)
|
715
|
-
p result
|
716
|
-
rescue KlaviyoAPI::ApiError => e
|
717
|
-
puts "Error when calling ListsApi->get_lists: #{e}"
|
718
|
-
end
|
719
|
-
```
|
720
|
-
|
721
|
-
#### Using the get_lists_with_http_info variant
|
722
|
-
|
723
|
-
This returns an Array which contains the response data, status code and headers.
|
724
|
-
|
725
|
-
> <Array(Hash<String, Object>, Integer, Hash)> get_lists_with_http_info(opts)
|
726
|
-
|
727
|
-
```ruby
|
728
|
-
begin
|
729
|
-
# Get Lists
|
730
|
-
data, status_code, headers = api_instance.get_lists_with_http_info(opts)
|
731
|
-
p status_code # => 2xx
|
732
|
-
p headers # => { ... }
|
733
|
-
p data # => Hash<String, Object>
|
734
|
-
rescue KlaviyoAPI::ApiError => e
|
735
|
-
puts "Error when calling ListsApi->get_lists_with_http_info: #{e}"
|
736
|
-
end
|
737
|
-
```
|
738
|
-
|
739
|
-
### Parameters
|
740
|
-
|
741
|
-
| Name | Type | Description | Notes |
|
742
|
-
| ---- | ---- | ----------- | ----- |
|
743
|
-
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
744
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` | [optional] |
|
745
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
746
|
-
|
747
|
-
### Return type
|
748
|
-
|
749
|
-
**Hash<String, Object>**
|
750
|
-
|
751
|
-
### Authorization
|
752
|
-
|
753
|
-
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
754
|
-
|
755
|
-
### HTTP request headers
|
756
|
-
|
757
|
-
- **Content-Type**: Not defined
|
758
|
-
- **Accept**: application/json
|
759
|
-
|
760
|
-
|
761
|
-
## update_list
|
762
|
-
|
763
|
-
> Hash<String, Object> update_list(id, list_partial_update_query)
|
764
|
-
|
765
|
-
Update List
|
766
|
-
|
767
|
-
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`
|
768
|
-
|
769
|
-
### Examples
|
770
|
-
|
771
|
-
```ruby
|
772
|
-
require 'time'
|
773
|
-
require 'klaviyo-api-sdk'
|
774
|
-
# setup authorization
|
775
|
-
KlaviyoAPI.configure do |config|
|
776
|
-
# Configure API key authorization: Klaviyo-API-Key
|
777
|
-
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
778
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
779
|
-
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
780
|
-
end
|
781
|
-
|
782
|
-
api_instance = KlaviyoAPI::ListsApi.new
|
783
|
-
id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
784
|
-
list_partial_update_query = KlaviyoAPI::ListPartialUpdateQuery.new({data: KlaviyoAPI::ListPartialUpdateQueryResourceObject.new({type: KlaviyoAPI::ListEnum::LIST, id: 'Y6nRLr', attributes: KlaviyoAPI::ListCreateQueryResourceObjectAttributes.new({name: 'Newsletter'})})}) # ListPartialUpdateQuery |
|
785
|
-
|
786
|
-
begin
|
787
|
-
# Update List
|
788
|
-
result = api_instance.update_list(id, list_partial_update_query)
|
789
|
-
p result
|
790
|
-
rescue KlaviyoAPI::ApiError => e
|
791
|
-
puts "Error when calling ListsApi->update_list: #{e}"
|
792
|
-
end
|
793
|
-
```
|
794
|
-
|
795
|
-
#### Using the update_list_with_http_info variant
|
796
|
-
|
797
|
-
This returns an Array which contains the response data, status code and headers.
|
798
|
-
|
799
|
-
> <Array(Hash<String, Object>, Integer, Hash)> update_list_with_http_info(id, list_partial_update_query)
|
800
|
-
|
801
|
-
```ruby
|
802
|
-
begin
|
803
|
-
# Update List
|
804
|
-
data, status_code, headers = api_instance.update_list_with_http_info(id, list_partial_update_query)
|
805
|
-
p status_code # => 2xx
|
806
|
-
p headers # => { ... }
|
807
|
-
p data # => Hash<String, Object>
|
808
|
-
rescue KlaviyoAPI::ApiError => e
|
809
|
-
puts "Error when calling ListsApi->update_list_with_http_info: #{e}"
|
810
|
-
end
|
811
|
-
```
|
812
|
-
|
813
|
-
### Parameters
|
814
|
-
|
815
|
-
| Name | Type | Description | Notes |
|
816
|
-
| ---- | ---- | ----------- | ----- |
|
817
|
-
| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
818
|
-
| **list_partial_update_query** | [**ListPartialUpdateQuery**](ListPartialUpdateQuery.md) | | |
|
819
|
-
|
820
|
-
### Return type
|
821
|
-
|
822
|
-
**Hash<String, Object>**
|
823
|
-
|
824
|
-
### Authorization
|
825
|
-
|
826
|
-
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
827
|
-
|
828
|
-
### HTTP request headers
|
829
|
-
|
830
|
-
- **Content-Type**: application/json
|
831
|
-
- **Accept**: application/json
|
832
|
-
|