klaviyo-api-sdk 18.0.0 → 19.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +44 -0
- data/README.md +1525 -459
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -6
- data/lib/klaviyo-api-sdk/api/billing_api.rb +162 -0
- data/lib/klaviyo-api-sdk/api/brands_api.rb +1933 -0
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +3298 -653
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +265 -265
- data/lib/klaviyo-api-sdk/api/client_api.rb +9 -13
- data/lib/klaviyo-api-sdk/api/conversations_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +80 -80
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +120 -117
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/events_api.rb +39 -39
- data/lib/klaviyo-api-sdk/api/flows_api.rb +190 -113
- data/lib/klaviyo-api-sdk/api/forms_api.rb +292 -43
- data/lib/klaviyo-api-sdk/api/images_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api/lists_api.rb +64 -64
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +94 -94
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +163 -163
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +27 -27
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api/segments_api.rb +58 -58
- data/lib/klaviyo-api-sdk/api/tags_api.rb +62 -62
- data/lib/klaviyo-api-sdk/api/templates_api.rb +236 -76
- data/lib/klaviyo-api-sdk/api/text_messaging_api.rb +774 -0
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +11 -11
- data/lib/klaviyo-api-sdk/api/translations_api.rb +1102 -0
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +19 -19
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +27 -27
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{push_on_open_app.rb → ab_test_action_link_only.rb} +23 -9
- data/lib/klaviyo-api-sdk/models/{sms_message_definition_create.rb → ab_test_settings.rb} +36 -35
- data/lib/klaviyo-api-sdk/models/action_output_split_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/address.rb +295 -0
- data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/age_gate_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → animation.rb} +56 -44
- data/lib/klaviyo-api-sdk/models/api_schema_property.rb +2 -2
- data/lib/klaviyo-api-sdk/models/audience_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object.rb → audience_clone_query_resource_object.rb} +7 -7
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes.rb → audience_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{html_block_data_v0.rb → audience_create_query_resource_object_relationships.rb} +19 -24
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages.rb +220 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{audiences_update.rb → audience_definition.rb} +32 -10
- data/lib/klaviyo-api-sdk/models/audience_inline_create.rb +261 -0
- data/lib/klaviyo-api-sdk/models/audience_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/audience_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object_attributes.rb → audience_update_query_resource_object_attributes.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/border_styles.rb +297 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object_attributes.rb +298 -0
- data/lib/klaviyo-api-sdk/models/brand_button_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object_attributes.rb +275 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object_attributes.rb +233 -0
- data/lib/klaviyo-api-sdk/models/brand_color_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options.rb → brand_email_body_patch_attributes.rb} +68 -38
- data/lib/klaviyo-api-sdk/models/brand_email_default_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object.rb +261 -0
- data/lib/klaviyo-api-sdk/models/{audiences.rb → brand_email_default_partial_update_query_resource_object_attributes.rb} +25 -28
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships.rb +236 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_button.rb +218 -0
- data/lib/klaviyo-api-sdk/models/{content_repeat_v0.rb → brand_email_default_partial_update_query_resource_object_relationships_brand_button_data.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_social_group.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_rels_brand_social_group_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_email_footer_patch_attributes.rb +283 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_content_update.rb → brand_email_header_patch_attributes.rb} +36 -38
- data/lib/klaviyo-api-sdk/models/brand_library_button_styles.rb +262 -0
- data/lib/klaviyo-api-sdk/models/brand_library_text_styles.rb +368 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_options_badge.rb → brand_library_text_styles_letter_spacing.rb} +3 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object.rb → brand_logo_create_query_resource_object.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_attributes.rb +264 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships.rb → brand_logo_create_query_resource_object_relationships.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query.rb → brand_logo_partial_update_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object.rb +261 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object_attributes.rb +259 -0
- data/lib/klaviyo-api-sdk/models/brand_social_group_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object.rb → brand_social_group_create_query_resource_object.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/brand_social_group_create_query_resource_object_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_badge_badge_options.rb → brand_social_group_create_query_resource_object_attributes_social_links_inner.rb} +3 -5
- data/lib/klaviyo-api-sdk/models/brand_social_group_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query.rb → brand_social_group_partial_update_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query_resource_object.rb → brand_social_group_partial_update_query_resource_object.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/brand_social_group_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_descriptor.rb +248 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/button_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/button_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/button_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/campaign_audience_clone_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_audience_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +9 -9
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +30 -63
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships.rb +236 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{push_action_button_definition.rb → campaign_definition.rb} +56 -44
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_attributes.rb +298 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/{non_local_static_send.rb → campaign_message_schedule_update_query_resource_object_attributes.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +12 -48
- data/lib/klaviyo-api-sdk/models/campaign_schedule_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_variation_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/checkboxes_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{mobile_push_no_badge.rb → click_tracking_subscription_parameters.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{campaign_message_increment.rb → click_tracking_unsubscription_parameters.rb} +22 -21
- data/lib/klaviyo-api-sdk/models/close_button_style.rb +49 -4
- data/lib/klaviyo-api-sdk/models/{push_on_open_web_url.rb → code_action_link_only.rb} +17 -14
- data/lib/klaviyo-api-sdk/models/color.rb +237 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/consent_page_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/content_experiment_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{push_on_open_deep_link.rb → continue_with_shop.rb} +29 -22
- data/lib/klaviyo-api-sdk/models/{text_block_data_v0.rb → continue_with_shop_autofill.rb} +50 -37
- data/lib/klaviyo-api-sdk/models/continue_with_shop_phone_consent.rb +262 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_update.rb → continue_with_shop_properties.rb} +76 -59
- data/lib/klaviyo-api-sdk/models/continue_with_shop_styles.rb +298 -0
- data/lib/klaviyo-api-sdk/models/conversation_message_create_query_resource_object_attributes.rb +17 -4
- data/lib/klaviyo-api-sdk/models/countdown_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/countdown_timer_properties.rb +33 -1
- data/lib/klaviyo-api-sdk/models/{horizontal_rule_block_v0.rb → coupon_assigner_configuration.rb} +40 -48
- data/lib/klaviyo-api-sdk/models/coupon_block_data.rb +1 -5
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/coupon_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +11 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger_trigger_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger_trigger_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/{local_static_send.rb → custom_social_link.rb} +72 -31
- data/lib/klaviyo-api-sdk/models/customer_hub_block_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object.rb +5 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_attributes.rb +5 -1
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships.rb +5 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_create_job_create_query_resource_object.rb +5 -0
- data/lib/klaviyo-api-sdk/models/date_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/date_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/dropdown_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{mobile_push_badge.rb → dynamic_sms_image.rb} +29 -28
- data/lib/klaviyo-api-sdk/models/{email_content.rb → email_channel_details.rb} +97 -42
- data/lib/klaviyo-api-sdk/models/{push_send_options.rb → email_header_link.rb} +29 -14
- data/lib/klaviyo-api-sdk/models/email_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/email_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +13 -4
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +13 -4
- data/lib/klaviyo-api-sdk/models/enroll_form_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +5 -14
- data/lib/klaviyo-api-sdk/models/{smart_send_time_strategy.rb → first_party_social_link.rb} +30 -31
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes_definition.rb +126 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes.rb +245 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_campaign_messages.rb → flow_action_insert_query_resource_object_attributes_anchor_action.rb} +6 -8
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes_definition.rb +124 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow.rb +218 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_action_update_query_resource_object_attributes_definition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{mobile_push_options_on_open.rb → flow_sms_message_hierarchy_inner.rb} +3 -4
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +25 -5
- data/lib/klaviyo-api-sdk/models/{campaigns_sms_tracking_options.rb → flow_whats_app_with_ac.rb} +86 -16
- data/lib/klaviyo-api-sdk/models/form_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form.rb +218 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships_image.rb → form_unpublish_job_create_query_resource_object_relationships_form.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships_image_data.rb → form_unpublish_job_create_query_resource_object_relationships_form_data.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/html_text_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen_properties.rb +36 -4
- data/lib/klaviyo-api-sdk/models/{html_block_v0.rb → iaf_open_url.rb} +42 -34
- data/lib/klaviyo-api-sdk/models/{sms_content_create.rb → iaf_open_url_properties.rb} +12 -12
- data/lib/klaviyo-api-sdk/models/image_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/image_asset.rb +409 -0
- data/lib/klaviyo-api-sdk/models/image_block_styles.rb +11 -1
- data/lib/klaviyo-api-sdk/models/image_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{throttled_send_strategy.rb → inline_message_schedule.rb} +69 -55
- data/lib/klaviyo-api-sdk/models/input_style_overrides.rb +307 -0
- data/lib/klaviyo-api-sdk/models/internal_service_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/link_text_styles.rb +352 -0
- data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options_custom_tracking_params_inner.rb → link_text_styles_letter_spacing.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/list_update_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox.rb +291 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_properties.rb +372 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_styles.rb +283 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_static_count.rb → marketing_tracking_consent_configuration.rb} +31 -30
- data/lib/klaviyo-api-sdk/models/media_asset.rb +318 -0
- data/lib/klaviyo-api-sdk/models/media_asset_reference.rb +240 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object.rb +266 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_attributes.rb +236 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships.rb +237 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{static_send_strategy.rb → message_definition.rb} +52 -42
- data/lib/klaviyo-api-sdk/models/{text_block_v0.rb → message_hierarchy_rcs_item.rb} +56 -57
- data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item.rb +301 -0
- data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item_image.rb +105 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_tracking_options.rb → message_hierarchy_sms_item_media.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{block_display_options.rb → message_inline_create.rb} +64 -33
- data/lib/klaviyo-api-sdk/models/message_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object_attributes.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_send_options.rb +344 -0
- data/lib/klaviyo-api-sdk/models/message_tracking_options.rb +239 -0
- data/lib/klaviyo-api-sdk/models/{static_tracking_param.rb → multi_branch_split_action_link_only.rb} +15 -32
- data/lib/klaviyo-api-sdk/models/multi_branch_split_action_link_only_data.rb +225 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter_condition_groups_inner_conditions_inner.rb +4 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_link_only.rb +237 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/phone_number_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +15 -5
- data/lib/klaviyo-api-sdk/models/profile_has_custom_object_filter_filter.rb +2 -0
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +5 -1
- data/lib/klaviyo-api-sdk/models/profile_permissions_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/push_action_button_v0.rb +322 -0
- data/lib/klaviyo-api-sdk/models/{push_action_button.rb → push_action_button_v2.rb} +28 -8
- data/lib/klaviyo-api-sdk/models/push_channel_details.rb +512 -0
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -10
- data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/radio_buttons_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/rcs_card.rb +290 -0
- data/lib/klaviyo-api-sdk/models/rcs_card_image.rb +105 -0
- data/lib/klaviyo-api-sdk/models/rcs_card_video.rb +105 -0
- data/lib/klaviyo-api-sdk/models/{sms_send_options.rb → rcs_rich_content.rb} +36 -14
- data/lib/klaviyo-api-sdk/models/{spacer_block_v0.rb → rcs_suggestion.rb} +63 -34
- data/lib/klaviyo-api-sdk/models/review_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/review_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +2 -0
- data/lib/klaviyo-api-sdk/models/send_email_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_settings.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{image_block_v0.rb → send_whats_app_with_ac_action.rb} +35 -31
- data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_data.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/signup_counter_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/slim_image_reference.rb +242 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_update.rb → sms_channel_details.rb} +135 -34
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{render_options.rb → spacing_styles.rb} +48 -40
- data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/static_sms_image.rb +270 -0
- data/lib/klaviyo-api-sdk/models/target_date_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query.rb → template_preview_send_job_create_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_options.rb → template_preview_send_job_create_query_resource_object_relationships.rb} +21 -31
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile.rb +218 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template.rb +218 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_attrs_text_messaging_sender_registration.rb +224 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_create.rb → text_messaging_sender_create_query_resource_object_attributes.rb} +50 -68
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_attributes.rb +440 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender.rb +218 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{button_block_v0.rb → text_style_overrides.rb} +54 -53
- data/lib/klaviyo-api-sdk/models/text_style_overrides_font_family.rb +103 -0
- data/lib/klaviyo-api-sdk/models/text_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{campaign_message_property.rb → throttled_options.rb} +31 -32
- data/lib/klaviyo-api-sdk/models/time_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{email_send_options.rb → timezone_options.rb} +13 -13
- data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object_attributes.rb +440 -0
- data/lib/klaviyo-api-sdk/models/{immediate_send_strategy.rb → toll_free_sender_details.rb} +22 -21
- data/lib/klaviyo-api-sdk/models/translation_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_create.rb → translation_create_query_resource_object_attributes.rb} +54 -41
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships.rb +254 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/translation_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/translation_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_content_create.rb → translation_partial_update_query_resource_object_attributes.rb} +39 -41
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object_attributes.rb → universal_content_create_query_v1_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_strategy.rb → universal_content_create_query_v1_resource_object_attributes_definition.rb} +17 -6
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query_resource_object_attributes.rb → universal_content_partial_update_query_v1_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes_definition.rb → universal_content_partial_update_query_v1_resource_object_attributes_definition.rb} +18 -5
- data/lib/klaviyo-api-sdk/models/update_profile_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/variation_definition.rb +230 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_options.rb → variation_definition_details.rb} +6 -5
- data/lib/klaviyo-api-sdk/models/variation_inline_create.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/verified_badge_style.rb +266 -0
- data/lib/klaviyo-api-sdk/models/{email_message_definition.rb → whatsapp_channel_details.rb} +23 -25
- data/lib/klaviyo-api-sdk.rb +305 -78
- data/lib/klaviyo-api-sdk.rb.bak +306 -79
- metadata +315 -82
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +0 -107
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +0 -107
- data/lib/klaviyo-api-sdk/models/drop_shadow_block_v0.rb +0 -293
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +0 -349
- data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +0 -105
- data/lib/klaviyo-api-sdk/models/text_block_styles_v0.rb +0 -533
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +0 -109
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +0 -109
|
@@ -22,7 +22,7 @@ module KlaviyoAPI
|
|
|
22
22
|
# Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max number of coupon codes per job we allow for is 1000. Max number of jobs queued at once we allow for is 100.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupon-codes:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_coupon_codes.json)
|
|
23
23
|
# @param coupon_code_create_job_create_query [CouponCodeCreateJobCreateQuery]
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
-
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
25
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
26
26
|
# @return [Hash<String, Object>]
|
|
27
27
|
def bulk_create_coupon_codes(coupon_code_create_job_create_query, opts = {})
|
|
28
28
|
data, _status_code, _headers = bulk_create_coupon_codes_with_http_info(coupon_code_create_job_create_query, opts)
|
|
@@ -39,7 +39,7 @@ module KlaviyoAPI
|
|
|
39
39
|
# Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max number of coupon codes per job we allow for is 1000. Max number of jobs queued at once we allow for is 100.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupon-codes:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_coupon_codes.json)
|
|
40
40
|
# @param coupon_code_create_job_create_query [CouponCodeCreateJobCreateQuery]
|
|
41
41
|
# @param [Hash] opts the optional parameters
|
|
42
|
-
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
42
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
43
43
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
44
44
|
def bulk_create_coupon_codes_with_http_info(coupon_code_create_job_create_query, opts = {})
|
|
45
45
|
if @api_client.config.debugging
|
|
@@ -63,7 +63,7 @@ module KlaviyoAPI
|
|
|
63
63
|
# header parameters
|
|
64
64
|
header_params = opts[:header_params] || {}
|
|
65
65
|
# klaviyo api revision
|
|
66
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
66
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
67
67
|
# HTTP header 'Accept' (if needed)
|
|
68
68
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
69
69
|
# HTTP header 'Content-Type'
|
|
@@ -111,7 +111,7 @@ module KlaviyoAPI
|
|
|
111
111
|
# Creates a new coupon.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `coupons:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_coupon.json)
|
|
112
112
|
# @param coupon_create_query [CouponCreateQuery]
|
|
113
113
|
# @param [Hash] opts the optional parameters
|
|
114
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
114
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
115
115
|
# @return [Hash<String, Object>]
|
|
116
116
|
def create_coupon(coupon_create_query, opts = {})
|
|
117
117
|
data, _status_code, _headers = create_coupon_with_http_info(coupon_create_query, opts)
|
|
@@ -122,7 +122,7 @@ module KlaviyoAPI
|
|
|
122
122
|
# Creates a new coupon.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `coupons:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_coupon.json)
|
|
123
123
|
# @param coupon_create_query [CouponCreateQuery]
|
|
124
124
|
# @param [Hash] opts the optional parameters
|
|
125
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
125
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
126
126
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
127
127
|
def create_coupon_with_http_info(coupon_create_query, opts = {})
|
|
128
128
|
if @api_client.config.debugging
|
|
@@ -132,7 +132,7 @@ module KlaviyoAPI
|
|
|
132
132
|
if @api_client.config.client_side_validation && coupon_create_query.nil?
|
|
133
133
|
fail ArgumentError, "Missing the required parameter 'coupon_create_query' when calling CouponsApi.create_coupon"
|
|
134
134
|
end
|
|
135
|
-
allowable_values = ["description", "external_id", "id", "monitor_configuration"]
|
|
135
|
+
allowable_values = ["assigner_configuration", "assigner_configuration.unused_expired", "assigner_configuration.used", "description", "external_id", "id", "monitor_configuration"]
|
|
136
136
|
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
|
137
137
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
|
138
138
|
end
|
|
@@ -146,7 +146,7 @@ module KlaviyoAPI
|
|
|
146
146
|
# header parameters
|
|
147
147
|
header_params = opts[:header_params] || {}
|
|
148
148
|
# klaviyo api revision
|
|
149
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
149
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
150
150
|
# HTTP header 'Accept' (if needed)
|
|
151
151
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
152
152
|
# HTTP header 'Content-Type'
|
|
@@ -188,7 +188,7 @@ module KlaviyoAPI
|
|
|
188
188
|
# Synchronously creates a coupon code for the given coupon.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_coupon_code.json)
|
|
189
189
|
# @param coupon_code_create_query [CouponCodeCreateQuery]
|
|
190
190
|
# @param [Hash] opts the optional parameters
|
|
191
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
191
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
192
192
|
# @return [Hash<String, Object>]
|
|
193
193
|
def create_coupon_code(coupon_code_create_query, opts = {})
|
|
194
194
|
data, _status_code, _headers = create_coupon_code_with_http_info(coupon_code_create_query, opts)
|
|
@@ -199,7 +199,7 @@ module KlaviyoAPI
|
|
|
199
199
|
# Synchronously creates a coupon code for the given coupon.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_coupon_code.json)
|
|
200
200
|
# @param coupon_code_create_query [CouponCodeCreateQuery]
|
|
201
201
|
# @param [Hash] opts the optional parameters
|
|
202
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
202
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
203
203
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
204
204
|
def create_coupon_code_with_http_info(coupon_code_create_query, opts = {})
|
|
205
205
|
if @api_client.config.debugging
|
|
@@ -223,7 +223,7 @@ module KlaviyoAPI
|
|
|
223
223
|
# header parameters
|
|
224
224
|
header_params = opts[:header_params] || {}
|
|
225
225
|
# klaviyo api revision
|
|
226
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
226
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
227
227
|
# HTTP header 'Accept' (if needed)
|
|
228
228
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
229
229
|
# HTTP header 'Content-Type'
|
|
@@ -293,7 +293,7 @@ module KlaviyoAPI
|
|
|
293
293
|
# header parameters
|
|
294
294
|
header_params = opts[:header_params] || {}
|
|
295
295
|
# klaviyo api revision
|
|
296
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
296
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
297
297
|
# HTTP header 'Accept' (if needed)
|
|
298
298
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
299
299
|
|
|
@@ -358,7 +358,7 @@ module KlaviyoAPI
|
|
|
358
358
|
# header parameters
|
|
359
359
|
header_params = opts[:header_params] || {}
|
|
360
360
|
# klaviyo api revision
|
|
361
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
361
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
362
362
|
# HTTP header 'Accept' (if needed)
|
|
363
363
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
364
364
|
|
|
@@ -394,9 +394,9 @@ module KlaviyoAPI
|
|
|
394
394
|
# Get Bulk Create Coupon Code Jobs
|
|
395
395
|
# Get all coupon code bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_code_jobs.json)
|
|
396
396
|
# @param [Hash] opts the optional parameters
|
|
397
|
-
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
398
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
399
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
397
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
398
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
399
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
400
400
|
# @return [Hash<String, Object>]
|
|
401
401
|
def get_bulk_create_coupon_code_jobs(opts = {})
|
|
402
402
|
data, _status_code, _headers = get_bulk_create_coupon_code_jobs_with_http_info(opts)
|
|
@@ -409,9 +409,9 @@ module KlaviyoAPI
|
|
|
409
409
|
# Get Bulk Create Coupon Code Jobs
|
|
410
410
|
# Get all coupon code bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_code_jobs.json)
|
|
411
411
|
# @param [Hash] opts the optional parameters
|
|
412
|
-
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
413
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
414
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
412
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
413
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` (allowed values: `'queued'`, `'processing'`, `'complete'`, `'cancelled'`)
|
|
414
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
415
415
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
416
416
|
def get_bulk_create_coupon_code_jobs_with_http_info(opts = {})
|
|
417
417
|
if @api_client.config.debugging
|
|
@@ -433,7 +433,7 @@ module KlaviyoAPI
|
|
|
433
433
|
# header parameters
|
|
434
434
|
header_params = opts[:header_params] || {}
|
|
435
435
|
# klaviyo api revision
|
|
436
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
436
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
437
437
|
# HTTP header 'Accept' (if needed)
|
|
438
438
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
439
439
|
|
|
@@ -473,9 +473,9 @@ module KlaviyoAPI
|
|
|
473
473
|
# Get a coupon code bulk create job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_codes_job.json)
|
|
474
474
|
# @param job_id [String] ID of the job to retrieve.
|
|
475
475
|
# @param [Hash] opts the optional parameters
|
|
476
|
-
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
477
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
478
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
476
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
477
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
478
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
479
479
|
# @return [Hash<String, Object>]
|
|
480
480
|
def get_bulk_create_coupon_codes_job(job_id, opts = {})
|
|
481
481
|
data, _status_code, _headers = get_bulk_create_coupon_codes_job_with_http_info(job_id, opts)
|
|
@@ -489,9 +489,9 @@ module KlaviyoAPI
|
|
|
489
489
|
# Get a coupon code bulk create job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_codes_job.json)
|
|
490
490
|
# @param job_id [String] ID of the job to retrieve.
|
|
491
491
|
# @param [Hash] opts the optional parameters
|
|
492
|
-
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
493
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
494
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
492
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
493
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
494
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
495
495
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
496
496
|
def get_bulk_create_coupon_codes_job_with_http_info(job_id, opts = {})
|
|
497
497
|
if @api_client.config.debugging
|
|
@@ -525,7 +525,7 @@ module KlaviyoAPI
|
|
|
525
525
|
# header parameters
|
|
526
526
|
header_params = opts[:header_params] || {}
|
|
527
527
|
# klaviyo api revision
|
|
528
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
528
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
529
529
|
# HTTP header 'Accept' (if needed)
|
|
530
530
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
531
531
|
|
|
@@ -565,7 +565,7 @@ module KlaviyoAPI
|
|
|
565
565
|
# Get a specific coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupons:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon.json)
|
|
566
566
|
# @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration.
|
|
567
567
|
# @param [Hash] opts the optional parameters
|
|
568
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
568
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
569
569
|
# @return [Hash<String, Object>]
|
|
570
570
|
def get_coupon(id, opts = {})
|
|
571
571
|
data, _status_code, _headers = get_coupon_with_http_info(id, opts)
|
|
@@ -576,7 +576,7 @@ module KlaviyoAPI
|
|
|
576
576
|
# Get a specific coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupons:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon.json)
|
|
577
577
|
# @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration.
|
|
578
578
|
# @param [Hash] opts the optional parameters
|
|
579
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
579
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
580
580
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
581
581
|
def get_coupon_with_http_info(id, opts = {})
|
|
582
582
|
if @api_client.config.debugging
|
|
@@ -586,7 +586,7 @@ module KlaviyoAPI
|
|
|
586
586
|
if @api_client.config.client_side_validation && id.nil?
|
|
587
587
|
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.get_coupon"
|
|
588
588
|
end
|
|
589
|
-
allowable_values = ["description", "external_id", "id", "monitor_configuration"]
|
|
589
|
+
allowable_values = ["assigner_configuration", "assigner_configuration.unused_expired", "assigner_configuration.used", "description", "external_id", "id", "monitor_configuration"]
|
|
590
590
|
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
|
591
591
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
|
592
592
|
end
|
|
@@ -600,7 +600,7 @@ module KlaviyoAPI
|
|
|
600
600
|
# header parameters
|
|
601
601
|
header_params = opts[:header_params] || {}
|
|
602
602
|
# klaviyo api revision
|
|
603
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
603
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
604
604
|
# HTTP header 'Accept' (if needed)
|
|
605
605
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
606
606
|
|
|
@@ -637,9 +637,9 @@ module KlaviyoAPI
|
|
|
637
637
|
# Returns a Coupon Code specified by the given identifier.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_code.json)
|
|
638
638
|
# @param id [String] The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
|
|
639
639
|
# @param [Hash] opts the optional parameters
|
|
640
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
641
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
642
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
640
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
641
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
642
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
643
643
|
# @return [Hash<String, Object>]
|
|
644
644
|
def get_coupon_code(id, opts = {})
|
|
645
645
|
data, _status_code, _headers = get_coupon_code_with_http_info(id, opts)
|
|
@@ -650,9 +650,9 @@ module KlaviyoAPI
|
|
|
650
650
|
# Returns a Coupon Code specified by the given identifier.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_code.json)
|
|
651
651
|
# @param id [String] The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
|
|
652
652
|
# @param [Hash] opts the optional parameters
|
|
653
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
654
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
655
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
653
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
654
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
655
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
656
656
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
657
657
|
def get_coupon_code_with_http_info(id, opts = {})
|
|
658
658
|
if @api_client.config.debugging
|
|
@@ -666,7 +666,7 @@ module KlaviyoAPI
|
|
|
666
666
|
if @api_client.config.client_side_validation && opts[:'fields_coupon_code'] && !opts[:'fields_coupon_code'].all? { |item| allowable_values.include?(item) }
|
|
667
667
|
fail ArgumentError, "invalid value for \"fields_coupon_code\", must include one of #{allowable_values}"
|
|
668
668
|
end
|
|
669
|
-
allowable_values = ["description", "external_id", "id", "monitor_configuration"]
|
|
669
|
+
allowable_values = ["assigner_configuration", "assigner_configuration.unused_expired", "assigner_configuration.used", "description", "external_id", "id", "monitor_configuration"]
|
|
670
670
|
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
|
671
671
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
|
672
672
|
end
|
|
@@ -686,7 +686,7 @@ module KlaviyoAPI
|
|
|
686
686
|
# header parameters
|
|
687
687
|
header_params = opts[:header_params] || {}
|
|
688
688
|
# klaviyo api revision
|
|
689
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
689
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
690
690
|
# HTTP header 'Accept' (if needed)
|
|
691
691
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
692
692
|
|
|
@@ -723,8 +723,8 @@ module KlaviyoAPI
|
|
|
723
723
|
# Gets a list of coupon code relationships associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_code_ids_for_coupon.json)
|
|
724
724
|
# @param id [String] The ID of the coupon to look up the relationship of.
|
|
725
725
|
# @param [Hash] opts the optional parameters
|
|
726
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
727
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
726
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`status`: `equals` (allowed values: `'UNASSIGNED'`, `'PROCESSING'`, `'ASSIGNED_TO_PROFILE'`, `'VERSION_NOT_ACTIVE'`, `'DELETING'`, `'USED'`)<br>`profile.id`: `any`, `equals` (string)
|
|
727
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
728
728
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
729
729
|
# @return [Hash<String, Object>]
|
|
730
730
|
def get_coupon_code_ids_for_coupon(id, opts = {})
|
|
@@ -745,8 +745,8 @@ module KlaviyoAPI
|
|
|
745
745
|
# Gets a list of coupon code relationships associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_code_ids_for_coupon.json)
|
|
746
746
|
# @param id [String] The ID of the coupon to look up the relationship of.
|
|
747
747
|
# @param [Hash] opts the optional parameters
|
|
748
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
749
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
748
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`status`: `equals` (allowed values: `'UNASSIGNED'`, `'PROCESSING'`, `'ASSIGNED_TO_PROFILE'`, `'VERSION_NOT_ACTIVE'`, `'DELETING'`, `'USED'`)<br>`profile.id`: `any`, `equals` (string)
|
|
749
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
750
750
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
751
751
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
752
752
|
def get_coupon_code_ids_for_coupon_with_http_info(id, opts = {})
|
|
@@ -777,7 +777,7 @@ module KlaviyoAPI
|
|
|
777
777
|
# header parameters
|
|
778
778
|
header_params = opts[:header_params] || {}
|
|
779
779
|
# klaviyo api revision
|
|
780
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
780
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
781
781
|
# HTTP header 'Accept' (if needed)
|
|
782
782
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
783
783
|
|
|
@@ -821,12 +821,12 @@ module KlaviyoAPI
|
|
|
821
821
|
|
|
822
822
|
# Get Coupon Codes
|
|
823
823
|
# Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles. A coupon/coupons or a profile/profiles must be provided as required filter params.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_codes.json)
|
|
824
|
-
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
824
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`status`: `equals` (allowed values: `'UNASSIGNED'`, `'PROCESSING'`, `'ASSIGNED_TO_PROFILE'`, `'VERSION_NOT_ACTIVE'`, `'DELETING'`, `'USED'`)<br>`coupon.id`: `any`, `equals` (string)<br>`profile.id`: `any`, `equals` (string)
|
|
825
825
|
# @param [Hash] opts the optional parameters
|
|
826
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
827
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
828
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
829
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
826
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
827
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
828
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
829
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
830
830
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
831
831
|
# @return [Hash<String, Object>]
|
|
832
832
|
def get_coupon_codes(filter, opts = {})
|
|
@@ -836,12 +836,12 @@ module KlaviyoAPI
|
|
|
836
836
|
|
|
837
837
|
# Get Coupon Codes
|
|
838
838
|
# Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles. A coupon/coupons or a profile/profiles must be provided as required filter params.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_codes.json)
|
|
839
|
-
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
839
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`status`: `equals` (allowed values: `'UNASSIGNED'`, `'PROCESSING'`, `'ASSIGNED_TO_PROFILE'`, `'VERSION_NOT_ACTIVE'`, `'DELETING'`, `'USED'`)<br>`coupon.id`: `any`, `equals` (string)<br>`profile.id`: `any`, `equals` (string)
|
|
840
840
|
# @param [Hash] opts the optional parameters
|
|
841
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
842
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
843
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
844
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
841
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
842
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
843
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
844
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
845
845
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
846
846
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
847
847
|
def get_coupon_codes_with_http_info(filter, opts = {})
|
|
@@ -856,7 +856,7 @@ module KlaviyoAPI
|
|
|
856
856
|
if @api_client.config.client_side_validation && opts[:'fields_coupon_code'] && !opts[:'fields_coupon_code'].all? { |item| allowable_values.include?(item) }
|
|
857
857
|
fail ArgumentError, "invalid value for \"fields_coupon_code\", must include one of #{allowable_values}"
|
|
858
858
|
end
|
|
859
|
-
allowable_values = ["description", "external_id", "id", "monitor_configuration"]
|
|
859
|
+
allowable_values = ["assigner_configuration", "assigner_configuration.unused_expired", "assigner_configuration.used", "description", "external_id", "id", "monitor_configuration"]
|
|
860
860
|
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
|
861
861
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
|
862
862
|
end
|
|
@@ -887,7 +887,7 @@ module KlaviyoAPI
|
|
|
887
887
|
# header parameters
|
|
888
888
|
header_params = opts[:header_params] || {}
|
|
889
889
|
# klaviyo api revision
|
|
890
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
890
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
891
891
|
# HTTP header 'Accept' (if needed)
|
|
892
892
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
893
893
|
|
|
@@ -924,9 +924,9 @@ module KlaviyoAPI
|
|
|
924
924
|
# Gets a list of coupon codes associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_codes_for_coupon.json)
|
|
925
925
|
# @param id [String] The ID of the coupon to look up the relationship of.
|
|
926
926
|
# @param [Hash] opts the optional parameters
|
|
927
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
928
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
929
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
927
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
928
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`status`: `equals` (allowed values: `'UNASSIGNED'`, `'PROCESSING'`, `'ASSIGNED_TO_PROFILE'`, `'VERSION_NOT_ACTIVE'`, `'DELETING'`, `'USED'`)<br>`profile.id`: `any`, `equals` (string)
|
|
929
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
930
930
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
931
931
|
# @return [Hash<String, Object>]
|
|
932
932
|
def get_coupon_codes_for_coupon(id, opts = {})
|
|
@@ -944,9 +944,9 @@ module KlaviyoAPI
|
|
|
944
944
|
# Gets a list of coupon codes associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_codes_for_coupon.json)
|
|
945
945
|
# @param id [String] The ID of the coupon to look up the relationship of.
|
|
946
946
|
# @param [Hash] opts the optional parameters
|
|
947
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
948
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
949
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
947
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
948
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`status`: `equals` (allowed values: `'UNASSIGNED'`, `'PROCESSING'`, `'ASSIGNED_TO_PROFILE'`, `'VERSION_NOT_ACTIVE'`, `'DELETING'`, `'USED'`)<br>`profile.id`: `any`, `equals` (string)
|
|
949
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
950
950
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
951
951
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
952
952
|
def get_coupon_codes_for_coupon_with_http_info(id, opts = {})
|
|
@@ -982,7 +982,7 @@ module KlaviyoAPI
|
|
|
982
982
|
# header parameters
|
|
983
983
|
header_params = opts[:header_params] || {}
|
|
984
984
|
# klaviyo api revision
|
|
985
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
985
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
986
986
|
# HTTP header 'Accept' (if needed)
|
|
987
987
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
988
988
|
|
|
@@ -1025,7 +1025,7 @@ module KlaviyoAPI
|
|
|
1025
1025
|
# Get the coupon associated with a given coupon code ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupons:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_for_coupon_code.json)
|
|
1026
1026
|
# @param id [String] The ID of the coupon to look up the relationship of.
|
|
1027
1027
|
# @param [Hash] opts the optional parameters
|
|
1028
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1028
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1029
1029
|
# @return [Hash<String, Object>]
|
|
1030
1030
|
def get_coupon_for_coupon_code(id, opts = {})
|
|
1031
1031
|
data, _status_code, _headers = get_coupon_for_coupon_code_with_http_info(id, opts)
|
|
@@ -1039,7 +1039,7 @@ module KlaviyoAPI
|
|
|
1039
1039
|
# Get the coupon associated with a given coupon code ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupons:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_for_coupon_code.json)
|
|
1040
1040
|
# @param id [String] The ID of the coupon to look up the relationship of.
|
|
1041
1041
|
# @param [Hash] opts the optional parameters
|
|
1042
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1042
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1043
1043
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1044
1044
|
def get_coupon_for_coupon_code_with_http_info(id, opts = {})
|
|
1045
1045
|
if @api_client.config.debugging
|
|
@@ -1049,7 +1049,7 @@ module KlaviyoAPI
|
|
|
1049
1049
|
if @api_client.config.client_side_validation && id.nil?
|
|
1050
1050
|
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.get_coupon_for_coupon_code"
|
|
1051
1051
|
end
|
|
1052
|
-
allowable_values = ["description", "external_id", "id", "monitor_configuration"]
|
|
1052
|
+
allowable_values = ["assigner_configuration", "assigner_configuration.unused_expired", "assigner_configuration.used", "description", "external_id", "id", "monitor_configuration"]
|
|
1053
1053
|
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
|
1054
1054
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
|
1055
1055
|
end
|
|
@@ -1063,7 +1063,7 @@ module KlaviyoAPI
|
|
|
1063
1063
|
# header parameters
|
|
1064
1064
|
header_params = opts[:header_params] || {}
|
|
1065
1065
|
# klaviyo api revision
|
|
1066
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1066
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1067
1067
|
# HTTP header 'Accept' (if needed)
|
|
1068
1068
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1069
1069
|
|
|
@@ -1134,7 +1134,7 @@ module KlaviyoAPI
|
|
|
1134
1134
|
# header parameters
|
|
1135
1135
|
header_params = opts[:header_params] || {}
|
|
1136
1136
|
# klaviyo api revision
|
|
1137
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1137
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1138
1138
|
# HTTP header 'Accept' (if needed)
|
|
1139
1139
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1140
1140
|
|
|
@@ -1173,8 +1173,8 @@ module KlaviyoAPI
|
|
|
1173
1173
|
# Get Coupons
|
|
1174
1174
|
# Get all coupons in an account. To learn more, see our [Coupons API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupons:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupons.json)
|
|
1175
1175
|
# @param [Hash] opts the optional parameters
|
|
1176
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1177
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1176
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1177
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1178
1178
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
1179
1179
|
# @return [Hash<String, Object>]
|
|
1180
1180
|
def get_coupons(opts = {})
|
|
@@ -1185,15 +1185,15 @@ module KlaviyoAPI
|
|
|
1185
1185
|
# Get Coupons
|
|
1186
1186
|
# Get all coupons in an account. To learn more, see our [Coupons API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `coupons:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupons.json)
|
|
1187
1187
|
# @param [Hash] opts the optional parameters
|
|
1188
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1189
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1188
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1189
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1190
1190
|
# @option opts [Integer] :page_size Default: 100. Min: 1. Max: 100. (default to 100)
|
|
1191
1191
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1192
1192
|
def get_coupons_with_http_info(opts = {})
|
|
1193
1193
|
if @api_client.config.debugging
|
|
1194
1194
|
@api_client.config.logger.debug 'Calling API: CouponsApi.get_coupons ...'
|
|
1195
1195
|
end
|
|
1196
|
-
allowable_values = ["description", "external_id", "id", "monitor_configuration"]
|
|
1196
|
+
allowable_values = ["assigner_configuration", "assigner_configuration.unused_expired", "assigner_configuration.used", "description", "external_id", "id", "monitor_configuration"]
|
|
1197
1197
|
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
|
1198
1198
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
|
1199
1199
|
end
|
|
@@ -1217,7 +1217,7 @@ module KlaviyoAPI
|
|
|
1217
1217
|
# header parameters
|
|
1218
1218
|
header_params = opts[:header_params] || {}
|
|
1219
1219
|
# klaviyo api revision
|
|
1220
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1220
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1221
1221
|
# HTTP header 'Accept' (if needed)
|
|
1222
1222
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1223
1223
|
|
|
@@ -1255,7 +1255,7 @@ module KlaviyoAPI
|
|
|
1255
1255
|
# @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration.
|
|
1256
1256
|
# @param coupon_update_query [CouponUpdateQuery]
|
|
1257
1257
|
# @param [Hash] opts the optional parameters
|
|
1258
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1258
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1259
1259
|
# @return [Hash<String, Object>]
|
|
1260
1260
|
def update_coupon(id, coupon_update_query, opts = {})
|
|
1261
1261
|
data, _status_code, _headers = update_coupon_with_http_info(id, coupon_update_query, opts)
|
|
@@ -1267,7 +1267,7 @@ module KlaviyoAPI
|
|
|
1267
1267
|
# @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration.
|
|
1268
1268
|
# @param coupon_update_query [CouponUpdateQuery]
|
|
1269
1269
|
# @param [Hash] opts the optional parameters
|
|
1270
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1270
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1271
1271
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1272
1272
|
def update_coupon_with_http_info(id, coupon_update_query, opts = {})
|
|
1273
1273
|
if @api_client.config.debugging
|
|
@@ -1281,7 +1281,7 @@ module KlaviyoAPI
|
|
|
1281
1281
|
if @api_client.config.client_side_validation && coupon_update_query.nil?
|
|
1282
1282
|
fail ArgumentError, "Missing the required parameter 'coupon_update_query' when calling CouponsApi.update_coupon"
|
|
1283
1283
|
end
|
|
1284
|
-
allowable_values = ["description", "external_id", "id", "monitor_configuration"]
|
|
1284
|
+
allowable_values = ["assigner_configuration", "assigner_configuration.unused_expired", "assigner_configuration.used", "description", "external_id", "id", "monitor_configuration"]
|
|
1285
1285
|
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
|
1286
1286
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
|
1287
1287
|
end
|
|
@@ -1295,7 +1295,7 @@ module KlaviyoAPI
|
|
|
1295
1295
|
# header parameters
|
|
1296
1296
|
header_params = opts[:header_params] || {}
|
|
1297
1297
|
# klaviyo api revision
|
|
1298
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1298
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1299
1299
|
# HTTP header 'Accept' (if needed)
|
|
1300
1300
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1301
1301
|
# HTTP header 'Content-Type'
|
|
@@ -1338,7 +1338,7 @@ module KlaviyoAPI
|
|
|
1338
1338
|
# @param id [String] The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
|
|
1339
1339
|
# @param coupon_code_update_query [CouponCodeUpdateQuery]
|
|
1340
1340
|
# @param [Hash] opts the optional parameters
|
|
1341
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1341
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1342
1342
|
# @return [Hash<String, Object>]
|
|
1343
1343
|
def update_coupon_code(id, coupon_code_update_query, opts = {})
|
|
1344
1344
|
data, _status_code, _headers = update_coupon_code_with_http_info(id, coupon_code_update_query, opts)
|
|
@@ -1350,7 +1350,7 @@ module KlaviyoAPI
|
|
|
1350
1350
|
# @param id [String] The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
|
|
1351
1351
|
# @param coupon_code_update_query [CouponCodeUpdateQuery]
|
|
1352
1352
|
# @param [Hash] opts the optional parameters
|
|
1353
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1353
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1354
1354
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1355
1355
|
def update_coupon_code_with_http_info(id, coupon_code_update_query, opts = {})
|
|
1356
1356
|
if @api_client.config.debugging
|
|
@@ -1378,7 +1378,7 @@ module KlaviyoAPI
|
|
|
1378
1378
|
# header parameters
|
|
1379
1379
|
header_params = opts[:header_params] || {}
|
|
1380
1380
|
# klaviyo api revision
|
|
1381
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1381
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1382
1382
|
# HTTP header 'Accept' (if needed)
|
|
1383
1383
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1384
1384
|
# HTTP header 'Content-Type'
|