klaviyo-api-sdk 3.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 +33 -7
- data/README.md +243 -173
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +7 -7
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +528 -57
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +290 -220
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +92 -92
- data/lib/klaviyo-api-sdk/api/flows_api.rb +105 -94
- data/lib/klaviyo-api-sdk/api/lists_api.rb +75 -40
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +57 -57
- data/lib/klaviyo-api-sdk/api/segments_api.rb +71 -36
- data/lib/klaviyo-api-sdk/api/tags_api.rb +91 -63
- data/lib/klaviyo-api-sdk/api/templates_api.rb +25 -25
- 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/{profile_unsuppression_bulk_create_job_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 +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +16 -22
- 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 +11 -2
- 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} +6 -6
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +253 -0
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +12 -3
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +3 -3
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +3 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships_items_data_inner.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op_data_inner.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +3 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
- 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 +1 -1
- 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 +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +224 -0
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
- 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 +1 -1
- 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} +19 -39
- 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} +18 -18
- data/lib/klaviyo-api-sdk/models/{event_create_query.rb → event_create_query_v2.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object.rb → event_create_query_v2_resource_object.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object_attributes.rb → event_create_query_v2_resource_object_attributes.rb} +6 -7
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +224 -0
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_create_variants_jobs5_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_create_variants_jobs5_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_create_variants_jobs5_xx_response_errors_inner_source.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object.rb → metric_create_query_resource_object.rb} +6 -6
- 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/{profile_unsubscription_bulk_create_job_enum.rb → metric_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +257 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +328 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +219 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +1 -1
- 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/profile_identifier_dto_resource_object_attributes.rb +249 -0
- data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +219 -0
- data/lib/klaviyo-api-sdk/models/{tag_create_query_resource_object_attributes.rb → profile_meta_patch_properties.rb} +28 -24
- 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 +11 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +36 -0
- 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} +17 -27
- 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/profile_suppression_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +238 -0
- 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/profile_suppression_delete_query_resource_object_attributes.rb +220 -0
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +261 -0
- 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 +1 -1
- 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 +1 -1
- 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_content_sub_object_create.rb +220 -0
- 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/{unsuppression_create_job_create_query_resource_object_attributes.rb → sms_tracking_options_sub_object.rb} +23 -18
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
- 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 +11 -2
- 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/{unsubscription_create_job_create_query.rb → subscription_delete_job_create_query.rb} +5 -5
- 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 +1 -1
- 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/suppression_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +224 -0
- 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 +12 -3
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +219 -0
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +2 -14
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +2 -14
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +2 -14
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +5 -17
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- 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 +81 -19
- metadata +82 -20
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2023-
|
6
|
+
The version of the OpenAPI document: 2023-07-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -51,7 +51,7 @@ module KlaviyoAPI
|
|
51
51
|
# header parameters
|
52
52
|
header_params = opts[:header_params] || {}
|
53
53
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
54
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
55
55
|
# HTTP header 'Accept' (if needed)
|
56
56
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
57
|
# HTTP header 'Content-Type'
|
@@ -121,7 +121,7 @@ module KlaviyoAPI
|
|
121
121
|
# header parameters
|
122
122
|
header_params = opts[:header_params] || {}
|
123
123
|
# klaviyo api revision
|
124
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
124
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
125
125
|
# HTTP header 'Accept' (if needed)
|
126
126
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
127
127
|
# HTTP header 'Content-Type'
|
@@ -197,7 +197,7 @@ module KlaviyoAPI
|
|
197
197
|
# header parameters
|
198
198
|
header_params = opts[:header_params] || {}
|
199
199
|
# klaviyo api revision
|
200
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
200
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
201
201
|
# HTTP header 'Accept' (if needed)
|
202
202
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
203
203
|
# HTTP header 'Content-Type'
|
@@ -273,7 +273,7 @@ module KlaviyoAPI
|
|
273
273
|
# header parameters
|
274
274
|
header_params = opts[:header_params] || {}
|
275
275
|
# klaviyo api revision
|
276
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
276
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
277
277
|
# HTTP header 'Accept' (if needed)
|
278
278
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
279
279
|
# HTTP header 'Content-Type'
|
@@ -349,7 +349,7 @@ module KlaviyoAPI
|
|
349
349
|
# header parameters
|
350
350
|
header_params = opts[:header_params] || {}
|
351
351
|
# klaviyo api revision
|
352
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
352
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
353
353
|
# HTTP header 'Accept' (if needed)
|
354
354
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
355
355
|
# HTTP header 'Content-Type'
|
@@ -425,7 +425,7 @@ module KlaviyoAPI
|
|
425
425
|
# header parameters
|
426
426
|
header_params = opts[:header_params] || {}
|
427
427
|
# klaviyo api revision
|
428
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
428
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
429
429
|
# HTTP header 'Accept' (if needed)
|
430
430
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
431
431
|
# HTTP header 'Content-Type'
|
@@ -467,17 +467,17 @@ module KlaviyoAPI
|
|
467
467
|
# Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
468
468
|
# @param id [String] The Tag ID
|
469
469
|
# @param [Hash] opts the optional parameters
|
470
|
-
# @return [
|
470
|
+
# @return [nil]
|
471
471
|
def delete_tag(id, opts = {})
|
472
|
-
|
473
|
-
|
472
|
+
delete_tag_with_http_info(id, opts)
|
473
|
+
nil
|
474
474
|
end
|
475
475
|
|
476
476
|
# Delete Tag
|
477
477
|
# Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
478
478
|
# @param id [String] The Tag ID
|
479
479
|
# @param [Hash] opts the optional parameters
|
480
|
-
# @return [Array<(
|
480
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
481
481
|
def delete_tag_with_http_info(id, opts = {})
|
482
482
|
if @api_client.config.debugging
|
483
483
|
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag ...'
|
@@ -495,7 +495,7 @@ module KlaviyoAPI
|
|
495
495
|
# header parameters
|
496
496
|
header_params = opts[:header_params] || {}
|
497
497
|
# klaviyo api revision
|
498
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
498
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
499
499
|
# HTTP header 'Accept' (if needed)
|
500
500
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
501
501
|
|
@@ -506,7 +506,7 @@ module KlaviyoAPI
|
|
506
506
|
post_body = opts[:debug_body]
|
507
507
|
|
508
508
|
# return_type
|
509
|
-
return_type = opts[:debug_return_type]
|
509
|
+
return_type = opts[:debug_return_type]
|
510
510
|
|
511
511
|
# auth_names
|
512
512
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
@@ -560,7 +560,7 @@ module KlaviyoAPI
|
|
560
560
|
# header parameters
|
561
561
|
header_params = opts[:header_params] || {}
|
562
562
|
# klaviyo api revision
|
563
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
563
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
564
564
|
# HTTP header 'Accept' (if needed)
|
565
565
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
566
566
|
|
@@ -631,7 +631,7 @@ module KlaviyoAPI
|
|
631
631
|
# header parameters
|
632
632
|
header_params = opts[:header_params] || {}
|
633
633
|
# klaviyo api revision
|
634
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
634
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
635
635
|
# HTTP header 'Accept' (if needed)
|
636
636
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
637
637
|
# HTTP header 'Content-Type'
|
@@ -707,7 +707,7 @@ module KlaviyoAPI
|
|
707
707
|
# header parameters
|
708
708
|
header_params = opts[:header_params] || {}
|
709
709
|
# klaviyo api revision
|
710
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
710
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
711
711
|
# HTTP header 'Accept' (if needed)
|
712
712
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
713
713
|
# HTTP header 'Content-Type'
|
@@ -783,7 +783,7 @@ module KlaviyoAPI
|
|
783
783
|
# header parameters
|
784
784
|
header_params = opts[:header_params] || {}
|
785
785
|
# klaviyo api revision
|
786
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
786
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
787
787
|
# HTTP header 'Accept' (if needed)
|
788
788
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
789
789
|
# HTTP header 'Content-Type'
|
@@ -859,7 +859,7 @@ module KlaviyoAPI
|
|
859
859
|
# header parameters
|
860
860
|
header_params = opts[:header_params] || {}
|
861
861
|
# klaviyo api revision
|
862
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
862
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
863
863
|
# HTTP header 'Accept' (if needed)
|
864
864
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
865
865
|
# HTTP header 'Content-Type'
|
@@ -901,7 +901,9 @@ module KlaviyoAPI
|
|
901
901
|
# Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
902
902
|
# @param id [String] The Tag ID
|
903
903
|
# @param [Hash] opts the optional parameters
|
904
|
-
# @option opts [Array<String>] :
|
904
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
905
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
906
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
905
907
|
# @return [Hash<String, Object>]
|
906
908
|
def get_tag(id, opts = {})
|
907
909
|
data, _status_code, _headers = get_tag_with_http_info(id, opts)
|
@@ -912,7 +914,9 @@ module KlaviyoAPI
|
|
912
914
|
# Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
913
915
|
# @param id [String] The Tag ID
|
914
916
|
# @param [Hash] opts the optional parameters
|
915
|
-
# @option opts [Array<String>] :
|
917
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
918
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
919
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
916
920
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
917
921
|
def get_tag_with_http_info(id, opts = {})
|
918
922
|
if @api_client.config.debugging
|
@@ -922,21 +926,31 @@ module KlaviyoAPI
|
|
922
926
|
if @api_client.config.client_side_validation && id.nil?
|
923
927
|
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag"
|
924
928
|
end
|
929
|
+
allowable_values = ["name", "exclusive", "default"]
|
930
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
931
|
+
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
932
|
+
end
|
925
933
|
allowable_values = ["name"]
|
926
934
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
927
935
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
928
936
|
end
|
937
|
+
allowable_values = ["tag-group"]
|
938
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
939
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
940
|
+
end
|
929
941
|
# resource path
|
930
942
|
local_var_path = '/api/tags/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
931
943
|
|
932
944
|
# query parameters
|
933
945
|
query_params = opts[:query_params] || {}
|
946
|
+
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
934
947
|
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
948
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
935
949
|
|
936
950
|
# header parameters
|
937
951
|
header_params = opts[:header_params] || {}
|
938
952
|
# klaviyo api revision
|
939
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
953
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
940
954
|
# HTTP header 'Accept' (if needed)
|
941
955
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
942
956
|
|
@@ -973,7 +987,7 @@ module KlaviyoAPI
|
|
973
987
|
# Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
974
988
|
# @param id [String] The Tag Group ID
|
975
989
|
# @param [Hash] opts the optional parameters
|
976
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
990
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
977
991
|
# @return [Hash<String, Object>]
|
978
992
|
def get_tag_group(id, opts = {})
|
979
993
|
data, _status_code, _headers = get_tag_group_with_http_info(id, opts)
|
@@ -984,7 +998,7 @@ module KlaviyoAPI
|
|
984
998
|
# Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
985
999
|
# @param id [String] The Tag Group ID
|
986
1000
|
# @param [Hash] opts the optional parameters
|
987
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1001
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
988
1002
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
989
1003
|
def get_tag_group_with_http_info(id, opts = {})
|
990
1004
|
if @api_client.config.debugging
|
@@ -1008,7 +1022,7 @@ module KlaviyoAPI
|
|
1008
1022
|
# header parameters
|
1009
1023
|
header_params = opts[:header_params] || {}
|
1010
1024
|
# klaviyo api revision
|
1011
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1025
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1012
1026
|
# HTTP header 'Accept' (if needed)
|
1013
1027
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1014
1028
|
|
@@ -1073,7 +1087,7 @@ module KlaviyoAPI
|
|
1073
1087
|
# header parameters
|
1074
1088
|
header_params = opts[:header_params] || {}
|
1075
1089
|
# klaviyo api revision
|
1076
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1090
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1077
1091
|
# HTTP header 'Accept' (if needed)
|
1078
1092
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1079
1093
|
|
@@ -1110,7 +1124,7 @@ module KlaviyoAPI
|
|
1110
1124
|
# Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1111
1125
|
# @param id [String]
|
1112
1126
|
# @param [Hash] opts the optional parameters
|
1113
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
1127
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1114
1128
|
# @return [Hash<String, Object>]
|
1115
1129
|
def get_tag_group_tags(id, opts = {})
|
1116
1130
|
data, _status_code, _headers = get_tag_group_tags_with_http_info(id, opts)
|
@@ -1121,7 +1135,7 @@ module KlaviyoAPI
|
|
1121
1135
|
# Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1122
1136
|
# @param id [String]
|
1123
1137
|
# @param [Hash] opts the optional parameters
|
1124
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
1138
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1125
1139
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1126
1140
|
def get_tag_group_tags_with_http_info(id, opts = {})
|
1127
1141
|
if @api_client.config.debugging
|
@@ -1145,7 +1159,7 @@ module KlaviyoAPI
|
|
1145
1159
|
# header parameters
|
1146
1160
|
header_params = opts[:header_params] || {}
|
1147
1161
|
# klaviyo api revision
|
1148
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1162
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1149
1163
|
# HTTP header 'Accept' (if needed)
|
1150
1164
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1151
1165
|
|
@@ -1181,10 +1195,10 @@ module KlaviyoAPI
|
|
1181
1195
|
# Get Tag Groups
|
1182
1196
|
# List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1183
1197
|
# @param [Hash] opts the optional parameters
|
1184
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1185
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1186
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1187
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1198
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1199
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
1200
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1201
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1188
1202
|
# @return [Hash<String, Object>]
|
1189
1203
|
def get_tag_groups(opts = {})
|
1190
1204
|
data, _status_code, _headers = get_tag_groups_with_http_info(opts)
|
@@ -1194,10 +1208,10 @@ module KlaviyoAPI
|
|
1194
1208
|
# Get Tag Groups
|
1195
1209
|
# List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1196
1210
|
# @param [Hash] opts the optional parameters
|
1197
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1198
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1199
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1200
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1211
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1212
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
1213
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1214
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1201
1215
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1202
1216
|
def get_tag_groups_with_http_info(opts = {})
|
1203
1217
|
if @api_client.config.debugging
|
@@ -1224,7 +1238,7 @@ module KlaviyoAPI
|
|
1224
1238
|
# header parameters
|
1225
1239
|
header_params = opts[:header_params] || {}
|
1226
1240
|
# klaviyo api revision
|
1227
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1241
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1228
1242
|
# HTTP header 'Accept' (if needed)
|
1229
1243
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1230
1244
|
|
@@ -1289,7 +1303,7 @@ module KlaviyoAPI
|
|
1289
1303
|
# header parameters
|
1290
1304
|
header_params = opts[:header_params] || {}
|
1291
1305
|
# klaviyo api revision
|
1292
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1306
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1293
1307
|
# HTTP header 'Accept' (if needed)
|
1294
1308
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1295
1309
|
|
@@ -1354,7 +1368,7 @@ module KlaviyoAPI
|
|
1354
1368
|
# header parameters
|
1355
1369
|
header_params = opts[:header_params] || {}
|
1356
1370
|
# klaviyo api revision
|
1357
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1371
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1358
1372
|
# HTTP header 'Accept' (if needed)
|
1359
1373
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1360
1374
|
|
@@ -1419,7 +1433,7 @@ module KlaviyoAPI
|
|
1419
1433
|
# header parameters
|
1420
1434
|
header_params = opts[:header_params] || {}
|
1421
1435
|
# klaviyo api revision
|
1422
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1436
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1423
1437
|
# HTTP header 'Accept' (if needed)
|
1424
1438
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1425
1439
|
|
@@ -1484,7 +1498,7 @@ module KlaviyoAPI
|
|
1484
1498
|
# header parameters
|
1485
1499
|
header_params = opts[:header_params] || {}
|
1486
1500
|
# klaviyo api revision
|
1487
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1501
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1488
1502
|
# HTTP header 'Accept' (if needed)
|
1489
1503
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1490
1504
|
|
@@ -1518,7 +1532,7 @@ module KlaviyoAPI
|
|
1518
1532
|
end
|
1519
1533
|
|
1520
1534
|
# Get Tag Relationships Tag Group
|
1521
|
-
# Returns the
|
1535
|
+
# Returns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1522
1536
|
# @param id [String]
|
1523
1537
|
# @param [Hash] opts the optional parameters
|
1524
1538
|
# @return [Hash<String, Object>]
|
@@ -1528,7 +1542,7 @@ module KlaviyoAPI
|
|
1528
1542
|
end
|
1529
1543
|
|
1530
1544
|
# Get Tag Relationships Tag Group
|
1531
|
-
# Returns the
|
1545
|
+
# Returns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1532
1546
|
# @param id [String]
|
1533
1547
|
# @param [Hash] opts the optional parameters
|
1534
1548
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -1549,7 +1563,7 @@ module KlaviyoAPI
|
|
1549
1563
|
# header parameters
|
1550
1564
|
header_params = opts[:header_params] || {}
|
1551
1565
|
# klaviyo api revision
|
1552
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1566
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1553
1567
|
# HTTP header 'Accept' (if needed)
|
1554
1568
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1555
1569
|
|
@@ -1586,7 +1600,7 @@ module KlaviyoAPI
|
|
1586
1600
|
# Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1587
1601
|
# @param id [String]
|
1588
1602
|
# @param [Hash] opts the optional parameters
|
1589
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1603
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1590
1604
|
# @return [Hash<String, Object>]
|
1591
1605
|
def get_tag_tag_group(id, opts = {})
|
1592
1606
|
data, _status_code, _headers = get_tag_tag_group_with_http_info(id, opts)
|
@@ -1597,7 +1611,7 @@ module KlaviyoAPI
|
|
1597
1611
|
# Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1598
1612
|
# @param id [String]
|
1599
1613
|
# @param [Hash] opts the optional parameters
|
1600
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1614
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1601
1615
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1602
1616
|
def get_tag_tag_group_with_http_info(id, opts = {})
|
1603
1617
|
if @api_client.config.debugging
|
@@ -1621,7 +1635,7 @@ module KlaviyoAPI
|
|
1621
1635
|
# header parameters
|
1622
1636
|
header_params = opts[:header_params] || {}
|
1623
1637
|
# klaviyo api revision
|
1624
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1638
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1625
1639
|
# HTTP header 'Accept' (if needed)
|
1626
1640
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1627
1641
|
|
@@ -1657,10 +1671,12 @@ module KlaviyoAPI
|
|
1657
1671
|
# Get Tags
|
1658
1672
|
# List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1659
1673
|
# @param [Hash] opts the optional parameters
|
1660
|
-
# @option opts [Array<String>] :
|
1661
|
-
# @option opts [String] :
|
1662
|
-
# @option opts [String] :
|
1663
|
-
# @option opts [String] :
|
1674
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1675
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1676
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
1677
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1678
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1679
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1664
1680
|
# @return [Hash<String, Object>]
|
1665
1681
|
def get_tags(opts = {})
|
1666
1682
|
data, _status_code, _headers = get_tags_with_http_info(opts)
|
@@ -1670,19 +1686,29 @@ module KlaviyoAPI
|
|
1670
1686
|
# Get Tags
|
1671
1687
|
# List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1672
1688
|
# @param [Hash] opts the optional parameters
|
1673
|
-
# @option opts [Array<String>] :
|
1674
|
-
# @option opts [String] :
|
1675
|
-
# @option opts [String] :
|
1676
|
-
# @option opts [String] :
|
1689
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1690
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1691
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
1692
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1693
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1694
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1677
1695
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1678
1696
|
def get_tags_with_http_info(opts = {})
|
1679
1697
|
if @api_client.config.debugging
|
1680
1698
|
@api_client.config.logger.debug 'Calling API: TagsApi.get_tags ...'
|
1681
1699
|
end
|
1700
|
+
allowable_values = ["name", "exclusive", "default"]
|
1701
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
1702
|
+
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
1703
|
+
end
|
1682
1704
|
allowable_values = ["name"]
|
1683
1705
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
1684
1706
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1685
1707
|
end
|
1708
|
+
allowable_values = ["tag-group"]
|
1709
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1710
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1711
|
+
end
|
1686
1712
|
allowable_values = ["id", "-id", "name", "-name"]
|
1687
1713
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1688
1714
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
@@ -1692,15 +1718,17 @@ module KlaviyoAPI
|
|
1692
1718
|
|
1693
1719
|
# query parameters
|
1694
1720
|
query_params = opts[:query_params] || {}
|
1721
|
+
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
1695
1722
|
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1696
1723
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1724
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1697
1725
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1698
1726
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1699
1727
|
|
1700
1728
|
# header parameters
|
1701
1729
|
header_params = opts[:header_params] || {}
|
1702
1730
|
# klaviyo api revision
|
1703
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1731
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1704
1732
|
# HTTP header 'Accept' (if needed)
|
1705
1733
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1706
1734
|
|
@@ -1738,10 +1766,10 @@ module KlaviyoAPI
|
|
1738
1766
|
# @param id [String] The Tag ID
|
1739
1767
|
# @param tag_update_query [TagUpdateQuery]
|
1740
1768
|
# @param [Hash] opts the optional parameters
|
1741
|
-
# @return [
|
1769
|
+
# @return [nil]
|
1742
1770
|
def update_tag(id, tag_update_query, opts = {})
|
1743
|
-
|
1744
|
-
|
1771
|
+
update_tag_with_http_info(id, tag_update_query, opts)
|
1772
|
+
nil
|
1745
1773
|
end
|
1746
1774
|
|
1747
1775
|
# Update Tag
|
@@ -1749,7 +1777,7 @@ module KlaviyoAPI
|
|
1749
1777
|
# @param id [String] The Tag ID
|
1750
1778
|
# @param tag_update_query [TagUpdateQuery]
|
1751
1779
|
# @param [Hash] opts the optional parameters
|
1752
|
-
# @return [Array<(
|
1780
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1753
1781
|
def update_tag_with_http_info(id, tag_update_query, opts = {})
|
1754
1782
|
if @api_client.config.debugging
|
1755
1783
|
@api_client.config.logger.debug 'Calling API: TagsApi.update_tag ...'
|
@@ -1771,7 +1799,7 @@ module KlaviyoAPI
|
|
1771
1799
|
# header parameters
|
1772
1800
|
header_params = opts[:header_params] || {}
|
1773
1801
|
# klaviyo api revision
|
1774
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1802
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1775
1803
|
# HTTP header 'Accept' (if needed)
|
1776
1804
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1777
1805
|
# HTTP header 'Content-Type'
|
@@ -1787,7 +1815,7 @@ module KlaviyoAPI
|
|
1787
1815
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_update_query)
|
1788
1816
|
|
1789
1817
|
# return_type
|
1790
|
-
return_type = opts[:debug_return_type]
|
1818
|
+
return_type = opts[:debug_return_type]
|
1791
1819
|
|
1792
1820
|
# auth_names
|
1793
1821
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
@@ -1847,7 +1875,7 @@ module KlaviyoAPI
|
|
1847
1875
|
# header parameters
|
1848
1876
|
header_params = opts[:header_params] || {}
|
1849
1877
|
# klaviyo api revision
|
1850
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1878
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1851
1879
|
# HTTP header 'Accept' (if needed)
|
1852
1880
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1853
1881
|
# HTTP header 'Content-Type'
|