klaviyo-api-sdk 8.0.0 → 10.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 +289 -0
- data/README.md +1414 -402
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +11 -11
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +645 -573
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +1764 -1446
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +329 -281
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +11 -5
- data/lib/klaviyo-api-sdk/api/events_api.rb +140 -122
- data/lib/klaviyo-api-sdk/api/flows_api.rb +487 -433
- data/lib/klaviyo-api-sdk/api/forms_api.rb +80 -60
- data/lib/klaviyo-api-sdk/api/images_api.rb +40 -28
- data/lib/klaviyo-api-sdk/api/lists_api.rb +328 -153
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +590 -21
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +1054 -548
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +341 -19
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +212 -0
- data/lib/klaviyo-api-sdk/api/segments_api.rb +341 -166
- data/lib/klaviyo-api-sdk/api/tags_api.rb +745 -625
- data/lib/klaviyo-api-sdk/api/templates_api.rb +493 -84
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +250 -0
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +32 -32
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/any_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/block_display_options.rb +274 -0
- data/lib/klaviyo-api-sdk/models/block_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/boolean_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/boolean_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +273 -0
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +239 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/content_repeat.rb +238 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +245 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +3 -3
- data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/dynamic_tracking_param.rb +288 -0
- data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +2 -2
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object_custom_tracking_params_inner.rb +105 -0
- data/lib/klaviyo-api-sdk/models/equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +273 -0
- data/lib/klaviyo-api-sdk/models/{utm_params_sub_object.rb → flow_tracking_setting_static_param.rb} +15 -16
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +314 -0
- data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +287 -0
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
- data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_block.rb +252 -0
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +248 -0
- data/lib/klaviyo-api-sdk/models/html_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +3 -3
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +283 -0
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +9 -3
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +301 -0
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +274 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +2 -7
- data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_tracking_param.rb +254 -0
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{marketing_subscription_parameters.rb → subscription_parameters.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +534 -0
- data/lib/klaviyo-api-sdk/models/text_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +230 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +279 -0
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +239 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +58 -3
- metadata +64 -9
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2024-
|
6
|
+
The version of the OpenAPI document: 2024-10-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -19,6 +19,88 @@ module KlaviyoAPI
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Bulk Create Coupon Codes
|
23
|
+
# 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: `700/m` **Scopes:** `coupon-codes:write`
|
24
|
+
# @param coupon_code_create_job_create_query [CouponCodeCreateJobCreateQuery]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [Hash<String, Object>]
|
27
|
+
def bulk_create_coupon_codes(coupon_code_create_job_create_query, opts = {})
|
28
|
+
data, _status_code, _headers = bulk_create_coupon_codes_with_http_info(coupon_code_create_job_create_query, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# alias of `bulk_create_coupon_codes`
|
33
|
+
alias spawn_coupon_code_bulk_create_job bulk_create_coupon_codes
|
34
|
+
|
35
|
+
# alias of `bulk_create_coupon_codes`
|
36
|
+
alias create_coupon_code_bulk_create_job bulk_create_coupon_codes
|
37
|
+
|
38
|
+
# Bulk Create Coupon Codes
|
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: `700/m` **Scopes:** `coupon-codes:write`
|
40
|
+
# @param coupon_code_create_job_create_query [CouponCodeCreateJobCreateQuery]
|
41
|
+
# @param [Hash] opts the optional parameters
|
42
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
43
|
+
def bulk_create_coupon_codes_with_http_info(coupon_code_create_job_create_query, opts = {})
|
44
|
+
if @api_client.config.debugging
|
45
|
+
@api_client.config.logger.debug 'Calling API: CouponsApi.bulk_create_coupon_codes ...'
|
46
|
+
end
|
47
|
+
# verify the required parameter 'coupon_code_create_job_create_query' is set
|
48
|
+
if @api_client.config.client_side_validation && coupon_code_create_job_create_query.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'coupon_code_create_job_create_query' when calling CouponsApi.bulk_create_coupon_codes"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
local_var_path = '/api/coupon-code-bulk-create-jobs'
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = opts[:query_params] || {}
|
56
|
+
|
57
|
+
# header parameters
|
58
|
+
header_params = opts[:header_params] || {}
|
59
|
+
# klaviyo api revision
|
60
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
61
|
+
# HTTP header 'Accept' (if needed)
|
62
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
63
|
+
# HTTP header 'Content-Type'
|
64
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
65
|
+
if !content_type.nil?
|
66
|
+
header_params['Content-Type'] = content_type
|
67
|
+
end
|
68
|
+
|
69
|
+
# form parameters
|
70
|
+
form_params = opts[:form_params] || {}
|
71
|
+
|
72
|
+
# http body (model)
|
73
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(coupon_code_create_job_create_query)
|
74
|
+
|
75
|
+
# return_type
|
76
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
77
|
+
|
78
|
+
# auth_names
|
79
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
80
|
+
|
81
|
+
new_options = opts.merge(
|
82
|
+
:operation => :"CouponsApi.bulk_create_coupon_codes",
|
83
|
+
:header_params => header_params,
|
84
|
+
:query_params => query_params,
|
85
|
+
:form_params => form_params,
|
86
|
+
:body => post_body,
|
87
|
+
:auth_names => auth_names,
|
88
|
+
:return_type => return_type
|
89
|
+
)
|
90
|
+
|
91
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
92
|
+
if @api_client.config.debugging
|
93
|
+
@api_client.config.logger.debug "API called: CouponsApi#bulk_create_coupon_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
94
|
+
end
|
95
|
+
return data, status_code, headers
|
96
|
+
end
|
97
|
+
|
98
|
+
# alias of `bulk_create_coupon_codes_with_http_info`
|
99
|
+
alias spawn_coupon_code_bulk_create_job_with_http_info bulk_create_coupon_codes_with_http_info
|
100
|
+
|
101
|
+
# alias of `bulk_create_coupon_codes_with_http_info`
|
102
|
+
alias create_coupon_code_bulk_create_job_with_http_info bulk_create_coupon_codes_with_http_info
|
103
|
+
|
22
104
|
# Create Coupon
|
23
105
|
# Creates a new coupon.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `coupons:write`
|
24
106
|
# @param coupon_create_query [CouponCreateQuery]
|
@@ -43,7 +125,7 @@ module KlaviyoAPI
|
|
43
125
|
fail ArgumentError, "Missing the required parameter 'coupon_create_query' when calling CouponsApi.create_coupon"
|
44
126
|
end
|
45
127
|
# resource path
|
46
|
-
local_var_path = '/api/coupons
|
128
|
+
local_var_path = '/api/coupons'
|
47
129
|
|
48
130
|
# query parameters
|
49
131
|
query_params = opts[:query_params] || {}
|
@@ -51,11 +133,11 @@ module KlaviyoAPI
|
|
51
133
|
# header parameters
|
52
134
|
header_params = opts[:header_params] || {}
|
53
135
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
136
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
55
137
|
# HTTP header 'Accept' (if needed)
|
56
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
138
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
57
139
|
# HTTP header 'Content-Type'
|
58
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
140
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
59
141
|
if !content_type.nil?
|
60
142
|
header_params['Content-Type'] = content_type
|
61
143
|
end
|
@@ -113,7 +195,7 @@ module KlaviyoAPI
|
|
113
195
|
fail ArgumentError, "Missing the required parameter 'coupon_code_create_query' when calling CouponsApi.create_coupon_code"
|
114
196
|
end
|
115
197
|
# resource path
|
116
|
-
local_var_path = '/api/coupon-codes
|
198
|
+
local_var_path = '/api/coupon-codes'
|
117
199
|
|
118
200
|
# query parameters
|
119
201
|
query_params = opts[:query_params] || {}
|
@@ -121,11 +203,11 @@ module KlaviyoAPI
|
|
121
203
|
# header parameters
|
122
204
|
header_params = opts[:header_params] || {}
|
123
205
|
# klaviyo api revision
|
124
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
206
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
125
207
|
# HTTP header 'Accept' (if needed)
|
126
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
208
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
127
209
|
# HTTP header 'Content-Type'
|
128
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
210
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
129
211
|
if !content_type.nil?
|
130
212
|
header_params['Content-Type'] = content_type
|
131
213
|
end
|
@@ -183,7 +265,7 @@ module KlaviyoAPI
|
|
183
265
|
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.delete_coupon"
|
184
266
|
end
|
185
267
|
# resource path
|
186
|
-
local_var_path = '/api/coupons/{id}
|
268
|
+
local_var_path = '/api/coupons/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
187
269
|
|
188
270
|
# query parameters
|
189
271
|
query_params = opts[:query_params] || {}
|
@@ -191,9 +273,9 @@ module KlaviyoAPI
|
|
191
273
|
# header parameters
|
192
274
|
header_params = opts[:header_params] || {}
|
193
275
|
# klaviyo api revision
|
194
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
276
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
195
277
|
# HTTP header 'Accept' (if needed)
|
196
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
278
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
197
279
|
|
198
280
|
# form parameters
|
199
281
|
form_params = opts[:form_params] || {}
|
@@ -248,7 +330,7 @@ module KlaviyoAPI
|
|
248
330
|
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.delete_coupon_code"
|
249
331
|
end
|
250
332
|
# resource path
|
251
|
-
local_var_path = '/api/coupon-codes/{id}
|
333
|
+
local_var_path = '/api/coupon-codes/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
252
334
|
|
253
335
|
# query parameters
|
254
336
|
query_params = opts[:query_params] || {}
|
@@ -256,9 +338,9 @@ module KlaviyoAPI
|
|
256
338
|
# header parameters
|
257
339
|
header_params = opts[:header_params] || {}
|
258
340
|
# klaviyo api revision
|
259
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
341
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
260
342
|
# HTTP header 'Accept' (if needed)
|
261
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
343
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
262
344
|
|
263
345
|
# form parameters
|
264
346
|
form_params = opts[:form_params] || {}
|
@@ -289,48 +371,51 @@ module KlaviyoAPI
|
|
289
371
|
return data, status_code, headers
|
290
372
|
end
|
291
373
|
|
292
|
-
# Get Coupon
|
293
|
-
# Get a
|
294
|
-
# @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration.
|
374
|
+
# Get Bulk Create Coupon Code Jobs
|
375
|
+
# 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: `700/m` **Scopes:** `coupon-codes:read`
|
295
376
|
# @param [Hash] opts the optional parameters
|
296
|
-
# @option opts [Array<String>] :
|
377
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
378
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
379
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
297
380
|
# @return [Hash<String, Object>]
|
298
|
-
def
|
299
|
-
data, _status_code, _headers =
|
381
|
+
def get_bulk_create_coupon_code_jobs(opts = {})
|
382
|
+
data, _status_code, _headers = get_bulk_create_coupon_code_jobs_with_http_info(opts)
|
300
383
|
data
|
301
384
|
end
|
302
385
|
|
303
|
-
#
|
304
|
-
|
305
|
-
|
386
|
+
# alias of `get_bulk_create_coupon_code_jobs`
|
387
|
+
alias get_coupon_code_bulk_create_jobs get_bulk_create_coupon_code_jobs
|
388
|
+
|
389
|
+
# Get Bulk Create Coupon Code Jobs
|
390
|
+
# 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: `700/m` **Scopes:** `coupon-codes:read`
|
306
391
|
# @param [Hash] opts the optional parameters
|
307
|
-
# @option opts [Array<String>] :
|
392
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
393
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
394
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
308
395
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
309
|
-
def
|
396
|
+
def get_bulk_create_coupon_code_jobs_with_http_info(opts = {})
|
310
397
|
if @api_client.config.debugging
|
311
|
-
@api_client.config.logger.debug 'Calling API: CouponsApi.
|
398
|
+
@api_client.config.logger.debug 'Calling API: CouponsApi.get_bulk_create_coupon_code_jobs ...'
|
312
399
|
end
|
313
|
-
|
314
|
-
if @api_client.config.client_side_validation &&
|
315
|
-
fail ArgumentError, "
|
316
|
-
end
|
317
|
-
allowable_values = ["external_id", "description"]
|
318
|
-
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
319
|
-
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
400
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
401
|
+
if @api_client.config.client_side_validation && opts[:'fields_coupon_code_bulk_create_job'] && !opts[:'fields_coupon_code_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
402
|
+
fail ArgumentError, "invalid value for \"fields_coupon_code_bulk_create_job\", must include one of #{allowable_values}"
|
320
403
|
end
|
321
404
|
# resource path
|
322
|
-
local_var_path = '/api/
|
405
|
+
local_var_path = '/api/coupon-code-bulk-create-jobs'
|
323
406
|
|
324
407
|
# query parameters
|
325
408
|
query_params = opts[:query_params] || {}
|
326
|
-
query_params[:'fields[coupon]'] = @api_client.build_collection_param(opts[:'
|
409
|
+
query_params[:'fields[coupon-code-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_coupon_code_bulk_create_job'], :csv) if !opts[:'fields_coupon_code_bulk_create_job'].nil?
|
410
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
411
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
327
412
|
|
328
413
|
# header parameters
|
329
414
|
header_params = opts[:header_params] || {}
|
330
415
|
# klaviyo api revision
|
331
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
416
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
332
417
|
# HTTP header 'Accept' (if needed)
|
333
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
418
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
334
419
|
|
335
420
|
# form parameters
|
336
421
|
form_params = opts[:form_params] || {}
|
@@ -345,7 +430,7 @@ module KlaviyoAPI
|
|
345
430
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
346
431
|
|
347
432
|
new_options = opts.merge(
|
348
|
-
:operation => :"CouponsApi.
|
433
|
+
:operation => :"CouponsApi.get_bulk_create_coupon_code_jobs",
|
349
434
|
:header_params => header_params,
|
350
435
|
:query_params => query_params,
|
351
436
|
:form_params => form_params,
|
@@ -356,67 +441,73 @@ module KlaviyoAPI
|
|
356
441
|
|
357
442
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
358
443
|
if @api_client.config.debugging
|
359
|
-
@api_client.config.logger.debug "API called: CouponsApi#
|
444
|
+
@api_client.config.logger.debug "API called: CouponsApi#get_bulk_create_coupon_code_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
360
445
|
end
|
361
446
|
return data, status_code, headers
|
362
447
|
end
|
363
448
|
|
364
|
-
#
|
365
|
-
|
366
|
-
|
449
|
+
# alias of `get_bulk_create_coupon_code_jobs_with_http_info`
|
450
|
+
alias get_coupon_code_bulk_create_jobs_with_http_info get_bulk_create_coupon_code_jobs_with_http_info
|
451
|
+
|
452
|
+
# Get Bulk Create Coupon Codes Job
|
453
|
+
# Get a coupon code bulk create job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
454
|
+
# @param job_id [String] ID of the job to retrieve.
|
367
455
|
# @param [Hash] opts the optional parameters
|
368
|
-
# @option opts [Array<String>] :
|
369
|
-
# @option opts [Array<String>] :
|
370
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-
|
456
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
457
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
458
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
371
459
|
# @return [Hash<String, Object>]
|
372
|
-
def
|
373
|
-
data, _status_code, _headers =
|
460
|
+
def get_bulk_create_coupon_codes_job(job_id, opts = {})
|
461
|
+
data, _status_code, _headers = get_bulk_create_coupon_codes_job_with_http_info(job_id, opts)
|
374
462
|
data
|
375
463
|
end
|
376
464
|
|
377
|
-
#
|
378
|
-
|
379
|
-
|
465
|
+
# alias of `get_bulk_create_coupon_codes_job`
|
466
|
+
alias get_coupon_code_bulk_create_job get_bulk_create_coupon_codes_job
|
467
|
+
|
468
|
+
# Get Bulk Create Coupon Codes Job
|
469
|
+
# Get a coupon code bulk create job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
470
|
+
# @param job_id [String] ID of the job to retrieve.
|
380
471
|
# @param [Hash] opts the optional parameters
|
381
|
-
# @option opts [Array<String>] :
|
382
|
-
# @option opts [Array<String>] :
|
383
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-
|
472
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
473
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
474
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
384
475
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
385
|
-
def
|
476
|
+
def get_bulk_create_coupon_codes_job_with_http_info(job_id, opts = {})
|
386
477
|
if @api_client.config.debugging
|
387
|
-
@api_client.config.logger.debug 'Calling API: CouponsApi.
|
478
|
+
@api_client.config.logger.debug 'Calling API: CouponsApi.get_bulk_create_coupon_codes_job ...'
|
388
479
|
end
|
389
|
-
# verify the required parameter '
|
390
|
-
if @api_client.config.client_side_validation &&
|
391
|
-
fail ArgumentError, "Missing the required parameter '
|
480
|
+
# verify the required parameter 'job_id' is set
|
481
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
482
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling CouponsApi.get_bulk_create_coupon_codes_job"
|
483
|
+
end
|
484
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
485
|
+
if @api_client.config.client_side_validation && opts[:'fields_coupon_code_bulk_create_job'] && !opts[:'fields_coupon_code_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
486
|
+
fail ArgumentError, "invalid value for \"fields_coupon_code_bulk_create_job\", must include one of #{allowable_values}"
|
392
487
|
end
|
393
488
|
allowable_values = ["unique_code", "expires_at", "status"]
|
394
489
|
if @api_client.config.client_side_validation && opts[:'fields_coupon_code'] && !opts[:'fields_coupon_code'].all? { |item| allowable_values.include?(item) }
|
395
490
|
fail ArgumentError, "invalid value for \"fields_coupon_code\", must include one of #{allowable_values}"
|
396
491
|
end
|
397
|
-
allowable_values = ["
|
398
|
-
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
399
|
-
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
400
|
-
end
|
401
|
-
allowable_values = ["coupon"]
|
492
|
+
allowable_values = ["coupon-codes"]
|
402
493
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
403
494
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
404
495
|
end
|
405
496
|
# resource path
|
406
|
-
local_var_path = '/api/coupon-
|
497
|
+
local_var_path = '/api/coupon-code-bulk-create-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
407
498
|
|
408
499
|
# query parameters
|
409
500
|
query_params = opts[:query_params] || {}
|
501
|
+
query_params[:'fields[coupon-code-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_coupon_code_bulk_create_job'], :csv) if !opts[:'fields_coupon_code_bulk_create_job'].nil?
|
410
502
|
query_params[:'fields[coupon-code]'] = @api_client.build_collection_param(opts[:'fields_coupon_code'], :csv) if !opts[:'fields_coupon_code'].nil?
|
411
|
-
query_params[:'fields[coupon]'] = @api_client.build_collection_param(opts[:'fields_coupon'], :csv) if !opts[:'fields_coupon'].nil?
|
412
503
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
413
504
|
|
414
505
|
# header parameters
|
415
506
|
header_params = opts[:header_params] || {}
|
416
507
|
# klaviyo api revision
|
417
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
508
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
418
509
|
# HTTP header 'Accept' (if needed)
|
419
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
510
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
420
511
|
|
421
512
|
# form parameters
|
422
513
|
form_params = opts[:form_params] || {}
|
@@ -431,7 +522,7 @@ module KlaviyoAPI
|
|
431
522
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
432
523
|
|
433
524
|
new_options = opts.merge(
|
434
|
-
:operation => :"CouponsApi.
|
525
|
+
:operation => :"CouponsApi.get_bulk_create_coupon_codes_job",
|
435
526
|
:header_params => header_params,
|
436
527
|
:query_params => query_params,
|
437
528
|
:form_params => form_params,
|
@@ -442,67 +533,55 @@ module KlaviyoAPI
|
|
442
533
|
|
443
534
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
444
535
|
if @api_client.config.debugging
|
445
|
-
@api_client.config.logger.debug "API called: CouponsApi#
|
536
|
+
@api_client.config.logger.debug "API called: CouponsApi#get_bulk_create_coupon_codes_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
446
537
|
end
|
447
538
|
return data, status_code, headers
|
448
539
|
end
|
449
540
|
|
450
|
-
#
|
451
|
-
|
452
|
-
|
541
|
+
# alias of `get_bulk_create_coupon_codes_job_with_http_info`
|
542
|
+
alias get_coupon_code_bulk_create_job_with_http_info get_bulk_create_coupon_codes_job_with_http_info
|
543
|
+
|
544
|
+
# Get Code IDs for Coupon
|
545
|
+
# Gets a list of coupon code relationships associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
546
|
+
# @param id [String] The ID of the coupon to look up the relationship of.
|
453
547
|
# @param [Hash] opts the optional parameters
|
454
|
-
# @option opts [
|
455
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
456
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
548
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
457
549
|
# @return [Hash<String, Object>]
|
458
|
-
def
|
459
|
-
data, _status_code, _headers =
|
550
|
+
def get_code_ids_for_coupon(id, opts = {})
|
551
|
+
data, _status_code, _headers = get_code_ids_for_coupon_with_http_info(id, opts)
|
460
552
|
data
|
461
553
|
end
|
462
554
|
|
463
|
-
#
|
464
|
-
|
465
|
-
|
555
|
+
# alias of `get_code_ids_for_coupon`
|
556
|
+
alias get_coupon_code_relationships_coupon get_code_ids_for_coupon
|
557
|
+
|
558
|
+
# Get Code IDs for Coupon
|
559
|
+
# Gets a list of coupon code relationships associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
560
|
+
# @param id [String] The ID of the coupon to look up the relationship of.
|
466
561
|
# @param [Hash] opts the optional parameters
|
467
|
-
# @option opts [
|
468
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
469
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
562
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
470
563
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
471
|
-
def
|
564
|
+
def get_code_ids_for_coupon_with_http_info(id, opts = {})
|
472
565
|
if @api_client.config.debugging
|
473
|
-
@api_client.config.logger.debug 'Calling API: CouponsApi.
|
474
|
-
end
|
475
|
-
# verify the required parameter 'job_id' is set
|
476
|
-
if @api_client.config.client_side_validation && job_id.nil?
|
477
|
-
fail ArgumentError, "Missing the required parameter 'job_id' when calling CouponsApi.get_coupon_code_bulk_create_job"
|
478
|
-
end
|
479
|
-
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
480
|
-
if @api_client.config.client_side_validation && opts[:'fields_coupon_code_bulk_create_job'] && !opts[:'fields_coupon_code_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
481
|
-
fail ArgumentError, "invalid value for \"fields_coupon_code_bulk_create_job\", must include one of #{allowable_values}"
|
482
|
-
end
|
483
|
-
allowable_values = ["unique_code", "expires_at", "status"]
|
484
|
-
if @api_client.config.client_side_validation && opts[:'fields_coupon_code'] && !opts[:'fields_coupon_code'].all? { |item| allowable_values.include?(item) }
|
485
|
-
fail ArgumentError, "invalid value for \"fields_coupon_code\", must include one of #{allowable_values}"
|
566
|
+
@api_client.config.logger.debug 'Calling API: CouponsApi.get_code_ids_for_coupon ...'
|
486
567
|
end
|
487
|
-
|
488
|
-
if @api_client.config.client_side_validation &&
|
489
|
-
fail ArgumentError, "
|
568
|
+
# verify the required parameter 'id' is set
|
569
|
+
if @api_client.config.client_side_validation && id.nil?
|
570
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.get_code_ids_for_coupon"
|
490
571
|
end
|
491
572
|
# resource path
|
492
|
-
local_var_path = '/api/
|
573
|
+
local_var_path = '/api/coupons/{id}/relationships/coupon-codes'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
493
574
|
|
494
575
|
# query parameters
|
495
576
|
query_params = opts[:query_params] || {}
|
496
|
-
query_params[:'
|
497
|
-
query_params[:'fields[coupon-code]'] = @api_client.build_collection_param(opts[:'fields_coupon_code'], :csv) if !opts[:'fields_coupon_code'].nil?
|
498
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
577
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
499
578
|
|
500
579
|
# header parameters
|
501
580
|
header_params = opts[:header_params] || {}
|
502
581
|
# klaviyo api revision
|
503
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
582
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
504
583
|
# HTTP header 'Accept' (if needed)
|
505
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
584
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
506
585
|
|
507
586
|
# form parameters
|
508
587
|
form_params = opts[:form_params] || {}
|
@@ -517,7 +596,7 @@ module KlaviyoAPI
|
|
517
596
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
518
597
|
|
519
598
|
new_options = opts.merge(
|
520
|
-
:operation => :"CouponsApi.
|
599
|
+
:operation => :"CouponsApi.get_code_ids_for_coupon",
|
521
600
|
:header_params => header_params,
|
522
601
|
:query_params => query_params,
|
523
602
|
:form_params => form_params,
|
@@ -528,53 +607,56 @@ module KlaviyoAPI
|
|
528
607
|
|
529
608
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
530
609
|
if @api_client.config.debugging
|
531
|
-
@api_client.config.logger.debug "API called: CouponsApi#
|
610
|
+
@api_client.config.logger.debug "API called: CouponsApi#get_code_ids_for_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
532
611
|
end
|
533
612
|
return data, status_code, headers
|
534
613
|
end
|
535
614
|
|
536
|
-
#
|
537
|
-
|
615
|
+
# alias of `get_code_ids_for_coupon_with_http_info`
|
616
|
+
alias get_coupon_code_relationships_coupon_with_http_info get_code_ids_for_coupon_with_http_info
|
617
|
+
|
618
|
+
# Get Coupon
|
619
|
+
# Get a specific coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
|
620
|
+
# @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration.
|
538
621
|
# @param [Hash] opts the optional parameters
|
539
|
-
# @option opts [Array<String>] :
|
540
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
541
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
622
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
542
623
|
# @return [Hash<String, Object>]
|
543
|
-
def
|
544
|
-
data, _status_code, _headers =
|
624
|
+
def get_coupon(id, opts = {})
|
625
|
+
data, _status_code, _headers = get_coupon_with_http_info(id, opts)
|
545
626
|
data
|
546
627
|
end
|
547
628
|
|
548
|
-
# Get Coupon
|
549
|
-
# Get
|
629
|
+
# Get Coupon
|
630
|
+
# Get a specific coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
|
631
|
+
# @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration.
|
550
632
|
# @param [Hash] opts the optional parameters
|
551
|
-
# @option opts [Array<String>] :
|
552
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
553
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
633
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
554
634
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
555
|
-
def
|
635
|
+
def get_coupon_with_http_info(id, opts = {})
|
556
636
|
if @api_client.config.debugging
|
557
|
-
@api_client.config.logger.debug 'Calling API: CouponsApi.
|
637
|
+
@api_client.config.logger.debug 'Calling API: CouponsApi.get_coupon ...'
|
558
638
|
end
|
559
|
-
|
560
|
-
if @api_client.config.client_side_validation &&
|
561
|
-
fail ArgumentError, "
|
639
|
+
# verify the required parameter 'id' is set
|
640
|
+
if @api_client.config.client_side_validation && id.nil?
|
641
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.get_coupon"
|
642
|
+
end
|
643
|
+
allowable_values = ["external_id", "description"]
|
644
|
+
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
645
|
+
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
562
646
|
end
|
563
647
|
# resource path
|
564
|
-
local_var_path = '/api/
|
648
|
+
local_var_path = '/api/coupons/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
565
649
|
|
566
650
|
# query parameters
|
567
651
|
query_params = opts[:query_params] || {}
|
568
|
-
query_params[:'fields[coupon
|
569
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
570
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
652
|
+
query_params[:'fields[coupon]'] = @api_client.build_collection_param(opts[:'fields_coupon'], :csv) if !opts[:'fields_coupon'].nil?
|
571
653
|
|
572
654
|
# header parameters
|
573
655
|
header_params = opts[:header_params] || {}
|
574
656
|
# klaviyo api revision
|
575
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
657
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
576
658
|
# HTTP header 'Accept' (if needed)
|
577
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
659
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
578
660
|
|
579
661
|
# form parameters
|
580
662
|
form_params = opts[:form_params] || {}
|
@@ -589,7 +671,7 @@ module KlaviyoAPI
|
|
589
671
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
590
672
|
|
591
673
|
new_options = opts.merge(
|
592
|
-
:operation => :"CouponsApi.
|
674
|
+
:operation => :"CouponsApi.get_coupon",
|
593
675
|
:header_params => header_params,
|
594
676
|
:query_params => query_params,
|
595
677
|
:form_params => form_params,
|
@@ -600,49 +682,67 @@ module KlaviyoAPI
|
|
600
682
|
|
601
683
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
602
684
|
if @api_client.config.debugging
|
603
|
-
@api_client.config.logger.debug "API called: CouponsApi#
|
685
|
+
@api_client.config.logger.debug "API called: CouponsApi#get_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
604
686
|
end
|
605
687
|
return data, status_code, headers
|
606
688
|
end
|
607
689
|
|
608
|
-
# Get Coupon Code
|
609
|
-
#
|
610
|
-
# @param id [String]
|
690
|
+
# Get Coupon Code
|
691
|
+
# 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`
|
692
|
+
# @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.
|
611
693
|
# @param [Hash] opts the optional parameters
|
612
|
-
# @option opts [String] :
|
694
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
695
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
696
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
613
697
|
# @return [Hash<String, Object>]
|
614
|
-
def
|
615
|
-
data, _status_code, _headers =
|
698
|
+
def get_coupon_code(id, opts = {})
|
699
|
+
data, _status_code, _headers = get_coupon_code_with_http_info(id, opts)
|
616
700
|
data
|
617
701
|
end
|
618
702
|
|
619
|
-
# Get Coupon Code
|
620
|
-
#
|
621
|
-
# @param id [String]
|
703
|
+
# Get Coupon Code
|
704
|
+
# 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`
|
705
|
+
# @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.
|
622
706
|
# @param [Hash] opts the optional parameters
|
623
|
-
# @option opts [String] :
|
707
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
708
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
709
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
624
710
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
625
|
-
def
|
711
|
+
def get_coupon_code_with_http_info(id, opts = {})
|
626
712
|
if @api_client.config.debugging
|
627
|
-
@api_client.config.logger.debug 'Calling API: CouponsApi.
|
713
|
+
@api_client.config.logger.debug 'Calling API: CouponsApi.get_coupon_code ...'
|
628
714
|
end
|
629
715
|
# verify the required parameter 'id' is set
|
630
716
|
if @api_client.config.client_side_validation && id.nil?
|
631
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.
|
717
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.get_coupon_code"
|
718
|
+
end
|
719
|
+
allowable_values = ["unique_code", "expires_at", "status"]
|
720
|
+
if @api_client.config.client_side_validation && opts[:'fields_coupon_code'] && !opts[:'fields_coupon_code'].all? { |item| allowable_values.include?(item) }
|
721
|
+
fail ArgumentError, "invalid value for \"fields_coupon_code\", must include one of #{allowable_values}"
|
722
|
+
end
|
723
|
+
allowable_values = ["external_id", "description"]
|
724
|
+
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
725
|
+
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
726
|
+
end
|
727
|
+
allowable_values = ["coupon"]
|
728
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
729
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
632
730
|
end
|
633
731
|
# resource path
|
634
|
-
local_var_path = '/api/
|
732
|
+
local_var_path = '/api/coupon-codes/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
635
733
|
|
636
734
|
# query parameters
|
637
735
|
query_params = opts[:query_params] || {}
|
638
|
-
query_params[:'
|
736
|
+
query_params[:'fields[coupon-code]'] = @api_client.build_collection_param(opts[:'fields_coupon_code'], :csv) if !opts[:'fields_coupon_code'].nil?
|
737
|
+
query_params[:'fields[coupon]'] = @api_client.build_collection_param(opts[:'fields_coupon'], :csv) if !opts[:'fields_coupon'].nil?
|
738
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
639
739
|
|
640
740
|
# header parameters
|
641
741
|
header_params = opts[:header_params] || {}
|
642
742
|
# klaviyo api revision
|
643
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
743
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
644
744
|
# HTTP header 'Accept' (if needed)
|
645
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
745
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
646
746
|
|
647
747
|
# form parameters
|
648
748
|
form_params = opts[:form_params] || {}
|
@@ -657,7 +757,7 @@ module KlaviyoAPI
|
|
657
757
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
658
758
|
|
659
759
|
new_options = opts.merge(
|
660
|
-
:operation => :"CouponsApi.
|
760
|
+
:operation => :"CouponsApi.get_coupon_code",
|
661
761
|
:header_params => header_params,
|
662
762
|
:query_params => query_params,
|
663
763
|
:form_params => form_params,
|
@@ -668,7 +768,7 @@ module KlaviyoAPI
|
|
668
768
|
|
669
769
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
670
770
|
if @api_client.config.debugging
|
671
|
-
@api_client.config.logger.debug "API called: CouponsApi#
|
771
|
+
@api_client.config.logger.debug "API called: CouponsApi#get_coupon_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
672
772
|
end
|
673
773
|
return data, status_code, headers
|
674
774
|
end
|
@@ -676,11 +776,11 @@ module KlaviyoAPI
|
|
676
776
|
# Get Coupon Codes
|
677
777
|
# 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`
|
678
778
|
# @param [Hash] opts the optional parameters
|
679
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-
|
680
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-
|
681
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-
|
682
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-
|
683
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-
|
779
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
780
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
781
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-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`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`
|
782
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
783
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
684
784
|
# @return [Hash<String, Object>]
|
685
785
|
def get_coupon_codes(opts = {})
|
686
786
|
data, _status_code, _headers = get_coupon_codes_with_http_info(opts)
|
@@ -690,11 +790,11 @@ module KlaviyoAPI
|
|
690
790
|
# Get Coupon Codes
|
691
791
|
# 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`
|
692
792
|
# @param [Hash] opts the optional parameters
|
693
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-
|
694
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-
|
695
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-
|
696
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-
|
697
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-
|
793
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
794
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
795
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-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`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`
|
796
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
797
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
698
798
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
699
799
|
def get_coupon_codes_with_http_info(opts = {})
|
700
800
|
if @api_client.config.debugging
|
@@ -713,7 +813,7 @@ module KlaviyoAPI
|
|
713
813
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
714
814
|
end
|
715
815
|
# resource path
|
716
|
-
local_var_path = '/api/coupon-codes
|
816
|
+
local_var_path = '/api/coupon-codes'
|
717
817
|
|
718
818
|
# query parameters
|
719
819
|
query_params = opts[:query_params] || {}
|
@@ -726,9 +826,9 @@ module KlaviyoAPI
|
|
726
826
|
# header parameters
|
727
827
|
header_params = opts[:header_params] || {}
|
728
828
|
# klaviyo api revision
|
729
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
829
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
730
830
|
# HTTP header 'Accept' (if needed)
|
731
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
831
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
732
832
|
|
733
833
|
# form parameters
|
734
834
|
form_params = opts[:form_params] || {}
|
@@ -763,22 +863,25 @@ module KlaviyoAPI
|
|
763
863
|
# Gets a list of coupon codes associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
764
864
|
# @param id [String]
|
765
865
|
# @param [Hash] opts the optional parameters
|
766
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-
|
767
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-
|
768
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-
|
866
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
867
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-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`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`
|
868
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
769
869
|
# @return [Hash<String, Object>]
|
770
870
|
def get_coupon_codes_for_coupon(id, opts = {})
|
771
871
|
data, _status_code, _headers = get_coupon_codes_for_coupon_with_http_info(id, opts)
|
772
872
|
data
|
773
873
|
end
|
774
874
|
|
875
|
+
# alias of `get_coupon_codes_for_coupon`
|
876
|
+
alias get_coupon_coupon_codes get_coupon_codes_for_coupon
|
877
|
+
|
775
878
|
# Get Coupon Codes For Coupon
|
776
879
|
# Gets a list of coupon codes associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
777
880
|
# @param id [String]
|
778
881
|
# @param [Hash] opts the optional parameters
|
779
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-
|
780
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-
|
781
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-
|
882
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
883
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-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`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`
|
884
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
782
885
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
783
886
|
def get_coupon_codes_for_coupon_with_http_info(id, opts = {})
|
784
887
|
if @api_client.config.debugging
|
@@ -793,7 +896,7 @@ module KlaviyoAPI
|
|
793
896
|
fail ArgumentError, "invalid value for \"fields_coupon_code\", must include one of #{allowable_values}"
|
794
897
|
end
|
795
898
|
# resource path
|
796
|
-
local_var_path = '/api/coupons/{id}/coupon-codes
|
899
|
+
local_var_path = '/api/coupons/{id}/coupon-codes'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
797
900
|
|
798
901
|
# query parameters
|
799
902
|
query_params = opts[:query_params] || {}
|
@@ -804,9 +907,9 @@ module KlaviyoAPI
|
|
804
907
|
# header parameters
|
805
908
|
header_params = opts[:header_params] || {}
|
806
909
|
# klaviyo api revision
|
807
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
910
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
808
911
|
# HTTP header 'Accept' (if needed)
|
809
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
912
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
810
913
|
|
811
914
|
# form parameters
|
812
915
|
form_params = opts[:form_params] || {}
|
@@ -837,22 +940,28 @@ module KlaviyoAPI
|
|
837
940
|
return data, status_code, headers
|
838
941
|
end
|
839
942
|
|
943
|
+
# alias of `get_coupon_codes_for_coupon_with_http_info`
|
944
|
+
alias get_coupon_coupon_codes_with_http_info get_coupon_codes_for_coupon_with_http_info
|
945
|
+
|
840
946
|
# Get Coupon For Coupon Code
|
841
947
|
# Get the coupon associated with a given coupon code ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
|
842
|
-
# @param id [String]
|
948
|
+
# @param id [String] The ID of the coupon to look up the relationship of.
|
843
949
|
# @param [Hash] opts the optional parameters
|
844
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-
|
950
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
845
951
|
# @return [Hash<String, Object>]
|
846
952
|
def get_coupon_for_coupon_code(id, opts = {})
|
847
953
|
data, _status_code, _headers = get_coupon_for_coupon_code_with_http_info(id, opts)
|
848
954
|
data
|
849
955
|
end
|
850
956
|
|
957
|
+
# alias of `get_coupon_for_coupon_code`
|
958
|
+
alias get_coupon_code_coupon get_coupon_for_coupon_code
|
959
|
+
|
851
960
|
# Get Coupon For Coupon Code
|
852
961
|
# Get the coupon associated with a given coupon code ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
|
853
|
-
# @param id [String]
|
962
|
+
# @param id [String] The ID of the coupon to look up the relationship of.
|
854
963
|
# @param [Hash] opts the optional parameters
|
855
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-
|
964
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
856
965
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
857
966
|
def get_coupon_for_coupon_code_with_http_info(id, opts = {})
|
858
967
|
if @api_client.config.debugging
|
@@ -867,7 +976,7 @@ module KlaviyoAPI
|
|
867
976
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
868
977
|
end
|
869
978
|
# resource path
|
870
|
-
local_var_path = '/api/coupon-codes/{id}/coupon
|
979
|
+
local_var_path = '/api/coupon-codes/{id}/coupon'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
871
980
|
|
872
981
|
# query parameters
|
873
982
|
query_params = opts[:query_params] || {}
|
@@ -876,9 +985,9 @@ module KlaviyoAPI
|
|
876
985
|
# header parameters
|
877
986
|
header_params = opts[:header_params] || {}
|
878
987
|
# klaviyo api revision
|
879
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
988
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
880
989
|
# HTTP header 'Accept' (if needed)
|
881
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
990
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
882
991
|
|
883
992
|
# form parameters
|
884
993
|
form_params = opts[:form_params] || {}
|
@@ -909,31 +1018,37 @@ module KlaviyoAPI
|
|
909
1018
|
return data, status_code, headers
|
910
1019
|
end
|
911
1020
|
|
912
|
-
#
|
1021
|
+
# alias of `get_coupon_for_coupon_code_with_http_info`
|
1022
|
+
alias get_coupon_code_coupon_with_http_info get_coupon_for_coupon_code_with_http_info
|
1023
|
+
|
1024
|
+
# Get Coupon ID for Coupon Code
|
913
1025
|
# Gets the coupon relationship associated with the given coupon code id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
|
914
|
-
# @param id [String]
|
1026
|
+
# @param id [String] The ID of the coupon code to look up the relationship of.
|
915
1027
|
# @param [Hash] opts the optional parameters
|
916
1028
|
# @return [Hash<String, Object>]
|
917
|
-
def
|
918
|
-
data, _status_code, _headers =
|
1029
|
+
def get_coupon_id_for_coupon_code(id, opts = {})
|
1030
|
+
data, _status_code, _headers = get_coupon_id_for_coupon_code_with_http_info(id, opts)
|
919
1031
|
data
|
920
1032
|
end
|
921
1033
|
|
922
|
-
#
|
1034
|
+
# alias of `get_coupon_id_for_coupon_code`
|
1035
|
+
alias get_coupon_relationships_coupon_codes get_coupon_id_for_coupon_code
|
1036
|
+
|
1037
|
+
# Get Coupon ID for Coupon Code
|
923
1038
|
# Gets the coupon relationship associated with the given coupon code id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
|
924
|
-
# @param id [String]
|
1039
|
+
# @param id [String] The ID of the coupon code to look up the relationship of.
|
925
1040
|
# @param [Hash] opts the optional parameters
|
926
1041
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
927
|
-
def
|
1042
|
+
def get_coupon_id_for_coupon_code_with_http_info(id, opts = {})
|
928
1043
|
if @api_client.config.debugging
|
929
|
-
@api_client.config.logger.debug 'Calling API: CouponsApi.
|
1044
|
+
@api_client.config.logger.debug 'Calling API: CouponsApi.get_coupon_id_for_coupon_code ...'
|
930
1045
|
end
|
931
1046
|
# verify the required parameter 'id' is set
|
932
1047
|
if @api_client.config.client_side_validation && id.nil?
|
933
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.
|
1048
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.get_coupon_id_for_coupon_code"
|
934
1049
|
end
|
935
1050
|
# resource path
|
936
|
-
local_var_path = '/api/coupon-codes/{id}/relationships/coupon
|
1051
|
+
local_var_path = '/api/coupon-codes/{id}/relationships/coupon'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
937
1052
|
|
938
1053
|
# query parameters
|
939
1054
|
query_params = opts[:query_params] || {}
|
@@ -941,9 +1056,9 @@ module KlaviyoAPI
|
|
941
1056
|
# header parameters
|
942
1057
|
header_params = opts[:header_params] || {}
|
943
1058
|
# klaviyo api revision
|
944
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1059
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
945
1060
|
# HTTP header 'Accept' (if needed)
|
946
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1061
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
947
1062
|
|
948
1063
|
# form parameters
|
949
1064
|
form_params = opts[:form_params] || {}
|
@@ -958,7 +1073,7 @@ module KlaviyoAPI
|
|
958
1073
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
959
1074
|
|
960
1075
|
new_options = opts.merge(
|
961
|
-
:operation => :"CouponsApi.
|
1076
|
+
:operation => :"CouponsApi.get_coupon_id_for_coupon_code",
|
962
1077
|
:header_params => header_params,
|
963
1078
|
:query_params => query_params,
|
964
1079
|
:form_params => form_params,
|
@@ -969,16 +1084,19 @@ module KlaviyoAPI
|
|
969
1084
|
|
970
1085
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
971
1086
|
if @api_client.config.debugging
|
972
|
-
@api_client.config.logger.debug "API called: CouponsApi#
|
1087
|
+
@api_client.config.logger.debug "API called: CouponsApi#get_coupon_id_for_coupon_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
973
1088
|
end
|
974
1089
|
return data, status_code, headers
|
975
1090
|
end
|
976
1091
|
|
1092
|
+
# alias of `get_coupon_id_for_coupon_code_with_http_info`
|
1093
|
+
alias get_coupon_relationships_coupon_codes_with_http_info get_coupon_id_for_coupon_code_with_http_info
|
1094
|
+
|
977
1095
|
# Get Coupons
|
978
1096
|
# 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: `700/m` **Scopes:** `coupons:read`
|
979
1097
|
# @param [Hash] opts the optional parameters
|
980
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-
|
981
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-
|
1098
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1099
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
982
1100
|
# @return [Hash<String, Object>]
|
983
1101
|
def get_coupons(opts = {})
|
984
1102
|
data, _status_code, _headers = get_coupons_with_http_info(opts)
|
@@ -988,8 +1106,8 @@ module KlaviyoAPI
|
|
988
1106
|
# Get Coupons
|
989
1107
|
# 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: `700/m` **Scopes:** `coupons:read`
|
990
1108
|
# @param [Hash] opts the optional parameters
|
991
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-
|
992
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-
|
1109
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1110
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
993
1111
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
994
1112
|
def get_coupons_with_http_info(opts = {})
|
995
1113
|
if @api_client.config.debugging
|
@@ -1000,7 +1118,7 @@ module KlaviyoAPI
|
|
1000
1118
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
1001
1119
|
end
|
1002
1120
|
# resource path
|
1003
|
-
local_var_path = '/api/coupons
|
1121
|
+
local_var_path = '/api/coupons'
|
1004
1122
|
|
1005
1123
|
# query parameters
|
1006
1124
|
query_params = opts[:query_params] || {}
|
@@ -1010,9 +1128,9 @@ module KlaviyoAPI
|
|
1010
1128
|
# header parameters
|
1011
1129
|
header_params = opts[:header_params] || {}
|
1012
1130
|
# klaviyo api revision
|
1013
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1131
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1014
1132
|
# HTTP header 'Accept' (if needed)
|
1015
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1133
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1016
1134
|
|
1017
1135
|
# form parameters
|
1018
1136
|
form_params = opts[:form_params] || {}
|
@@ -1043,76 +1161,6 @@ module KlaviyoAPI
|
|
1043
1161
|
return data, status_code, headers
|
1044
1162
|
end
|
1045
1163
|
|
1046
|
-
# Spawn Coupon Code Bulk Create Job
|
1047
|
-
# Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max number of jobs queued at once we allow for is 100.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:write`
|
1048
|
-
# @param coupon_code_create_job_create_query [CouponCodeCreateJobCreateQuery]
|
1049
|
-
# @param [Hash] opts the optional parameters
|
1050
|
-
# @return [Hash<String, Object>]
|
1051
|
-
def spawn_coupon_code_bulk_create_job(coupon_code_create_job_create_query, opts = {})
|
1052
|
-
data, _status_code, _headers = spawn_coupon_code_bulk_create_job_with_http_info(coupon_code_create_job_create_query, opts)
|
1053
|
-
data
|
1054
|
-
end
|
1055
|
-
|
1056
|
-
# Spawn Coupon Code Bulk Create Job
|
1057
|
-
# Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max number of jobs queued at once we allow for is 100.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:write`
|
1058
|
-
# @param coupon_code_create_job_create_query [CouponCodeCreateJobCreateQuery]
|
1059
|
-
# @param [Hash] opts the optional parameters
|
1060
|
-
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1061
|
-
def spawn_coupon_code_bulk_create_job_with_http_info(coupon_code_create_job_create_query, opts = {})
|
1062
|
-
if @api_client.config.debugging
|
1063
|
-
@api_client.config.logger.debug 'Calling API: CouponsApi.spawn_coupon_code_bulk_create_job ...'
|
1064
|
-
end
|
1065
|
-
# verify the required parameter 'coupon_code_create_job_create_query' is set
|
1066
|
-
if @api_client.config.client_side_validation && coupon_code_create_job_create_query.nil?
|
1067
|
-
fail ArgumentError, "Missing the required parameter 'coupon_code_create_job_create_query' when calling CouponsApi.spawn_coupon_code_bulk_create_job"
|
1068
|
-
end
|
1069
|
-
# resource path
|
1070
|
-
local_var_path = '/api/coupon-code-bulk-create-jobs/'
|
1071
|
-
|
1072
|
-
# query parameters
|
1073
|
-
query_params = opts[:query_params] || {}
|
1074
|
-
|
1075
|
-
# header parameters
|
1076
|
-
header_params = opts[:header_params] || {}
|
1077
|
-
# klaviyo api revision
|
1078
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
|
1079
|
-
# HTTP header 'Accept' (if needed)
|
1080
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1081
|
-
# HTTP header 'Content-Type'
|
1082
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1083
|
-
if !content_type.nil?
|
1084
|
-
header_params['Content-Type'] = content_type
|
1085
|
-
end
|
1086
|
-
|
1087
|
-
# form parameters
|
1088
|
-
form_params = opts[:form_params] || {}
|
1089
|
-
|
1090
|
-
# http body (model)
|
1091
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(coupon_code_create_job_create_query)
|
1092
|
-
|
1093
|
-
# return_type
|
1094
|
-
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1095
|
-
|
1096
|
-
# auth_names
|
1097
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1098
|
-
|
1099
|
-
new_options = opts.merge(
|
1100
|
-
:operation => :"CouponsApi.spawn_coupon_code_bulk_create_job",
|
1101
|
-
:header_params => header_params,
|
1102
|
-
:query_params => query_params,
|
1103
|
-
:form_params => form_params,
|
1104
|
-
:body => post_body,
|
1105
|
-
:auth_names => auth_names,
|
1106
|
-
:return_type => return_type
|
1107
|
-
)
|
1108
|
-
|
1109
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1110
|
-
if @api_client.config.debugging
|
1111
|
-
@api_client.config.logger.debug "API called: CouponsApi#spawn_coupon_code_bulk_create_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1112
|
-
end
|
1113
|
-
return data, status_code, headers
|
1114
|
-
end
|
1115
|
-
|
1116
1164
|
# Update Coupon
|
1117
1165
|
# *Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `coupons:write`
|
1118
1166
|
# @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration.
|
@@ -1143,7 +1191,7 @@ module KlaviyoAPI
|
|
1143
1191
|
fail ArgumentError, "Missing the required parameter 'coupon_update_query' when calling CouponsApi.update_coupon"
|
1144
1192
|
end
|
1145
1193
|
# resource path
|
1146
|
-
local_var_path = '/api/coupons/{id}
|
1194
|
+
local_var_path = '/api/coupons/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1147
1195
|
|
1148
1196
|
# query parameters
|
1149
1197
|
query_params = opts[:query_params] || {}
|
@@ -1151,11 +1199,11 @@ module KlaviyoAPI
|
|
1151
1199
|
# header parameters
|
1152
1200
|
header_params = opts[:header_params] || {}
|
1153
1201
|
# klaviyo api revision
|
1154
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1202
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1155
1203
|
# HTTP header 'Accept' (if needed)
|
1156
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1204
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1157
1205
|
# HTTP header 'Content-Type'
|
1158
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1206
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1159
1207
|
if !content_type.nil?
|
1160
1208
|
header_params['Content-Type'] = content_type
|
1161
1209
|
end
|
@@ -1219,7 +1267,7 @@ module KlaviyoAPI
|
|
1219
1267
|
fail ArgumentError, "Missing the required parameter 'coupon_code_update_query' when calling CouponsApi.update_coupon_code"
|
1220
1268
|
end
|
1221
1269
|
# resource path
|
1222
|
-
local_var_path = '/api/coupon-codes/{id}
|
1270
|
+
local_var_path = '/api/coupon-codes/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1223
1271
|
|
1224
1272
|
# query parameters
|
1225
1273
|
query_params = opts[:query_params] || {}
|
@@ -1227,11 +1275,11 @@ module KlaviyoAPI
|
|
1227
1275
|
# header parameters
|
1228
1276
|
header_params = opts[:header_params] || {}
|
1229
1277
|
# klaviyo api revision
|
1230
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1278
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1231
1279
|
# HTTP header 'Accept' (if needed)
|
1232
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1280
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1233
1281
|
# HTTP header 'Content-Type'
|
1234
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1282
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1235
1283
|
if !content_type.nil?
|
1236
1284
|
header_params['Content-Type'] = content_type
|
1237
1285
|
end
|