klaviyo-api-sdk 2.0.0 → 4.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +91 -0
- data/README.md +562 -235
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +160 -0
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +569 -98
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +427 -357
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +108 -108
- data/lib/klaviyo-api-sdk/api/flows_api.rb +229 -163
- data/lib/klaviyo-api-sdk/api/lists_api.rb +117 -74
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +18 -18
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +108 -114
- data/lib/klaviyo-api-sdk/api/segments_api.rb +105 -62
- data/lib/klaviyo-api-sdk/api/tags_api.rb +145 -117
- data/lib/klaviyo-api-sdk/api/templates_api.rb +39 -39
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{subscription_enum.rb → back_in_stock_subscription_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +32 -38
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +227 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +25 -16
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +5 -20
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object.rb → campaign_message_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{collection_links.rb → campaign_message_create_query_resource_object_attributes.rb} +34 -41
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +23 -14
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +18 -16
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships_items.rb +226 -0
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_update_query_resource_object_relationships_items_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_resource_object_relationships_categories_data_inner.rb → catalog_item_category_op_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +72 -70
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +43 -43
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +115 -113
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +8 -8
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items.rb → catalog_variant_create_query_resource_object_relationships_item.rb} +6 -8
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +57 -57
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +13 -29
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/{content_sub_object.rb → email_content_sub_object.rb} +12 -32
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +220 -0
- data/lib/klaviyo-api-sdk/models/{tracking_options_sub_object.rb → email_tracking_options_sub_object.rb} +28 -28
- data/lib/klaviyo-api-sdk/models/{event_create_query.rb → event_create_query_v2.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object.rb → event_create_query_v2_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object_attributes.rb → event_create_query_v2_resource_object_attributes.rb} +21 -22
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query.rb → event_create_query_v2_resource_object_attributes_metric.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{onsite_profile_create_query.rb → event_create_query_v2_resource_object_attributes_profile.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response.rb → get_create_variants_jobs5_xx_response.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner.rb → get_create_variants_jobs5_xx_response_errors_inner.rb} +40 -40
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner_source.rb → get_create_variants_jobs5_xx_response_errors_inner_source.rb} +17 -17
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +64 -67
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object.rb → metric_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{metric_create_query.rb → metric_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +29 -19
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +55 -45
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +8 -13
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +39 -39
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/{onsite_profile_meta_identifiers.rb → profile_identifier_dto_resource_object_attributes.rb} +18 -38
- data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{object_links.rb → profile_meta.rb} +11 -16
- data/lib/klaviyo-api-sdk/models/{sms_message_content.rb → profile_meta_patch_properties.rb} +28 -27
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +106 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +28 -19
- data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query_resource_object_attributes.rb → profile_partial_update_query_resource_object_attributes.rb} +92 -39
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{flow_action_enum.rb → profile_subscription_bulk_delete_job_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/{subscription.rb → profile_subscription_create_query_resource_object_attributes.rb} +18 -28
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{campaign_recipient_estimation_enum.rb → profile_suppression_bulk_delete_job_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query_resource_object.rb → profile_suppression_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{suppression.rb → profile_suppression_create_query_resource_object_attributes.rb} +5 -10
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{subscriptions.rb → profile_suppression_delete_query_resource_object_attributes.rb} +9 -17
- data/lib/klaviyo-api-sdk/models/{sms_render_options.rb → render_options_sub_object.rb} +32 -37
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query.rb → server_bis_subscription_create_query.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object_attributes.rb → server_bis_subscription_create_query_resource_object_attributes.rb} +46 -32
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +224 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/{sms_channel.rb → sms_content_sub_object_create.rb} +12 -11
- data/lib/klaviyo-api-sdk/models/{send_options_sub_object.rb → sms_send_options_sub_object.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{sms_tracking_options.rb → sms_tracking_options_sub_object.rb} +19 -27
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +25 -16
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +14 -32
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +11 -14
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query.rb → suppression_delete_job_create_query.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{error_source.rb → suppression_delete_job_create_query_resource_object_attributes.rb} +14 -17
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +25 -16
- data/lib/klaviyo-api-sdk/models/{email_channel.rb → tag_create_query_resource_object_relationships.rb} +11 -11
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +5 -17
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +23 -35
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +5 -17
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -28
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +85 -59
- metadata +91 -571
- data/Gemfile +0 -9
- data/Rakefile +0 -10
- data/docs/AudiencesSubObject.md +0 -20
- data/docs/CampaignCloneQuery.md +0 -18
- data/docs/CampaignCloneQueryResourceObject.md +0 -20
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignCreateQuery.md +0 -18
- data/docs/CampaignCreateQueryResourceObject.md +0 -20
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/CampaignEnum.md +0 -15
- data/docs/CampaignMessageAssignTemplateQuery.md +0 -18
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +0 -20
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignMessageEnum.md +0 -15
- data/docs/CampaignMessagePartialUpdateQuery.md +0 -18
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignPartialUpdateQuery.md +0 -18
- data/docs/CampaignPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +0 -26
- data/docs/CampaignRecipientEstimationEnum.md +0 -15
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +0 -18
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignRecipientEstimationJobEnum.md +0 -15
- data/docs/CampaignSendJobCreateQuery.md +0 -18
- data/docs/CampaignSendJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignSendJobEnum.md +0 -15
- data/docs/CampaignSendJobPartialUpdateQuery.md +0 -18
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignsApi.md +0 -1275
- data/docs/CatalogCategoryBulkCreateJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogCategoryCreateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateQueryResourceObject.md +0 -22
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +0 -24
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryEnum.md +0 -15
- data/docs/CatalogCategoryItemOp.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryUpdateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemBulkCreateJobEnum.md +0 -15
- data/docs/CatalogItemBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogItemBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogItemCategoryOp.md +0 -18
- data/docs/CatalogItemCreateJobCreateQuery.md +0 -18
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemCreateQuery.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObject.md +0 -22
- data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogItemEnum.md +0 -15
- data/docs/CatalogItemUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemUpdateQuery.md +0 -18
- data/docs/CatalogItemUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +0 -34
- data/docs/CatalogJobErrorPayload.md +0 -26
- data/docs/CatalogVariantBulkCreateJobEnum.md +0 -15
- data/docs/CatalogVariantBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogVariantBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogVariantCreateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +0 -46
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItems.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogVariantEnum.md +0 -15
- data/docs/CatalogVariantUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantUpdateQuery.md +0 -18
- data/docs/CatalogVariantUpdateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogsApi.md +0 -4032
- data/docs/ClientApi.md +0 -205
- data/docs/CollectionLinks.md +0 -26
- data/docs/ContentSubObject.md +0 -28
- data/docs/DataPrivacyApi.md +0 -78
- data/docs/DataPrivacyCreateDeletionJobQuery.md +0 -18
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +0 -20
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +0 -22
- data/docs/DataPrivacyDeletionJobEnum.md +0 -15
- data/docs/EmailChannel.md +0 -18
- data/docs/EmailMarketing.md +0 -32
- data/docs/EmailMarketingListSuppression.md +0 -22
- data/docs/EmailMarketingSuppression.md +0 -20
- data/docs/EmailMessageContent.md +0 -24
- data/docs/EmailTrackingOptions.md +0 -24
- data/docs/ErrorSource.md +0 -18
- data/docs/EventCreateQuery.md +0 -18
- data/docs/EventCreateQueryResourceObject.md +0 -20
- data/docs/EventCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/EventEnum.md +0 -15
- data/docs/EventsApi.md +0 -544
- data/docs/FlowActionEnum.md +0 -15
- data/docs/FlowEnum.md +0 -15
- data/docs/FlowMessageEnum.md +0 -15
- data/docs/FlowUpdateQuery.md +0 -18
- data/docs/FlowUpdateQueryResourceObject.md +0 -22
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/FlowsApi.md +0 -1173
- data/docs/GetCampaigns4XXResponse.md +0 -18
- data/docs/GetCampaigns4XXResponseErrorsInner.md +0 -26
- data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +0 -20
- data/docs/ListCreateQuery.md +0 -18
- data/docs/ListCreateQueryResourceObject.md +0 -20
- data/docs/ListCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/ListEnum.md +0 -15
- data/docs/ListMembersAddQuery.md +0 -18
- data/docs/ListMembersAddQueryDataInner.md +0 -20
- data/docs/ListMembersDeleteQuery.md +0 -18
- data/docs/ListPartialUpdateQuery.md +0 -18
- data/docs/ListPartialUpdateQueryResourceObject.md +0 -22
- data/docs/ListsApi.md +0 -832
- data/docs/MetricAggregateEnum.md +0 -15
- data/docs/MetricAggregateQuery.md +0 -18
- data/docs/MetricAggregateQueryResourceObject.md +0 -20
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +0 -36
- data/docs/MetricAggregateRowDTO.md +0 -20
- data/docs/MetricCreateQuery.md +0 -20
- data/docs/MetricEnum.md +0 -15
- data/docs/MetricsApi.md +0 -233
- data/docs/ObjectLinks.md +0 -18
- data/docs/OnsiteProfileCreateQuery.md +0 -18
- data/docs/OnsiteProfileCreateQueryResourceObject.md +0 -22
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +0 -38
- data/docs/OnsiteProfileMeta.md +0 -18
- data/docs/OnsiteProfileMetaIdentifiers.md +0 -28
- data/docs/OnsiteSubscriptionCreateQuery.md +0 -18
- data/docs/OnsiteSubscriptionCreateQueryResourceObject.md +0 -20
- data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md +0 -26
- data/docs/PredictiveAnalytics.md +0 -34
- data/docs/ProfileAggregateEnum.md +0 -15
- data/docs/ProfileCreateQuery.md +0 -18
- data/docs/ProfileCreateQueryResourceObject.md +0 -20
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +0 -36
- data/docs/ProfileEnum.md +0 -15
- data/docs/ProfileLocation.md +0 -34
- data/docs/ProfileLocationLatitude.md +0 -49
- data/docs/ProfileLocationLongitude.md +0 -49
- data/docs/ProfilePartialUpdateQuery.md +0 -18
- data/docs/ProfilePartialUpdateQueryResourceObject.md +0 -22
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileUnsubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileUnsuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfilesApi.md +0 -909
- data/docs/SMSChannel.md +0 -18
- data/docs/SMSMarketing.md +0 -24
- data/docs/SMSMessageContent.md +0 -20
- data/docs/SMSRenderOptions.md +0 -24
- data/docs/SMSTrackingOptions.md +0 -20
- data/docs/STOScheduleOptions.md +0 -18
- data/docs/SegmentEnum.md +0 -15
- data/docs/SegmentPartialUpdateQuery.md +0 -18
- data/docs/SegmentPartialUpdateQueryResourceObject.md +0 -22
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/SegmentsApi.md +0 -543
- data/docs/SendOptions.md +0 -20
- data/docs/SendOptionsSubObject.md +0 -18
- data/docs/SendStrategySubObject.md +0 -24
- data/docs/SendTimeSubObject.md +0 -20
- data/docs/StaticScheduleOptions.md +0 -22
- data/docs/Subscription.md +0 -24
- data/docs/SubscriptionChannels.md +0 -20
- data/docs/SubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/SubscriptionEnum.md +0 -15
- data/docs/Subscriptions.md +0 -20
- data/docs/Suppression.md +0 -18
- data/docs/SuppressionCreateJobCreateQuery.md +0 -18
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagCampaignOp.md +0 -18
- data/docs/TagCampaignOpDataInner.md +0 -20
- data/docs/TagCreateQuery.md +0 -18
- data/docs/TagCreateQueryResourceObject.md +0 -20
- data/docs/TagCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagEnum.md +0 -15
- data/docs/TagFlowOp.md +0 -18
- data/docs/TagFlowOpDataInner.md +0 -20
- data/docs/TagGroupCreateQuery.md +0 -18
- data/docs/TagGroupCreateQueryResourceObject.md +0 -20
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagGroupEnum.md +0 -15
- data/docs/TagGroupUpdateQuery.md +0 -18
- data/docs/TagGroupUpdateQueryResourceObject.md +0 -22
- data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagListOp.md +0 -18
- data/docs/TagListOpDataInner.md +0 -20
- data/docs/TagSegmentOp.md +0 -18
- data/docs/TagSegmentOpDataInner.md +0 -20
- data/docs/TagUpdateQuery.md +0 -18
- data/docs/TagUpdateQueryResourceObject.md +0 -22
- data/docs/TagUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagsApi.md +0 -1923
- data/docs/TemplateCloneQuery.md +0 -18
- data/docs/TemplateCloneQueryResourceObject.md +0 -20
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +0 -22
- data/docs/TemplateCreateQuery.md +0 -18
- data/docs/TemplateCreateQueryResourceObject.md +0 -20
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +0 -32
- data/docs/TemplateEnum.md +0 -15
- data/docs/TemplateRenderQuery.md +0 -18
- data/docs/TemplateRenderQueryResourceObject.md +0 -20
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +0 -22
- data/docs/TemplateUpdateQuery.md +0 -18
- data/docs/TemplateUpdateQueryResourceObject.md +0 -22
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +0 -30
- data/docs/TemplatesApi.md +0 -525
- data/docs/TestApiAnalyticsSampleEnum.md +0 -15
- data/docs/TestListEnum.md +0 -15
- data/docs/ThrottledScheduleOptions.md +0 -20
- data/docs/TrackingOptionsSubObject.md +0 -24
- data/docs/UTMParamsSubObject.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/UnsuppressionCreateJobCreateQuery.md +0 -18
- data/docs/UnsuppressionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/UnsuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/UtmParamInfo.md +0 -20
- data/git_push.sh +0 -57
- data/lib/klaviyo-api-sdk/api/client_api.rb +0 -249
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +0 -284
- data/lib/klaviyo-api-sdk/models/email_marketing.rb +0 -298
- data/lib/klaviyo-api-sdk/models/email_marketing_list_suppression.rb +0 -255
- data/lib/klaviyo-api-sdk/models/email_marketing_suppression.rb +0 -240
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +0 -266
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +0 -268
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +0 -242
- data/lib/klaviyo-api-sdk/models/predictive_analytics.rb +0 -300
- data/lib/klaviyo-api-sdk/models/profile_aggregate_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/send_options.rb +0 -238
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +0 -240
- data/lib/klaviyo-api-sdk/models/sms_marketing.rb +0 -270
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +0 -235
- data/lib/klaviyo-api-sdk/models/test_api_analytics_sample_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/test_list_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +0 -238
- data/spec/api/campaigns_api_spec.rb +0 -255
- data/spec/api/catalogs_api_spec.rb +0 -751
- data/spec/api/client_api_spec.rb +0 -74
- data/spec/api/data_privacy_api_spec.rb +0 -47
- data/spec/api/events_api_spec.rb +0 -132
- data/spec/api/flows_api_spec.rb +0 -247
- data/spec/api/lists_api_spec.rb +0 -180
- data/spec/api/metrics_api_spec.rb +0 -74
- data/spec/api/profiles_api_spec.rb +0 -194
- data/spec/api/segments_api_spec.rb +0 -130
- data/spec/api/tags_api_spec.rb +0 -367
- data/spec/api/templates_api_spec.rb +0 -124
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/audiences_sub_object_spec.rb +0 -40
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_clone_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_clone_query_spec.rb +0 -34
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/campaign_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_create_query_spec.rb +0 -34
- data/spec/models/campaign_enum_spec.rb +0 -28
- data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_spec.rb +0 -34
- data/spec/models/campaign_message_enum_spec.rb +0 -28
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_message_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_enum_spec.rb +0 -28
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_send_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_send_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +0 -34
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +0 -56
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_category_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_enum_spec.rb +0 -28
- data/spec/models/catalog_category_item_op_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_category_update_query_spec.rb +0 -34
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_category_op_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_item_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_enum_spec.rb +0 -28
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +0 -82
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_item_update_query_spec.rb +0 -34
- data/spec/models/catalog_job_error_payload_spec.rb +0 -58
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +0 -126
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_data_inner_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_update_query_spec.rb +0 -34
- data/spec/models/collection_links_spec.rb +0 -58
- data/spec/models/content_sub_object_spec.rb +0 -64
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +0 -40
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +0 -34
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +0 -28
- data/spec/models/email_channel_spec.rb +0 -34
- data/spec/models/email_marketing_list_suppression_spec.rb +0 -46
- data/spec/models/email_marketing_spec.rb +0 -76
- data/spec/models/email_marketing_suppression_spec.rb +0 -40
- data/spec/models/email_message_content_spec.rb +0 -52
- data/spec/models/email_tracking_options_spec.rb +0 -52
- data/spec/models/error_source_spec.rb +0 -34
- data/spec/models/event_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/event_create_query_resource_object_spec.rb +0 -40
- data/spec/models/event_create_query_spec.rb +0 -34
- data/spec/models/event_enum_spec.rb +0 -28
- data/spec/models/flow_action_enum_spec.rb +0 -28
- data/spec/models/flow_enum_spec.rb +0 -28
- data/spec/models/flow_message_enum_spec.rb +0 -28
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/flow_update_query_resource_object_spec.rb +0 -46
- data/spec/models/flow_update_query_spec.rb +0 -34
- data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +0 -40
- data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +0 -58
- data/spec/models/get_campaigns4_xx_response_spec.rb +0 -34
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/list_create_query_resource_object_spec.rb +0 -40
- data/spec/models/list_create_query_spec.rb +0 -34
- data/spec/models/list_enum_spec.rb +0 -28
- data/spec/models/list_members_add_query_data_inner_spec.rb +0 -44
- data/spec/models/list_members_add_query_spec.rb +0 -34
- data/spec/models/list_members_delete_query_spec.rb +0 -34
- data/spec/models/list_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/list_partial_update_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_enum_spec.rb +0 -28
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +0 -40
- data/spec/models/metric_aggregate_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_row_dto_spec.rb +0 -40
- data/spec/models/metric_create_query_spec.rb +0 -40
- data/spec/models/metric_enum_spec.rb +0 -28
- data/spec/models/object_links_spec.rb +0 -34
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +0 -94
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +0 -46
- data/spec/models/onsite_profile_create_query_spec.rb +0 -34
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +0 -64
- data/spec/models/onsite_profile_meta_spec.rb +0 -34
- data/spec/models/onsite_subscription_create_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/onsite_subscription_create_query_resource_object_spec.rb +0 -40
- data/spec/models/onsite_subscription_create_query_spec.rb +0 -34
- data/spec/models/predictive_analytics_spec.rb +0 -82
- data/spec/models/profile_aggregate_enum_spec.rb +0 -28
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +0 -88
- data/spec/models/profile_create_query_resource_object_spec.rb +0 -40
- data/spec/models/profile_create_query_spec.rb +0 -34
- data/spec/models/profile_enum_spec.rb +0 -28
- data/spec/models/profile_location_latitude_spec.rb +0 -31
- data/spec/models/profile_location_longitude_spec.rb +0 -31
- data/spec/models/profile_location_spec.rb +0 -82
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/profile_partial_update_query_spec.rb +0 -34
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_unsubscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_unsuppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/segment_enum_spec.rb +0 -28
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/segment_partial_update_query_spec.rb +0 -34
- data/spec/models/send_options_spec.rb +0 -40
- data/spec/models/send_options_sub_object_spec.rb +0 -34
- data/spec/models/send_strategy_sub_object_spec.rb +0 -52
- data/spec/models/send_time_sub_object_spec.rb +0 -40
- data/spec/models/sms_channel_spec.rb +0 -34
- data/spec/models/sms_marketing_spec.rb +0 -52
- data/spec/models/sms_message_content_spec.rb +0 -40
- data/spec/models/sms_render_options_spec.rb +0 -52
- data/spec/models/sms_tracking_options_spec.rb +0 -40
- data/spec/models/static_schedule_options_spec.rb +0 -46
- data/spec/models/sto_schedule_options_spec.rb +0 -34
- data/spec/models/subscription_channels_spec.rb +0 -48
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/subscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/subscription_enum_spec.rb +0 -28
- data/spec/models/subscription_spec.rb +0 -52
- data/spec/models/subscriptions_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/suppression_spec.rb +0 -34
- data/spec/models/tag_campaign_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_campaign_op_spec.rb +0 -34
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_create_query_spec.rb +0 -34
- data/spec/models/tag_enum_spec.rb +0 -28
- data/spec/models/tag_flow_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_flow_op_spec.rb +0 -34
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_group_create_query_spec.rb +0 -34
- data/spec/models/tag_group_enum_spec.rb +0 -28
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_group_update_query_spec.rb +0 -34
- data/spec/models/tag_list_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_list_op_spec.rb +0 -34
- data/spec/models/tag_segment_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_segment_op_spec.rb +0 -34
- data/spec/models/tag_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/tag_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_update_query_spec.rb +0 -34
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_clone_query_resource_object_spec.rb +0 -40
- data/spec/models/template_clone_query_spec.rb +0 -34
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/template_create_query_resource_object_spec.rb +0 -40
- data/spec/models/template_create_query_spec.rb +0 -34
- data/spec/models/template_enum_spec.rb +0 -28
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_render_query_resource_object_spec.rb +0 -40
- data/spec/models/template_render_query_spec.rb +0 -34
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +0 -52
- data/spec/models/template_update_query_resource_object_spec.rb +0 -46
- data/spec/models/template_update_query_spec.rb +0 -34
- data/spec/models/test_api_analytics_sample_enum_spec.rb +0 -28
- data/spec/models/test_list_enum_spec.rb +0 -28
- data/spec/models/throttled_schedule_options_spec.rb +0 -40
- data/spec/models/tracking_options_sub_object_spec.rb +0 -52
- data/spec/models/unsubscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/unsubscription_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/unsubscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/unsuppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/utm_param_info_spec.rb +0 -40
- data/spec/models/utm_params_sub_object_spec.rb +0 -40
- data/spec/spec_helper.rb +0 -111
@@ -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
|
@@ -20,7 +20,7 @@ module KlaviyoAPI
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Create Campaign
|
23
|
-
# Creates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
23
|
+
# Creates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
24
24
|
# @param campaign_create_query [CampaignCreateQuery] Creates a campaign from parameters
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [Hash<String, Object>]
|
@@ -30,7 +30,7 @@ module KlaviyoAPI
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Create Campaign
|
33
|
-
# Creates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
33
|
+
# Creates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
34
34
|
# @param campaign_create_query [CampaignCreateQuery] Creates a campaign from parameters
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -51,7 +51,7 @@ module KlaviyoAPI
|
|
51
51
|
# header parameters
|
52
52
|
header_params = opts[:header_params] || {}
|
53
53
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
54
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-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'
|
@@ -90,7 +90,7 @@ module KlaviyoAPI
|
|
90
90
|
end
|
91
91
|
|
92
92
|
# Create Campaign Clone
|
93
|
-
# Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
93
|
+
# Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
94
94
|
# @param campaign_clone_query [CampaignCloneQuery] Clones a campaign from an existing campaign
|
95
95
|
# @param [Hash] opts the optional parameters
|
96
96
|
# @return [Hash<String, Object>]
|
@@ -100,7 +100,7 @@ module KlaviyoAPI
|
|
100
100
|
end
|
101
101
|
|
102
102
|
# Create Campaign Clone
|
103
|
-
# Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
103
|
+
# Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
104
104
|
# @param campaign_clone_query [CampaignCloneQuery] Clones a campaign from an existing campaign
|
105
105
|
# @param [Hash] opts the optional parameters
|
106
106
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -121,7 +121,7 @@ module KlaviyoAPI
|
|
121
121
|
# header parameters
|
122
122
|
header_params = opts[:header_params] || {}
|
123
123
|
# klaviyo api revision
|
124
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
124
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-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'
|
@@ -160,7 +160,7 @@ module KlaviyoAPI
|
|
160
160
|
end
|
161
161
|
|
162
162
|
# Assign Campaign Message Template
|
163
|
-
# Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
163
|
+
# Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
164
164
|
# @param campaign_message_assign_template_query [CampaignMessageAssignTemplateQuery] Takes a reusable template, clones it, and assigns the non-reusable clone to the message.
|
165
165
|
# @param [Hash] opts the optional parameters
|
166
166
|
# @return [Hash<String, Object>]
|
@@ -170,7 +170,7 @@ module KlaviyoAPI
|
|
170
170
|
end
|
171
171
|
|
172
172
|
# Assign Campaign Message Template
|
173
|
-
# Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
173
|
+
# Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
174
174
|
# @param campaign_message_assign_template_query [CampaignMessageAssignTemplateQuery] Takes a reusable template, clones it, and assigns the non-reusable clone to the message.
|
175
175
|
# @param [Hash] opts the optional parameters
|
176
176
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -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'
|
@@ -230,7 +230,7 @@ module KlaviyoAPI
|
|
230
230
|
end
|
231
231
|
|
232
232
|
# Create Campaign Recipient Estimation Job
|
233
|
-
# Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
233
|
+
# Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
234
234
|
# @param campaign_recipient_estimation_job_create_query [CampaignRecipientEstimationJobCreateQuery] Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.
|
235
235
|
# @param [Hash] opts the optional parameters
|
236
236
|
# @return [Hash<String, Object>]
|
@@ -240,7 +240,7 @@ module KlaviyoAPI
|
|
240
240
|
end
|
241
241
|
|
242
242
|
# Create Campaign Recipient Estimation Job
|
243
|
-
# Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
243
|
+
# Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
244
244
|
# @param campaign_recipient_estimation_job_create_query [CampaignRecipientEstimationJobCreateQuery] Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.
|
245
245
|
# @param [Hash] opts the optional parameters
|
246
246
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -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'
|
@@ -300,7 +300,7 @@ module KlaviyoAPI
|
|
300
300
|
end
|
301
301
|
|
302
302
|
# Create Campaign Send Job
|
303
|
-
# Trigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
303
|
+
# Trigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
304
304
|
# @param campaign_send_job_create_query [CampaignSendJobCreateQuery] Trigger the campaign to send asynchronously
|
305
305
|
# @param [Hash] opts the optional parameters
|
306
306
|
# @return [Hash<String, Object>]
|
@@ -310,7 +310,7 @@ module KlaviyoAPI
|
|
310
310
|
end
|
311
311
|
|
312
312
|
# Create Campaign Send Job
|
313
|
-
# Trigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
313
|
+
# Trigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
314
314
|
# @param campaign_send_job_create_query [CampaignSendJobCreateQuery] Trigger the campaign to send asynchronously
|
315
315
|
# @param [Hash] opts the optional parameters
|
316
316
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -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'
|
@@ -370,7 +370,7 @@ module KlaviyoAPI
|
|
370
370
|
end
|
371
371
|
|
372
372
|
# Delete Campaign
|
373
|
-
# Delete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
373
|
+
# Delete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
374
374
|
# @param id [String] The campaign ID to be deleted
|
375
375
|
# @param [Hash] opts the optional parameters
|
376
376
|
# @return [nil]
|
@@ -380,7 +380,7 @@ module KlaviyoAPI
|
|
380
380
|
end
|
381
381
|
|
382
382
|
# Delete Campaign
|
383
|
-
# Delete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
383
|
+
# Delete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
384
384
|
# @param id [String] The campaign ID to be deleted
|
385
385
|
# @param [Hash] opts the optional parameters
|
386
386
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -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
|
|
@@ -435,12 +435,13 @@ module KlaviyoAPI
|
|
435
435
|
end
|
436
436
|
|
437
437
|
# Get Campaign
|
438
|
-
# Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
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)
|
@@ -448,12 +449,13 @@ module KlaviyoAPI
|
|
448
449
|
end
|
449
450
|
|
450
451
|
# Get Campaign
|
451
|
-
# Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
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
|
-
# Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
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)
|
@@ -532,10 +635,13 @@ module KlaviyoAPI
|
|
532
635
|
end
|
533
636
|
|
534
637
|
# Get Campaign Message
|
535
|
-
# Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
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
|
-
# 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:** `
|
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)
|
@@ -604,10 +999,10 @@ module KlaviyoAPI
|
|
604
999
|
end
|
605
1000
|
|
606
1001
|
# Get Campaign Recipient Estimation
|
607
|
-
# 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:** `
|
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
|
|
@@ -665,10 +1060,10 @@ module KlaviyoAPI
|
|
665
1060
|
end
|
666
1061
|
|
667
1062
|
# Get Campaign Recipient Estimation Job
|
668
|
-
# 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:** `
|
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)
|
@@ -676,10 +1071,10 @@ module KlaviyoAPI
|
|
676
1071
|
end
|
677
1072
|
|
678
1073
|
# Get Campaign Recipient Estimation Job
|
679
|
-
# 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:** `
|
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,8 +1131,73 @@ 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
|
-
# Returns the IDs of all tags associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
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]
|
742
1202
|
# @param [Hash] opts the optional parameters
|
743
1203
|
# @return [Hash<String, Object>]
|
@@ -747,7 +1207,7 @@ module KlaviyoAPI
|
|
747
1207
|
end
|
748
1208
|
|
749
1209
|
# Get Campaign Relationships Tags
|
750
|
-
# Returns the IDs of all tags associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1210
|
+
# 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`
|
751
1211
|
# @param id [String]
|
752
1212
|
# @param [Hash] opts the optional parameters
|
753
1213
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -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
|
|
@@ -802,10 +1262,10 @@ module KlaviyoAPI
|
|
802
1262
|
end
|
803
1263
|
|
804
1264
|
# Get Campaign Send Job
|
805
|
-
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
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)
|
@@ -813,10 +1273,10 @@ module KlaviyoAPI
|
|
813
1273
|
end
|
814
1274
|
|
815
1275
|
# Get Campaign Send Job
|
816
|
-
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
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
|
|
@@ -874,36 +1334,36 @@ module KlaviyoAPI
|
|
874
1334
|
end
|
875
1335
|
|
876
1336
|
# Get Campaign Tags
|
877
|
-
# Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
878
|
-
# @param
|
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`
|
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
|
-
def get_campaign_tags(
|
883
|
-
data, _status_code, _headers = get_campaign_tags_with_http_info(
|
1342
|
+
def get_campaign_tags(id, opts = {})
|
1343
|
+
data, _status_code, _headers = get_campaign_tags_with_http_info(id, opts)
|
884
1344
|
data
|
885
1345
|
end
|
886
1346
|
|
887
1347
|
# Get Campaign Tags
|
888
|
-
# Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
889
|
-
# @param
|
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`
|
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
|
-
def get_campaign_tags_with_http_info(
|
1353
|
+
def get_campaign_tags_with_http_info(id, opts = {})
|
894
1354
|
if @api_client.config.debugging
|
895
1355
|
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_tags ...'
|
896
1356
|
end
|
897
|
-
# verify the required parameter '
|
898
|
-
if @api_client.config.client_side_validation &&
|
899
|
-
fail ArgumentError, "Missing the required parameter '
|
1357
|
+
# verify the required parameter 'id' is set
|
1358
|
+
if @api_client.config.client_side_validation && id.nil?
|
1359
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_tags"
|
900
1360
|
end
|
901
1361
|
allowable_values = ["name"]
|
902
1362
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
903
1363
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
904
1364
|
end
|
905
1365
|
# resource path
|
906
|
-
local_var_path = '/api/campaigns/{
|
1366
|
+
local_var_path = '/api/campaigns/{id}/tags/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
907
1367
|
|
908
1368
|
# query parameters
|
909
1369
|
query_params = opts[:query_params] || {}
|
@@ -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
|
|
@@ -1039,7 +1510,7 @@ module KlaviyoAPI
|
|
1039
1510
|
end
|
1040
1511
|
|
1041
1512
|
# Update Campaign
|
1042
|
-
# Update a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
1513
|
+
# Update a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1043
1514
|
# @param id [String] The campaign ID to be retrieved
|
1044
1515
|
# @param campaign_partial_update_query [CampaignPartialUpdateQuery] Update a campaign and return it
|
1045
1516
|
# @param [Hash] opts the optional parameters
|
@@ -1050,7 +1521,7 @@ module KlaviyoAPI
|
|
1050
1521
|
end
|
1051
1522
|
|
1052
1523
|
# Update Campaign
|
1053
|
-
# Update a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
1524
|
+
# Update a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1054
1525
|
# @param id [String] The campaign ID to be retrieved
|
1055
1526
|
# @param campaign_partial_update_query [CampaignPartialUpdateQuery] Update a campaign and return it
|
1056
1527
|
# @param [Hash] opts the optional parameters
|
@@ -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'
|
@@ -1115,7 +1586,7 @@ module KlaviyoAPI
|
|
1115
1586
|
end
|
1116
1587
|
|
1117
1588
|
# Update Campaign Message
|
1118
|
-
# Update a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
1589
|
+
# Update a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1119
1590
|
# @param id [String] The message ID to be retrieved
|
1120
1591
|
# @param campaign_message_partial_update_query [CampaignMessagePartialUpdateQuery] Update a message and return it
|
1121
1592
|
# @param [Hash] opts the optional parameters
|
@@ -1126,7 +1597,7 @@ module KlaviyoAPI
|
|
1126
1597
|
end
|
1127
1598
|
|
1128
1599
|
# Update Campaign Message
|
1129
|
-
# Update a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
1600
|
+
# Update a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1130
1601
|
# @param id [String] The message ID to be retrieved
|
1131
1602
|
# @param campaign_message_partial_update_query [CampaignMessagePartialUpdateQuery] Update a message and return it
|
1132
1603
|
# @param [Hash] opts the optional parameters
|
@@ -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'
|
@@ -1191,7 +1662,7 @@ module KlaviyoAPI
|
|
1191
1662
|
end
|
1192
1663
|
|
1193
1664
|
# Update Campaign Send Job
|
1194
|
-
# Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
1665
|
+
# Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1195
1666
|
# @param id [String] The ID of the currently sending campaign to cancel or revert
|
1196
1667
|
# @param campaign_send_job_partial_update_query [CampaignSendJobPartialUpdateQuery] Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT
|
1197
1668
|
# @param [Hash] opts the optional parameters
|
@@ -1202,7 +1673,7 @@ module KlaviyoAPI
|
|
1202
1673
|
end
|
1203
1674
|
|
1204
1675
|
# Update Campaign Send Job
|
1205
|
-
# Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
1676
|
+
# Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1206
1677
|
# @param id [String] The ID of the currently sending campaign to cancel or revert
|
1207
1678
|
# @param campaign_send_job_partial_update_query [CampaignSendJobPartialUpdateQuery] Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT
|
1208
1679
|
# @param [Hash] opts the optional parameters
|
@@ -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'
|