klaviyo-api-sdk 3.0.0 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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'
|
@@ -191,7 +191,7 @@ module KlaviyoAPI
|
|
191
191
|
# header parameters
|
192
192
|
header_params = opts[:header_params] || {}
|
193
193
|
# klaviyo api revision
|
194
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
194
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
195
195
|
# HTTP header 'Accept' (if needed)
|
196
196
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
197
197
|
# HTTP header 'Content-Type'
|
@@ -261,7 +261,7 @@ module KlaviyoAPI
|
|
261
261
|
# header parameters
|
262
262
|
header_params = opts[:header_params] || {}
|
263
263
|
# klaviyo api revision
|
264
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
264
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
265
265
|
# HTTP header 'Accept' (if needed)
|
266
266
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
267
267
|
# HTTP header 'Content-Type'
|
@@ -331,7 +331,7 @@ module KlaviyoAPI
|
|
331
331
|
# header parameters
|
332
332
|
header_params = opts[:header_params] || {}
|
333
333
|
# klaviyo api revision
|
334
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
334
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
335
335
|
# HTTP header 'Accept' (if needed)
|
336
336
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
337
337
|
# HTTP header 'Content-Type'
|
@@ -401,7 +401,7 @@ module KlaviyoAPI
|
|
401
401
|
# header parameters
|
402
402
|
header_params = opts[:header_params] || {}
|
403
403
|
# klaviyo api revision
|
404
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
404
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
405
405
|
# HTTP header 'Accept' (if needed)
|
406
406
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
407
407
|
|
@@ -438,9 +438,10 @@ module KlaviyoAPI
|
|
438
438
|
# Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
439
439
|
# @param id [String] The campaign ID to be retrieved
|
440
440
|
# @param [Hash] opts the optional parameters
|
441
|
-
# @option opts [Array<String>] :
|
442
|
-
# @option opts [Array<String>] :
|
443
|
-
# @option opts [Array<String>] :
|
441
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
442
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
443
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
444
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
444
445
|
# @return [Hash<String, Object>]
|
445
446
|
def get_campaign(id, opts = {})
|
446
447
|
data, _status_code, _headers = get_campaign_with_http_info(id, opts)
|
@@ -451,9 +452,10 @@ module KlaviyoAPI
|
|
451
452
|
# Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
452
453
|
# @param id [String] The campaign ID to be retrieved
|
453
454
|
# @param [Hash] opts the optional parameters
|
454
|
-
# @option opts [Array<String>] :
|
455
|
-
# @option opts [Array<String>] :
|
456
|
-
# @option opts [Array<String>] :
|
455
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
456
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
457
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
458
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
457
459
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
458
460
|
def get_campaign_with_http_info(id, opts = {})
|
459
461
|
if @api_client.config.debugging
|
@@ -463,7 +465,11 @@ module KlaviyoAPI
|
|
463
465
|
if @api_client.config.client_side_validation && id.nil?
|
464
466
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign"
|
465
467
|
end
|
466
|
-
allowable_values = ["
|
468
|
+
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "render_options.include_contact_card", "created_at", "updated_at"]
|
469
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
470
|
+
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
471
|
+
end
|
472
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "tracking_options", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
467
473
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
468
474
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
469
475
|
end
|
@@ -471,7 +477,7 @@ module KlaviyoAPI
|
|
471
477
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
472
478
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
473
479
|
end
|
474
|
-
allowable_values = ["tags"]
|
480
|
+
allowable_values = ["campaign-messages", "tags"]
|
475
481
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
476
482
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
477
483
|
end
|
@@ -480,6 +486,7 @@ module KlaviyoAPI
|
|
480
486
|
|
481
487
|
# query parameters
|
482
488
|
query_params = opts[:query_params] || {}
|
489
|
+
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
483
490
|
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
484
491
|
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
485
492
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
@@ -487,7 +494,7 @@ module KlaviyoAPI
|
|
487
494
|
# header parameters
|
488
495
|
header_params = opts[:header_params] || {}
|
489
496
|
# klaviyo api revision
|
490
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
497
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
491
498
|
# HTTP header 'Accept' (if needed)
|
492
499
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
493
500
|
|
@@ -520,11 +527,107 @@ module KlaviyoAPI
|
|
520
527
|
return data, status_code, headers
|
521
528
|
end
|
522
529
|
|
530
|
+
# Get Campaign Campaign Messages
|
531
|
+
# Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
532
|
+
# @param id [String]
|
533
|
+
# @param [Hash] opts the optional parameters
|
534
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
535
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
536
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
537
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
538
|
+
# @return [Hash<String, Object>]
|
539
|
+
def get_campaign_campaign_messages(id, opts = {})
|
540
|
+
data, _status_code, _headers = get_campaign_campaign_messages_with_http_info(id, opts)
|
541
|
+
data
|
542
|
+
end
|
543
|
+
|
544
|
+
# Get Campaign Campaign Messages
|
545
|
+
# Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
546
|
+
# @param id [String]
|
547
|
+
# @param [Hash] opts the optional parameters
|
548
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
549
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
550
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
551
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
552
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
553
|
+
def get_campaign_campaign_messages_with_http_info(id, opts = {})
|
554
|
+
if @api_client.config.debugging
|
555
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_campaign_messages ...'
|
556
|
+
end
|
557
|
+
# verify the required parameter 'id' is set
|
558
|
+
if @api_client.config.client_side_validation && id.nil?
|
559
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_campaign_messages"
|
560
|
+
end
|
561
|
+
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "render_options.include_contact_card", "created_at", "updated_at"]
|
562
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
563
|
+
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
564
|
+
end
|
565
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "tracking_options", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
566
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
567
|
+
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
568
|
+
end
|
569
|
+
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
570
|
+
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
571
|
+
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
572
|
+
end
|
573
|
+
allowable_values = ["campaign", "template"]
|
574
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
575
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
576
|
+
end
|
577
|
+
# resource path
|
578
|
+
local_var_path = '/api/campaigns/{id}/campaign-messages/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
579
|
+
|
580
|
+
# query parameters
|
581
|
+
query_params = opts[:query_params] || {}
|
582
|
+
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
583
|
+
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
584
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
585
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
586
|
+
|
587
|
+
# header parameters
|
588
|
+
header_params = opts[:header_params] || {}
|
589
|
+
# klaviyo api revision
|
590
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
591
|
+
# HTTP header 'Accept' (if needed)
|
592
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
593
|
+
|
594
|
+
# form parameters
|
595
|
+
form_params = opts[:form_params] || {}
|
596
|
+
|
597
|
+
# http body (model)
|
598
|
+
post_body = opts[:debug_body]
|
599
|
+
|
600
|
+
# return_type
|
601
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
602
|
+
|
603
|
+
# auth_names
|
604
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
605
|
+
|
606
|
+
new_options = opts.merge(
|
607
|
+
:operation => :"CampaignsApi.get_campaign_campaign_messages",
|
608
|
+
:header_params => header_params,
|
609
|
+
:query_params => query_params,
|
610
|
+
:form_params => form_params,
|
611
|
+
:body => post_body,
|
612
|
+
:auth_names => auth_names,
|
613
|
+
:return_type => return_type
|
614
|
+
)
|
615
|
+
|
616
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
617
|
+
if @api_client.config.debugging
|
618
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_campaign_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
619
|
+
end
|
620
|
+
return data, status_code, headers
|
621
|
+
end
|
622
|
+
|
523
623
|
# Get Campaign Message
|
524
624
|
# Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
525
625
|
# @param id [String] The message ID to be retrieved
|
526
626
|
# @param [Hash] opts the optional parameters
|
527
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
627
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
628
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
629
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
630
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
528
631
|
# @return [Hash<String, Object>]
|
529
632
|
def get_campaign_message(id, opts = {})
|
530
633
|
data, _status_code, _headers = get_campaign_message_with_http_info(id, opts)
|
@@ -535,7 +638,10 @@ module KlaviyoAPI
|
|
535
638
|
# Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
536
639
|
# @param id [String] The message ID to be retrieved
|
537
640
|
# @param [Hash] opts the optional parameters
|
538
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
641
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
642
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
643
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
644
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
539
645
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
540
646
|
def get_campaign_message_with_http_info(id, opts = {})
|
541
647
|
if @api_client.config.debugging
|
@@ -545,21 +651,36 @@ module KlaviyoAPI
|
|
545
651
|
if @api_client.config.client_side_validation && id.nil?
|
546
652
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message"
|
547
653
|
end
|
548
|
-
allowable_values = ["label", "channel", "content", "
|
654
|
+
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "render_options.include_contact_card", "created_at", "updated_at"]
|
549
655
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
550
656
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
551
657
|
end
|
658
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "tracking_options", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
659
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
660
|
+
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
661
|
+
end
|
662
|
+
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
663
|
+
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
664
|
+
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
665
|
+
end
|
666
|
+
allowable_values = ["campaign", "template"]
|
667
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
668
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
669
|
+
end
|
552
670
|
# resource path
|
553
671
|
local_var_path = '/api/campaign-messages/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
554
672
|
|
555
673
|
# query parameters
|
556
674
|
query_params = opts[:query_params] || {}
|
557
675
|
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
676
|
+
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
677
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
678
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
558
679
|
|
559
680
|
# header parameters
|
560
681
|
header_params = opts[:header_params] || {}
|
561
682
|
# klaviyo api revision
|
562
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
683
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
563
684
|
# HTTP header 'Accept' (if needed)
|
564
685
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
565
686
|
|
@@ -592,11 +713,285 @@ module KlaviyoAPI
|
|
592
713
|
return data, status_code, headers
|
593
714
|
end
|
594
715
|
|
716
|
+
# Get Campaign Message Campaign
|
717
|
+
# Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
718
|
+
# @param id [String]
|
719
|
+
# @param [Hash] opts the optional parameters
|
720
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
721
|
+
# @return [Hash<String, Object>]
|
722
|
+
def get_campaign_message_campaign(id, opts = {})
|
723
|
+
data, _status_code, _headers = get_campaign_message_campaign_with_http_info(id, opts)
|
724
|
+
data
|
725
|
+
end
|
726
|
+
|
727
|
+
# Get Campaign Message Campaign
|
728
|
+
# Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
729
|
+
# @param id [String]
|
730
|
+
# @param [Hash] opts the optional parameters
|
731
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
732
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
733
|
+
def get_campaign_message_campaign_with_http_info(id, opts = {})
|
734
|
+
if @api_client.config.debugging
|
735
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_message_campaign ...'
|
736
|
+
end
|
737
|
+
# verify the required parameter 'id' is set
|
738
|
+
if @api_client.config.client_side_validation && id.nil?
|
739
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message_campaign"
|
740
|
+
end
|
741
|
+
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "render_options.include_contact_card", "created_at", "updated_at"]
|
742
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
743
|
+
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
744
|
+
end
|
745
|
+
# resource path
|
746
|
+
local_var_path = '/api/campaign-messages/{id}/campaign/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
747
|
+
|
748
|
+
# query parameters
|
749
|
+
query_params = opts[:query_params] || {}
|
750
|
+
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
751
|
+
|
752
|
+
# header parameters
|
753
|
+
header_params = opts[:header_params] || {}
|
754
|
+
# klaviyo api revision
|
755
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
756
|
+
# HTTP header 'Accept' (if needed)
|
757
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
758
|
+
|
759
|
+
# form parameters
|
760
|
+
form_params = opts[:form_params] || {}
|
761
|
+
|
762
|
+
# http body (model)
|
763
|
+
post_body = opts[:debug_body]
|
764
|
+
|
765
|
+
# return_type
|
766
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
767
|
+
|
768
|
+
# auth_names
|
769
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
770
|
+
|
771
|
+
new_options = opts.merge(
|
772
|
+
:operation => :"CampaignsApi.get_campaign_message_campaign",
|
773
|
+
:header_params => header_params,
|
774
|
+
:query_params => query_params,
|
775
|
+
:form_params => form_params,
|
776
|
+
:body => post_body,
|
777
|
+
:auth_names => auth_names,
|
778
|
+
:return_type => return_type
|
779
|
+
)
|
780
|
+
|
781
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
782
|
+
if @api_client.config.debugging
|
783
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_message_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
784
|
+
end
|
785
|
+
return data, status_code, headers
|
786
|
+
end
|
787
|
+
|
788
|
+
# Get Campaign Message Relationships Campaign
|
789
|
+
# Returns the ID of the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
790
|
+
# @param id [String]
|
791
|
+
# @param [Hash] opts the optional parameters
|
792
|
+
# @return [Hash<String, Object>]
|
793
|
+
def get_campaign_message_relationships_campaign(id, opts = {})
|
794
|
+
data, _status_code, _headers = get_campaign_message_relationships_campaign_with_http_info(id, opts)
|
795
|
+
data
|
796
|
+
end
|
797
|
+
|
798
|
+
# Get Campaign Message Relationships Campaign
|
799
|
+
# Returns the ID of the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
800
|
+
# @param id [String]
|
801
|
+
# @param [Hash] opts the optional parameters
|
802
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
803
|
+
def get_campaign_message_relationships_campaign_with_http_info(id, opts = {})
|
804
|
+
if @api_client.config.debugging
|
805
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_message_relationships_campaign ...'
|
806
|
+
end
|
807
|
+
# verify the required parameter 'id' is set
|
808
|
+
if @api_client.config.client_side_validation && id.nil?
|
809
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message_relationships_campaign"
|
810
|
+
end
|
811
|
+
# resource path
|
812
|
+
local_var_path = '/api/campaign-messages/{id}/relationships/campaign/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
813
|
+
|
814
|
+
# query parameters
|
815
|
+
query_params = opts[:query_params] || {}
|
816
|
+
|
817
|
+
# header parameters
|
818
|
+
header_params = opts[:header_params] || {}
|
819
|
+
# klaviyo api revision
|
820
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
821
|
+
# HTTP header 'Accept' (if needed)
|
822
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
823
|
+
|
824
|
+
# form parameters
|
825
|
+
form_params = opts[:form_params] || {}
|
826
|
+
|
827
|
+
# http body (model)
|
828
|
+
post_body = opts[:debug_body]
|
829
|
+
|
830
|
+
# return_type
|
831
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
832
|
+
|
833
|
+
# auth_names
|
834
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
835
|
+
|
836
|
+
new_options = opts.merge(
|
837
|
+
:operation => :"CampaignsApi.get_campaign_message_relationships_campaign",
|
838
|
+
:header_params => header_params,
|
839
|
+
:query_params => query_params,
|
840
|
+
:form_params => form_params,
|
841
|
+
:body => post_body,
|
842
|
+
:auth_names => auth_names,
|
843
|
+
:return_type => return_type
|
844
|
+
)
|
845
|
+
|
846
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
847
|
+
if @api_client.config.debugging
|
848
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_message_relationships_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
849
|
+
end
|
850
|
+
return data, status_code, headers
|
851
|
+
end
|
852
|
+
|
853
|
+
# Get Campaign Message Relationships Template
|
854
|
+
# Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
855
|
+
# @param id [String]
|
856
|
+
# @param [Hash] opts the optional parameters
|
857
|
+
# @return [Hash<String, Object>]
|
858
|
+
def get_campaign_message_relationships_template(id, opts = {})
|
859
|
+
data, _status_code, _headers = get_campaign_message_relationships_template_with_http_info(id, opts)
|
860
|
+
data
|
861
|
+
end
|
862
|
+
|
863
|
+
# Get Campaign Message Relationships Template
|
864
|
+
# Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
865
|
+
# @param id [String]
|
866
|
+
# @param [Hash] opts the optional parameters
|
867
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
868
|
+
def get_campaign_message_relationships_template_with_http_info(id, opts = {})
|
869
|
+
if @api_client.config.debugging
|
870
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_message_relationships_template ...'
|
871
|
+
end
|
872
|
+
# verify the required parameter 'id' is set
|
873
|
+
if @api_client.config.client_side_validation && id.nil?
|
874
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message_relationships_template"
|
875
|
+
end
|
876
|
+
# resource path
|
877
|
+
local_var_path = '/api/campaign-messages/{id}/relationships/template/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
878
|
+
|
879
|
+
# query parameters
|
880
|
+
query_params = opts[:query_params] || {}
|
881
|
+
|
882
|
+
# header parameters
|
883
|
+
header_params = opts[:header_params] || {}
|
884
|
+
# klaviyo api revision
|
885
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
886
|
+
# HTTP header 'Accept' (if needed)
|
887
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
888
|
+
|
889
|
+
# form parameters
|
890
|
+
form_params = opts[:form_params] || {}
|
891
|
+
|
892
|
+
# http body (model)
|
893
|
+
post_body = opts[:debug_body]
|
894
|
+
|
895
|
+
# return_type
|
896
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
897
|
+
|
898
|
+
# auth_names
|
899
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
900
|
+
|
901
|
+
new_options = opts.merge(
|
902
|
+
:operation => :"CampaignsApi.get_campaign_message_relationships_template",
|
903
|
+
:header_params => header_params,
|
904
|
+
:query_params => query_params,
|
905
|
+
:form_params => form_params,
|
906
|
+
:body => post_body,
|
907
|
+
:auth_names => auth_names,
|
908
|
+
:return_type => return_type
|
909
|
+
)
|
910
|
+
|
911
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
912
|
+
if @api_client.config.debugging
|
913
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_message_relationships_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
914
|
+
end
|
915
|
+
return data, status_code, headers
|
916
|
+
end
|
917
|
+
|
918
|
+
# Get Campaign Message Template
|
919
|
+
# Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
920
|
+
# @param id [String]
|
921
|
+
# @param [Hash] opts the optional parameters
|
922
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
923
|
+
# @return [Hash<String, Object>]
|
924
|
+
def get_campaign_message_template(id, opts = {})
|
925
|
+
data, _status_code, _headers = get_campaign_message_template_with_http_info(id, opts)
|
926
|
+
data
|
927
|
+
end
|
928
|
+
|
929
|
+
# Get Campaign Message Template
|
930
|
+
# Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
931
|
+
# @param id [String]
|
932
|
+
# @param [Hash] opts the optional parameters
|
933
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
934
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
935
|
+
def get_campaign_message_template_with_http_info(id, opts = {})
|
936
|
+
if @api_client.config.debugging
|
937
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_message_template ...'
|
938
|
+
end
|
939
|
+
# verify the required parameter 'id' is set
|
940
|
+
if @api_client.config.client_side_validation && id.nil?
|
941
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message_template"
|
942
|
+
end
|
943
|
+
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "render_options.include_contact_card", "created_at", "updated_at"]
|
944
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
945
|
+
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
946
|
+
end
|
947
|
+
# resource path
|
948
|
+
local_var_path = '/api/campaign-messages/{id}/template/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
949
|
+
|
950
|
+
# query parameters
|
951
|
+
query_params = opts[:query_params] || {}
|
952
|
+
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
953
|
+
|
954
|
+
# header parameters
|
955
|
+
header_params = opts[:header_params] || {}
|
956
|
+
# klaviyo api revision
|
957
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
958
|
+
# HTTP header 'Accept' (if needed)
|
959
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
960
|
+
|
961
|
+
# form parameters
|
962
|
+
form_params = opts[:form_params] || {}
|
963
|
+
|
964
|
+
# http body (model)
|
965
|
+
post_body = opts[:debug_body]
|
966
|
+
|
967
|
+
# return_type
|
968
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
969
|
+
|
970
|
+
# auth_names
|
971
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
972
|
+
|
973
|
+
new_options = opts.merge(
|
974
|
+
:operation => :"CampaignsApi.get_campaign_message_template",
|
975
|
+
:header_params => header_params,
|
976
|
+
:query_params => query_params,
|
977
|
+
:form_params => form_params,
|
978
|
+
:body => post_body,
|
979
|
+
:auth_names => auth_names,
|
980
|
+
:return_type => return_type
|
981
|
+
)
|
982
|
+
|
983
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
984
|
+
if @api_client.config.debugging
|
985
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_message_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
986
|
+
end
|
987
|
+
return data, status_code, headers
|
988
|
+
end
|
989
|
+
|
595
990
|
# Get Campaign Recipient Estimation
|
596
991
|
# Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
597
992
|
# @param id [String] The ID of the campaign for which to get the estimated number of recipients
|
598
993
|
# @param [Hash] opts the optional parameters
|
599
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2023-
|
994
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
600
995
|
# @return [Hash<String, Object>]
|
601
996
|
def get_campaign_recipient_estimation(id, opts = {})
|
602
997
|
data, _status_code, _headers = get_campaign_recipient_estimation_with_http_info(id, opts)
|
@@ -607,7 +1002,7 @@ module KlaviyoAPI
|
|
607
1002
|
# Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
608
1003
|
# @param id [String] The ID of the campaign for which to get the estimated number of recipients
|
609
1004
|
# @param [Hash] opts the optional parameters
|
610
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2023-
|
1005
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
611
1006
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
612
1007
|
def get_campaign_recipient_estimation_with_http_info(id, opts = {})
|
613
1008
|
if @api_client.config.debugging
|
@@ -631,7 +1026,7 @@ module KlaviyoAPI
|
|
631
1026
|
# header parameters
|
632
1027
|
header_params = opts[:header_params] || {}
|
633
1028
|
# klaviyo api revision
|
634
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1029
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
635
1030
|
# HTTP header 'Accept' (if needed)
|
636
1031
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
637
1032
|
|
@@ -668,7 +1063,7 @@ module KlaviyoAPI
|
|
668
1063
|
# Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
669
1064
|
# @param id [String] The ID of the campaign to get recipient estimation status
|
670
1065
|
# @param [Hash] opts the optional parameters
|
671
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1066
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
672
1067
|
# @return [Hash<String, Object>]
|
673
1068
|
def get_campaign_recipient_estimation_job(id, opts = {})
|
674
1069
|
data, _status_code, _headers = get_campaign_recipient_estimation_job_with_http_info(id, opts)
|
@@ -679,7 +1074,7 @@ module KlaviyoAPI
|
|
679
1074
|
# Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
680
1075
|
# @param id [String] The ID of the campaign to get recipient estimation status
|
681
1076
|
# @param [Hash] opts the optional parameters
|
682
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1077
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
683
1078
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
684
1079
|
def get_campaign_recipient_estimation_job_with_http_info(id, opts = {})
|
685
1080
|
if @api_client.config.debugging
|
@@ -703,7 +1098,7 @@ module KlaviyoAPI
|
|
703
1098
|
# header parameters
|
704
1099
|
header_params = opts[:header_params] || {}
|
705
1100
|
# klaviyo api revision
|
706
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1101
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
707
1102
|
# HTTP header 'Accept' (if needed)
|
708
1103
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
709
1104
|
|
@@ -736,6 +1131,71 @@ module KlaviyoAPI
|
|
736
1131
|
return data, status_code, headers
|
737
1132
|
end
|
738
1133
|
|
1134
|
+
# Get Campaign Relationships Campaign Messages
|
1135
|
+
# Returns the IDs of all messages associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1136
|
+
# @param id [String]
|
1137
|
+
# @param [Hash] opts the optional parameters
|
1138
|
+
# @return [Hash<String, Object>]
|
1139
|
+
def get_campaign_relationships_campaign_messages(id, opts = {})
|
1140
|
+
data, _status_code, _headers = get_campaign_relationships_campaign_messages_with_http_info(id, opts)
|
1141
|
+
data
|
1142
|
+
end
|
1143
|
+
|
1144
|
+
# Get Campaign Relationships Campaign Messages
|
1145
|
+
# Returns the IDs of all messages associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1146
|
+
# @param id [String]
|
1147
|
+
# @param [Hash] opts the optional parameters
|
1148
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1149
|
+
def get_campaign_relationships_campaign_messages_with_http_info(id, opts = {})
|
1150
|
+
if @api_client.config.debugging
|
1151
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_relationships_campaign_messages ...'
|
1152
|
+
end
|
1153
|
+
# verify the required parameter 'id' is set
|
1154
|
+
if @api_client.config.client_side_validation && id.nil?
|
1155
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_relationships_campaign_messages"
|
1156
|
+
end
|
1157
|
+
# resource path
|
1158
|
+
local_var_path = '/api/campaigns/{id}/relationships/campaign-messages/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1159
|
+
|
1160
|
+
# query parameters
|
1161
|
+
query_params = opts[:query_params] || {}
|
1162
|
+
|
1163
|
+
# header parameters
|
1164
|
+
header_params = opts[:header_params] || {}
|
1165
|
+
# klaviyo api revision
|
1166
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1167
|
+
# HTTP header 'Accept' (if needed)
|
1168
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1169
|
+
|
1170
|
+
# form parameters
|
1171
|
+
form_params = opts[:form_params] || {}
|
1172
|
+
|
1173
|
+
# http body (model)
|
1174
|
+
post_body = opts[:debug_body]
|
1175
|
+
|
1176
|
+
# return_type
|
1177
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1178
|
+
|
1179
|
+
# auth_names
|
1180
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1181
|
+
|
1182
|
+
new_options = opts.merge(
|
1183
|
+
:operation => :"CampaignsApi.get_campaign_relationships_campaign_messages",
|
1184
|
+
:header_params => header_params,
|
1185
|
+
:query_params => query_params,
|
1186
|
+
:form_params => form_params,
|
1187
|
+
:body => post_body,
|
1188
|
+
:auth_names => auth_names,
|
1189
|
+
:return_type => return_type
|
1190
|
+
)
|
1191
|
+
|
1192
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1193
|
+
if @api_client.config.debugging
|
1194
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_relationships_campaign_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1195
|
+
end
|
1196
|
+
return data, status_code, headers
|
1197
|
+
end
|
1198
|
+
|
739
1199
|
# Get Campaign Relationships Tags
|
740
1200
|
# Returns the IDs of all tags associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
741
1201
|
# @param id [String]
|
@@ -768,7 +1228,7 @@ module KlaviyoAPI
|
|
768
1228
|
# header parameters
|
769
1229
|
header_params = opts[:header_params] || {}
|
770
1230
|
# klaviyo api revision
|
771
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1231
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
772
1232
|
# HTTP header 'Accept' (if needed)
|
773
1233
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
774
1234
|
|
@@ -805,7 +1265,7 @@ module KlaviyoAPI
|
|
805
1265
|
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
806
1266
|
# @param id [String] The ID of the campaign to send
|
807
1267
|
# @param [Hash] opts the optional parameters
|
808
|
-
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1268
|
+
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
809
1269
|
# @return [Hash<String, Object>]
|
810
1270
|
def get_campaign_send_job(id, opts = {})
|
811
1271
|
data, _status_code, _headers = get_campaign_send_job_with_http_info(id, opts)
|
@@ -816,7 +1276,7 @@ module KlaviyoAPI
|
|
816
1276
|
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
817
1277
|
# @param id [String] The ID of the campaign to send
|
818
1278
|
# @param [Hash] opts the optional parameters
|
819
|
-
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1279
|
+
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
820
1280
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
821
1281
|
def get_campaign_send_job_with_http_info(id, opts = {})
|
822
1282
|
if @api_client.config.debugging
|
@@ -840,7 +1300,7 @@ module KlaviyoAPI
|
|
840
1300
|
# header parameters
|
841
1301
|
header_params = opts[:header_params] || {}
|
842
1302
|
# klaviyo api revision
|
843
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1303
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
844
1304
|
# HTTP header 'Accept' (if needed)
|
845
1305
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
846
1306
|
|
@@ -877,7 +1337,7 @@ module KlaviyoAPI
|
|
877
1337
|
# Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
878
1338
|
# @param id [String]
|
879
1339
|
# @param [Hash] opts the optional parameters
|
880
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
1340
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
881
1341
|
# @return [Hash<String, Object>]
|
882
1342
|
def get_campaign_tags(id, opts = {})
|
883
1343
|
data, _status_code, _headers = get_campaign_tags_with_http_info(id, opts)
|
@@ -888,7 +1348,7 @@ module KlaviyoAPI
|
|
888
1348
|
# Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
889
1349
|
# @param id [String]
|
890
1350
|
# @param [Hash] opts the optional parameters
|
891
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
1351
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
892
1352
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
893
1353
|
def get_campaign_tags_with_http_info(id, opts = {})
|
894
1354
|
if @api_client.config.debugging
|
@@ -912,7 +1372,7 @@ module KlaviyoAPI
|
|
912
1372
|
# header parameters
|
913
1373
|
header_params = opts[:header_params] || {}
|
914
1374
|
# klaviyo api revision
|
915
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1375
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
916
1376
|
# HTTP header 'Accept' (if needed)
|
917
1377
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
918
1378
|
|
@@ -946,35 +1406,45 @@ module KlaviyoAPI
|
|
946
1406
|
end
|
947
1407
|
|
948
1408
|
# Get Campaigns
|
949
|
-
# Returns some or all campaigns based on
|
1409
|
+
# Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1410
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
950
1411
|
# @param [Hash] opts the optional parameters
|
951
|
-
# @option opts [Array<String>] :
|
952
|
-
# @option opts [Array<String>] :
|
953
|
-
# @option opts [String] :
|
954
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
955
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
956
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1412
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1413
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1414
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1415
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1416
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1417
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
957
1418
|
# @return [Hash<String, Object>]
|
958
|
-
def get_campaigns(opts = {})
|
959
|
-
data, _status_code, _headers = get_campaigns_with_http_info(opts)
|
1419
|
+
def get_campaigns(filter, opts = {})
|
1420
|
+
data, _status_code, _headers = get_campaigns_with_http_info(filter, opts)
|
960
1421
|
data
|
961
1422
|
end
|
962
1423
|
|
963
1424
|
# Get Campaigns
|
964
|
-
# Returns some or all campaigns based on
|
1425
|
+
# Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1426
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
965
1427
|
# @param [Hash] opts the optional parameters
|
966
|
-
# @option opts [Array<String>] :
|
967
|
-
# @option opts [Array<String>] :
|
968
|
-
# @option opts [String] :
|
969
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
970
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
971
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1428
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1429
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1430
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1431
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1432
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1433
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
972
1434
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
973
|
-
def get_campaigns_with_http_info(opts = {})
|
1435
|
+
def get_campaigns_with_http_info(filter, opts = {})
|
974
1436
|
if @api_client.config.debugging
|
975
1437
|
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaigns ...'
|
976
1438
|
end
|
977
|
-
|
1439
|
+
# verify the required parameter 'filter' is set
|
1440
|
+
if @api_client.config.client_side_validation && filter.nil?
|
1441
|
+
fail ArgumentError, "Missing the required parameter 'filter' when calling CampaignsApi.get_campaigns"
|
1442
|
+
end
|
1443
|
+
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "render_options.include_contact_card", "created_at", "updated_at"]
|
1444
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
1445
|
+
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
1446
|
+
end
|
1447
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "tracking_options", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
978
1448
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
979
1449
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
980
1450
|
end
|
@@ -982,7 +1452,7 @@ module KlaviyoAPI
|
|
982
1452
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
983
1453
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
984
1454
|
end
|
985
|
-
allowable_values = ["tags"]
|
1455
|
+
allowable_values = ["campaign-messages", "tags"]
|
986
1456
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
987
1457
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
988
1458
|
end
|
@@ -995,9 +1465,10 @@ module KlaviyoAPI
|
|
995
1465
|
|
996
1466
|
# query parameters
|
997
1467
|
query_params = opts[:query_params] || {}
|
1468
|
+
query_params[:'filter'] = filter
|
1469
|
+
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
998
1470
|
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
999
1471
|
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1000
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1001
1472
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1002
1473
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1003
1474
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
@@ -1005,7 +1476,7 @@ module KlaviyoAPI
|
|
1005
1476
|
# header parameters
|
1006
1477
|
header_params = opts[:header_params] || {}
|
1007
1478
|
# klaviyo api revision
|
1008
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1479
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1009
1480
|
# HTTP header 'Accept' (if needed)
|
1010
1481
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1011
1482
|
|
@@ -1076,7 +1547,7 @@ module KlaviyoAPI
|
|
1076
1547
|
# header parameters
|
1077
1548
|
header_params = opts[:header_params] || {}
|
1078
1549
|
# klaviyo api revision
|
1079
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1550
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1080
1551
|
# HTTP header 'Accept' (if needed)
|
1081
1552
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1082
1553
|
# HTTP header 'Content-Type'
|
@@ -1152,7 +1623,7 @@ module KlaviyoAPI
|
|
1152
1623
|
# header parameters
|
1153
1624
|
header_params = opts[:header_params] || {}
|
1154
1625
|
# klaviyo api revision
|
1155
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1626
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1156
1627
|
# HTTP header 'Accept' (if needed)
|
1157
1628
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1158
1629
|
# HTTP header 'Content-Type'
|
@@ -1228,7 +1699,7 @@ module KlaviyoAPI
|
|
1228
1699
|
# header parameters
|
1229
1700
|
header_params = opts[:header_params] || {}
|
1230
1701
|
# klaviyo api revision
|
1231
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1702
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1232
1703
|
# HTTP header 'Accept' (if needed)
|
1233
1704
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1234
1705
|
# HTTP header 'Content-Type'
|