From e26814dae84705e26cd7c3a3c8a376ba033c4e0d Mon Sep 17 00:00:00 2001 From: klaviyo-sdk Date: Thu, 15 Feb 2024 17:52:01 +0000 Subject: [PATCH] version 6.0.0 --- CHANGELOG.md | 28 ++ README.md | 466 ++++++++++-------- klaviyo-api-sdk.gemspec | 4 +- lib/klaviyo-api-sdk.rb | 19 +- lib/klaviyo-api-sdk/api/accounts_api.rb | 14 +- lib/klaviyo-api-sdk/api/campaigns_api.rb | 156 +++--- lib/klaviyo-api-sdk/api/catalogs_api.rb | 442 ++++++++--------- lib/klaviyo-api-sdk/api/coupons_api.rb | 124 ++--- lib/klaviyo-api-sdk/api/data_privacy_api.rb | 4 +- lib/klaviyo-api-sdk/api/events_api.rb | 72 +-- lib/klaviyo-api-sdk/api/flows_api.rb | 176 +++---- lib/klaviyo-api-sdk/api/images_api.rb | 32 +- lib/klaviyo-api-sdk/api/lists_api.rb | 100 ++-- lib/klaviyo-api-sdk/api/metrics_api.rb | 24 +- lib/klaviyo-api-sdk/api/profiles_api.rb | 236 +++++---- lib/klaviyo-api-sdk/api/reporting_api.rb | 241 +++++++++ lib/klaviyo-api-sdk/api/segments_api.rb | 88 ++-- lib/klaviyo-api-sdk/api/tags_api.rb | 118 ++--- lib/klaviyo-api-sdk/api/templates_api.rb | 40 +- lib/klaviyo-api-sdk/api_client.rb | 4 +- lib/klaviyo-api-sdk/api_error.rb | 2 +- lib/klaviyo-api-sdk/configuration.rb | 2 +- .../models/audiences_sub_object.rb | 2 +- .../models/back_in_stock_subscription_enum.rb | 2 +- .../models/campaign_clone_query.rb | 2 +- .../campaign_clone_query_resource_object.rb | 2 +- ..._clone_query_resource_object_attributes.rb | 2 +- .../models/campaign_create_query.rb | 2 +- .../campaign_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...rce_object_attributes_campaign_messages.rb | 2 +- ...resource_object_attributes_send_options.rb | 2 +- ...urce_object_attributes_tracking_options.rb | 2 +- lib/klaviyo-api-sdk/models/campaign_enum.rb | 2 +- .../campaign_message_assign_template_query.rb | 2 +- ...e_assign_template_query_resource_object.rb | 2 +- ...ate_query_resource_object_relationships.rb | 2 +- ..._resource_object_relationships_template.rb | 2 +- ...urce_object_relationships_template_data.rb | 2 +- ...gn_message_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...uery_resource_object_attributes_content.rb | 2 +- .../models/campaign_message_enum.rb | 2 +- .../campaign_message_partial_update_query.rb | 2 +- ...ge_partial_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- .../models/campaign_partial_update_query.rb | 2 +- ...gn_partial_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- ...n_recipient_estimation_job_create_query.rb | 2 +- ...mation_job_create_query_resource_object.rb | 2 +- .../campaign_recipient_estimation_job_enum.rb | 2 +- .../models/campaign_send_job_create_query.rb | 2 +- ...n_send_job_create_query_resource_object.rb | 2 +- .../models/campaign_send_job_enum.rb | 2 +- .../campaign_send_job_partial_update_query.rb | 2 +- ...ob_partial_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- .../models/campaign_values_report_enum.rb | 36 ++ .../models/campaign_values_request_dto.rb | 224 +++++++++ ...aign_values_request_dto_resource_object.rb | 238 +++++++++ ..._request_dto_resource_object_attributes.rb | 288 +++++++++++ ...to_resource_object_attributes_timeframe.rb | 106 ++++ .../catalog_category_bulk_create_job_enum.rb | 2 +- .../catalog_category_bulk_delete_job_enum.rb | 2 +- .../catalog_category_bulk_update_job_enum.rb | 2 +- ...atalog_category_create_job_create_query.rb | 2 +- ...create_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...y_resource_object_attributes_categories.rb | 2 +- .../models/catalog_category_create_query.rb | 2 +- ...g_category_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ate_query_resource_object_relationships.rb | 2 +- ...ery_resource_object_relationships_items.rb | 2 +- ...e_object_relationships_items_data_inner.rb | 2 +- ...atalog_category_delete_job_create_query.rb | 2 +- ...delete_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...y_resource_object_attributes_categories.rb | 2 +- ...g_category_delete_query_resource_object.rb | 2 +- .../models/catalog_category_enum.rb | 2 +- .../models/catalog_category_item_op.rb | 2 +- ...atalog_category_update_job_create_query.rb | 2 +- ...update_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...y_resource_object_attributes_categories.rb | 2 +- .../models/catalog_category_update_query.rb | 2 +- ...g_category_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- .../catalog_item_bulk_create_job_enum.rb | 2 +- .../catalog_item_bulk_delete_job_enum.rb | 2 +- .../catalog_item_bulk_update_job_enum.rb | 2 +- .../models/catalog_item_category_op.rb | 2 +- .../catalog_item_create_job_create_query.rb | 2 +- ...create_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ..._query_resource_object_attributes_items.rb | 2 +- .../models/catalog_item_create_query.rb | 2 +- ...talog_item_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ate_query_resource_object_relationships.rb | 2 +- ...esource_object_relationships_categories.rb | 2 +- ...ect_relationships_categories_data_inner.rb | 2 +- .../catalog_item_delete_job_create_query.rb | 2 +- ...delete_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ..._query_resource_object_attributes_items.rb | 2 +- ...talog_item_delete_query_resource_object.rb | 2 +- .../models/catalog_item_enum.rb | 2 +- .../catalog_item_update_job_create_query.rb | 2 +- ...update_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ..._query_resource_object_attributes_items.rb | 2 +- .../models/catalog_item_update_query.rb | 2 +- ...talog_item_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- .../catalog_variant_bulk_create_job_enum.rb | 2 +- .../catalog_variant_bulk_delete_job_enum.rb | 2 +- .../catalog_variant_bulk_update_job_enum.rb | 2 +- ...catalog_variant_create_job_create_query.rb | 2 +- ...create_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ery_resource_object_attributes_variants.rb | 2 +- .../models/catalog_variant_create_query.rb | 2 +- ...og_variant_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ate_query_resource_object_relationships.rb | 2 +- ...uery_resource_object_relationships_item.rb | 2 +- ...resource_object_relationships_item_data.rb | 2 +- ...catalog_variant_delete_job_create_query.rb | 2 +- ...delete_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ery_resource_object_attributes_variants.rb | 2 +- ...og_variant_delete_query_resource_object.rb | 2 +- .../models/catalog_variant_enum.rb | 2 +- ...catalog_variant_update_job_create_query.rb | 2 +- ...update_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ery_resource_object_attributes_variants.rb | 2 +- .../models/catalog_variant_update_query.rb | 2 +- ...og_variant_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- .../coupon_code_bulk_create_job_enum.rb | 2 +- .../coupon_code_create_job_create_query.rb | 2 +- ...create_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...resource_object_attributes_coupon_codes.rb | 2 +- .../models/coupon_code_create_query.rb | 2 +- ...oupon_code_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ate_query_resource_object_relationships.rb | 2 +- ...ry_resource_object_relationships_coupon.rb | 2 +- ...source_object_relationships_coupon_data.rb | 2 +- .../models/coupon_code_enum.rb | 2 +- .../models/coupon_code_update_query.rb | 2 +- ...oupon_code_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- .../models/coupon_create_query.rb | 2 +- .../coupon_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- lib/klaviyo-api-sdk/models/coupon_enum.rb | 2 +- .../models/coupon_update_query.rb | 2 +- .../coupon_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- .../models/custom_timeframe.rb | 238 +++++++++ .../data_privacy_create_deletion_job_query.rb | 2 +- ...eate_deletion_job_query_resource_object.rb | 2 +- ...on_job_query_resource_object_attributes.rb | 2 +- ...uery_resource_object_attributes_profile.rb | 2 +- .../models/data_privacy_deletion_job_enum.rb | 2 +- ...a_privacy_profile_query_resource_object.rb | 2 +- ...rofile_query_resource_object_attributes.rb | 2 +- lib/klaviyo-api-sdk/models/device_metadata.rb | 2 +- .../models/email_content_sub_object.rb | 2 +- .../models/email_send_options_sub_object.rb | 2 +- .../models/email_subscription_parameters.rb | 2 +- .../email_tracking_options_sub_object.rb | 2 +- .../models/event_create_query_v2.rb | 2 +- .../event_create_query_v2_resource_object.rb | 2 +- ...ate_query_v2_resource_object_attributes.rb | 2 +- ...ry_v2_resource_object_attributes_metric.rb | 2 +- ...y_v2_resource_object_attributes_profile.rb | 2 +- lib/klaviyo-api-sdk/models/event_enum.rb | 2 +- lib/klaviyo-api-sdk/models/flow_enum.rb | 2 +- .../models/flow_series_report_enum.rb | 36 ++ .../models/flow_series_request_dto.rb | 224 +++++++++ ...flow_series_request_dto_resource_object.rb | 238 +++++++++ ..._request_dto_resource_object_attributes.rb | 315 ++++++++++++ .../models/flow_update_query.rb | 2 +- .../flow_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- .../models/flow_values_report_enum.rb | 36 ++ .../models/flow_values_request_dto.rb | 224 +++++++++ ...flow_values_request_dto_resource_object.rb | 238 +++++++++ ..._request_dto_resource_object_attributes.rb | 288 +++++++++++ .../models/get_accounts4_xx_response.rb | 2 +- .../get_accounts4_xx_response_errors_inner.rb | 2 +- ...counts4_xx_response_errors_inner_source.rb | 2 +- .../models/image_create_query.rb | 2 +- .../image_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- lib/klaviyo-api-sdk/models/image_enum.rb | 2 +- .../models/image_partial_update_query.rb | 2 +- ...ge_partial_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- .../models/list_create_query.rb | 2 +- .../list_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- lib/klaviyo-api-sdk/models/list_enum.rb | 2 +- .../models/list_members_add_query.rb | 2 +- .../list_members_add_query_data_inner.rb | 2 +- .../models/list_members_delete_query.rb | 2 +- .../models/list_partial_update_query.rb | 2 +- ...st_partial_update_query_resource_object.rb | 2 +- .../marketing_subscription_parameters.rb | 20 +- .../models/metric_aggregate_enum.rb | 2 +- .../models/metric_aggregate_query.rb | 2 +- .../metric_aggregate_query_resource_object.rb | 2 +- ...regate_query_resource_object_attributes.rb | 2 +- .../metric_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- lib/klaviyo-api-sdk/models/metric_enum.rb | 2 +- ...te_profile_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- .../models/onsite_profile_meta.rb | 2 +- .../models/profile_bulk_import_job_enum.rb | 2 +- .../models/profile_create_query.rb | 2 +- .../profile_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- lib/klaviyo-api-sdk/models/profile_enum.rb | 2 +- .../profile_identifier_dto_resource_object.rb | 2 +- ...entifier_dto_resource_object_attributes.rb | 2 +- .../models/profile_import_job_create_query.rb | 2 +- ...import_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ery_resource_object_attributes_profiles.rb | 2 +- ...ate_query_resource_object_relationships.rb | 2 +- ...ery_resource_object_relationships_lists.rb | 2 +- ...e_object_relationships_lists_data_inner.rb | 2 +- .../models/profile_location.rb | 2 +- .../models/profile_location_latitude.rb | 2 +- .../models/profile_location_longitude.rb | 2 +- .../models/profile_merge_enum.rb | 2 +- .../models/profile_merge_query.rb | 2 +- .../profile_merge_query_resource_object.rb | 2 +- ...rge_query_resource_object_relationships.rb | 2 +- ..._resource_object_relationships_profiles.rb | 2 +- ...bject_relationships_profiles_data_inner.rb | 2 +- lib/klaviyo-api-sdk/models/profile_meta.rb | 2 +- .../models/profile_meta_patch_properties.rb | 2 +- .../profile_meta_patch_properties_unset.rb | 2 +- .../models/profile_partial_update_query.rb | 2 +- ...le_partial_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- ...ofile_subscription_bulk_create_job_enum.rb | 2 +- ...ofile_subscription_bulk_delete_job_enum.rb | 2 +- ...bscription_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 4 +- ...bscription_delete_query_resource_object.rb | 2 +- ...delete_query_resource_object_attributes.rb | 4 +- ...rofile_suppression_bulk_create_job_enum.rb | 2 +- ...rofile_suppression_bulk_delete_job_enum.rb | 2 +- ...uppression_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...uppression_delete_query_resource_object.rb | 2 +- ...delete_query_resource_object_attributes.rb | 2 +- .../models/profile_upsert_query.rb | 224 +++++++++ .../profile_upsert_query_resource_object.rb | 19 +- ...upsert_query_resource_object_attributes.rb | 19 +- .../models/push_token_create_query.rb | 2 +- ...push_token_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...uery_resource_object_attributes_profile.rb | 2 +- lib/klaviyo-api-sdk/models/push_token_enum.rb | 2 +- .../models/render_options_sub_object.rb | 2 +- lib/klaviyo-api-sdk/models/segment_enum.rb | 2 +- .../models/segment_partial_update_query.rb | 2 +- ...nt_partial_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 7 +- .../models/send_strategy_sub_object.rb | 2 +- .../server_bis_subscription_create_query.rb | 2 +- ...bscription_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...uery_resource_object_attributes_profile.rb | 2 +- ...ate_query_resource_object_relationships.rb | 2 +- ...y_resource_object_relationships_variant.rb | 2 +- ...ource_object_relationships_variant_data.rb | 2 +- .../models/sms_content_sub_object_create.rb | 2 +- .../models/sms_send_options_sub_object.rb | 2 +- .../models/sms_subscription_parameters.rb | 2 +- .../models/sms_tracking_options_sub_object.rb | 2 +- .../models/static_schedule_options.rb | 2 +- .../models/sto_schedule_options.rb | 2 +- .../models/subscription_channels.rb | 2 +- .../subscription_create_job_create_query.rb | 2 +- ...create_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ery_resource_object_attributes_profiles.rb | 2 +- ...ate_query_resource_object_relationships.rb | 2 +- ...uery_resource_object_relationships_list.rb | 2 +- ...resource_object_relationships_list_data.rb | 2 +- .../subscription_delete_job_create_query.rb | 2 +- ...delete_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ery_resource_object_attributes_profiles.rb | 2 +- ...ate_query_resource_object_relationships.rb | 2 +- ...uery_resource_object_relationships_list.rb | 2 +- ...resource_object_relationships_list_data.rb | 2 +- .../suppression_create_job_create_query.rb | 2 +- ...create_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ery_resource_object_attributes_profiles.rb | 2 +- .../suppression_delete_job_create_query.rb | 2 +- ...delete_job_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ery_resource_object_attributes_profiles.rb | 2 +- lib/klaviyo-api-sdk/models/tag_campaign_op.rb | 2 +- .../models/tag_campaign_op_data_inner.rb | 2 +- .../models/tag_create_query.rb | 2 +- .../tag_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- ...ate_query_resource_object_relationships.rb | 2 +- ...resource_object_relationships_tag_group.rb | 2 +- ...rce_object_relationships_tag_group_data.rb | 2 +- lib/klaviyo-api-sdk/models/tag_enum.rb | 2 +- lib/klaviyo-api-sdk/models/tag_flow_op.rb | 2 +- .../models/tag_flow_op_data_inner.rb | 2 +- .../models/tag_group_create_query.rb | 2 +- .../tag_group_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- lib/klaviyo-api-sdk/models/tag_group_enum.rb | 2 +- .../models/tag_group_update_query.rb | 2 +- .../tag_group_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- lib/klaviyo-api-sdk/models/tag_list_op.rb | 2 +- .../models/tag_list_op_data_inner.rb | 2 +- lib/klaviyo-api-sdk/models/tag_segment_op.rb | 2 +- .../models/tag_segment_op_data_inner.rb | 2 +- .../models/tag_update_query.rb | 2 +- .../tag_update_query_resource_object.rb | 2 +- .../models/template_clone_query.rb | 2 +- .../template_clone_query_resource_object.rb | 2 +- ..._clone_query_resource_object_attributes.rb | 2 +- .../models/template_create_query.rb | 2 +- .../template_create_query_resource_object.rb | 2 +- ...create_query_resource_object_attributes.rb | 2 +- lib/klaviyo-api-sdk/models/template_enum.rb | 2 +- .../models/template_render_query.rb | 2 +- .../template_render_query_resource_object.rb | 2 +- ...render_query_resource_object_attributes.rb | 2 +- .../models/template_update_query.rb | 2 +- .../template_update_query_resource_object.rb | 2 +- ...update_query_resource_object_attributes.rb | 2 +- .../models/throttled_schedule_options.rb | 2 +- lib/klaviyo-api-sdk/models/timeframe.rb | 259 ++++++++++ .../models/utm_params_sub_object.rb | 2 +- lib/klaviyo-api-sdk/version.rb | 2 +- 358 files changed, 4963 insertions(+), 1342 deletions(-) create mode 100644 lib/klaviyo-api-sdk/api/reporting_api.rb create mode 100644 lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb create mode 100644 lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb create mode 100644 lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb create mode 100644 lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb create mode 100644 lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb create mode 100644 lib/klaviyo-api-sdk/models/custom_timeframe.rb create mode 100644 lib/klaviyo-api-sdk/models/flow_series_report_enum.rb create mode 100644 lib/klaviyo-api-sdk/models/flow_series_request_dto.rb create mode 100644 lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb create mode 100644 lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb create mode 100644 lib/klaviyo-api-sdk/models/flow_values_report_enum.rb create mode 100644 lib/klaviyo-api-sdk/models/flow_values_request_dto.rb create mode 100644 lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb create mode 100644 lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb create mode 100644 lib/klaviyo-api-sdk/models/profile_upsert_query.rb create mode 100644 lib/klaviyo-api-sdk/models/timeframe.rb diff --git a/CHANGELOG.md b/CHANGELOG.md index 903eb42..c41312a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,34 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [6.0.0] - revision 2024-02-15 + +### Added: + +- New `Reporting` allows you to request campaign and flow performance data that you can view in the Klaviyo UI. + +- `campaign_values_query` + - Request campaign analytics data, for example, a campaign performance report on the open rate over the past 30 days. + +- `flow_values_query` + - Request flow analytics data, for example, a flow performance report on the revenue per recipient value over the past 3 months. + +- `flow_series_query` + - Fetch flow series data for a specific interval and timeframe, for example, a flow performance report on weekly click rates over the past 12 months. + + +- New `Profiles` endpoint allows you to create or update a profile with a set of profile attributes. + + - `create_or_update_profile` + - This endpoint operates synchronously and offers an upsert pattern similar to the [v1/v2 Identify API](https://developers.klaviyo.com/en/docs/apis_comparison_chart). + +### Changed: + +- Removed the $attribution field from event_properties in get_event and get_events (breaking change). + + - To include this data in your request, add include=attributions to your request. + + ## [5.1.0] - revision 2023-12-15 ### Added - New Endpoints: Bulk Profile Imports: diff --git a/README.md b/README.md index f5f3a57..1ed3483 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Klaviyo Ruby SDK -- SDK version: 5.1.0 -- API revision: 2023-12-15 +- SDK version: 6.0.0 +- API revision: 2024-02-15 ## Helpful Resources -- [API Reference](https://developers.klaviyo.com/en/v2023-12-15/reference) -- [API Guides](https://developers.klaviyo.com/en/v2023-12-15/docs) +- [API Reference](https://developers.klaviyo.com/en/v2024-02-15/reference) +- [API Guides](https://developers.klaviyo.com/en/v2024-02-15/docs) - [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers) ## Design & Approach @@ -63,6 +63,10 @@ This SDK is organized into the following resources: +- Reporting + + + - Segments @@ -90,13 +94,13 @@ gem build klaviyo-api-sdk.gemspec Then install the gem locally: ```shell -gem install ./klaviyo-api-sdk-5.1.0.gem +gem install ./klaviyo-api-sdk-6.0.0.gem ``` Finally add this to the Gemfile: - gem 'klaviyo-api-sdk', '~> 5.1.0' + gem 'klaviyo-api-sdk', '~> 6.0.0' To install directly from rubygems: @@ -460,7 +464,7 @@ response = KlaviyoAPI::Events.get_events(opts) ## Comprehensive list of Operations & Parameters _**NOTE:**_ -- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2023-12-15/reference/get_events). +- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2024-02-15/reference/get_events). - For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link. - Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required. @@ -472,7 +476,7 @@ _**NOTE:**_ ## Accounts -#### [Get Account](https://developers.klaviyo.com/en/v2023-12-15/reference/get_account) +#### [Get Account](https://developers.klaviyo.com/en/v2024-02-15/reference/get_account) ```ruby KlaviyoAPI::Accounts.get_account(id, opts) @@ -482,7 +486,7 @@ KlaviyoAPI::Accounts.get_account(id, opts) -#### [Get Accounts](https://developers.klaviyo.com/en/v2023-12-15/reference/get_accounts) +#### [Get Accounts](https://developers.klaviyo.com/en/v2024-02-15/reference/get_accounts) ```ruby KlaviyoAPI::Accounts.get_accounts(opts) @@ -496,7 +500,7 @@ KlaviyoAPI::Accounts.get_accounts(opts) ## Campaigns -#### [Create Campaign](https://developers.klaviyo.com/en/v2023-12-15/reference/create_campaign) +#### [Create Campaign](https://developers.klaviyo.com/en/v2024-02-15/reference/create_campaign) ```ruby KlaviyoAPI::Campaigns.create_campaign(body) @@ -506,7 +510,7 @@ KlaviyoAPI::Campaigns.create_campaign(body) -#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2023-12-15/reference/create_campaign_clone) +#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2024-02-15/reference/create_campaign_clone) ```ruby KlaviyoAPI::Campaigns.create_campaign_clone(body) @@ -516,7 +520,7 @@ KlaviyoAPI::Campaigns.create_campaign_clone(body) -#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2023-12-15/reference/create_campaign_message_assign_template) +#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2024-02-15/reference/create_campaign_message_assign_template) ```ruby KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body) @@ -526,7 +530,7 @@ KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body) -#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-12-15/reference/create_campaign_recipient_estimation_job) +#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2024-02-15/reference/create_campaign_recipient_estimation_job) ```ruby KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body) @@ -536,7 +540,7 @@ KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body) -#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2023-12-15/reference/create_campaign_send_job) +#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2024-02-15/reference/create_campaign_send_job) ```ruby KlaviyoAPI::Campaigns.create_campaign_send_job(body) @@ -546,7 +550,7 @@ KlaviyoAPI::Campaigns.create_campaign_send_job(body) -#### [Delete Campaign](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_campaign) +#### [Delete Campaign](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_campaign) ```ruby KlaviyoAPI::Campaigns.delete_campaign(id) @@ -556,7 +560,7 @@ KlaviyoAPI::Campaigns.delete_campaign(id) -#### [Get Campaign](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign) +#### [Get Campaign](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign) ```ruby KlaviyoAPI::Campaigns.get_campaign(id, opts) @@ -566,7 +570,7 @@ KlaviyoAPI::Campaigns.get_campaign(id, opts) -#### [Get Campaign Campaign Messages](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_campaign_messages) +#### [Get Campaign Campaign Messages](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_campaign_messages) ```ruby KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts) @@ -576,7 +580,7 @@ KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts) -#### [Get Campaign Message](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_message) +#### [Get Campaign Message](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_message) ```ruby KlaviyoAPI::Campaigns.get_campaign_message(id, opts) @@ -586,7 +590,7 @@ KlaviyoAPI::Campaigns.get_campaign_message(id, opts) -#### [Get Campaign Message Campaign](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_message_campaign) +#### [Get Campaign Message Campaign](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_message_campaign) ```ruby KlaviyoAPI::Campaigns.get_campaign_message_campaign(id, opts) @@ -596,7 +600,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_campaign(id, opts) -#### [Get Campaign Message Relationships Campaign](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_message_relationships_campaign) +#### [Get Campaign Message Relationships Campaign](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_message_relationships_campaign) ```ruby KlaviyoAPI::Campaigns.get_campaign_message_relationships_campaign(id) @@ -606,7 +610,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_relationships_campaign(id) -#### [Get Campaign Message Relationships Template](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_message_relationships_template) +#### [Get Campaign Message Relationships Template](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_message_relationships_template) ```ruby KlaviyoAPI::Campaigns.get_campaign_message_relationships_template(id) @@ -616,7 +620,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_relationships_template(id) -#### [Get Campaign Message Template](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_message_template) +#### [Get Campaign Message Template](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_message_template) ```ruby KlaviyoAPI::Campaigns.get_campaign_message_template(id, opts) @@ -626,7 +630,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_template(id, opts) -#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_recipient_estimation) +#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_recipient_estimation) ```ruby KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts) @@ -636,7 +640,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts) -#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_recipient_estimation_job) +#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_recipient_estimation_job) ```ruby KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts) @@ -646,7 +650,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts) -#### [Get Campaign Relationships Campaign Messages](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_relationships_campaign_messages) +#### [Get Campaign Relationships Campaign Messages](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_relationships_campaign_messages) ```ruby KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id) @@ -656,7 +660,7 @@ KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id) -#### [Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_relationships_tags) +#### [Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_relationships_tags) ```ruby KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id) @@ -666,7 +670,7 @@ KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id) -#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_send_job) +#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_send_job) ```ruby KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts) @@ -676,7 +680,7 @@ KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts) -#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_tags) +#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_tags) ```ruby KlaviyoAPI::Campaigns.get_campaign_tags(id, opts) @@ -686,7 +690,7 @@ KlaviyoAPI::Campaigns.get_campaign_tags(id, opts) -#### [Get Campaigns](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaigns) +#### [Get Campaigns](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaigns) ```ruby KlaviyoAPI::Campaigns.get_campaigns(filter, opts) @@ -696,7 +700,7 @@ KlaviyoAPI::Campaigns.get_campaigns(filter, opts) -#### [Update Campaign](https://developers.klaviyo.com/en/v2023-12-15/reference/update_campaign) +#### [Update Campaign](https://developers.klaviyo.com/en/v2024-02-15/reference/update_campaign) ```ruby KlaviyoAPI::Campaigns.update_campaign(id, body) @@ -706,7 +710,7 @@ KlaviyoAPI::Campaigns.update_campaign(id, body) -#### [Update Campaign Message](https://developers.klaviyo.com/en/v2023-12-15/reference/update_campaign_message) +#### [Update Campaign Message](https://developers.klaviyo.com/en/v2024-02-15/reference/update_campaign_message) ```ruby KlaviyoAPI::Campaigns.update_campaign_message(id, body) @@ -716,7 +720,7 @@ KlaviyoAPI::Campaigns.update_campaign_message(id, body) -#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2023-12-15/reference/update_campaign_send_job) +#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2024-02-15/reference/update_campaign_send_job) ```ruby KlaviyoAPI::Campaigns.update_campaign_send_job(id, body) @@ -730,7 +734,7 @@ KlaviyoAPI::Campaigns.update_campaign_send_job(id, body) ## Catalogs -#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2023-12-15/reference/create_back_in_stock_subscription) +#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2024-02-15/reference/create_back_in_stock_subscription) ```ruby KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body) @@ -740,7 +744,7 @@ KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body) -#### [Create Catalog Category](https://developers.klaviyo.com/en/v2023-12-15/reference/create_catalog_category) +#### [Create Catalog Category](https://developers.klaviyo.com/en/v2024-02-15/reference/create_catalog_category) ```ruby KlaviyoAPI::Catalogs.create_catalog_category(body) @@ -750,7 +754,7 @@ KlaviyoAPI::Catalogs.create_catalog_category(body) -#### [Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-12-15/reference/create_catalog_category_relationships_items) +#### [Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-02-15/reference/create_catalog_category_relationships_items) ```ruby KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body) @@ -760,7 +764,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body) -#### [Create Catalog Item](https://developers.klaviyo.com/en/v2023-12-15/reference/create_catalog_item) +#### [Create Catalog Item](https://developers.klaviyo.com/en/v2024-02-15/reference/create_catalog_item) ```ruby KlaviyoAPI::Catalogs.create_catalog_item(body) @@ -770,7 +774,7 @@ KlaviyoAPI::Catalogs.create_catalog_item(body) -#### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-12-15/reference/create_catalog_item_relationships_categories) +#### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-02-15/reference/create_catalog_item_relationships_categories) ```ruby KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body) @@ -780,7 +784,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body) -#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2023-12-15/reference/create_catalog_variant) +#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2024-02-15/reference/create_catalog_variant) ```ruby KlaviyoAPI::Catalogs.create_catalog_variant(body) @@ -790,7 +794,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant(body) -#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_catalog_category) +#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_catalog_category) ```ruby KlaviyoAPI::Catalogs.delete_catalog_category(id) @@ -800,7 +804,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category(id) -#### [Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_catalog_category_relationships_items) +#### [Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_catalog_category_relationships_items) ```ruby KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body) @@ -810,7 +814,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body) -#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_catalog_item) +#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_catalog_item) ```ruby KlaviyoAPI::Catalogs.delete_catalog_item(id) @@ -820,7 +824,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item(id) -#### [Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_catalog_item_relationships_categories) +#### [Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_catalog_item_relationships_categories) ```ruby KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body) @@ -830,7 +834,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body) -#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_catalog_variant) +#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_catalog_variant) ```ruby KlaviyoAPI::Catalogs.delete_catalog_variant(id) @@ -840,7 +844,7 @@ KlaviyoAPI::Catalogs.delete_catalog_variant(id) -#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_categories) +#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_categories) ```ruby KlaviyoAPI::Catalogs.get_catalog_categories(opts) @@ -850,7 +854,7 @@ KlaviyoAPI::Catalogs.get_catalog_categories(opts) -#### [Get Catalog Category](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_category) +#### [Get Catalog Category](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_category) ```ruby KlaviyoAPI::Catalogs.get_catalog_category(id, opts) @@ -860,7 +864,7 @@ KlaviyoAPI::Catalogs.get_catalog_category(id, opts) -#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_category_items) +#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_category_items) ```ruby KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts) @@ -870,7 +874,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts) -#### [Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_category_relationships_items) +#### [Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_category_relationships_items) ```ruby KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts) @@ -880,7 +884,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts) -#### [Get Catalog Item](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_item) +#### [Get Catalog Item](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_item) ```ruby KlaviyoAPI::Catalogs.get_catalog_item(id, opts) @@ -890,7 +894,7 @@ KlaviyoAPI::Catalogs.get_catalog_item(id, opts) -#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_item_categories) +#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_item_categories) ```ruby KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts) @@ -900,7 +904,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts) -#### [Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_item_relationships_categories) +#### [Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_item_relationships_categories) ```ruby KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts) @@ -910,7 +914,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts) -#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_item_variants) +#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_item_variants) ```ruby KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts) @@ -920,7 +924,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts) -#### [Get Catalog Items](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_items) +#### [Get Catalog Items](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_items) ```ruby KlaviyoAPI::Catalogs.get_catalog_items(opts) @@ -930,7 +934,7 @@ KlaviyoAPI::Catalogs.get_catalog_items(opts) -#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_variant) +#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_variant) ```ruby KlaviyoAPI::Catalogs.get_catalog_variant(id, opts) @@ -940,7 +944,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant(id, opts) -#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_variants) +#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_variants) ```ruby KlaviyoAPI::Catalogs.get_catalog_variants(opts) @@ -950,7 +954,7 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts) -#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_create_categories_job) +#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_create_categories_job) ```ruby KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts) @@ -960,7 +964,7 @@ KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts) -#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_create_categories_jobs) +#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_create_categories_jobs) ```ruby KlaviyoAPI::Catalogs.get_create_categories_jobs(opts) @@ -970,7 +974,7 @@ KlaviyoAPI::Catalogs.get_create_categories_jobs(opts) -#### [Get Create Items Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_create_items_job) +#### [Get Create Items Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_create_items_job) ```ruby KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts) @@ -980,7 +984,7 @@ KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts) -#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_create_items_jobs) +#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_create_items_jobs) ```ruby KlaviyoAPI::Catalogs.get_create_items_jobs(opts) @@ -990,7 +994,7 @@ KlaviyoAPI::Catalogs.get_create_items_jobs(opts) -#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_create_variants_job) +#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_create_variants_job) ```ruby KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts) @@ -1000,7 +1004,7 @@ KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts) -#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_create_variants_jobs) +#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_create_variants_jobs) ```ruby KlaviyoAPI::Catalogs.get_create_variants_jobs(opts) @@ -1010,7 +1014,7 @@ KlaviyoAPI::Catalogs.get_create_variants_jobs(opts) -#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_delete_categories_job) +#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_delete_categories_job) ```ruby KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts) @@ -1020,7 +1024,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts) -#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_delete_categories_jobs) +#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_delete_categories_jobs) ```ruby KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts) @@ -1030,7 +1034,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts) -#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_delete_items_job) +#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_delete_items_job) ```ruby KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts) @@ -1040,7 +1044,7 @@ KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts) -#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_delete_items_jobs) +#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_delete_items_jobs) ```ruby KlaviyoAPI::Catalogs.get_delete_items_jobs(opts) @@ -1050,7 +1054,7 @@ KlaviyoAPI::Catalogs.get_delete_items_jobs(opts) -#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_delete_variants_job) +#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_delete_variants_job) ```ruby KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts) @@ -1060,7 +1064,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts) -#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_delete_variants_jobs) +#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_delete_variants_jobs) ```ruby KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts) @@ -1070,7 +1074,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts) -#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_update_categories_job) +#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_update_categories_job) ```ruby KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts) @@ -1080,7 +1084,7 @@ KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts) -#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_update_categories_jobs) +#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_update_categories_jobs) ```ruby KlaviyoAPI::Catalogs.get_update_categories_jobs(opts) @@ -1090,7 +1094,7 @@ KlaviyoAPI::Catalogs.get_update_categories_jobs(opts) -#### [Get Update Items Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_update_items_job) +#### [Get Update Items Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_update_items_job) ```ruby KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts) @@ -1100,7 +1104,7 @@ KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts) -#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_update_items_jobs) +#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_update_items_jobs) ```ruby KlaviyoAPI::Catalogs.get_update_items_jobs(opts) @@ -1110,7 +1114,7 @@ KlaviyoAPI::Catalogs.get_update_items_jobs(opts) -#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_update_variants_job) +#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_update_variants_job) ```ruby KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts) @@ -1120,7 +1124,7 @@ KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts) -#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_update_variants_jobs) +#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_update_variants_jobs) ```ruby KlaviyoAPI::Catalogs.get_update_variants_jobs(opts) @@ -1130,7 +1134,7 @@ KlaviyoAPI::Catalogs.get_update_variants_jobs(opts) -#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_create_categories_job) +#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_create_categories_job) ```ruby KlaviyoAPI::Catalogs.spawn_create_categories_job(body) @@ -1140,7 +1144,7 @@ KlaviyoAPI::Catalogs.spawn_create_categories_job(body) -#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_create_items_job) +#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_create_items_job) ```ruby KlaviyoAPI::Catalogs.spawn_create_items_job(body) @@ -1150,7 +1154,7 @@ KlaviyoAPI::Catalogs.spawn_create_items_job(body) -#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_create_variants_job) +#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_create_variants_job) ```ruby KlaviyoAPI::Catalogs.spawn_create_variants_job(body) @@ -1160,7 +1164,7 @@ KlaviyoAPI::Catalogs.spawn_create_variants_job(body) -#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_delete_categories_job) +#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_delete_categories_job) ```ruby KlaviyoAPI::Catalogs.spawn_delete_categories_job(body) @@ -1170,7 +1174,7 @@ KlaviyoAPI::Catalogs.spawn_delete_categories_job(body) -#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_delete_items_job) +#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_delete_items_job) ```ruby KlaviyoAPI::Catalogs.spawn_delete_items_job(body) @@ -1180,7 +1184,7 @@ KlaviyoAPI::Catalogs.spawn_delete_items_job(body) -#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_delete_variants_job) +#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_delete_variants_job) ```ruby KlaviyoAPI::Catalogs.spawn_delete_variants_job(body) @@ -1190,7 +1194,7 @@ KlaviyoAPI::Catalogs.spawn_delete_variants_job(body) -#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_update_categories_job) +#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_update_categories_job) ```ruby KlaviyoAPI::Catalogs.spawn_update_categories_job(body) @@ -1200,7 +1204,7 @@ KlaviyoAPI::Catalogs.spawn_update_categories_job(body) -#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_update_items_job) +#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_update_items_job) ```ruby KlaviyoAPI::Catalogs.spawn_update_items_job(body) @@ -1210,7 +1214,7 @@ KlaviyoAPI::Catalogs.spawn_update_items_job(body) -#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_update_variants_job) +#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_update_variants_job) ```ruby KlaviyoAPI::Catalogs.spawn_update_variants_job(body) @@ -1220,7 +1224,7 @@ KlaviyoAPI::Catalogs.spawn_update_variants_job(body) -#### [Update Catalog Category](https://developers.klaviyo.com/en/v2023-12-15/reference/update_catalog_category) +#### [Update Catalog Category](https://developers.klaviyo.com/en/v2024-02-15/reference/update_catalog_category) ```ruby KlaviyoAPI::Catalogs.update_catalog_category(id, body) @@ -1230,7 +1234,7 @@ KlaviyoAPI::Catalogs.update_catalog_category(id, body) -#### [Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-12-15/reference/update_catalog_category_relationships_items) +#### [Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-02-15/reference/update_catalog_category_relationships_items) ```ruby KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body) @@ -1240,7 +1244,7 @@ KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body) -#### [Update Catalog Item](https://developers.klaviyo.com/en/v2023-12-15/reference/update_catalog_item) +#### [Update Catalog Item](https://developers.klaviyo.com/en/v2024-02-15/reference/update_catalog_item) ```ruby KlaviyoAPI::Catalogs.update_catalog_item(id, body) @@ -1250,7 +1254,7 @@ KlaviyoAPI::Catalogs.update_catalog_item(id, body) -#### [Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-12-15/reference/update_catalog_item_relationships_categories) +#### [Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-02-15/reference/update_catalog_item_relationships_categories) ```ruby KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body) @@ -1260,7 +1264,7 @@ KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body) -#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2023-12-15/reference/update_catalog_variant) +#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2024-02-15/reference/update_catalog_variant) ```ruby KlaviyoAPI::Catalogs.update_catalog_variant(id, body) @@ -1274,7 +1278,7 @@ KlaviyoAPI::Catalogs.update_catalog_variant(id, body) ## Coupons -#### [Create Coupon](https://developers.klaviyo.com/en/v2023-12-15/reference/create_coupon) +#### [Create Coupon](https://developers.klaviyo.com/en/v2024-02-15/reference/create_coupon) ```ruby KlaviyoAPI::Coupons.create_coupon(body) @@ -1284,7 +1288,7 @@ KlaviyoAPI::Coupons.create_coupon(body) -#### [Create Coupon Code](https://developers.klaviyo.com/en/v2023-12-15/reference/create_coupon_code) +#### [Create Coupon Code](https://developers.klaviyo.com/en/v2024-02-15/reference/create_coupon_code) ```ruby KlaviyoAPI::Coupons.create_coupon_code(body) @@ -1294,7 +1298,7 @@ KlaviyoAPI::Coupons.create_coupon_code(body) -#### [Delete Coupon](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_coupon) +#### [Delete Coupon](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_coupon) ```ruby KlaviyoAPI::Coupons.delete_coupon(id) @@ -1304,7 +1308,7 @@ KlaviyoAPI::Coupons.delete_coupon(id) -#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_coupon_code) +#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_coupon_code) ```ruby KlaviyoAPI::Coupons.delete_coupon_code(id) @@ -1314,7 +1318,7 @@ KlaviyoAPI::Coupons.delete_coupon_code(id) -#### [Get Coupon](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon) +#### [Get Coupon](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon) ```ruby KlaviyoAPI::Coupons.get_coupon(id, opts) @@ -1324,7 +1328,7 @@ KlaviyoAPI::Coupons.get_coupon(id, opts) -#### [Get Coupon Code](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_code) +#### [Get Coupon Code](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_code) ```ruby KlaviyoAPI::Coupons.get_coupon_code(id, opts) @@ -1334,7 +1338,7 @@ KlaviyoAPI::Coupons.get_coupon_code(id, opts) -#### [Get Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_code_bulk_create_job) +#### [Get Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_code_bulk_create_job) ```ruby KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts) @@ -1344,7 +1348,7 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts) -#### [Get Coupon Code Bulk Create Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_code_bulk_create_jobs) +#### [Get Coupon Code Bulk Create Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_code_bulk_create_jobs) ```ruby KlaviyoAPI::Coupons.get_coupon_code_bulk_create_jobs(opts) @@ -1354,7 +1358,7 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_jobs(opts) -#### [Get Coupon Code Relationships Coupon](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_code_relationships_coupon) +#### [Get Coupon Code Relationships Coupon](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_code_relationships_coupon) ```ruby KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts) @@ -1364,7 +1368,7 @@ KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts) -#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_codes) +#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_codes) ```ruby KlaviyoAPI::Coupons.get_coupon_codes(opts) @@ -1374,7 +1378,7 @@ KlaviyoAPI::Coupons.get_coupon_codes(opts) -#### [Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_codes_for_coupon) +#### [Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_codes_for_coupon) ```ruby KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts) @@ -1384,7 +1388,7 @@ KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts) -#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_for_coupon_code) +#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_for_coupon_code) ```ruby KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts) @@ -1394,7 +1398,7 @@ KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts) -#### [Get Coupon Relationships Coupon Codes](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_relationships_coupon_codes) +#### [Get Coupon Relationships Coupon Codes](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_relationships_coupon_codes) ```ruby KlaviyoAPI::Coupons.get_coupon_relationships_coupon_codes(id) @@ -1404,7 +1408,7 @@ KlaviyoAPI::Coupons.get_coupon_relationships_coupon_codes(id) -#### [Get Coupons](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupons) +#### [Get Coupons](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupons) ```ruby KlaviyoAPI::Coupons.get_coupons(opts) @@ -1414,7 +1418,7 @@ KlaviyoAPI::Coupons.get_coupons(opts) -#### [Spawn Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_coupon_code_bulk_create_job) +#### [Spawn Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_coupon_code_bulk_create_job) ```ruby KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body) @@ -1424,7 +1428,7 @@ KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body) -#### [Update Coupon](https://developers.klaviyo.com/en/v2023-12-15/reference/update_coupon) +#### [Update Coupon](https://developers.klaviyo.com/en/v2024-02-15/reference/update_coupon) ```ruby KlaviyoAPI::Coupons.update_coupon(id, body) @@ -1434,7 +1438,7 @@ KlaviyoAPI::Coupons.update_coupon(id, body) -#### [Update Coupon Code](https://developers.klaviyo.com/en/v2023-12-15/reference/update_coupon_code) +#### [Update Coupon Code](https://developers.klaviyo.com/en/v2024-02-15/reference/update_coupon_code) ```ruby KlaviyoAPI::Coupons.update_coupon_code(id, body) @@ -1448,7 +1452,7 @@ KlaviyoAPI::Coupons.update_coupon_code(id, body) ## Data Privacy -#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2023-12-15/reference/request_profile_deletion) +#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2024-02-15/reference/request_profile_deletion) ```ruby KlaviyoAPI::DataPrivacy.request_profile_deletion(body) @@ -1462,7 +1466,7 @@ KlaviyoAPI::DataPrivacy.request_profile_deletion(body) ## Events -#### [Create Event](https://developers.klaviyo.com/en/v2023-12-15/reference/create_event) +#### [Create Event](https://developers.klaviyo.com/en/v2024-02-15/reference/create_event) ```ruby KlaviyoAPI::Events.create_event(body) @@ -1472,7 +1476,7 @@ KlaviyoAPI::Events.create_event(body) -#### [Get Event](https://developers.klaviyo.com/en/v2023-12-15/reference/get_event) +#### [Get Event](https://developers.klaviyo.com/en/v2024-02-15/reference/get_event) ```ruby KlaviyoAPI::Events.get_event(id, opts) @@ -1482,7 +1486,7 @@ KlaviyoAPI::Events.get_event(id, opts) -#### [Get Event Metric](https://developers.klaviyo.com/en/v2023-12-15/reference/get_event_metric) +#### [Get Event Metric](https://developers.klaviyo.com/en/v2024-02-15/reference/get_event_metric) ```ruby KlaviyoAPI::Events.get_event_metric(id, opts) @@ -1492,7 +1496,7 @@ KlaviyoAPI::Events.get_event_metric(id, opts) -#### [Get Event Profile](https://developers.klaviyo.com/en/v2023-12-15/reference/get_event_profile) +#### [Get Event Profile](https://developers.klaviyo.com/en/v2024-02-15/reference/get_event_profile) ```ruby KlaviyoAPI::Events.get_event_profile(id, opts) @@ -1502,7 +1506,7 @@ KlaviyoAPI::Events.get_event_profile(id, opts) -#### [Get Event Relationships Metric](https://developers.klaviyo.com/en/v2023-12-15/reference/get_event_relationships_metric) +#### [Get Event Relationships Metric](https://developers.klaviyo.com/en/v2024-02-15/reference/get_event_relationships_metric) ```ruby KlaviyoAPI::Events.get_event_relationships_metric(id) @@ -1512,7 +1516,7 @@ KlaviyoAPI::Events.get_event_relationships_metric(id) -#### [Get Event Relationships Profile](https://developers.klaviyo.com/en/v2023-12-15/reference/get_event_relationships_profile) +#### [Get Event Relationships Profile](https://developers.klaviyo.com/en/v2024-02-15/reference/get_event_relationships_profile) ```ruby KlaviyoAPI::Events.get_event_relationships_profile(id) @@ -1522,7 +1526,7 @@ KlaviyoAPI::Events.get_event_relationships_profile(id) -#### [Get Events](https://developers.klaviyo.com/en/v2023-12-15/reference/get_events) +#### [Get Events](https://developers.klaviyo.com/en/v2024-02-15/reference/get_events) ```ruby KlaviyoAPI::Events.get_events(opts) @@ -1536,7 +1540,7 @@ KlaviyoAPI::Events.get_events(opts) ## Flows -#### [Get Flow](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow) +#### [Get Flow](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow) ```ruby KlaviyoAPI::Flows.get_flow(id, opts) @@ -1546,7 +1550,7 @@ KlaviyoAPI::Flows.get_flow(id, opts) -#### [Get Flow Action](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_action) +#### [Get Flow Action](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_action) ```ruby KlaviyoAPI::Flows.get_flow_action(id, opts) @@ -1556,7 +1560,7 @@ KlaviyoAPI::Flows.get_flow_action(id, opts) -#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_action_flow) +#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_action_flow) ```ruby KlaviyoAPI::Flows.get_flow_action_flow(id, opts) @@ -1566,7 +1570,7 @@ KlaviyoAPI::Flows.get_flow_action_flow(id, opts) -#### [Get Flow Action Messages](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_action_messages) +#### [Get Flow Action Messages](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_action_messages) ```ruby KlaviyoAPI::Flows.get_flow_action_messages(id, opts) @@ -1576,7 +1580,7 @@ KlaviyoAPI::Flows.get_flow_action_messages(id, opts) -#### [Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_action_relationships_flow) +#### [Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_action_relationships_flow) ```ruby KlaviyoAPI::Flows.get_flow_action_relationships_flow(id) @@ -1586,7 +1590,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_flow(id) -#### [Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_action_relationships_messages) +#### [Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_action_relationships_messages) ```ruby KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts) @@ -1596,7 +1600,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts) -#### [Get Flow Flow Actions](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_flow_actions) +#### [Get Flow Flow Actions](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_flow_actions) ```ruby KlaviyoAPI::Flows.get_flow_flow_actions(id, opts) @@ -1606,7 +1610,7 @@ KlaviyoAPI::Flows.get_flow_flow_actions(id, opts) -#### [Get Flow Message](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_message) +#### [Get Flow Message](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_message) ```ruby KlaviyoAPI::Flows.get_flow_message(id, opts) @@ -1616,7 +1620,7 @@ KlaviyoAPI::Flows.get_flow_message(id, opts) -#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_message_action) +#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_message_action) ```ruby KlaviyoAPI::Flows.get_flow_message_action(id, opts) @@ -1626,7 +1630,7 @@ KlaviyoAPI::Flows.get_flow_message_action(id, opts) -#### [Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_message_relationships_action) +#### [Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_message_relationships_action) ```ruby KlaviyoAPI::Flows.get_flow_message_relationships_action(id) @@ -1636,7 +1640,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships_action(id) -#### [Get Flow Message Relationships Template](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_message_relationships_template) +#### [Get Flow Message Relationships Template](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_message_relationships_template) ```ruby KlaviyoAPI::Flows.get_flow_message_relationships_template(id) @@ -1646,7 +1650,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships_template(id) -#### [Get Flow Message Template](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_message_template) +#### [Get Flow Message Template](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_message_template) ```ruby KlaviyoAPI::Flows.get_flow_message_template(id, opts) @@ -1656,7 +1660,7 @@ KlaviyoAPI::Flows.get_flow_message_template(id, opts) -#### [Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_relationships_flow_actions) +#### [Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_relationships_flow_actions) ```ruby KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts) @@ -1666,7 +1670,7 @@ KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts) -#### [Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_relationships_tags) +#### [Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_relationships_tags) ```ruby KlaviyoAPI::Flows.get_flow_relationships_tags(id) @@ -1676,7 +1680,7 @@ KlaviyoAPI::Flows.get_flow_relationships_tags(id) -#### [Get Flow Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_tags) +#### [Get Flow Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_tags) ```ruby KlaviyoAPI::Flows.get_flow_tags(id, opts) @@ -1686,7 +1690,7 @@ KlaviyoAPI::Flows.get_flow_tags(id, opts) -#### [Get Flows](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flows) +#### [Get Flows](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flows) ```ruby KlaviyoAPI::Flows.get_flows(opts) @@ -1696,7 +1700,7 @@ KlaviyoAPI::Flows.get_flows(opts) -#### [Update Flow Status](https://developers.klaviyo.com/en/v2023-12-15/reference/update_flow) +#### [Update Flow Status](https://developers.klaviyo.com/en/v2024-02-15/reference/update_flow) ```ruby KlaviyoAPI::Flows.update_flow(id, body) @@ -1710,7 +1714,7 @@ KlaviyoAPI::Flows.update_flow(id, body) ## Images -#### [Get Image](https://developers.klaviyo.com/en/v2023-12-15/reference/get_image) +#### [Get Image](https://developers.klaviyo.com/en/v2024-02-15/reference/get_image) ```ruby KlaviyoAPI::Images.get_image(id, opts) @@ -1720,7 +1724,7 @@ KlaviyoAPI::Images.get_image(id, opts) -#### [Get Images](https://developers.klaviyo.com/en/v2023-12-15/reference/get_images) +#### [Get Images](https://developers.klaviyo.com/en/v2024-02-15/reference/get_images) ```ruby KlaviyoAPI::Images.get_images(opts) @@ -1730,7 +1734,7 @@ KlaviyoAPI::Images.get_images(opts) -#### [Update Image](https://developers.klaviyo.com/en/v2023-12-15/reference/update_image) +#### [Update Image](https://developers.klaviyo.com/en/v2024-02-15/reference/update_image) ```ruby KlaviyoAPI::Images.update_image(id, body) @@ -1740,7 +1744,7 @@ KlaviyoAPI::Images.update_image(id, body) -#### [Upload Image From File](https://developers.klaviyo.com/en/v2023-12-15/reference/upload_image_from_file) +#### [Upload Image From File](https://developers.klaviyo.com/en/v2024-02-15/reference/upload_image_from_file) ```ruby KlaviyoAPI::Images.upload_image_from_file(file, opts) @@ -1750,7 +1754,7 @@ KlaviyoAPI::Images.upload_image_from_file(file, opts) -#### [Upload Image From URL](https://developers.klaviyo.com/en/v2023-12-15/reference/upload_image_from_url) +#### [Upload Image From URL](https://developers.klaviyo.com/en/v2024-02-15/reference/upload_image_from_url) ```ruby KlaviyoAPI::Images.upload_image_from_url(body) @@ -1764,7 +1768,7 @@ KlaviyoAPI::Images.upload_image_from_url(body) ## Lists -#### [Create List](https://developers.klaviyo.com/en/v2023-12-15/reference/create_list) +#### [Create List](https://developers.klaviyo.com/en/v2024-02-15/reference/create_list) ```ruby KlaviyoAPI::Lists.create_list(body) @@ -1774,7 +1778,7 @@ KlaviyoAPI::Lists.create_list(body) -#### [Add Profile To List](https://developers.klaviyo.com/en/v2023-12-15/reference/create_list_relationships) +#### [Add Profile To List](https://developers.klaviyo.com/en/v2024-02-15/reference/create_list_relationships) ```ruby KlaviyoAPI::Lists.create_list_relationships(id, body) @@ -1784,7 +1788,7 @@ KlaviyoAPI::Lists.create_list_relationships(id, body) -#### [Delete List](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_list) +#### [Delete List](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_list) ```ruby KlaviyoAPI::Lists.delete_list(id) @@ -1794,7 +1798,7 @@ KlaviyoAPI::Lists.delete_list(id) -#### [Remove Profile From List](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_list_relationships) +#### [Remove Profile From List](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_list_relationships) ```ruby KlaviyoAPI::Lists.delete_list_relationships(id, body) @@ -1804,7 +1808,7 @@ KlaviyoAPI::Lists.delete_list_relationships(id, body) -#### [Get List](https://developers.klaviyo.com/en/v2023-12-15/reference/get_list) +#### [Get List](https://developers.klaviyo.com/en/v2024-02-15/reference/get_list) ```ruby KlaviyoAPI::Lists.get_list(id, opts) @@ -1814,7 +1818,7 @@ KlaviyoAPI::Lists.get_list(id, opts) -#### [Get List Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_list_profiles) +#### [Get List Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_list_profiles) ```ruby KlaviyoAPI::Lists.get_list_profiles(id, opts) @@ -1824,7 +1828,7 @@ KlaviyoAPI::Lists.get_list_profiles(id, opts) -#### [Get List Relationships Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_list_relationships_profiles) +#### [Get List Relationships Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_list_relationships_profiles) ```ruby KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts) @@ -1834,7 +1838,7 @@ KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts) -#### [Get List Relationships Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_list_relationships_tags) +#### [Get List Relationships Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_list_relationships_tags) ```ruby KlaviyoAPI::Lists.get_list_relationships_tags(id) @@ -1844,7 +1848,7 @@ KlaviyoAPI::Lists.get_list_relationships_tags(id) -#### [Get List Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_list_tags) +#### [Get List Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_list_tags) ```ruby KlaviyoAPI::Lists.get_list_tags(id, opts) @@ -1854,7 +1858,7 @@ KlaviyoAPI::Lists.get_list_tags(id, opts) -#### [Get Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/get_lists) +#### [Get Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/get_lists) ```ruby KlaviyoAPI::Lists.get_lists(opts) @@ -1864,7 +1868,7 @@ KlaviyoAPI::Lists.get_lists(opts) -#### [Update List](https://developers.klaviyo.com/en/v2023-12-15/reference/update_list) +#### [Update List](https://developers.klaviyo.com/en/v2024-02-15/reference/update_list) ```ruby KlaviyoAPI::Lists.update_list(id, body) @@ -1878,7 +1882,7 @@ KlaviyoAPI::Lists.update_list(id, body) ## Metrics -#### [Get Metric](https://developers.klaviyo.com/en/v2023-12-15/reference/get_metric) +#### [Get Metric](https://developers.klaviyo.com/en/v2024-02-15/reference/get_metric) ```ruby KlaviyoAPI::Metrics.get_metric(id, opts) @@ -1888,7 +1892,7 @@ KlaviyoAPI::Metrics.get_metric(id, opts) -#### [Get Metrics](https://developers.klaviyo.com/en/v2023-12-15/reference/get_metrics) +#### [Get Metrics](https://developers.klaviyo.com/en/v2024-02-15/reference/get_metrics) ```ruby KlaviyoAPI::Metrics.get_metrics(opts) @@ -1898,7 +1902,7 @@ KlaviyoAPI::Metrics.get_metrics(opts) -#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-12-15/reference/query_metric_aggregates) +#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2024-02-15/reference/query_metric_aggregates) ```ruby KlaviyoAPI::Metrics.query_metric_aggregates(body) @@ -1912,7 +1916,17 @@ KlaviyoAPI::Metrics.query_metric_aggregates(body) ## Profiles -#### [Create Profile](https://developers.klaviyo.com/en/v2023-12-15/reference/create_profile) +#### [Create or Update Profile](https://developers.klaviyo.com/en/v2024-02-15/reference/create_or_update_profile) + +```ruby +KlaviyoAPI::Profiles.create_or_update_profile(body) +``` + + + + + +#### [Create Profile](https://developers.klaviyo.com/en/v2024-02-15/reference/create_profile) ```ruby KlaviyoAPI::Profiles.create_profile(body) @@ -1922,7 +1936,7 @@ KlaviyoAPI::Profiles.create_profile(body) -#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2023-12-15/reference/create_push_token) +#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2024-02-15/reference/create_push_token) ```ruby KlaviyoAPI::Profiles.create_push_token(body) @@ -1932,7 +1946,7 @@ KlaviyoAPI::Profiles.create_push_token(body) -#### [Get Bulk Profile Import Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_job) +#### [Get Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_job) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts) @@ -1942,7 +1956,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts) -#### [Get Bulk Profile Import Job Import Errors](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_job_import_errors) +#### [Get Bulk Profile Import Job Errors](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_job_import_errors) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts) @@ -1952,7 +1966,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts) -#### [Get Bulk Profile Import Job Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_job_lists) +#### [Get Bulk Profile Import Job Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_job_lists) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts) @@ -1962,7 +1976,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts) -#### [Get Bulk Profile Import Job Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_job_profiles) +#### [Get Bulk Profile Import Job Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_job_profiles) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts) @@ -1972,7 +1986,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts) -#### [Get Bulk Profile Import Job Relationships Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_job_relationships_lists) +#### [Get Bulk Profile Import Job Relationships Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_job_relationships_lists) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id) @@ -1982,7 +1996,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id) -#### [Get Bulk Profile Import Job Relationships Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_job_relationships_profiles) +#### [Get Bulk Profile Import Job Relationships Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_job_relationships_profiles) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts) @@ -1992,7 +2006,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts -#### [Get Bulk Profile Import Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_jobs) +#### [Get Bulk Profile Import Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_jobs) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_jobs(opts) @@ -2002,7 +2016,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_jobs(opts) -#### [Get Profile](https://developers.klaviyo.com/en/v2023-12-15/reference/get_profile) +#### [Get Profile](https://developers.klaviyo.com/en/v2024-02-15/reference/get_profile) ```ruby KlaviyoAPI::Profiles.get_profile(id, opts) @@ -2012,7 +2026,7 @@ KlaviyoAPI::Profiles.get_profile(id, opts) -#### [Get Profile Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/get_profile_lists) +#### [Get Profile Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/get_profile_lists) ```ruby KlaviyoAPI::Profiles.get_profile_lists(id, opts) @@ -2022,7 +2036,7 @@ KlaviyoAPI::Profiles.get_profile_lists(id, opts) -#### [Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/get_profile_relationships_lists) +#### [Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/get_profile_relationships_lists) ```ruby KlaviyoAPI::Profiles.get_profile_relationships_lists(id) @@ -2032,7 +2046,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_lists(id) -#### [Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2023-12-15/reference/get_profile_relationships_segments) +#### [Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2024-02-15/reference/get_profile_relationships_segments) ```ruby KlaviyoAPI::Profiles.get_profile_relationships_segments(id) @@ -2042,7 +2056,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_segments(id) -#### [Get Profile Segments](https://developers.klaviyo.com/en/v2023-12-15/reference/get_profile_segments) +#### [Get Profile Segments](https://developers.klaviyo.com/en/v2024-02-15/reference/get_profile_segments) ```ruby KlaviyoAPI::Profiles.get_profile_segments(id, opts) @@ -2052,7 +2066,7 @@ KlaviyoAPI::Profiles.get_profile_segments(id, opts) -#### [Get Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_profiles) +#### [Get Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_profiles) ```ruby KlaviyoAPI::Profiles.get_profiles(opts) @@ -2062,7 +2076,7 @@ KlaviyoAPI::Profiles.get_profiles(opts) -#### [Merge Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/merge_profiles) +#### [Merge Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/merge_profiles) ```ruby KlaviyoAPI::Profiles.merge_profiles(body) @@ -2072,7 +2086,7 @@ KlaviyoAPI::Profiles.merge_profiles(body) -#### [Spawn Bulk Profile Import Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_bulk_profile_import_job) +#### [Spawn Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_bulk_profile_import_job) ```ruby KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body) @@ -2082,7 +2096,7 @@ KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body) -#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/subscribe_profiles) +#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/subscribe_profiles) ```ruby KlaviyoAPI::Profiles.subscribe_profiles(body) @@ -2092,7 +2106,7 @@ KlaviyoAPI::Profiles.subscribe_profiles(body) -#### [Suppress Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/suppress_profiles) +#### [Suppress Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/suppress_profiles) ```ruby KlaviyoAPI::Profiles.suppress_profiles(body) @@ -2102,7 +2116,7 @@ KlaviyoAPI::Profiles.suppress_profiles(body) -#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/unsubscribe_profiles) +#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/unsubscribe_profiles) ```ruby KlaviyoAPI::Profiles.unsubscribe_profiles(body) @@ -2112,7 +2126,7 @@ KlaviyoAPI::Profiles.unsubscribe_profiles(body) -#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/unsuppress_profiles) +#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/unsuppress_profiles) ```ruby KlaviyoAPI::Profiles.unsuppress_profiles(body) @@ -2122,7 +2136,7 @@ KlaviyoAPI::Profiles.unsuppress_profiles(body) -#### [Update Profile](https://developers.klaviyo.com/en/v2023-12-15/reference/update_profile) +#### [Update Profile](https://developers.klaviyo.com/en/v2024-02-15/reference/update_profile) ```ruby KlaviyoAPI::Profiles.update_profile(id, body) @@ -2133,10 +2147,44 @@ KlaviyoAPI::Profiles.update_profile(id, body) +## Reporting + + +#### [Query Campaign Values](https://developers.klaviyo.com/en/v2024-02-15/reference/query_campaign_values) + +```ruby +KlaviyoAPI::Reporting.query_campaign_values(body, opts) +``` + + + + + +#### [Query Flow Series](https://developers.klaviyo.com/en/v2024-02-15/reference/query_flow_series) + +```ruby +KlaviyoAPI::Reporting.query_flow_series(body, opts) +``` + + + + + +#### [Query Flow Values](https://developers.klaviyo.com/en/v2024-02-15/reference/query_flow_values) + +```ruby +KlaviyoAPI::Reporting.query_flow_values(body, opts) +``` + + + + + + ## Segments -#### [Get Segment](https://developers.klaviyo.com/en/v2023-12-15/reference/get_segment) +#### [Get Segment](https://developers.klaviyo.com/en/v2024-02-15/reference/get_segment) ```ruby KlaviyoAPI::Segments.get_segment(id, opts) @@ -2146,7 +2194,7 @@ KlaviyoAPI::Segments.get_segment(id, opts) -#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_segment_profiles) +#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_segment_profiles) ```ruby KlaviyoAPI::Segments.get_segment_profiles(id, opts) @@ -2156,7 +2204,7 @@ KlaviyoAPI::Segments.get_segment_profiles(id, opts) -#### [Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_segment_relationships_profiles) +#### [Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_segment_relationships_profiles) ```ruby KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts) @@ -2166,7 +2214,7 @@ KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts) -#### [Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_segment_relationships_tags) +#### [Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_segment_relationships_tags) ```ruby KlaviyoAPI::Segments.get_segment_relationships_tags(id) @@ -2176,7 +2224,7 @@ KlaviyoAPI::Segments.get_segment_relationships_tags(id) -#### [Get Segment Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_segment_tags) +#### [Get Segment Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_segment_tags) ```ruby KlaviyoAPI::Segments.get_segment_tags(id, opts) @@ -2186,7 +2234,7 @@ KlaviyoAPI::Segments.get_segment_tags(id, opts) -#### [Get Segments](https://developers.klaviyo.com/en/v2023-12-15/reference/get_segments) +#### [Get Segments](https://developers.klaviyo.com/en/v2024-02-15/reference/get_segments) ```ruby KlaviyoAPI::Segments.get_segments(opts) @@ -2196,7 +2244,7 @@ KlaviyoAPI::Segments.get_segments(opts) -#### [Update Segment](https://developers.klaviyo.com/en/v2023-12-15/reference/update_segment) +#### [Update Segment](https://developers.klaviyo.com/en/v2024-02-15/reference/update_segment) ```ruby KlaviyoAPI::Segments.update_segment(id, body) @@ -2210,7 +2258,7 @@ KlaviyoAPI::Segments.update_segment(id, body) ## Tags -#### [Create Tag](https://developers.klaviyo.com/en/v2023-12-15/reference/create_tag) +#### [Create Tag](https://developers.klaviyo.com/en/v2024-02-15/reference/create_tag) ```ruby KlaviyoAPI::Tags.create_tag(body) @@ -2220,7 +2268,7 @@ KlaviyoAPI::Tags.create_tag(body) -#### [Create Tag Group](https://developers.klaviyo.com/en/v2023-12-15/reference/create_tag_group) +#### [Create Tag Group](https://developers.klaviyo.com/en/v2024-02-15/reference/create_tag_group) ```ruby KlaviyoAPI::Tags.create_tag_group(body) @@ -2230,7 +2278,7 @@ KlaviyoAPI::Tags.create_tag_group(body) -#### [Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-12-15/reference/create_tag_relationships_campaigns) +#### [Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-02-15/reference/create_tag_relationships_campaigns) ```ruby KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body) @@ -2240,7 +2288,7 @@ KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body) -#### [Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-12-15/reference/create_tag_relationships_flows) +#### [Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-02-15/reference/create_tag_relationships_flows) ```ruby KlaviyoAPI::Tags.create_tag_relationships_flows(id, body) @@ -2250,7 +2298,7 @@ KlaviyoAPI::Tags.create_tag_relationships_flows(id, body) -#### [Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/create_tag_relationships_lists) +#### [Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/create_tag_relationships_lists) ```ruby KlaviyoAPI::Tags.create_tag_relationships_lists(id, body) @@ -2260,7 +2308,7 @@ KlaviyoAPI::Tags.create_tag_relationships_lists(id, body) -#### [Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-12-15/reference/create_tag_relationships_segments) +#### [Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-02-15/reference/create_tag_relationships_segments) ```ruby KlaviyoAPI::Tags.create_tag_relationships_segments(id, body) @@ -2270,7 +2318,7 @@ KlaviyoAPI::Tags.create_tag_relationships_segments(id, body) -#### [Delete Tag](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_tag) +#### [Delete Tag](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_tag) ```ruby KlaviyoAPI::Tags.delete_tag(id) @@ -2280,7 +2328,7 @@ KlaviyoAPI::Tags.delete_tag(id) -#### [Delete Tag Group](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_tag_group) +#### [Delete Tag Group](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_tag_group) ```ruby KlaviyoAPI::Tags.delete_tag_group(id) @@ -2290,7 +2338,7 @@ KlaviyoAPI::Tags.delete_tag_group(id) -#### [Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_tag_relationships_campaigns) +#### [Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_tag_relationships_campaigns) ```ruby KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body) @@ -2300,7 +2348,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body) -#### [Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_tag_relationships_flows) +#### [Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_tag_relationships_flows) ```ruby KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body) @@ -2310,7 +2358,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body) -#### [Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_tag_relationships_lists) +#### [Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_tag_relationships_lists) ```ruby KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body) @@ -2320,7 +2368,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body) -#### [Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_tag_relationships_segments) +#### [Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_tag_relationships_segments) ```ruby KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body) @@ -2330,7 +2378,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body) -#### [Get Tag](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag) +#### [Get Tag](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag) ```ruby KlaviyoAPI::Tags.get_tag(id, opts) @@ -2340,7 +2388,7 @@ KlaviyoAPI::Tags.get_tag(id, opts) -#### [Get Tag Group](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_group) +#### [Get Tag Group](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_group) ```ruby KlaviyoAPI::Tags.get_tag_group(id, opts) @@ -2350,7 +2398,7 @@ KlaviyoAPI::Tags.get_tag_group(id, opts) -#### [Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_group_relationships_tags) +#### [Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_group_relationships_tags) ```ruby KlaviyoAPI::Tags.get_tag_group_relationships_tags(id) @@ -2360,7 +2408,7 @@ KlaviyoAPI::Tags.get_tag_group_relationships_tags(id) -#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_group_tags) +#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_group_tags) ```ruby KlaviyoAPI::Tags.get_tag_group_tags(id, opts) @@ -2370,7 +2418,7 @@ KlaviyoAPI::Tags.get_tag_group_tags(id, opts) -#### [Get Tag Groups](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_groups) +#### [Get Tag Groups](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_groups) ```ruby KlaviyoAPI::Tags.get_tag_groups(opts) @@ -2380,7 +2428,7 @@ KlaviyoAPI::Tags.get_tag_groups(opts) -#### [Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_relationships_campaigns) +#### [Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_relationships_campaigns) ```ruby KlaviyoAPI::Tags.get_tag_relationships_campaigns(id) @@ -2390,7 +2438,7 @@ KlaviyoAPI::Tags.get_tag_relationships_campaigns(id) -#### [Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_relationships_flows) +#### [Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_relationships_flows) ```ruby KlaviyoAPI::Tags.get_tag_relationships_flows(id) @@ -2400,7 +2448,7 @@ KlaviyoAPI::Tags.get_tag_relationships_flows(id) -#### [Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_relationships_lists) +#### [Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_relationships_lists) ```ruby KlaviyoAPI::Tags.get_tag_relationships_lists(id) @@ -2410,7 +2458,7 @@ KlaviyoAPI::Tags.get_tag_relationships_lists(id) -#### [Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_relationships_segments) +#### [Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_relationships_segments) ```ruby KlaviyoAPI::Tags.get_tag_relationships_segments(id) @@ -2420,7 +2468,7 @@ KlaviyoAPI::Tags.get_tag_relationships_segments(id) -#### [Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_relationships_tag_group) +#### [Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_relationships_tag_group) ```ruby KlaviyoAPI::Tags.get_tag_relationships_tag_group(id) @@ -2430,7 +2478,7 @@ KlaviyoAPI::Tags.get_tag_relationships_tag_group(id) -#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_tag_group) +#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_tag_group) ```ruby KlaviyoAPI::Tags.get_tag_tag_group(id, opts) @@ -2440,7 +2488,7 @@ KlaviyoAPI::Tags.get_tag_tag_group(id, opts) -#### [Get Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tags) +#### [Get Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tags) ```ruby KlaviyoAPI::Tags.get_tags(opts) @@ -2450,7 +2498,7 @@ KlaviyoAPI::Tags.get_tags(opts) -#### [Update Tag](https://developers.klaviyo.com/en/v2023-12-15/reference/update_tag) +#### [Update Tag](https://developers.klaviyo.com/en/v2024-02-15/reference/update_tag) ```ruby KlaviyoAPI::Tags.update_tag(id, body) @@ -2460,7 +2508,7 @@ KlaviyoAPI::Tags.update_tag(id, body) -#### [Update Tag Group](https://developers.klaviyo.com/en/v2023-12-15/reference/update_tag_group) +#### [Update Tag Group](https://developers.klaviyo.com/en/v2024-02-15/reference/update_tag_group) ```ruby KlaviyoAPI::Tags.update_tag_group(id, body) @@ -2474,7 +2522,7 @@ KlaviyoAPI::Tags.update_tag_group(id, body) ## Templates -#### [Create Template](https://developers.klaviyo.com/en/v2023-12-15/reference/create_template) +#### [Create Template](https://developers.klaviyo.com/en/v2024-02-15/reference/create_template) ```ruby KlaviyoAPI::Templates.create_template(body) @@ -2484,7 +2532,7 @@ KlaviyoAPI::Templates.create_template(body) -#### [Create Template Clone](https://developers.klaviyo.com/en/v2023-12-15/reference/create_template_clone) +#### [Create Template Clone](https://developers.klaviyo.com/en/v2024-02-15/reference/create_template_clone) ```ruby KlaviyoAPI::Templates.create_template_clone(body) @@ -2494,7 +2542,7 @@ KlaviyoAPI::Templates.create_template_clone(body) -#### [Create Template Render](https://developers.klaviyo.com/en/v2023-12-15/reference/create_template_render) +#### [Create Template Render](https://developers.klaviyo.com/en/v2024-02-15/reference/create_template_render) ```ruby KlaviyoAPI::Templates.create_template_render(body) @@ -2504,7 +2552,7 @@ KlaviyoAPI::Templates.create_template_render(body) -#### [Delete Template](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_template) +#### [Delete Template](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_template) ```ruby KlaviyoAPI::Templates.delete_template(id) @@ -2514,7 +2562,7 @@ KlaviyoAPI::Templates.delete_template(id) -#### [Get Template](https://developers.klaviyo.com/en/v2023-12-15/reference/get_template) +#### [Get Template](https://developers.klaviyo.com/en/v2024-02-15/reference/get_template) ```ruby KlaviyoAPI::Templates.get_template(id, opts) @@ -2524,7 +2572,7 @@ KlaviyoAPI::Templates.get_template(id, opts) -#### [Get Templates](https://developers.klaviyo.com/en/v2023-12-15/reference/get_templates) +#### [Get Templates](https://developers.klaviyo.com/en/v2024-02-15/reference/get_templates) ```ruby KlaviyoAPI::Templates.get_templates(opts) @@ -2534,7 +2582,7 @@ KlaviyoAPI::Templates.get_templates(opts) -#### [Update Template](https://developers.klaviyo.com/en/v2023-12-15/reference/update_template) +#### [Update Template](https://developers.klaviyo.com/en/v2024-02-15/reference/update_template) ```ruby KlaviyoAPI::Templates.update_template(id, body) diff --git a/klaviyo-api-sdk.gemspec b/klaviyo-api-sdk.gemspec index 0100e20..fcc393d 100644 --- a/klaviyo-api-sdk.gemspec +++ b/klaviyo-api-sdk.gemspec @@ -5,7 +5,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -17,7 +17,7 @@ require "klaviyo-api-sdk/version" Gem::Specification.new do |s| s.name = "klaviyo-api-sdk" - s.version = "5.1.0" + s.version = "6.0.0" s.authors = ['Klaviyo Team'] s.email = ['libraries@klaviyo.com'] s.summary = 'You heard us, a Ruby wrapper for the Klaviyo API' diff --git a/lib/klaviyo-api-sdk.rb b/lib/klaviyo-api-sdk.rb index d45912b..5b731c0 100644 --- a/lib/klaviyo-api-sdk.rb +++ b/lib/klaviyo-api-sdk.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -53,6 +53,11 @@ require 'klaviyo-api-sdk/models/campaign_send_job_partial_update_query' require 'klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object' require 'klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes' +require 'klaviyo-api-sdk/models/campaign_values_report_enum' +require 'klaviyo-api-sdk/models/campaign_values_request_dto' +require 'klaviyo-api-sdk/models/campaign_values_request_dto_resource_object' +require 'klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes' +require 'klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe' require 'klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum' require 'klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum' require 'klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum' @@ -155,6 +160,7 @@ require 'klaviyo-api-sdk/models/coupon_update_query' require 'klaviyo-api-sdk/models/coupon_update_query_resource_object' require 'klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes' +require 'klaviyo-api-sdk/models/custom_timeframe' require 'klaviyo-api-sdk/models/data_privacy_create_deletion_job_query' require 'klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object' require 'klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes' @@ -174,9 +180,17 @@ require 'klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile' require 'klaviyo-api-sdk/models/event_enum' require 'klaviyo-api-sdk/models/flow_enum' +require 'klaviyo-api-sdk/models/flow_series_report_enum' +require 'klaviyo-api-sdk/models/flow_series_request_dto' +require 'klaviyo-api-sdk/models/flow_series_request_dto_resource_object' +require 'klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes' require 'klaviyo-api-sdk/models/flow_update_query' require 'klaviyo-api-sdk/models/flow_update_query_resource_object' require 'klaviyo-api-sdk/models/flow_update_query_resource_object_attributes' +require 'klaviyo-api-sdk/models/flow_values_report_enum' +require 'klaviyo-api-sdk/models/flow_values_request_dto' +require 'klaviyo-api-sdk/models/flow_values_request_dto_resource_object' +require 'klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes' require 'klaviyo-api-sdk/models/get_accounts4_xx_response' require 'klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner' require 'klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source' @@ -248,6 +262,7 @@ require 'klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes' require 'klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object' require 'klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes' +require 'klaviyo-api-sdk/models/profile_upsert_query' require 'klaviyo-api-sdk/models/profile_upsert_query_resource_object' require 'klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes' require 'klaviyo-api-sdk/models/push_token_create_query' @@ -335,6 +350,7 @@ require 'klaviyo-api-sdk/models/template_update_query_resource_object' require 'klaviyo-api-sdk/models/template_update_query_resource_object_attributes' require 'klaviyo-api-sdk/models/throttled_schedule_options' +require 'klaviyo-api-sdk/models/timeframe' require 'klaviyo-api-sdk/models/utm_params_sub_object' # APIs @@ -349,6 +365,7 @@ require 'klaviyo-api-sdk/api/lists_api' require 'klaviyo-api-sdk/api/metrics_api' require 'klaviyo-api-sdk/api/profiles_api' +require 'klaviyo-api-sdk/api/reporting_api' require 'klaviyo-api-sdk/api/segments_api' require 'klaviyo-api-sdk/api/tags_api' require 'klaviyo-api-sdk/api/templates_api' diff --git a/lib/klaviyo-api-sdk/api/accounts_api.rb b/lib/klaviyo-api-sdk/api/accounts_api.rb index 21f9d35..f769fd5 100644 --- a/lib/klaviyo-api-sdk/api/accounts_api.rb +++ b/lib/klaviyo-api-sdk/api/accounts_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -23,7 +23,7 @@ def initialize(api_client = ApiClient.default) # Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.

*Rate limits*:
Burst: `1/s`
Steady: `15/m` **Scopes:** `accounts:read` # @param id [String] The ID of the account # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_account(id, opts = {}) data, _status_code, _headers = get_account_with_http_info(id, opts) @@ -34,7 +34,7 @@ def get_account(id, opts = {}) # Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read` # @param id [String] The ID of the account # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_account_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -58,7 +58,7 @@ def get_account_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -94,7 +94,7 @@ def get_account_with_http_info(id, opts = {}) # Get Accounts # Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.

*Rate limits*:
Burst: `1/s`
Steady: `15/m` **Scopes:** `accounts:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_accounts(opts = {}) data, _status_code, _headers = get_accounts_with_http_info(opts) @@ -104,7 +104,7 @@ def get_accounts(opts = {}) # Get Accounts # Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_accounts_with_http_info(opts = {}) if @api_client.config.debugging @@ -124,7 +124,7 @@ def get_accounts_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) diff --git a/lib/klaviyo-api-sdk/api/campaigns_api.rb b/lib/klaviyo-api-sdk/api/campaigns_api.rb index 0d6fbf8..5a99e7e 100644 --- a/lib/klaviyo-api-sdk/api/campaigns_api.rb +++ b/lib/klaviyo-api-sdk/api/campaigns_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -51,7 +51,7 @@ def create_campaign_with_http_info(campaign_create_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -121,7 +121,7 @@ def create_campaign_clone_with_http_info(campaign_clone_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -191,7 +191,7 @@ def create_campaign_message_assign_template_with_http_info(campaign_message_assi # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -261,7 +261,7 @@ def create_campaign_recipient_estimation_job_with_http_info(campaign_recipient_e # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -331,7 +331,7 @@ def create_campaign_send_job_with_http_info(campaign_send_job_create_query, opts # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -401,7 +401,7 @@ def delete_campaign_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -438,10 +438,10 @@ def delete_campaign_with_http_info(id, opts = {}) # Returns a specific campaign based on a required id.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] The campaign ID to be retrieved # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_campaign(id, opts = {}) data, _status_code, _headers = get_campaign_with_http_info(id, opts) @@ -452,10 +452,10 @@ def get_campaign(id, opts = {}) # Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] The campaign ID to be retrieved # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_campaign_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -494,7 +494,7 @@ def get_campaign_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -531,10 +531,10 @@ def get_campaign_with_http_info(id, opts = {}) # Return all messages that belong to the given campaign.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_campaign_campaign_messages(id, opts = {}) data, _status_code, _headers = get_campaign_campaign_messages_with_http_info(id, opts) @@ -545,10 +545,10 @@ def get_campaign_campaign_messages(id, opts = {}) # Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_campaign_campaign_messages_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -587,7 +587,7 @@ def get_campaign_campaign_messages_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -624,10 +624,10 @@ def get_campaign_campaign_messages_with_http_info(id, opts = {}) # Returns a specific message based on a required id.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] The message ID to be retrieved # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_campaign_message(id, opts = {}) data, _status_code, _headers = get_campaign_message_with_http_info(id, opts) @@ -638,10 +638,10 @@ def get_campaign_message(id, opts = {}) # Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] The message ID to be retrieved # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_campaign_message_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -680,7 +680,7 @@ def get_campaign_message_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -717,7 +717,7 @@ def get_campaign_message_with_http_info(id, opts = {}) # Return the related campaign

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_campaign_message_campaign(id, opts = {}) data, _status_code, _headers = get_campaign_message_campaign_with_http_info(id, opts) @@ -728,7 +728,7 @@ def get_campaign_message_campaign(id, opts = {}) # Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_campaign_message_campaign_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -738,21 +738,21 @@ def get_campaign_message_campaign_with_http_info(id, opts = {}) if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message_campaign" end - allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "created_at", "updated_at"] - if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) } - fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}" + allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "tracking_options", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"] + if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) } + fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/campaign-messages/{id}/campaign/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} - query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil? + query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -817,7 +817,7 @@ def get_campaign_message_relationships_campaign_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -882,7 +882,7 @@ def get_campaign_message_relationships_template_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -919,7 +919,7 @@ def get_campaign_message_relationships_template_with_http_info(id, opts = {}) # Return the related template

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` `templates:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_campaign_message_template(id, opts = {}) data, _status_code, _headers = get_campaign_message_template_with_http_info(id, opts) @@ -930,7 +930,7 @@ def get_campaign_message_template(id, opts = {}) # Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_campaign_message_template_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -954,7 +954,7 @@ def get_campaign_message_template_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -991,7 +991,7 @@ def get_campaign_message_template_with_http_info(id, opts = {}) # Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] The ID of the campaign for which to get the estimated number of recipients # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_campaign_recipient_estimation(id, opts = {}) data, _status_code, _headers = get_campaign_recipient_estimation_with_http_info(id, opts) @@ -1002,7 +1002,7 @@ def get_campaign_recipient_estimation(id, opts = {}) # Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] The ID of the campaign for which to get the estimated number of recipients # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_campaign_recipient_estimation_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1026,7 +1026,7 @@ def get_campaign_recipient_estimation_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1063,7 +1063,7 @@ def get_campaign_recipient_estimation_with_http_info(id, opts = {}) # Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] The ID of the campaign to get recipient estimation status # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_campaign_recipient_estimation_job(id, opts = {}) data, _status_code, _headers = get_campaign_recipient_estimation_job_with_http_info(id, opts) @@ -1074,7 +1074,7 @@ def get_campaign_recipient_estimation_job(id, opts = {}) # Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] The ID of the campaign to get recipient estimation status # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_campaign_recipient_estimation_job_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1098,7 +1098,7 @@ def get_campaign_recipient_estimation_job_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1163,7 +1163,7 @@ def get_campaign_relationships_campaign_messages_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1228,7 +1228,7 @@ def get_campaign_relationships_tags_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1265,7 +1265,7 @@ def get_campaign_relationships_tags_with_http_info(id, opts = {}) # Get a campaign send job

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] The ID of the campaign to send # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_campaign_send_job(id, opts = {}) data, _status_code, _headers = get_campaign_send_job_with_http_info(id, opts) @@ -1276,7 +1276,7 @@ def get_campaign_send_job(id, opts = {}) # Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` # @param id [String] The ID of the campaign to send # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_campaign_send_job_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1300,7 +1300,7 @@ def get_campaign_send_job_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1337,7 +1337,7 @@ def get_campaign_send_job_with_http_info(id, opts = {}) # Return all tags that belong to the given campaign.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `campaigns:read` `tags:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_campaign_tags(id, opts = {}) data, _status_code, _headers = get_campaign_tags_with_http_info(id, opts) @@ -1348,7 +1348,7 @@ def get_campaign_tags(id, opts = {}) # Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_campaign_tags_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1372,7 +1372,7 @@ def get_campaign_tags_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1407,14 +1407,14 @@ def get_campaign_tags_with_http_info(id, opts = {}) # Get Campaigns # Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` - # @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_campaigns(filter, opts = {}) data, _status_code, _headers = get_campaigns_with_http_info(filter, opts) @@ -1423,14 +1423,14 @@ def get_campaigns(filter, opts = {}) # Get Campaigns # Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` - # @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_campaigns_with_http_info(filter, opts = {}) if @api_client.config.debugging @@ -1476,7 +1476,7 @@ def get_campaigns_with_http_info(filter, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1547,7 +1547,7 @@ def update_campaign_with_http_info(id, campaign_partial_update_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -1623,7 +1623,7 @@ def update_campaign_message_with_http_info(id, campaign_message_partial_update_q # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -1699,7 +1699,7 @@ def update_campaign_send_job_with_http_info(id, campaign_send_job_partial_update # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' diff --git a/lib/klaviyo-api-sdk/api/catalogs_api.rb b/lib/klaviyo-api-sdk/api/catalogs_api.rb index ca31ff6..a809a85 100644 --- a/lib/klaviyo-api-sdk/api/catalogs_api.rb +++ b/lib/klaviyo-api-sdk/api/catalogs_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -51,7 +51,7 @@ def create_back_in_stock_subscription_with_http_info(server_bis_subscription_cre # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -121,7 +121,7 @@ def create_catalog_category_with_http_info(catalog_category_create_query, opts = # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -197,7 +197,7 @@ def create_catalog_category_relationships_items_with_http_info(id, catalog_categ # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -267,7 +267,7 @@ def create_catalog_item_with_http_info(catalog_item_create_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -343,7 +343,7 @@ def create_catalog_item_relationships_categories_with_http_info(id, catalog_item # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -413,7 +413,7 @@ def create_catalog_variant_with_http_info(catalog_variant_create_query, opts = { # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -483,7 +483,7 @@ def delete_catalog_category_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -554,7 +554,7 @@ def delete_catalog_category_relationships_items_with_http_info(id, catalog_categ # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -624,7 +624,7 @@ def delete_catalog_item_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -695,7 +695,7 @@ def delete_catalog_item_relationships_categories_with_http_info(id, catalog_item # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -765,7 +765,7 @@ def delete_catalog_variant_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -801,10 +801,10 @@ def delete_catalog_variant_with_http_info(id, opts = {}) # Get Catalog Categories # Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 categories per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_catalog_categories(opts = {}) data, _status_code, _headers = get_catalog_categories_with_http_info(opts) @@ -814,10 +814,10 @@ def get_catalog_categories(opts = {}) # Get Catalog Categories # Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_catalog_categories_with_http_info(opts = {}) if @api_client.config.debugging @@ -844,7 +844,7 @@ def get_catalog_categories_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -881,7 +881,7 @@ def get_catalog_categories_with_http_info(opts = {}) # Get a catalog category with the given category ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_catalog_category(id, opts = {}) data, _status_code, _headers = get_catalog_category_with_http_info(id, opts) @@ -892,7 +892,7 @@ def get_catalog_category(id, opts = {}) # Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_catalog_category_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -916,7 +916,7 @@ def get_catalog_category_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -953,12 +953,12 @@ def get_catalog_category_with_http_info(id, opts = {}) # Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_catalog_category_items(id, opts = {}) data, _status_code, _headers = get_catalog_category_items_with_http_info(id, opts) @@ -969,12 +969,12 @@ def get_catalog_category_items(id, opts = {}) # Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_catalog_category_items_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1015,7 +1015,7 @@ def get_catalog_category_items_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1052,7 +1052,7 @@ def get_catalog_category_items_with_http_info(id, opts = {}) # Get all items in the given category ID. Returns a maximum of 100 items per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_catalog_category_relationships_items(id, opts = {}) data, _status_code, _headers = get_catalog_category_relationships_items_with_http_info(id, opts) @@ -1063,7 +1063,7 @@ def get_catalog_category_relationships_items(id, opts = {}) # Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_catalog_category_relationships_items_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1083,7 +1083,7 @@ def get_catalog_category_relationships_items_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1120,9 +1120,9 @@ def get_catalog_category_relationships_items_with_http_info(id, opts = {}) # Get a specific catalog item with the given item ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_catalog_item(id, opts = {}) data, _status_code, _headers = get_catalog_item_with_http_info(id, opts) @@ -1133,9 +1133,9 @@ def get_catalog_item(id, opts = {}) # Get a specific catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_catalog_item_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1169,7 +1169,7 @@ def get_catalog_item_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1206,10 +1206,10 @@ def get_catalog_item_with_http_info(id, opts = {}) # Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_catalog_item_categories(id, opts = {}) data, _status_code, _headers = get_catalog_item_categories_with_http_info(id, opts) @@ -1220,10 +1220,10 @@ def get_catalog_item_categories(id, opts = {}) # Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_catalog_item_categories_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1254,7 +1254,7 @@ def get_catalog_item_categories_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1291,7 +1291,7 @@ def get_catalog_item_categories_with_http_info(id, opts = {}) # Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_catalog_item_relationships_categories(id, opts = {}) data, _status_code, _headers = get_catalog_item_relationships_categories_with_http_info(id, opts) @@ -1302,7 +1302,7 @@ def get_catalog_item_relationships_categories(id, opts = {}) # Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_catalog_item_relationships_categories_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1322,7 +1322,7 @@ def get_catalog_item_relationships_categories_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1359,10 +1359,10 @@ def get_catalog_item_relationships_categories_with_http_info(id, opts = {}) # Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_catalog_item_variants(id, opts = {}) data, _status_code, _headers = get_catalog_item_variants_with_http_info(id, opts) @@ -1373,10 +1373,10 @@ def get_catalog_item_variants(id, opts = {}) # Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_catalog_item_variants_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1407,7 +1407,7 @@ def get_catalog_item_variants_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1443,12 +1443,12 @@ def get_catalog_item_variants_with_http_info(id, opts = {}) # Get Catalog Items # Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 items per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_catalog_items(opts = {}) data, _status_code, _headers = get_catalog_items_with_http_info(opts) @@ -1458,12 +1458,12 @@ def get_catalog_items(opts = {}) # Get Catalog Items # Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_catalog_items_with_http_info(opts = {}) if @api_client.config.debugging @@ -1500,7 +1500,7 @@ def get_catalog_items_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1537,7 +1537,7 @@ def get_catalog_items_with_http_info(opts = {}) # Get a catalog item variant with the given variant ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_catalog_variant(id, opts = {}) data, _status_code, _headers = get_catalog_variant_with_http_info(id, opts) @@ -1548,7 +1548,7 @@ def get_catalog_variant(id, opts = {}) # Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param id [String] The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_catalog_variant_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1572,7 +1572,7 @@ def get_catalog_variant_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1608,10 +1608,10 @@ def get_catalog_variant_with_http_info(id, opts = {}) # Get Catalog Variants # Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 variants per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_catalog_variants(opts = {}) data, _status_code, _headers = get_catalog_variants_with_http_info(opts) @@ -1621,10 +1621,10 @@ def get_catalog_variants(opts = {}) # Get Catalog Variants # Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_catalog_variants_with_http_info(opts = {}) if @api_client.config.debugging @@ -1651,7 +1651,7 @@ def get_catalog_variants_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1688,9 +1688,9 @@ def get_catalog_variants_with_http_info(opts = {}) # Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_create_categories_job(job_id, opts = {}) data, _status_code, _headers = get_create_categories_job_with_http_info(job_id, opts) @@ -1701,9 +1701,9 @@ def get_create_categories_job(job_id, opts = {}) # Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_create_categories_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @@ -1737,7 +1737,7 @@ def get_create_categories_job_with_http_info(job_id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1773,9 +1773,9 @@ def get_create_categories_job_with_http_info(job_id, opts = {}) # Get Create Categories Jobs # Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_create_categories_jobs(opts = {}) data, _status_code, _headers = get_create_categories_jobs_with_http_info(opts) @@ -1785,9 +1785,9 @@ def get_create_categories_jobs(opts = {}) # Get Create Categories Jobs # Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_create_categories_jobs_with_http_info(opts = {}) if @api_client.config.debugging @@ -1809,7 +1809,7 @@ def get_create_categories_jobs_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1846,9 +1846,9 @@ def get_create_categories_jobs_with_http_info(opts = {}) # Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_create_items_job(job_id, opts = {}) data, _status_code, _headers = get_create_items_job_with_http_info(job_id, opts) @@ -1859,9 +1859,9 @@ def get_create_items_job(job_id, opts = {}) # Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_create_items_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @@ -1895,7 +1895,7 @@ def get_create_items_job_with_http_info(job_id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1931,9 +1931,9 @@ def get_create_items_job_with_http_info(job_id, opts = {}) # Get Create Items Jobs # Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_create_items_jobs(opts = {}) data, _status_code, _headers = get_create_items_jobs_with_http_info(opts) @@ -1943,9 +1943,9 @@ def get_create_items_jobs(opts = {}) # Get Create Items Jobs # Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_create_items_jobs_with_http_info(opts = {}) if @api_client.config.debugging @@ -1967,7 +1967,7 @@ def get_create_items_jobs_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2004,9 +2004,9 @@ def get_create_items_jobs_with_http_info(opts = {}) # Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_create_variants_job(job_id, opts = {}) data, _status_code, _headers = get_create_variants_job_with_http_info(job_id, opts) @@ -2017,9 +2017,9 @@ def get_create_variants_job(job_id, opts = {}) # Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_create_variants_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @@ -2053,7 +2053,7 @@ def get_create_variants_job_with_http_info(job_id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2089,9 +2089,9 @@ def get_create_variants_job_with_http_info(job_id, opts = {}) # Get Create Variants Jobs # Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_create_variants_jobs(opts = {}) data, _status_code, _headers = get_create_variants_jobs_with_http_info(opts) @@ -2101,9 +2101,9 @@ def get_create_variants_jobs(opts = {}) # Get Create Variants Jobs # Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_create_variants_jobs_with_http_info(opts = {}) if @api_client.config.debugging @@ -2125,7 +2125,7 @@ def get_create_variants_jobs_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2162,7 +2162,7 @@ def get_create_variants_jobs_with_http_info(opts = {}) # Get a catalog category bulk delete job with the given job ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_delete_categories_job(job_id, opts = {}) data, _status_code, _headers = get_delete_categories_job_with_http_info(job_id, opts) @@ -2173,7 +2173,7 @@ def get_delete_categories_job(job_id, opts = {}) # Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_delete_categories_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @@ -2197,7 +2197,7 @@ def get_delete_categories_job_with_http_info(job_id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2233,9 +2233,9 @@ def get_delete_categories_job_with_http_info(job_id, opts = {}) # Get Delete Categories Jobs # Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_delete_categories_jobs(opts = {}) data, _status_code, _headers = get_delete_categories_jobs_with_http_info(opts) @@ -2245,9 +2245,9 @@ def get_delete_categories_jobs(opts = {}) # Get Delete Categories Jobs # Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_delete_categories_jobs_with_http_info(opts = {}) if @api_client.config.debugging @@ -2269,7 +2269,7 @@ def get_delete_categories_jobs_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2306,7 +2306,7 @@ def get_delete_categories_jobs_with_http_info(opts = {}) # Get a catalog item bulk delete job with the given job ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_delete_items_job(job_id, opts = {}) data, _status_code, _headers = get_delete_items_job_with_http_info(job_id, opts) @@ -2317,7 +2317,7 @@ def get_delete_items_job(job_id, opts = {}) # Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_delete_items_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @@ -2341,7 +2341,7 @@ def get_delete_items_job_with_http_info(job_id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2377,9 +2377,9 @@ def get_delete_items_job_with_http_info(job_id, opts = {}) # Get Delete Items Jobs # Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_delete_items_jobs(opts = {}) data, _status_code, _headers = get_delete_items_jobs_with_http_info(opts) @@ -2389,9 +2389,9 @@ def get_delete_items_jobs(opts = {}) # Get Delete Items Jobs # Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_delete_items_jobs_with_http_info(opts = {}) if @api_client.config.debugging @@ -2413,7 +2413,7 @@ def get_delete_items_jobs_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2450,7 +2450,7 @@ def get_delete_items_jobs_with_http_info(opts = {}) # Get a catalog variant bulk delete job with the given job ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_delete_variants_job(job_id, opts = {}) data, _status_code, _headers = get_delete_variants_job_with_http_info(job_id, opts) @@ -2461,7 +2461,7 @@ def get_delete_variants_job(job_id, opts = {}) # Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_delete_variants_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @@ -2485,7 +2485,7 @@ def get_delete_variants_job_with_http_info(job_id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2521,9 +2521,9 @@ def get_delete_variants_job_with_http_info(job_id, opts = {}) # Get Delete Variants Jobs # Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_delete_variants_jobs(opts = {}) data, _status_code, _headers = get_delete_variants_jobs_with_http_info(opts) @@ -2533,9 +2533,9 @@ def get_delete_variants_jobs(opts = {}) # Get Delete Variants Jobs # Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_delete_variants_jobs_with_http_info(opts = {}) if @api_client.config.debugging @@ -2557,7 +2557,7 @@ def get_delete_variants_jobs_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2594,9 +2594,9 @@ def get_delete_variants_jobs_with_http_info(opts = {}) # Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_update_categories_job(job_id, opts = {}) data, _status_code, _headers = get_update_categories_job_with_http_info(job_id, opts) @@ -2607,9 +2607,9 @@ def get_update_categories_job(job_id, opts = {}) # Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_update_categories_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @@ -2643,7 +2643,7 @@ def get_update_categories_job_with_http_info(job_id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2679,9 +2679,9 @@ def get_update_categories_job_with_http_info(job_id, opts = {}) # Get Update Categories Jobs # Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_update_categories_jobs(opts = {}) data, _status_code, _headers = get_update_categories_jobs_with_http_info(opts) @@ -2691,9 +2691,9 @@ def get_update_categories_jobs(opts = {}) # Get Update Categories Jobs # Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_update_categories_jobs_with_http_info(opts = {}) if @api_client.config.debugging @@ -2715,7 +2715,7 @@ def get_update_categories_jobs_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2752,9 +2752,9 @@ def get_update_categories_jobs_with_http_info(opts = {}) # Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_update_items_job(job_id, opts = {}) data, _status_code, _headers = get_update_items_job_with_http_info(job_id, opts) @@ -2765,9 +2765,9 @@ def get_update_items_job(job_id, opts = {}) # Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_update_items_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @@ -2801,7 +2801,7 @@ def get_update_items_job_with_http_info(job_id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2837,9 +2837,9 @@ def get_update_items_job_with_http_info(job_id, opts = {}) # Get Update Items Jobs # Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_update_items_jobs(opts = {}) data, _status_code, _headers = get_update_items_jobs_with_http_info(opts) @@ -2849,9 +2849,9 @@ def get_update_items_jobs(opts = {}) # Get Update Items Jobs # Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_update_items_jobs_with_http_info(opts = {}) if @api_client.config.debugging @@ -2873,7 +2873,7 @@ def get_update_items_jobs_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2910,9 +2910,9 @@ def get_update_items_jobs_with_http_info(opts = {}) # Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_update_variants_job(job_id, opts = {}) data, _status_code, _headers = get_update_variants_job_with_http_info(job_id, opts) @@ -2923,9 +2923,9 @@ def get_update_variants_job(job_id, opts = {}) # Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_update_variants_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @@ -2959,7 +2959,7 @@ def get_update_variants_job_with_http_info(job_id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -2995,9 +2995,9 @@ def get_update_variants_job_with_http_info(job_id, opts = {}) # Get Update Variants Jobs # Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_update_variants_jobs(opts = {}) data, _status_code, _headers = get_update_variants_jobs_with_http_info(opts) @@ -3007,9 +3007,9 @@ def get_update_variants_jobs(opts = {}) # Get Update Variants Jobs # Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_update_variants_jobs_with_http_info(opts = {}) if @api_client.config.debugging @@ -3031,7 +3031,7 @@ def get_update_variants_jobs_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -3096,7 +3096,7 @@ def spawn_create_categories_job_with_http_info(catalog_category_create_job_creat # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -3166,7 +3166,7 @@ def spawn_create_items_job_with_http_info(catalog_item_create_job_create_query, # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -3236,7 +3236,7 @@ def spawn_create_variants_job_with_http_info(catalog_variant_create_job_create_q # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -3306,7 +3306,7 @@ def spawn_delete_categories_job_with_http_info(catalog_category_delete_job_creat # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -3376,7 +3376,7 @@ def spawn_delete_items_job_with_http_info(catalog_item_delete_job_create_query, # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -3446,7 +3446,7 @@ def spawn_delete_variants_job_with_http_info(catalog_variant_delete_job_create_q # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -3516,7 +3516,7 @@ def spawn_update_categories_job_with_http_info(catalog_category_update_job_creat # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -3586,7 +3586,7 @@ def spawn_update_items_job_with_http_info(catalog_item_update_job_create_query, # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -3656,7 +3656,7 @@ def spawn_update_variants_job_with_http_info(catalog_variant_update_job_create_q # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -3732,7 +3732,7 @@ def update_catalog_category_with_http_info(id, catalog_category_update_query, op # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -3808,7 +3808,7 @@ def update_catalog_category_relationships_items_with_http_info(id, catalog_categ # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -3884,7 +3884,7 @@ def update_catalog_item_with_http_info(id, catalog_item_update_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -3960,7 +3960,7 @@ def update_catalog_item_relationships_categories_with_http_info(id, catalog_item # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -4036,7 +4036,7 @@ def update_catalog_variant_with_http_info(id, catalog_variant_update_query, opts # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' diff --git a/lib/klaviyo-api-sdk/api/coupons_api.rb b/lib/klaviyo-api-sdk/api/coupons_api.rb index cb0683f..61baf8f 100644 --- a/lib/klaviyo-api-sdk/api/coupons_api.rb +++ b/lib/klaviyo-api-sdk/api/coupons_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -51,7 +51,7 @@ def create_coupon_with_http_info(coupon_create_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -121,7 +121,7 @@ def create_coupon_code_with_http_info(coupon_code_create_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -191,7 +191,7 @@ def delete_coupon_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -256,7 +256,7 @@ def delete_coupon_code_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -293,7 +293,7 @@ def delete_coupon_code_with_http_info(id, opts = {}) # Get a specific coupon with the given coupon ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupons:read` # @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_coupon(id, opts = {}) data, _status_code, _headers = get_coupon_with_http_info(id, opts) @@ -304,7 +304,7 @@ def get_coupon(id, opts = {}) # Get a specific coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read` # @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_coupon_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -328,7 +328,7 @@ def get_coupon_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -365,9 +365,9 @@ def get_coupon_with_http_info(id, opts = {}) # Returns a Coupon Code specified by the given identifier.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `coupon-codes:read` # @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. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_coupon_code(id, opts = {}) data, _status_code, _headers = get_coupon_code_with_http_info(id, opts) @@ -378,9 +378,9 @@ def get_coupon_code(id, opts = {}) # 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` # @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. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_coupon_code_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -414,7 +414,7 @@ def get_coupon_code_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -451,9 +451,9 @@ def get_coupon_code_with_http_info(id, opts = {}) # Get a coupon code bulk create job with the given job ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupon-codes:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_coupon_code_bulk_create_job(job_id, opts = {}) data, _status_code, _headers = get_coupon_code_bulk_create_job_with_http_info(job_id, opts) @@ -464,9 +464,9 @@ def get_coupon_code_bulk_create_job(job_id, opts = {}) # 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` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_coupon_code_bulk_create_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @@ -500,7 +500,7 @@ def get_coupon_code_bulk_create_job_with_http_info(job_id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -536,9 +536,9 @@ def get_coupon_code_bulk_create_job_with_http_info(job_id, opts = {}) # Get Coupon Code Bulk Create Jobs # Get all coupon code bulk create jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupon-codes:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_coupon_code_bulk_create_jobs(opts = {}) data, _status_code, _headers = get_coupon_code_bulk_create_jobs_with_http_info(opts) @@ -548,9 +548,9 @@ def get_coupon_code_bulk_create_jobs(opts = {}) # Get Coupon Code Bulk Create Jobs # 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` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_coupon_code_bulk_create_jobs_with_http_info(opts = {}) if @api_client.config.debugging @@ -572,7 +572,7 @@ def get_coupon_code_bulk_create_jobs_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -609,7 +609,7 @@ def get_coupon_code_bulk_create_jobs_with_http_info(opts = {}) # Gets a list of coupon code relationships associated with the given coupon id

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupon-codes:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_coupon_code_relationships_coupon(id, opts = {}) data, _status_code, _headers = get_coupon_code_relationships_coupon_with_http_info(id, opts) @@ -620,7 +620,7 @@ def get_coupon_code_relationships_coupon(id, opts = {}) # 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` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_coupon_code_relationships_coupon_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -640,7 +640,7 @@ def get_coupon_code_relationships_coupon_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -676,11 +676,11 @@ def get_coupon_code_relationships_coupon_with_http_info(id, opts = {}) # Get Coupon Codes # 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.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `coupon-codes:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-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` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-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` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_coupon_codes(opts = {}) data, _status_code, _headers = get_coupon_codes_with_http_info(opts) @@ -690,11 +690,11 @@ def get_coupon_codes(opts = {}) # Get Coupon Codes # 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` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-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` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-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` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_coupon_codes_with_http_info(opts = {}) if @api_client.config.debugging @@ -726,7 +726,7 @@ def get_coupon_codes_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -763,9 +763,9 @@ def get_coupon_codes_with_http_info(opts = {}) # Gets a list of coupon codes associated with the given coupon id

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupon-codes:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-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` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-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` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_coupon_codes_for_coupon(id, opts = {}) data, _status_code, _headers = get_coupon_codes_for_coupon_with_http_info(id, opts) @@ -776,9 +776,9 @@ def get_coupon_codes_for_coupon(id, opts = {}) # 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` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-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` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-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` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_coupon_codes_for_coupon_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -804,7 +804,7 @@ def get_coupon_codes_for_coupon_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -841,7 +841,7 @@ def get_coupon_codes_for_coupon_with_http_info(id, opts = {}) # Gets a list of coupon codes associated with the given coupon id

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupons:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_coupon_for_coupon_code(id, opts = {}) data, _status_code, _headers = get_coupon_for_coupon_code_with_http_info(id, opts) @@ -852,7 +852,7 @@ def get_coupon_for_coupon_code(id, opts = {}) # 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:** `coupons:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_coupon_for_coupon_code_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -876,7 +876,7 @@ def get_coupon_for_coupon_code_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -941,7 +941,7 @@ def get_coupon_relationships_coupon_codes_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -977,8 +977,8 @@ def get_coupon_relationships_coupon_codes_with_http_info(id, opts = {}) # Get Coupons # Get all coupons in an account. To learn more, see our [Coupons API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api).

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupons:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_coupons(opts = {}) data, _status_code, _headers = get_coupons_with_http_info(opts) @@ -988,8 +988,8 @@ def get_coupons(opts = {}) # Get Coupons # 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` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_coupons_with_http_info(opts = {}) if @api_client.config.debugging @@ -1010,7 +1010,7 @@ def get_coupons_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1075,7 +1075,7 @@ def spawn_coupon_code_bulk_create_job_with_http_info(coupon_code_create_job_crea # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -1151,7 +1151,7 @@ def update_coupon_with_http_info(id, coupon_update_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -1227,7 +1227,7 @@ def update_coupon_code_with_http_info(id, coupon_code_update_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' diff --git a/lib/klaviyo-api-sdk/api/data_privacy_api.rb b/lib/klaviyo-api-sdk/api/data_privacy_api.rb index d73a6f1..b8061bc 100644 --- a/lib/klaviyo-api-sdk/api/data_privacy_api.rb +++ b/lib/klaviyo-api-sdk/api/data_privacy_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -51,7 +51,7 @@ def request_profile_deletion_with_http_info(data_privacy_create_deletion_job_que # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' diff --git a/lib/klaviyo-api-sdk/api/events_api.rb b/lib/klaviyo-api-sdk/api/events_api.rb index 79c3477..5511d5e 100644 --- a/lib/klaviyo-api-sdk/api/events_api.rb +++ b/lib/klaviyo-api-sdk/api/events_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -51,7 +51,7 @@ def create_event_with_http_info(event_create_query_v2, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -93,10 +93,10 @@ def create_event_with_http_info(event_create_query_v2, opts = {}) # Get an event with the given event ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `events:read` # @param id [String] ID of the event # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_event For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_event(id, opts = {}) data, _status_code, _headers = get_event_with_http_info(id, opts) @@ -107,10 +107,10 @@ def get_event(id, opts = {}) # Get an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `events:read` # @param id [String] ID of the event # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_event For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_event_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -132,7 +132,7 @@ def get_event_with_http_info(id, opts = {}) if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}" end - allowable_values = ["metric", "profile"] + allowable_values = ["attributions", "metric", "profile"] if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}" end @@ -149,7 +149,7 @@ def get_event_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -186,7 +186,7 @@ def get_event_with_http_info(id, opts = {}) # Get the metric for an event with the given event ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `events:read` `metrics:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_event_metric(id, opts = {}) data, _status_code, _headers = get_event_metric_with_http_info(id, opts) @@ -197,7 +197,7 @@ def get_event_metric(id, opts = {}) # Get the metric for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `metrics:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_event_metric_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -221,7 +221,7 @@ def get_event_metric_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -259,7 +259,7 @@ def get_event_metric_with_http_info(id, opts = {}) # @param id [String] # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_event_profile(id, opts = {}) data, _status_code, _headers = get_event_profile_with_http_info(id, opts) @@ -271,7 +271,7 @@ def get_event_profile(id, opts = {}) # @param id [String] # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_event_profile_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -300,7 +300,7 @@ def get_event_profile_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -365,7 +365,7 @@ def get_event_relationships_metric_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -430,7 +430,7 @@ def get_event_relationships_profile_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -466,13 +466,13 @@ def get_event_relationships_profile_with_http_info(id, opts = {}) # Get Events # Get all events in an account Requests can be sorted by the following fields: `datetime`, `timestamp` Returns a maximum of 200 events per page.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `events:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`profile`: `has`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_event For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`profile`: `has`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_events(opts = {}) data, _status_code, _headers = get_events_with_http_info(opts) @@ -482,13 +482,13 @@ def get_events(opts = {}) # Get Events # Get all events in an account Requests can be sorted by the following fields: `datetime`, `timestamp` Returns a maximum of 200 events per page.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`profile`: `has`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_event For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`profile`: `has`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_events_with_http_info(opts = {}) if @api_client.config.debugging @@ -506,7 +506,7 @@ def get_events_with_http_info(opts = {}) if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}" end - allowable_values = ["metric", "profile"] + allowable_values = ["attributions", "metric", "profile"] if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}" end @@ -530,7 +530,7 @@ def get_events_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) diff --git a/lib/klaviyo-api-sdk/api/flows_api.rb b/lib/klaviyo-api-sdk/api/flows_api.rb index 8037fa2..95da165 100644 --- a/lib/klaviyo-api-sdk/api/flows_api.rb +++ b/lib/klaviyo-api-sdk/api/flows_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -23,10 +23,10 @@ def initialize(api_client = ApiClient.default) # Get a flow with the given flow ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_flow(id, opts = {}) data, _status_code, _headers = get_flow_with_http_info(id, opts) @@ -37,10 +37,10 @@ def get_flow(id, opts = {}) # Get a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_flow_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -79,7 +79,7 @@ def get_flow_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -116,10 +116,10 @@ def get_flow_with_http_info(id, opts = {}) # Get a flow action from a flow with the given flow action ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_flow_action(id, opts = {}) data, _status_code, _headers = get_flow_action_with_http_info(id, opts) @@ -130,10 +130,10 @@ def get_flow_action(id, opts = {}) # Get a flow action from a flow with the given flow action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_flow_action_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -172,7 +172,7 @@ def get_flow_action_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -209,7 +209,7 @@ def get_flow_action_with_http_info(id, opts = {}) # Get the flow associated with the given action ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_flow_action_flow(id, opts = {}) data, _status_code, _headers = get_flow_action_flow_with_http_info(id, opts) @@ -220,7 +220,7 @@ def get_flow_action_flow(id, opts = {}) # Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_flow_action_flow_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -244,7 +244,7 @@ def get_flow_action_flow_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -281,10 +281,10 @@ def get_flow_action_flow_with_http_info(id, opts = {}) # Get all flow messages associated with the given action ID. Flow messages can be sorted by the following fields, in ascending and descending order: ascending: `id`, `name`, `created`, `updated` descending: `-id`, `-name`, `-created`, `-updated` Returns a maximum of 50 flows per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [Array] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` # @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_flow_action_messages(id, opts = {}) data, _status_code, _headers = get_flow_action_messages_with_http_info(id, opts) @@ -295,10 +295,10 @@ def get_flow_action_messages(id, opts = {}) # Get all flow messages associated with the given action ID. Flow messages can be sorted by the following fields, in ascending and descending order: ascending: `id`, `name`, `created`, `updated` descending: `-id`, `-name`, `-created`, `-updated` Returns a maximum of 50 flows per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [Array] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` # @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_flow_action_messages_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -337,7 +337,7 @@ def get_flow_action_messages_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -402,7 +402,7 @@ def get_flow_action_relationships_flow_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -439,10 +439,10 @@ def get_flow_action_relationships_flow_with_http_info(id, opts = {}) # Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_flow_action_relationships_messages(id, opts = {}) data, _status_code, _headers = get_flow_action_relationships_messages_with_http_info(id, opts) @@ -453,10 +453,10 @@ def get_flow_action_relationships_messages(id, opts = {}) # Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_flow_action_relationships_messages_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -491,7 +491,7 @@ def get_flow_action_relationships_messages_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -528,11 +528,11 @@ def get_flow_action_relationships_messages_with_http_info(id, opts = {}) # Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_flow_flow_actions(id, opts = {}) data, _status_code, _headers = get_flow_flow_actions_with_http_info(id, opts) @@ -543,11 +543,11 @@ def get_flow_flow_actions(id, opts = {}) # Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_flow_flow_actions_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -587,7 +587,7 @@ def get_flow_flow_actions_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -624,10 +624,10 @@ def get_flow_flow_actions_with_http_info(id, opts = {}) # Get the flow message of a flow with the given message ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_flow_message(id, opts = {}) data, _status_code, _headers = get_flow_message_with_http_info(id, opts) @@ -638,10 +638,10 @@ def get_flow_message(id, opts = {}) # Get the flow message of a flow with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_flow_message_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -680,7 +680,7 @@ def get_flow_message_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -717,7 +717,7 @@ def get_flow_message_with_http_info(id, opts = {}) # Get the flow action for a flow message with the given message ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_flow_message_action(id, opts = {}) data, _status_code, _headers = get_flow_message_action_with_http_info(id, opts) @@ -728,7 +728,7 @@ def get_flow_message_action(id, opts = {}) # Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_flow_message_action_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -752,7 +752,7 @@ def get_flow_message_action_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -817,7 +817,7 @@ def get_flow_message_relationships_action_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -882,7 +882,7 @@ def get_flow_message_relationships_template_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -919,7 +919,7 @@ def get_flow_message_relationships_template_with_http_info(id, opts = {}) # Return the related template

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `templates:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_flow_message_template(id, opts = {}) data, _status_code, _headers = get_flow_message_template_with_http_info(id, opts) @@ -930,7 +930,7 @@ def get_flow_message_template(id, opts = {}) # Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_flow_message_template_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -954,7 +954,7 @@ def get_flow_message_template_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -991,9 +991,9 @@ def get_flow_message_template_with_http_info(id, opts = {}) # Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`action_type`: `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`action_type`: `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` # @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_flow_relationships_flow_actions(id, opts = {}) data, _status_code, _headers = get_flow_relationships_flow_actions_with_http_info(id, opts) @@ -1004,9 +1004,9 @@ def get_flow_relationships_flow_actions(id, opts = {}) # Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`action_type`: `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`action_type`: `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` # @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_flow_relationships_flow_actions_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1040,7 +1040,7 @@ def get_flow_relationships_flow_actions_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1105,7 +1105,7 @@ def get_flow_relationships_tags_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1142,7 +1142,7 @@ def get_flow_relationships_tags_with_http_info(id, opts = {}) # Return all tags associated with the given flow ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` `tags:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_flow_tags(id, opts = {}) data, _status_code, _headers = get_flow_tags_with_http_info(id, opts) @@ -1153,7 +1153,7 @@ def get_flow_tags(id, opts = {}) # Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_flow_tags_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1177,7 +1177,7 @@ def get_flow_tags_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1213,14 +1213,14 @@ def get_flow_tags_with_http_info(id, opts = {}) # Get Flows # Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_flows(opts = {}) data, _status_code, _headers = get_flows_with_http_info(opts) @@ -1230,14 +1230,14 @@ def get_flows(opts = {}) # Get Flows # Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_flows_with_http_info(opts = {}) if @api_client.config.debugging @@ -1288,7 +1288,7 @@ def get_flows_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1359,7 +1359,7 @@ def update_flow_with_http_info(id, flow_update_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' diff --git a/lib/klaviyo-api-sdk/api/images_api.rb b/lib/klaviyo-api-sdk/api/images_api.rb index 6dab9ee..24422f4 100644 --- a/lib/klaviyo-api-sdk/api/images_api.rb +++ b/lib/klaviyo-api-sdk/api/images_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -23,7 +23,7 @@ def initialize(api_client = ApiClient.default) # Get the image with the given image ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `images:read` # @param id [String] The ID of the image # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_image For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_image(id, opts = {}) data, _status_code, _headers = get_image_with_http_info(id, opts) @@ -34,7 +34,7 @@ def get_image(id, opts = {}) # Get the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read` # @param id [String] The ID of the image # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_image For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_image_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -58,7 +58,7 @@ def get_image_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -94,11 +94,11 @@ def get_image_with_http_info(id, opts = {}) # Get Images # Get all images in an account.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `images:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_image For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_images(opts = {}) data, _status_code, _headers = get_images_with_http_info(opts) @@ -108,11 +108,11 @@ def get_images(opts = {}) # Get Images # Get all images in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_image For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_images_with_http_info(opts = {}) if @api_client.config.debugging @@ -148,7 +148,7 @@ def get_images_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -219,7 +219,7 @@ def update_image_with_http_info(id, image_partial_update_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -293,7 +293,7 @@ def upload_image_from_file_with_http_info(file, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -366,7 +366,7 @@ def upload_image_from_url_with_http_info(image_create_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' diff --git a/lib/klaviyo-api-sdk/api/lists_api.rb b/lib/klaviyo-api-sdk/api/lists_api.rb index 2c6da64..740c75c 100644 --- a/lib/klaviyo-api-sdk/api/lists_api.rb +++ b/lib/klaviyo-api-sdk/api/lists_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -51,7 +51,7 @@ def create_list_with_http_info(list_create_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -127,7 +127,7 @@ def create_list_relationships_with_http_info(id, list_members_add_query, opts = # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -197,7 +197,7 @@ def delete_list_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -268,7 +268,7 @@ def delete_list_relationships_with_http_info(id, list_members_delete_query, opts # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -307,13 +307,13 @@ def delete_list_relationships_with_http_info(id, list_members_delete_query, opts end # Get List - # Get a list with the given list ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:
Burst: `1/s`
Steady: `15/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` + # Get a list with the given list ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:
Burst: `1/s`
Steady: `15/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` # @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo. # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_list Request additional fields not included by default in the response. Supported values: 'profile_count' - # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_list(id, opts = {}) data, _status_code, _headers = get_list_with_http_info(id, opts) @@ -321,13 +321,13 @@ def get_list(id, opts = {}) end # Get List - # Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` + # Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` # @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo. # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_list Request additional fields not included by default in the response. Supported values: 'profile_count' - # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_list_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -341,7 +341,7 @@ def get_list_with_http_info(id, opts = {}) if @api_client.config.client_side_validation && opts[:'additional_fields_list'] && !opts[:'additional_fields_list'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"additional_fields_list\", must include one of #{allowable_values}" end - allowable_values = ["name", "created", "updated", "profile_count"] + allowable_values = ["name", "created", "updated", "opt_in_process", "profile_count"] if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}" end @@ -366,7 +366,7 @@ def get_list_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -400,15 +400,15 @@ def get_list_with_http_info(id, opts = {}) end # Get List Profiles - # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:
Burst: `10/s`
Steady: `150/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read` + # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:
Burst: `10/s`
Steady: `150/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read` # @param id [String] # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_list_profiles(id, opts = {}) data, _status_code, _headers = get_list_profiles_with_http_info(id, opts) @@ -416,15 +416,15 @@ def get_list_profiles(id, opts = {}) end # Get List Profiles - # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read` + # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read` # @param id [String] # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_list_profiles_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -469,7 +469,7 @@ def get_list_profiles_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -506,10 +506,10 @@ def get_list_profiles_with_http_info(id, opts = {}) # Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `lists:read` `profiles:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 1000. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_list_relationships_profiles(id, opts = {}) data, _status_code, _headers = get_list_relationships_profiles_with_http_info(id, opts) @@ -520,10 +520,10 @@ def get_list_relationships_profiles(id, opts = {}) # Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:read` `profiles:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 1000. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_list_relationships_profiles_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -558,7 +558,7 @@ def get_list_relationships_profiles_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -623,7 +623,7 @@ def get_list_relationships_tags_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -660,7 +660,7 @@ def get_list_relationships_tags_with_http_info(id, opts = {}) # Return all tags associated with the given list ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `lists:read` `tags:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_list_tags(id, opts = {}) data, _status_code, _headers = get_list_tags_with_http_info(id, opts) @@ -671,7 +671,7 @@ def get_list_tags(id, opts = {}) # Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_list_tags_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -695,7 +695,7 @@ def get_list_tags_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -731,11 +731,11 @@ def get_list_tags_with_http_info(id, opts = {}) # Get Lists # Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `lists:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_lists(opts = {}) data, _status_code, _headers = get_lists_with_http_info(opts) @@ -745,17 +745,17 @@ def get_lists(opts = {}) # Get Lists # Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_lists_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ListsApi.get_lists ...' end - allowable_values = ["name", "created", "updated"] + allowable_values = ["name", "created", "updated", "opt_in_process"] if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}" end @@ -781,7 +781,7 @@ def get_lists_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -852,7 +852,7 @@ def update_list_with_http_info(id, list_partial_update_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' diff --git a/lib/klaviyo-api-sdk/api/metrics_api.rb b/lib/klaviyo-api-sdk/api/metrics_api.rb index 49bf3d4..146a4a2 100644 --- a/lib/klaviyo-api-sdk/api/metrics_api.rb +++ b/lib/klaviyo-api-sdk/api/metrics_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -23,7 +23,7 @@ def initialize(api_client = ApiClient.default) # Get a metric with the given metric ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `metrics:read` # @param id [String] Metric ID # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_metric(id, opts = {}) data, _status_code, _headers = get_metric_with_http_info(id, opts) @@ -34,7 +34,7 @@ def get_metric(id, opts = {}) # Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read` # @param id [String] Metric ID # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_metric_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -58,7 +58,7 @@ def get_metric_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -94,9 +94,9 @@ def get_metric_with_http_info(id, opts = {}) # Get Metrics # Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `metrics:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_metrics(opts = {}) data, _status_code, _headers = get_metrics_with_http_info(opts) @@ -106,9 +106,9 @@ def get_metrics(opts = {}) # Get Metrics # Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_metrics_with_http_info(opts = {}) if @api_client.config.debugging @@ -130,7 +130,7 @@ def get_metrics_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -195,7 +195,7 @@ def query_metric_aggregates_with_http_info(metric_aggregate_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' diff --git a/lib/klaviyo-api-sdk/api/profiles_api.rb b/lib/klaviyo-api-sdk/api/profiles_api.rb index 3c805dc..8658b18 100644 --- a/lib/klaviyo-api-sdk/api/profiles_api.rb +++ b/lib/klaviyo-api-sdk/api/profiles_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -19,6 +19,76 @@ class ProfilesApi def initialize(api_client = ApiClient.default) @api_client = api_client end + # Create or Update Profile + # Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `profiles:write` + # @param profile_upsert_query [ProfileUpsertQuery] + # @param [Hash] opts the optional parameters + # @return [Hash] + def create_or_update_profile(profile_upsert_query, opts = {}) + data, _status_code, _headers = create_or_update_profile_with_http_info(profile_upsert_query, opts) + data + end + + # Create or Update Profile + # Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` + # @param profile_upsert_query [ProfileUpsertQuery] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def create_or_update_profile_with_http_info(profile_upsert_query, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: ProfilesApi.create_or_update_profile ...' + end + # verify the required parameter 'profile_upsert_query' is set + if @api_client.config.client_side_validation && profile_upsert_query.nil? + fail ArgumentError, "Missing the required parameter 'profile_upsert_query' when calling ProfilesApi.create_or_update_profile" + end + # resource path + local_var_path = '/api/profile-import/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # klaviyo api revision + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_upsert_query) + + # return_type + return_type = opts[:debug_return_type] || 'Hash' + + # auth_names + auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] + + new_options = opts.merge( + :operation => :"ProfilesApi.create_or_update_profile", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ProfilesApi#create_or_update_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Create Profile # Create a new profile. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `profiles:write` # @param profile_create_query [ProfileCreateQuery] @@ -51,7 +121,7 @@ def create_profile_with_http_info(profile_create_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -121,7 +191,7 @@ def create_push_token_with_http_info(push_token_create_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -163,9 +233,9 @@ def create_push_token_with_http_info(push_token_create_query, opts = {}) # Get a bulk profile import job with the given job ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `lists:read` `profiles:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_bulk_profile_import_job(job_id, opts = {}) data, _status_code, _headers = get_bulk_profile_import_job_with_http_info(job_id, opts) @@ -176,9 +246,9 @@ def get_bulk_profile_import_job(job_id, opts = {}) # Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read` # @param job_id [String] ID of the job to retrieve. # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_bulk_profile_import_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @@ -188,7 +258,7 @@ def get_bulk_profile_import_job_with_http_info(job_id, opts = {}) if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_profile_import_job" end - allowable_values = ["name", "created", "updated"] + allowable_values = ["name", "created", "updated", "opt_in_process"] if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}" end @@ -212,7 +282,7 @@ def get_bulk_profile_import_job_with_http_info(job_id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -245,12 +315,12 @@ def get_bulk_profile_import_job_with_http_info(job_id, opts = {}) return data, status_code, headers end - # Get Bulk Profile Import Job Import Errors + # Get Bulk Profile Import Job Errors # Get import errors for the bulk profile import job with the given ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `profiles:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) # @return [Hash] def get_bulk_profile_import_job_import_errors(id, opts = {}) @@ -258,12 +328,12 @@ def get_bulk_profile_import_job_import_errors(id, opts = {}) data end - # Get Bulk Profile Import Job Import Errors + # Get Bulk Profile Import Job Errors # Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_bulk_profile_import_job_import_errors_with_http_info(id, opts = {}) @@ -298,7 +368,7 @@ def get_bulk_profile_import_job_import_errors_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -335,7 +405,7 @@ def get_bulk_profile_import_job_import_errors_with_http_info(id, opts = {}) # Get list for the bulk profile import job with the given ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `lists:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_bulk_profile_import_job_lists(id, opts = {}) data, _status_code, _headers = get_bulk_profile_import_job_lists_with_http_info(id, opts) @@ -346,7 +416,7 @@ def get_bulk_profile_import_job_lists(id, opts = {}) # Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_bulk_profile_import_job_lists_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -356,7 +426,7 @@ def get_bulk_profile_import_job_lists_with_http_info(id, opts = {}) if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_lists" end - allowable_values = ["name", "created", "updated"] + allowable_values = ["name", "created", "updated", "opt_in_process"] if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}" end @@ -370,7 +440,7 @@ def get_bulk_profile_import_job_lists_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -408,8 +478,8 @@ def get_bulk_profile_import_job_lists_with_http_info(id, opts = {}) # @param id [String] # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) # @return [Hash] def get_bulk_profile_import_job_profiles(id, opts = {}) @@ -422,8 +492,8 @@ def get_bulk_profile_import_job_profiles(id, opts = {}) # @param id [String] # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_bulk_profile_import_job_profiles_with_http_info(id, opts = {}) @@ -463,7 +533,7 @@ def get_bulk_profile_import_job_profiles_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -528,7 +598,7 @@ def get_bulk_profile_import_job_relationships_lists_with_http_info(id, opts = {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -565,7 +635,7 @@ def get_bulk_profile_import_job_relationships_lists_with_http_info(id, opts = {} # Get profile relationships for the bulk profile import job with the given ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `profiles:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) # @return [Hash] def get_bulk_profile_import_job_relationships_profiles(id, opts = {}) @@ -577,7 +647,7 @@ def get_bulk_profile_import_job_relationships_profiles(id, opts = {}) # Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts = {}) @@ -607,7 +677,7 @@ def get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts = # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -643,11 +713,11 @@ def get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts = # Get Bulk Profile Import Jobs # Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `lists:read` `profiles:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_bulk_profile_import_jobs(opts = {}) data, _status_code, _headers = get_bulk_profile_import_jobs_with_http_info(opts) @@ -657,11 +727,11 @@ def get_bulk_profile_import_jobs(opts = {}) # Get Bulk Profile Import Jobs # Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_bulk_profile_import_jobs_with_http_info(opts = {}) if @api_client.config.debugging @@ -697,7 +767,7 @@ def get_bulk_profile_import_jobs_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -735,10 +805,10 @@ def get_bulk_profile_import_jobs_with_http_info(opts = {}) # @param id [String] # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' - # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_profile(id, opts = {}) data, _status_code, _headers = get_profile_with_http_info(id, opts) @@ -750,10 +820,10 @@ def get_profile(id, opts = {}) # @param id [String] # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' - # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_profile_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -767,7 +837,7 @@ def get_profile_with_http_info(id, opts = {}) if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}" end - allowable_values = ["name", "created", "updated"] + allowable_values = ["name", "created", "updated", "opt_in_process"] if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}" end @@ -797,7 +867,7 @@ def get_profile_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -834,7 +904,7 @@ def get_profile_with_http_info(id, opts = {}) # Get list memberships for a profile with the given profile ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `lists:read` `profiles:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_profile_lists(id, opts = {}) data, _status_code, _headers = get_profile_lists_with_http_info(id, opts) @@ -845,7 +915,7 @@ def get_profile_lists(id, opts = {}) # Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_profile_lists_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -855,7 +925,7 @@ def get_profile_lists_with_http_info(id, opts = {}) if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_lists" end - allowable_values = ["name", "created", "updated"] + allowable_values = ["name", "created", "updated", "opt_in_process"] if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}" end @@ -869,7 +939,7 @@ def get_profile_lists_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -934,7 +1004,7 @@ def get_profile_relationships_lists_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -999,7 +1069,7 @@ def get_profile_relationships_segments_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1036,7 +1106,7 @@ def get_profile_relationships_segments_with_http_info(id, opts = {}) # Get segment memberships for a profile with the given profile ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `profiles:read` `segments:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_profile_segments(id, opts = {}) data, _status_code, _headers = get_profile_segments_with_http_info(id, opts) @@ -1047,7 +1117,7 @@ def get_profile_segments(id, opts = {}) # Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_profile_segments_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1071,7 +1141,7 @@ def get_profile_segments_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1105,14 +1175,14 @@ def get_profile_segments_with_http_info(id, opts = {}) end # Get Profiles - # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:
Burst: `10/s`
Steady: `150/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read` + # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:
Burst: `10/s`
Steady: `150/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read` # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.suppression.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`<br>`subscriptions.email.marketing.suppression.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.list_id` : `equals`<br>`subscriptions.email.marketing.list_suppressions.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.suppression.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`<br>`subscriptions.email.marketing.suppression.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.list_id` : `equals`<br>`subscriptions.email.marketing.list_suppressions.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_profiles(opts = {}) data, _status_code, _headers = get_profiles_with_http_info(opts) @@ -1120,14 +1190,14 @@ def get_profiles(opts = {}) end # Get Profiles - # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read` + # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read` # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.suppression.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`<br>`subscriptions.email.marketing.suppression.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.list_id` : `equals`<br>`subscriptions.email.marketing.list_suppressions.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.suppression.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`<br>`subscriptions.email.marketing.suppression.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.list_id` : `equals`<br>`subscriptions.email.marketing.list_suppressions.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_profiles_with_http_info(opts = {}) if @api_client.config.debugging @@ -1168,7 +1238,7 @@ def get_profiles_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1233,7 +1303,7 @@ def merge_profiles_with_http_info(profile_merge_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -1272,7 +1342,7 @@ def merge_profiles_with_http_info(profile_merge_query, opts = {}) end # Spawn Bulk Profile Import Job - # *Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `lists:write` `profiles:write` + # Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `lists:write` `profiles:write` # @param profile_import_job_create_query [ProfileImportJobCreateQuery] # @param [Hash] opts the optional parameters # @return [Hash] @@ -1282,7 +1352,7 @@ def spawn_bulk_profile_import_job(profile_import_job_create_query, opts = {}) end # Spawn Bulk Profile Import Job - # *Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write` + # Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write` # @param profile_import_job_create_query [ProfileImportJobCreateQuery] # @param [Hash] opts the optional parameters # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers @@ -1303,7 +1373,7 @@ def spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -1342,7 +1412,7 @@ def spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query end # Subscribe Profiles - # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about suppressed profiles in [this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 100

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` + # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 100

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` # @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed. # @param [Hash] opts the optional parameters # @return [nil] @@ -1352,7 +1422,7 @@ def subscribe_profiles(subscription_create_job_create_query, opts = {}) end # Subscribe Profiles - # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about suppressed profiles in [this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` + # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` # @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed. # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -1373,7 +1443,7 @@ def subscribe_profiles_with_http_info(subscription_create_job_create_query, opts # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -1443,7 +1513,7 @@ def suppress_profiles_with_http_info(suppression_create_job_create_query, opts = # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -1482,7 +1552,7 @@ def suppress_profiles_with_http_info(suppression_create_job_create_query, opts = end # Unsubscribe Profiles - # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` + # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` # @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed. # @param [Hash] opts the optional parameters # @return [nil] @@ -1492,7 +1562,7 @@ def unsubscribe_profiles(subscription_delete_job_create_query, opts = {}) end # Unsubscribe Profiles - # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` + # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` # @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed. # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -1513,7 +1583,7 @@ def unsubscribe_profiles_with_http_info(subscription_delete_job_create_query, op # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -1583,7 +1653,7 @@ def unsuppress_profiles_with_http_info(suppression_delete_job_create_query, opts # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -1659,7 +1729,7 @@ def update_profile_with_http_info(id, profile_partial_update_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' diff --git a/lib/klaviyo-api-sdk/api/reporting_api.rb b/lib/klaviyo-api-sdk/api/reporting_api.rb new file mode 100644 index 0000000..c61ad01 --- /dev/null +++ b/lib/klaviyo-api-sdk/api/reporting_api.rb @@ -0,0 +1,241 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'cgi' + +module KlaviyoAPI + class ReportingApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Query Campaign Values + # Returns the requested campaign analytics values data

*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d` **Scopes:** `campaigns:read` + # @param campaign_values_request_dto [CampaignValuesRequestDTO] + # @param [Hash] opts the optional parameters + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @return [Hash] + def query_campaign_values(campaign_values_request_dto, opts = {}) + data, _status_code, _headers = query_campaign_values_with_http_info(campaign_values_request_dto, opts) + data + end + + # Query Campaign Values + # Returns the requested campaign analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `campaigns:read` + # @param campaign_values_request_dto [CampaignValuesRequestDTO] + # @param [Hash] opts the optional parameters + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def query_campaign_values_with_http_info(campaign_values_request_dto, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: ReportingApi.query_campaign_values ...' + end + # verify the required parameter 'campaign_values_request_dto' is set + if @api_client.config.client_side_validation && campaign_values_request_dto.nil? + fail ArgumentError, "Missing the required parameter 'campaign_values_request_dto' when calling ReportingApi.query_campaign_values" + end + # resource path + local_var_path = '/api/campaign-values-reports/' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'page_cursor'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # klaviyo api revision + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_values_request_dto) + + # return_type + return_type = opts[:debug_return_type] || 'Hash' + + # auth_names + auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] + + new_options = opts.merge( + :operation => :"ReportingApi.query_campaign_values", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ReportingApi#query_campaign_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Query Flow Series + # Returns the requested flow analytics series data

*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d` **Scopes:** `flows:read` + # @param flow_series_request_dto [FlowSeriesRequestDTO] + # @param [Hash] opts the optional parameters + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @return [Hash] + def query_flow_series(flow_series_request_dto, opts = {}) + data, _status_code, _headers = query_flow_series_with_http_info(flow_series_request_dto, opts) + data + end + + # Query Flow Series + # Returns the requested flow analytics series data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `flows:read` + # @param flow_series_request_dto [FlowSeriesRequestDTO] + # @param [Hash] opts the optional parameters + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def query_flow_series_with_http_info(flow_series_request_dto, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: ReportingApi.query_flow_series ...' + end + # verify the required parameter 'flow_series_request_dto' is set + if @api_client.config.client_side_validation && flow_series_request_dto.nil? + fail ArgumentError, "Missing the required parameter 'flow_series_request_dto' when calling ReportingApi.query_flow_series" + end + # resource path + local_var_path = '/api/flow-series-reports/' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'page_cursor'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # klaviyo api revision + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] || @api_client.object_to_http_body(flow_series_request_dto) + + # return_type + return_type = opts[:debug_return_type] || 'Hash' + + # auth_names + auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] + + new_options = opts.merge( + :operation => :"ReportingApi.query_flow_series", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ReportingApi#query_flow_series\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Query Flow Values + # Returns the requested flow analytics values data

*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d` **Scopes:** `flows:read` + # @param flow_values_request_dto [FlowValuesRequestDTO] + # @param [Hash] opts the optional parameters + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @return [Hash] + def query_flow_values(flow_values_request_dto, opts = {}) + data, _status_code, _headers = query_flow_values_with_http_info(flow_values_request_dto, opts) + data + end + + # Query Flow Values + # Returns the requested flow analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `flows:read` + # @param flow_values_request_dto [FlowValuesRequestDTO] + # @param [Hash] opts the optional parameters + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def query_flow_values_with_http_info(flow_values_request_dto, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: ReportingApi.query_flow_values ...' + end + # verify the required parameter 'flow_values_request_dto' is set + if @api_client.config.client_side_validation && flow_values_request_dto.nil? + fail ArgumentError, "Missing the required parameter 'flow_values_request_dto' when calling ReportingApi.query_flow_values" + end + # resource path + local_var_path = '/api/flow-values-reports/' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'page_cursor'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # klaviyo api revision + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] || @api_client.object_to_http_body(flow_values_request_dto) + + # return_type + return_type = opts[:debug_return_type] || 'Hash' + + # auth_names + auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] + + new_options = opts.merge( + :operation => :"ReportingApi.query_flow_values", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ReportingApi#query_flow_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/lib/klaviyo-api-sdk/api/segments_api.rb b/lib/klaviyo-api-sdk/api/segments_api.rb index 915cce9..ed8537a 100644 --- a/lib/klaviyo-api-sdk/api/segments_api.rb +++ b/lib/klaviyo-api-sdk/api/segments_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -20,13 +20,13 @@ def initialize(api_client = ApiClient.default) @api_client = api_client end # Get Segment - # Get a segment with the given segment ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:
Burst: `1/s`
Steady: `15/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read` + # Get a segment with the given segment ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:
Burst: `1/s`
Steady: `15/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read` # @param id [String] # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_segment Request additional fields not included by default in the response. Supported values: 'profile_count' - # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_segment(id, opts = {}) data, _status_code, _headers = get_segment_with_http_info(id, opts) @@ -34,13 +34,13 @@ def get_segment(id, opts = {}) end # Get Segment - # Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read` + # Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read` # @param id [String] # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_segment Request additional fields not included by default in the response. Supported values: 'profile_count' - # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_segment_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -79,7 +79,7 @@ def get_segment_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -117,11 +117,11 @@ def get_segment_with_http_info(id, opts = {}) # @param id [String] # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_segment_profiles(id, opts = {}) data, _status_code, _headers = get_segment_profiles_with_http_info(id, opts) @@ -133,11 +133,11 @@ def get_segment_profiles(id, opts = {}) # @param id [String] # @param [Hash] opts the optional parameters # @option opts [Array] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' - # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_segment_profiles_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -182,7 +182,7 @@ def get_segment_profiles_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -219,10 +219,10 @@ def get_segment_profiles_with_http_info(id, opts = {}) # Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `profiles:read` `segments:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 1000. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_segment_relationships_profiles(id, opts = {}) data, _status_code, _headers = get_segment_relationships_profiles_with_http_info(id, opts) @@ -233,10 +233,10 @@ def get_segment_relationships_profiles(id, opts = {}) # Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read` `segments:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 1000. (default to 20) - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_segment_relationships_profiles_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -271,7 +271,7 @@ def get_segment_relationships_profiles_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -336,7 +336,7 @@ def get_segment_relationships_tags_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -373,7 +373,7 @@ def get_segment_relationships_tags_with_http_info(id, opts = {}) # Return all tags associated with the given segment ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `segments:read` `tags:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_segment_tags(id, opts = {}) data, _status_code, _headers = get_segment_tags_with_http_info(id, opts) @@ -384,7 +384,7 @@ def get_segment_tags(id, opts = {}) # Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_segment_tags_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -408,7 +408,7 @@ def get_segment_tags_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -444,11 +444,11 @@ def get_segment_tags_with_http_info(id, opts = {}) # Get Segments # Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `segments:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Hash] def get_segments(opts = {}) data, _status_code, _headers = get_segments_with_http_info(opts) @@ -458,11 +458,11 @@ def get_segments(opts = {}) # Get Segments # Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `segments:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination + # @option opts [Array] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_segments_with_http_info(opts = {}) if @api_client.config.debugging @@ -494,7 +494,7 @@ def get_segments_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -528,7 +528,7 @@ def get_segments_with_http_info(opts = {}) end # Update Segment - # Update the name of a segment with the given segment ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `segments:write` + # Update the name of a segment with the given segment ID.

*Rate limits*:
Burst: `1/s`
Steady: `15/m` **Scopes:** `segments:write` # @param id [String] # @param segment_partial_update_query [SegmentPartialUpdateQuery] # @param [Hash] opts the optional parameters @@ -539,7 +539,7 @@ def update_segment(id, segment_partial_update_query, opts = {}) end # Update Segment - # Update the name of a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `segments:write` + # Update the name of a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `segments:write` # @param id [String] # @param segment_partial_update_query [SegmentPartialUpdateQuery] # @param [Hash] opts the optional parameters @@ -565,7 +565,7 @@ def update_segment_with_http_info(id, segment_partial_update_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' diff --git a/lib/klaviyo-api-sdk/api/tags_api.rb b/lib/klaviyo-api-sdk/api/tags_api.rb index 045279d..618a3bd 100644 --- a/lib/klaviyo-api-sdk/api/tags_api.rb +++ b/lib/klaviyo-api-sdk/api/tags_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -51,7 +51,7 @@ def create_tag_with_http_info(tag_create_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -121,7 +121,7 @@ def create_tag_group_with_http_info(tag_group_create_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -197,7 +197,7 @@ def create_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -273,7 +273,7 @@ def create_tag_relationships_flows_with_http_info(id, tag_flow_op, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -349,7 +349,7 @@ def create_tag_relationships_lists_with_http_info(id, tag_list_op, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -425,7 +425,7 @@ def create_tag_relationships_segments_with_http_info(id, tag_segment_op, opts = # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -495,7 +495,7 @@ def delete_tag_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -560,7 +560,7 @@ def delete_tag_group_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -631,7 +631,7 @@ def delete_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -707,7 +707,7 @@ def delete_tag_relationships_flows_with_http_info(id, tag_flow_op, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -783,7 +783,7 @@ def delete_tag_relationships_lists_with_http_info(id, tag_list_op, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -859,7 +859,7 @@ def delete_tag_relationships_segments_with_http_info(id, tag_segment_op, opts = # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -901,9 +901,9 @@ def delete_tag_relationships_segments_with_http_info(id, tag_segment_op, opts = # Retrieve the tag with the given tag ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` # @param id [String] The Tag ID # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Hash] def get_tag(id, opts = {}) data, _status_code, _headers = get_tag_with_http_info(id, opts) @@ -914,9 +914,9 @@ def get_tag(id, opts = {}) # Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` # @param id [String] The Tag ID # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships + # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_tag_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -950,7 +950,7 @@ def get_tag_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -987,7 +987,7 @@ def get_tag_with_http_info(id, opts = {}) # Retrieve the tag group with the given tag group ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` # @param id [String] The Tag Group ID # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_tag_group(id, opts = {}) data, _status_code, _headers = get_tag_group_with_http_info(id, opts) @@ -998,7 +998,7 @@ def get_tag_group(id, opts = {}) # Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` # @param id [String] The Tag Group ID # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_tag_group_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1022,7 +1022,7 @@ def get_tag_group_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1087,7 +1087,7 @@ def get_tag_group_relationships_tags_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1124,7 +1124,7 @@ def get_tag_group_relationships_tags_with_http_info(id, opts = {}) # Return the tags for a given tag group ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_tag_group_tags(id, opts = {}) data, _status_code, _headers = get_tag_group_tags_with_http_info(id, opts) @@ -1135,7 +1135,7 @@ def get_tag_group_tags(id, opts = {}) # Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_tag_group_tags_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1159,7 +1159,7 @@ def get_tag_group_tags_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1195,10 +1195,10 @@ def get_tag_group_tags_with_http_info(id, opts = {}) # Get Tag Groups # List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_tag_groups(opts = {}) data, _status_code, _headers = get_tag_groups_with_http_info(opts) @@ -1208,10 +1208,10 @@ def get_tag_groups(opts = {}) # Get Tag Groups # List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_tag_groups_with_http_info(opts = {}) if @api_client.config.debugging @@ -1238,7 +1238,7 @@ def get_tag_groups_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1303,7 +1303,7 @@ def get_tag_relationships_campaigns_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1368,7 +1368,7 @@ def get_tag_relationships_flows_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1433,7 +1433,7 @@ def get_tag_relationships_lists_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1498,7 +1498,7 @@ def get_tag_relationships_segments_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1563,7 +1563,7 @@ def get_tag_relationships_tag_group_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1600,7 +1600,7 @@ def get_tag_relationships_tag_group_with_http_info(id, opts = {}) # Returns the tag group resource for a given tag ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_tag_tag_group(id, opts = {}) data, _status_code, _headers = get_tag_tag_group_with_http_info(id, opts) @@ -1611,7 +1611,7 @@ def get_tag_tag_group(id, opts = {}) # Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` # @param id [String] # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_tag_tag_group_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -1635,7 +1635,7 @@ def get_tag_tag_group_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1671,12 +1671,12 @@ def get_tag_tag_group_with_http_info(id, opts = {}) # Get Tags # List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_tags(opts = {}) data, _status_code, _headers = get_tags_with_http_info(opts) @@ -1686,12 +1686,12 @@ def get_tags(opts = {}) # Get Tags # List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with` - # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with` + # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_tags_with_http_info(opts = {}) if @api_client.config.debugging @@ -1728,7 +1728,7 @@ def get_tags_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -1799,7 +1799,7 @@ def update_tag_with_http_info(id, tag_update_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -1875,7 +1875,7 @@ def update_tag_group_with_http_info(id, tag_group_update_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' diff --git a/lib/klaviyo-api-sdk/api/templates_api.rb b/lib/klaviyo-api-sdk/api/templates_api.rb index cf2609f..b696c2f 100644 --- a/lib/klaviyo-api-sdk/api/templates_api.rb +++ b/lib/klaviyo-api-sdk/api/templates_api.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -51,7 +51,7 @@ def create_template_with_http_info(template_create_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -90,7 +90,7 @@ def create_template_with_http_info(template_create_query, opts = {}) end # Create Template Clone - # Create a clone of a template with the given template ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `templates:write` + # Create a clone of a template with the given template ID. If there are 1,000 or more templates in an account, cloning will fail as there is a limit of 1,000 templates that can be created via the API.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `templates:write` # @param template_clone_query [TemplateCloneQuery] # @param [Hash] opts the optional parameters # @return [Hash] @@ -100,7 +100,7 @@ def create_template_clone(template_clone_query, opts = {}) end # Create Template Clone - # Create a clone of a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:write` + # Create a clone of a template with the given template ID. If there are 1,000 or more templates in an account, cloning will fail as there is a limit of 1,000 templates that can be created via the API.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:write` # @param template_clone_query [TemplateCloneQuery] # @param [Hash] opts the optional parameters # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers @@ -121,7 +121,7 @@ def create_template_clone_with_http_info(template_clone_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -191,7 +191,7 @@ def create_template_render_with_http_info(template_render_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' @@ -261,7 +261,7 @@ def delete_template_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -298,7 +298,7 @@ def delete_template_with_http_info(id, opts = {}) # Get a template with the given template ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `templates:read` # @param id [String] The ID of template # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Hash] def get_template(id, opts = {}) data, _status_code, _headers = get_template_with_http_info(id, opts) @@ -309,7 +309,7 @@ def get_template(id, opts = {}) # Get a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read` # @param id [String] The ID of template # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_template_with_http_info(id, opts = {}) if @api_client.config.debugging @@ -333,7 +333,7 @@ def get_template_with_http_info(id, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -369,10 +369,10 @@ def get_template_with_http_info(id, opts = {}) # Get Templates # Get all templates in an account. Filter to request a subset of all templates. Templates can be sorted by the following fields, in ascending and descending order: `id`, `name`, `created`, `updated` Returns a maximum of 10 results per page.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `templates:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Hash] def get_templates(opts = {}) data, _status_code, _headers = get_templates_with_http_info(opts) @@ -382,10 +382,10 @@ def get_templates(opts = {}) # Get Templates # Get all templates in an account. Filter to request a subset of all templates. Templates can be sorted by the following fields, in ascending and descending order: `id`, `name`, `created`, `updated` Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read` # @param [Hash] opts the optional parameters - # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets - # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination - # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting + # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets + # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination + # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers def get_templates_with_http_info(opts = {}) if @api_client.config.debugging @@ -412,7 +412,7 @@ def get_templates_with_http_info(opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) @@ -483,7 +483,7 @@ def update_template_with_http_info(id, template_update_query, opts = {}) # header parameters header_params = opts[:header_params] || {} # klaviyo api revision - header_params['revision'] = ENV['API_REVISION'] || "2023-12-15" + header_params['revision'] = ENV['API_REVISION'] || "2024-02-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' diff --git a/lib/klaviyo-api-sdk/api_client.rb b/lib/klaviyo-api-sdk/api_client.rb index b7522ac..ede3e58 100644 --- a/lib/klaviyo-api-sdk/api_client.rb +++ b/lib/klaviyo-api-sdk/api_client.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -32,7 +32,7 @@ class ApiClient # @option config [Configuration] Configuration for initializing the object, default to Configuration.default def initialize(config = Configuration.default) @config = config - @user_agent = "klaviyo-api-ruby/5.1.0" + @user_agent = "klaviyo-api-ruby/6.0.0" @default_headers = { 'Content-Type' => 'application/json', 'User-Agent' => @user_agent diff --git a/lib/klaviyo-api-sdk/api_error.rb b/lib/klaviyo-api-sdk/api_error.rb index e5c64b3..36f1ddc 100644 --- a/lib/klaviyo-api-sdk/api_error.rb +++ b/lib/klaviyo-api-sdk/api_error.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/configuration.rb b/lib/klaviyo-api-sdk/configuration.rb index d68d1d3..a3efc37 100644 --- a/lib/klaviyo-api-sdk/configuration.rb +++ b/lib/klaviyo-api-sdk/configuration.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/audiences_sub_object.rb b/lib/klaviyo-api-sdk/models/audiences_sub_object.rb index 933c44a..295a328 100644 --- a/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +++ b/lib/klaviyo-api-sdk/models/audiences_sub_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb b/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb index 89c2404..bd8be70 100644 --- a/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +++ b/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_clone_query.rb b/lib/klaviyo-api-sdk/models/campaign_clone_query.rb index 8265271..d491d8d 100644 --- a/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +++ b/lib/klaviyo-api-sdk/models/campaign_clone_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb b/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb index f4d5e9f..9ea5b25 100644 --- a/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb index 12a1fa6..8200738 100644 --- a/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_create_query.rb b/lib/klaviyo-api-sdk/models/campaign_create_query.rb index ac6e100..ee6250a 100644 --- a/lib/klaviyo-api-sdk/models/campaign_create_query.rb +++ b/lib/klaviyo-api-sdk/models/campaign_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb index 2061821..fdd55b7 100644 --- a/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb index d62c301..ce9b3b2 100644 --- a/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb b/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb index b99d1c7..b03cf79 100644 --- a/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +++ b/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb b/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb index 806d5e5..4ec1993 100644 --- a/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +++ b/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb b/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb index fd28a6d..f6d2436 100644 --- a/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +++ b/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_enum.rb b/lib/klaviyo-api-sdk/models/campaign_enum.rb index 9831efb..de21614 100644 --- a/lib/klaviyo-api-sdk/models/campaign_enum.rb +++ b/lib/klaviyo-api-sdk/models/campaign_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb b/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb index 499a9fc..350d101 100644 --- a/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +++ b/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb b/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb index 968cc6a..dfd8764 100644 --- a/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb b/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb index 84ae0a2..ce85a6b 100644 --- a/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +++ b/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb b/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb index 84ff359..c3196c3 100644 --- a/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +++ b/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb b/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb index 627c23b..331ca83 100644 --- a/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +++ b/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb index 4de4734..ea2c3d9 100644 --- a/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb index b35dc24..50ff9f0 100644 --- a/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb b/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb index 1c1a6ca..943e50b 100644 --- a/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +++ b/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_message_enum.rb b/lib/klaviyo-api-sdk/models/campaign_message_enum.rb index c362cb8..ddd558a 100644 --- a/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +++ b/lib/klaviyo-api-sdk/models/campaign_message_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb b/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb index e7086ae..44b53e2 100644 --- a/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +++ b/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb index eee37f7..d2991d4 100644 --- a/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb index 55ee379..25e1ef1 100644 --- a/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb b/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb index ce7db9b..d2b4753 100644 --- a/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +++ b/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb index 1a6f6a8..6ccfae5 100644 --- a/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb index 9e01829..0ab0920 100644 --- a/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb b/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb index 31d2001..0b3aa5e 100644 --- a/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb index b278473..40bca2a 100644 --- a/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb b/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb index 4e34eeb..211d4d0 100644 --- a/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb b/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb index 6366b25..4a55c1b 100644 --- a/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb index 90eae29..0ab85a4 100644 --- a/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb b/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb index 9edab82..3ea57a5 100644 --- a/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb b/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb index f11dd04..149577c 100644 --- a/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +++ b/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb index 15d1dd0..d2ac290 100644 --- a/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb index 314b972..b005aef 100644 --- a/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb b/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb new file mode 100644 index 0000000..05c32dc --- /dev/null +++ b/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb @@ -0,0 +1,36 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class CampaignValuesReportEnum + CAMPAIGN_VALUES_REPORT = "campaign-values-report".freeze + + # Builds the enum from string + # @param [String] The enum value in the form of the string + # @return [String] The enum value + def self.build_from_hash(value) + new.build_from_hash(value) + end + + # Builds the enum from string + # @param [String] The enum value in the form of the string + # @return [String] The enum value + def build_from_hash(value) + constantValues = CampaignValuesReportEnum.constants.select { |c| CampaignValuesReportEnum::const_get(c) == value } + raise "Invalid ENUM value #{value} for class #CampaignValuesReportEnum" if constantValues.empty? + value + end + end +end diff --git a/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb b/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb new file mode 100644 index 0000000..3e1aedc --- /dev/null +++ b/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb @@ -0,0 +1,224 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class CampaignValuesRequestDTO + attr_accessor :data + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'data' => :'data' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'data' => :'CampaignValuesRequestDTOResourceObject' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::CampaignValuesRequestDTO` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::CampaignValuesRequestDTO`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'data') + self.data = attributes[:'data'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @data.nil? + invalid_properties.push('invalid value for "data", data cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @data.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + data == o.data + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [data].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + self.class.openapi_types.each_pair do |key, type| + if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) + self.send("#{key}=", nil) + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = KlaviyoAPI.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb b/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb new file mode 100644 index 0000000..3a4e833 --- /dev/null +++ b/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb @@ -0,0 +1,238 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class CampaignValuesRequestDTOResourceObject + attr_accessor :type + + attr_accessor :attributes + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'type' => :'type', + :'attributes' => :'attributes' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'type' => :'CampaignValuesReportEnum', + :'attributes' => :'CampaignValuesRequestDTOResourceObjectAttributes' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::CampaignValuesRequestDTOResourceObject` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::CampaignValuesRequestDTOResourceObject`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + + if attributes.key?(:'attributes') + self.attributes = attributes[:'attributes'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @type.nil? + invalid_properties.push('invalid value for "type", type cannot be nil.') + end + + if @attributes.nil? + invalid_properties.push('invalid value for "attributes", attributes cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @type.nil? + return false if @attributes.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + type == o.type && + attributes == o.attributes + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [type, attributes].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + self.class.openapi_types.each_pair do |key, type| + if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) + self.send("#{key}=", nil) + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = KlaviyoAPI.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb new file mode 100644 index 0000000..7d41d6d --- /dev/null +++ b/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb @@ -0,0 +1,288 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class CampaignValuesRequestDTOResourceObjectAttributes + # List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0] + attr_accessor :statistics + + attr_accessor :timeframe + + # ID of the metric to be used for conversion statistics + attr_accessor :conversion_metric_id + + # API filter string used to filter the query. Allowed filters are send_channel, campaign_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. + attr_accessor :filter + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'statistics' => :'statistics', + :'timeframe' => :'timeframe', + :'conversion_metric_id' => :'conversion_metric_id', + :'filter' => :'filter' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'statistics' => :'Array', + :'timeframe' => :'CampaignValuesRequestDTOResourceObjectAttributesTimeframe', + :'conversion_metric_id' => :'String', + :'filter' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::CampaignValuesRequestDTOResourceObjectAttributes` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::CampaignValuesRequestDTOResourceObjectAttributes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'statistics') + if (value = attributes[:'statistics']).is_a?(Array) + self.statistics = value + end + end + + if attributes.key?(:'timeframe') + self.timeframe = attributes[:'timeframe'] + end + + if attributes.key?(:'conversion_metric_id') + self.conversion_metric_id = attributes[:'conversion_metric_id'] + end + + if attributes.key?(:'filter') + self.filter = attributes[:'filter'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @statistics.nil? + invalid_properties.push('invalid value for "statistics", statistics cannot be nil.') + end + + if @timeframe.nil? + invalid_properties.push('invalid value for "timeframe", timeframe cannot be nil.') + end + + if @conversion_metric_id.nil? + invalid_properties.push('invalid value for "conversion_metric_id", conversion_metric_id cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @statistics.nil? + return false if @timeframe.nil? + return false if @conversion_metric_id.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + statistics == o.statistics && + timeframe == o.timeframe && + conversion_metric_id == o.conversion_metric_id && + filter == o.filter + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [statistics, timeframe, conversion_metric_id, filter].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + self.class.openapi_types.each_pair do |key, type| + if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) + self.send("#{key}=", nil) + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = KlaviyoAPI.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb b/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb new file mode 100644 index 0000000..445bf1a --- /dev/null +++ b/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb @@ -0,0 +1,106 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + # The timeframe to query for data within. The max length a timeframe can be is 1 year + module CampaignValuesRequestDTOResourceObjectAttributesTimeframe + class << self + # List of class defined in oneOf (OpenAPI v3) + def openapi_one_of + [ + :'CustomTimeframe', + :'Timeframe' + ] + end + + # Builds the object + # @param [Mixed] Data to be matched against the list of oneOf items + # @return [Object] Returns the model or the data itself + def build(data) + # Go through the list of oneOf items and attempt to identify the appropriate one. + # Note: + # - We do not attempt to check whether exactly one item matches. + # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 }) + # due to the way the deserialization is made in the base_object template (it just casts without verifying). + # - TODO: scalar values are de facto behaving as if they were nullable. + # - TODO: logging when debugging is set. + openapi_one_of.each do |klass| + begin + next if klass == :AnyType # "nullable: true" + typed_data = find_and_cast_into_type(klass, data) + return typed_data if typed_data + rescue # rescue all errors so we keep iterating even if the current item lookup raises + end + end + + openapi_one_of.include?(:AnyType) ? data : nil + end + + private + + SchemaMismatchError = Class.new(StandardError) + + # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse. + def find_and_cast_into_type(klass, data) + return if data.nil? + + case klass.to_s + when 'Boolean' + return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass) + when 'Float' + return data if data.instance_of?(Float) + when 'Integer' + return data if data.instance_of?(Integer) + when 'Time' + return Time.parse(data) + when 'Date' + return Date.parse(data) + when 'String' + return data if data.instance_of?(String) + when 'Object' # "type: object" + return data if data.instance_of?(Hash) + when /\AArray<(?.+)>\z/ # "type: array" + if data.instance_of?(Array) + sub_type = Regexp.last_match[:sub_type] + return data.map { |item| find_and_cast_into_type(sub_type, item) } + end + when /\AHash.+)>\z/ # "type: object" with "additionalProperties: { ... }" + if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) } + sub_type = Regexp.last_match[:sub_type] + return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) } + end + else # model + const = KlaviyoAPI.const_get(klass) + if const + if const.respond_to?(:openapi_one_of) # nested oneOf model + model = const.build(data) + return model if model + else + # raise if data contains keys that are not known to the model + raise unless (data.keys - const.acceptable_attributes).empty? + model = const.build_from_hash(data) + return model if model && model.valid? + end + end + end + + raise # if no match by now, raise + rescue + raise SchemaMismatchError, "#{data} doesn't match the #{klass} type" + end + end + end + +end diff --git a/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb b/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb index aa5d469..48fb237 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb b/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb index 9189728..66d232e 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb b/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb index c301b9a..01399a9 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb b/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb index 529002e..178c508 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb index 3a7921f..f61828b 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb index 1e9ffa7..9afa5f5 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb b/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb index 2732597..2bdd3ef 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb b/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb index 399b1b9..a1b5ad3 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb index 24d8b97..955475e 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb index 92889c5..32a2952 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb b/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb index d2b0fd5..c09e95e 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb b/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb index 6381c39..b0671bd 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb b/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb index 9280e3f..7134b8c 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb b/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb index db78898..e5878a3 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb index 4b33069..ee32281 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb index 63c71c5..3df2733 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb b/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb index e0887b9..7333cb8 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb index b7c3a9e..bc8f1d5 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_enum.rb b/lib/klaviyo-api-sdk/models/catalog_category_enum.rb index 09fed2a..5d55874 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb b/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb index 7163735..d4595ee 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb b/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb index 4b2d33e..c6650c5 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb index 9e70578..504a4ae 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb index d1ce242..371d283 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb b/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb index dd1591d..8f60391 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb b/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb index 5a99044..998eeae 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb index 6fe0bb9..0d56a72 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb index e4cab6c..80def19 100644 --- a/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb b/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb index ecb178f..59ba1ab 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb b/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb index c3d5607..a977514 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb b/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb index d355659..8916c2f 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb b/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb index ed575f6..2b3ef43 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb b/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb index 0c8267a..1ef3936 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb index ac49997..58392c0 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb index ce351ba..3d25fd9 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb b/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb index 4ab4bfd..36c55b5 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb b/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb index ebd58bd..24829bb 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb index d86348b..23145b4 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb index 63233f9..e24e2ce 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb b/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb index 821ee7c..f9416dd 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb b/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb index 609f490..8524781 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb b/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb index c7b2ed4..bd9493b 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb b/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb index affc52b..1eb8b59 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb index 46a39f5..294c283 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb index c32f55c..9df4f89 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb b/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb index 2136673..7ea2d11 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb index 40b0f62..8f62990 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_enum.rb b/lib/klaviyo-api-sdk/models/catalog_item_enum.rb index 43975a9..968247f 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb b/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb index f49d7f3..7b95a5f 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb index d2f1658..49654fa 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb index f9f7ed4..23582b7 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb b/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb index ca3eb2f..741dcc4 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb b/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb index 45694de..0d46797 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb index 0a2c3a1..a63d66b 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb index 3f1524e..10ad56e 100644 --- a/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb b/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb index 9c31912..865ae92 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb b/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb index 7f0ee92..eaa4ae3 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb b/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb index 8c28b5d..549e7bc 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb b/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb index 6470b11..3de9582 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb index ce3c693..b9a20fd 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb index 2dd6a4b..839d0d9 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb b/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb index 79a2a56..d9150a1 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb b/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb index 0f3953a..a65edcb 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb index 9f215d1..d43a1b6 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb index de89693..b7108e5 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb b/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb index af590d1..9a668fe 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb b/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb index 63ec9ba..63af418 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb b/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb index d186e24..5e331e2 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb b/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb index 5d03c63..5be3cb6 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb index 16f2d0b..9928886 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb index 9ba311f..753a1d7 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb b/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb index 7b91006..7c3f290 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb index 127cb53..33d5793 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb b/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb index 2b116b3..fca1e22 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb b/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb index 0ceeaa6..e5f53ef 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb index 40b9a04..e5aa1a4 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb index e885342..25f5a0c 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb b/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb index d226474..726467d 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb b/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb index f5e9109..c94b1a3 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb index 1fa3fe0..514cb1b 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb index 8afe709..09b61ca 100644 --- a/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb b/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb index 63fd722..1666fdd 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb b/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb index 201c241..21afbf5 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb index 0bb6b96..13ed5c5 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb index 46c097f..d57d8b8 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb b/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb index 21e4f75..44c3aae 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb b/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb index 87292fb..94ea974 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb index 0e4031d..b18a7b9 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb index ba77587..8ce4e4b 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb b/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb index dfac439..cd15a4a 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb b/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb index 202aac9..28794fb 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb b/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb index 14d0f3e..f755da4 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_enum.rb b/lib/klaviyo-api-sdk/models/coupon_code_enum.rb index 4c38486..ab2f1d7 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb b/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb index 928e44c..5d76466 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb index 80944d1..39c0d35 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb index bf71cc9..f8454cd 100644 --- a/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_create_query.rb b/lib/klaviyo-api-sdk/models/coupon_create_query.rb index e6c0842..a2ecabf 100644 --- a/lib/klaviyo-api-sdk/models/coupon_create_query.rb +++ b/lib/klaviyo-api-sdk/models/coupon_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb index 1fbdd8e..948ab80 100644 --- a/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb index af832d9..92ee987 100644 --- a/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_enum.rb b/lib/klaviyo-api-sdk/models/coupon_enum.rb index 07a0d83..485f5c1 100644 --- a/lib/klaviyo-api-sdk/models/coupon_enum.rb +++ b/lib/klaviyo-api-sdk/models/coupon_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_update_query.rb b/lib/klaviyo-api-sdk/models/coupon_update_query.rb index 666680a..3ea585c 100644 --- a/lib/klaviyo-api-sdk/models/coupon_update_query.rb +++ b/lib/klaviyo-api-sdk/models/coupon_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb index 756b252..9481777 100644 --- a/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb index 1b39e8c..5958f9e 100644 --- a/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/custom_timeframe.rb b/lib/klaviyo-api-sdk/models/custom_timeframe.rb new file mode 100644 index 0000000..ce8dac9 --- /dev/null +++ b/lib/klaviyo-api-sdk/models/custom_timeframe.rb @@ -0,0 +1,238 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class CustomTimeframe + attr_accessor :start + + attr_accessor :_end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'start' => :'start', + :'_end' => :'end' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'start' => :'Time', + :'_end' => :'Time' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::CustomTimeframe` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::CustomTimeframe`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'start') + self.start = attributes[:'start'] + end + + if attributes.key?(:'_end') + self._end = attributes[:'_end'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @start.nil? + invalid_properties.push('invalid value for "start", start cannot be nil.') + end + + if @_end.nil? + invalid_properties.push('invalid value for "_end", _end cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @start.nil? + return false if @_end.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + start == o.start && + _end == o._end + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [start, _end].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + self.class.openapi_types.each_pair do |key, type| + if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) + self.send("#{key}=", nil) + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = KlaviyoAPI.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb b/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb index 9cac6bb..84f2339 100644 --- a/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +++ b/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb b/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb index 0523afc..422107d 100644 --- a/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb index 3769703..dfdaea3 100644 --- a/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb b/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb index af35ad8..4f68682 100644 --- a/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +++ b/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb b/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb index 0a014be..2f95475 100644 --- a/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb b/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb index 13a4ac2..7be3c36 100644 --- a/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb index 04bd63d..1339b2b 100644 --- a/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/device_metadata.rb b/lib/klaviyo-api-sdk/models/device_metadata.rb index 480a4af..3cccf7c 100644 --- a/lib/klaviyo-api-sdk/models/device_metadata.rb +++ b/lib/klaviyo-api-sdk/models/device_metadata.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/email_content_sub_object.rb b/lib/klaviyo-api-sdk/models/email_content_sub_object.rb index 9d8c8bc..b0d30a8 100644 --- a/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +++ b/lib/klaviyo-api-sdk/models/email_content_sub_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb b/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb index 4cfb1ae..5e36fee 100644 --- a/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +++ b/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb b/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb index 6e6d65e..1dcc749 100644 --- a/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +++ b/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb b/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb index d073283..4f22347 100644 --- a/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +++ b/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/event_create_query_v2.rb b/lib/klaviyo-api-sdk/models/event_create_query_v2.rb index 32aa45d..195f0d9 100644 --- a/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +++ b/lib/klaviyo-api-sdk/models/event_create_query_v2.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb b/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb index a07d5e1..c3acd63 100644 --- a/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb index be6b2cf..8b45529 100644 --- a/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb b/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb index 83f8edb..16ecb9f 100644 --- a/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +++ b/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb b/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb index 33c13fb..42aae42 100644 --- a/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +++ b/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/event_enum.rb b/lib/klaviyo-api-sdk/models/event_enum.rb index 2bb7b73..dc05c54 100644 --- a/lib/klaviyo-api-sdk/models/event_enum.rb +++ b/lib/klaviyo-api-sdk/models/event_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/flow_enum.rb b/lib/klaviyo-api-sdk/models/flow_enum.rb index 040c8f3..d28f88a 100644 --- a/lib/klaviyo-api-sdk/models/flow_enum.rb +++ b/lib/klaviyo-api-sdk/models/flow_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb b/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb new file mode 100644 index 0000000..755f922 --- /dev/null +++ b/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb @@ -0,0 +1,36 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class FlowSeriesReportEnum + FLOW_SERIES_REPORT = "flow-series-report".freeze + + # Builds the enum from string + # @param [String] The enum value in the form of the string + # @return [String] The enum value + def self.build_from_hash(value) + new.build_from_hash(value) + end + + # Builds the enum from string + # @param [String] The enum value in the form of the string + # @return [String] The enum value + def build_from_hash(value) + constantValues = FlowSeriesReportEnum.constants.select { |c| FlowSeriesReportEnum::const_get(c) == value } + raise "Invalid ENUM value #{value} for class #FlowSeriesReportEnum" if constantValues.empty? + value + end + end +end diff --git a/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb b/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb new file mode 100644 index 0000000..950719e --- /dev/null +++ b/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb @@ -0,0 +1,224 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class FlowSeriesRequestDTO + attr_accessor :data + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'data' => :'data' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'data' => :'FlowSeriesRequestDTOResourceObject' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::FlowSeriesRequestDTO` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::FlowSeriesRequestDTO`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'data') + self.data = attributes[:'data'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @data.nil? + invalid_properties.push('invalid value for "data", data cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @data.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + data == o.data + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [data].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + self.class.openapi_types.each_pair do |key, type| + if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) + self.send("#{key}=", nil) + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = KlaviyoAPI.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb b/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb new file mode 100644 index 0000000..0c03646 --- /dev/null +++ b/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb @@ -0,0 +1,238 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class FlowSeriesRequestDTOResourceObject + attr_accessor :type + + attr_accessor :attributes + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'type' => :'type', + :'attributes' => :'attributes' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'type' => :'FlowSeriesReportEnum', + :'attributes' => :'FlowSeriesRequestDTOResourceObjectAttributes' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::FlowSeriesRequestDTOResourceObject` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::FlowSeriesRequestDTOResourceObject`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + + if attributes.key?(:'attributes') + self.attributes = attributes[:'attributes'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @type.nil? + invalid_properties.push('invalid value for "type", type cannot be nil.') + end + + if @attributes.nil? + invalid_properties.push('invalid value for "attributes", attributes cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @type.nil? + return false if @attributes.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + type == o.type && + attributes == o.attributes + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [type, attributes].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + self.class.openapi_types.each_pair do |key, type| + if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) + self.send("#{key}=", nil) + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = KlaviyoAPI.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb new file mode 100644 index 0000000..70a7357 --- /dev/null +++ b/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb @@ -0,0 +1,315 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class FlowSeriesRequestDTOResourceObjectAttributes + # List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0] + attr_accessor :statistics + + attr_accessor :timeframe + + # The interval used to aggregate data within the series request. If hourly is used, the timeframe cannot be longer than 7 days. If daily is used, the timeframe cannot be longer than 60 days. If monthly is used, the timeframe cannot be longer than 52 weeks. + attr_accessor :interval + + # ID of the metric to be used for conversion statistics + attr_accessor :conversion_metric_id + + # API filter string used to filter the query. Allowed filters are flow_id, send_channel, flow_message_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. + attr_accessor :filter + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'statistics' => :'statistics', + :'timeframe' => :'timeframe', + :'interval' => :'interval', + :'conversion_metric_id' => :'conversion_metric_id', + :'filter' => :'filter' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'statistics' => :'Array', + :'timeframe' => :'CampaignValuesRequestDTOResourceObjectAttributesTimeframe', + :'interval' => :'String', + :'conversion_metric_id' => :'String', + :'filter' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::FlowSeriesRequestDTOResourceObjectAttributes` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::FlowSeriesRequestDTOResourceObjectAttributes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'statistics') + if (value = attributes[:'statistics']).is_a?(Array) + self.statistics = value + end + end + + if attributes.key?(:'timeframe') + self.timeframe = attributes[:'timeframe'] + end + + if attributes.key?(:'interval') + self.interval = attributes[:'interval'] + end + + if attributes.key?(:'conversion_metric_id') + self.conversion_metric_id = attributes[:'conversion_metric_id'] + end + + if attributes.key?(:'filter') + self.filter = attributes[:'filter'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @statistics.nil? + invalid_properties.push('invalid value for "statistics", statistics cannot be nil.') + end + + if @timeframe.nil? + invalid_properties.push('invalid value for "timeframe", timeframe cannot be nil.') + end + + if @interval.nil? + invalid_properties.push('invalid value for "interval", interval cannot be nil.') + end + + if @conversion_metric_id.nil? + invalid_properties.push('invalid value for "conversion_metric_id", conversion_metric_id cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @statistics.nil? + return false if @timeframe.nil? + return false if @interval.nil? + interval_validator = EnumAttributeValidator.new('String', ["daily", "hourly", "monthly", "weekly"]) + return false unless interval_validator.valid?(@interval) + return false if @conversion_metric_id.nil? + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] interval Object to be assigned + def interval=(interval) + validator = EnumAttributeValidator.new('String', ["daily", "hourly", "monthly", "weekly"]) + unless validator.valid?(interval) + fail ArgumentError, "invalid value for \"interval\", must be one of #{validator.allowable_values}." + end + @interval = interval + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + statistics == o.statistics && + timeframe == o.timeframe && + interval == o.interval && + conversion_metric_id == o.conversion_metric_id && + filter == o.filter + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [statistics, timeframe, interval, conversion_metric_id, filter].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + self.class.openapi_types.each_pair do |key, type| + if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) + self.send("#{key}=", nil) + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = KlaviyoAPI.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/klaviyo-api-sdk/models/flow_update_query.rb b/lib/klaviyo-api-sdk/models/flow_update_query.rb index 5535813..74f98d1 100644 --- a/lib/klaviyo-api-sdk/models/flow_update_query.rb +++ b/lib/klaviyo-api-sdk/models/flow_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb index 2448e39..2f8c9c4 100644 --- a/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb index 8c0c900..94ef201 100644 --- a/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb b/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb new file mode 100644 index 0000000..c72e17d --- /dev/null +++ b/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb @@ -0,0 +1,36 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class FlowValuesReportEnum + FLOW_VALUES_REPORT = "flow-values-report".freeze + + # Builds the enum from string + # @param [String] The enum value in the form of the string + # @return [String] The enum value + def self.build_from_hash(value) + new.build_from_hash(value) + end + + # Builds the enum from string + # @param [String] The enum value in the form of the string + # @return [String] The enum value + def build_from_hash(value) + constantValues = FlowValuesReportEnum.constants.select { |c| FlowValuesReportEnum::const_get(c) == value } + raise "Invalid ENUM value #{value} for class #FlowValuesReportEnum" if constantValues.empty? + value + end + end +end diff --git a/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb b/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb new file mode 100644 index 0000000..15dab5c --- /dev/null +++ b/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb @@ -0,0 +1,224 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class FlowValuesRequestDTO + attr_accessor :data + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'data' => :'data' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'data' => :'FlowValuesRequestDTOResourceObject' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::FlowValuesRequestDTO` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::FlowValuesRequestDTO`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'data') + self.data = attributes[:'data'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @data.nil? + invalid_properties.push('invalid value for "data", data cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @data.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + data == o.data + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [data].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + self.class.openapi_types.each_pair do |key, type| + if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) + self.send("#{key}=", nil) + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = KlaviyoAPI.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb b/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb new file mode 100644 index 0000000..2fe5da3 --- /dev/null +++ b/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb @@ -0,0 +1,238 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class FlowValuesRequestDTOResourceObject + attr_accessor :type + + attr_accessor :attributes + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'type' => :'type', + :'attributes' => :'attributes' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'type' => :'FlowValuesReportEnum', + :'attributes' => :'FlowValuesRequestDTOResourceObjectAttributes' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::FlowValuesRequestDTOResourceObject` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::FlowValuesRequestDTOResourceObject`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + + if attributes.key?(:'attributes') + self.attributes = attributes[:'attributes'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @type.nil? + invalid_properties.push('invalid value for "type", type cannot be nil.') + end + + if @attributes.nil? + invalid_properties.push('invalid value for "attributes", attributes cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @type.nil? + return false if @attributes.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + type == o.type && + attributes == o.attributes + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [type, attributes].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + self.class.openapi_types.each_pair do |key, type| + if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) + self.send("#{key}=", nil) + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = KlaviyoAPI.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb new file mode 100644 index 0000000..ac4440c --- /dev/null +++ b/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb @@ -0,0 +1,288 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class FlowValuesRequestDTOResourceObjectAttributes + # List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0] + attr_accessor :statistics + + attr_accessor :timeframe + + # ID of the metric to be used for conversion statistics + attr_accessor :conversion_metric_id + + # API filter string used to filter the query. Allowed filters are flow_id, send_channel, flow_message_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. + attr_accessor :filter + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'statistics' => :'statistics', + :'timeframe' => :'timeframe', + :'conversion_metric_id' => :'conversion_metric_id', + :'filter' => :'filter' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'statistics' => :'Array', + :'timeframe' => :'CampaignValuesRequestDTOResourceObjectAttributesTimeframe', + :'conversion_metric_id' => :'String', + :'filter' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::FlowValuesRequestDTOResourceObjectAttributes` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::FlowValuesRequestDTOResourceObjectAttributes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'statistics') + if (value = attributes[:'statistics']).is_a?(Array) + self.statistics = value + end + end + + if attributes.key?(:'timeframe') + self.timeframe = attributes[:'timeframe'] + end + + if attributes.key?(:'conversion_metric_id') + self.conversion_metric_id = attributes[:'conversion_metric_id'] + end + + if attributes.key?(:'filter') + self.filter = attributes[:'filter'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @statistics.nil? + invalid_properties.push('invalid value for "statistics", statistics cannot be nil.') + end + + if @timeframe.nil? + invalid_properties.push('invalid value for "timeframe", timeframe cannot be nil.') + end + + if @conversion_metric_id.nil? + invalid_properties.push('invalid value for "conversion_metric_id", conversion_metric_id cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @statistics.nil? + return false if @timeframe.nil? + return false if @conversion_metric_id.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + statistics == o.statistics && + timeframe == o.timeframe && + conversion_metric_id == o.conversion_metric_id && + filter == o.filter + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [statistics, timeframe, conversion_metric_id, filter].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + self.class.openapi_types.each_pair do |key, type| + if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) + self.send("#{key}=", nil) + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = KlaviyoAPI.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb b/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb index d8878dd..32b55ef 100644 --- a/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +++ b/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb b/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb index 51a50f8..285c07e 100644 --- a/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +++ b/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb b/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb index ef1fba5..6f5a8cf 100644 --- a/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +++ b/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/image_create_query.rb b/lib/klaviyo-api-sdk/models/image_create_query.rb index 8668c86..ba1a197 100644 --- a/lib/klaviyo-api-sdk/models/image_create_query.rb +++ b/lib/klaviyo-api-sdk/models/image_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb index 0fb13d0..8f82ac9 100644 --- a/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb index 1eabcd9..5f69cf9 100644 --- a/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/image_enum.rb b/lib/klaviyo-api-sdk/models/image_enum.rb index 3443615..54c2006 100644 --- a/lib/klaviyo-api-sdk/models/image_enum.rb +++ b/lib/klaviyo-api-sdk/models/image_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/image_partial_update_query.rb b/lib/klaviyo-api-sdk/models/image_partial_update_query.rb index 68274bf..43246fe 100644 --- a/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +++ b/lib/klaviyo-api-sdk/models/image_partial_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb index ee27971..20cd5a1 100644 --- a/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb index edad071..e7a7e0e 100644 --- a/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/list_create_query.rb b/lib/klaviyo-api-sdk/models/list_create_query.rb index 6d22974..9daa3d5 100644 --- a/lib/klaviyo-api-sdk/models/list_create_query.rb +++ b/lib/klaviyo-api-sdk/models/list_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb index 1a654a6..dd51752 100644 --- a/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb index 2f62025..2f64aab 100644 --- a/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/list_enum.rb b/lib/klaviyo-api-sdk/models/list_enum.rb index ae5c552..23ddf9b 100644 --- a/lib/klaviyo-api-sdk/models/list_enum.rb +++ b/lib/klaviyo-api-sdk/models/list_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/list_members_add_query.rb b/lib/klaviyo-api-sdk/models/list_members_add_query.rb index 89b62e3..11e47e0 100644 --- a/lib/klaviyo-api-sdk/models/list_members_add_query.rb +++ b/lib/klaviyo-api-sdk/models/list_members_add_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb b/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb index 9dd02ff..989a193 100644 --- a/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +++ b/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/list_members_delete_query.rb b/lib/klaviyo-api-sdk/models/list_members_delete_query.rb index 09586a2..0b3defc 100644 --- a/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +++ b/lib/klaviyo-api-sdk/models/list_members_delete_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/list_partial_update_query.rb b/lib/klaviyo-api-sdk/models/list_partial_update_query.rb index eea3134..3e52f6c 100644 --- a/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +++ b/lib/klaviyo-api-sdk/models/list_partial_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb index 12f8d4c..913628f 100644 --- a/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/marketing_subscription_parameters.rb b/lib/klaviyo-api-sdk/models/marketing_subscription_parameters.rb index 5f56e28..da3920f 100644 --- a/lib/klaviyo-api-sdk/models/marketing_subscription_parameters.rb +++ b/lib/klaviyo-api-sdk/models/marketing_subscription_parameters.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -18,6 +18,9 @@ class MarketingSubscriptionParameters # The Consent status to subscribe to for the \"Marketing\" type. Currently supports \"SUBSCRIBED\". attr_accessor :consent + # The timestamp of when the profile's consent was gathered + attr_accessor :consented_at + class EnumAttributeValidator attr_reader :datatype attr_reader :allowable_values @@ -43,7 +46,8 @@ def valid?(value) # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'consent' => :'consent' + :'consent' => :'consent', + :'consented_at' => :'consented_at' } end @@ -55,7 +59,8 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'consent' => :'String' + :'consent' => :'String', + :'consented_at' => :'Time' } end @@ -83,6 +88,10 @@ def initialize(attributes = {}) if attributes.key?(:'consent') self.consent = attributes[:'consent'] end + + if attributes.key?(:'consented_at') + self.consented_at = attributes[:'consented_at'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -120,7 +129,8 @@ def consent=(consent) def ==(o) return true if self.equal?(o) self.class == o.class && - consent == o.consent + consent == o.consent && + consented_at == o.consented_at end # @see the `==` method @@ -132,7 +142,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [consent].hash + [consent, consented_at].hash end # Builds the object from hash diff --git a/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb b/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb index 009d152..05652c3 100644 --- a/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +++ b/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb b/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb index 169655a..33129f5 100644 --- a/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +++ b/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb b/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb index 3fc410d..44f7f08 100644 --- a/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb index 43e55ec..b19e3f8 100644 --- a/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb index aea32f0..3c65626 100644 --- a/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb index 4adbc80..9028765 100644 --- a/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/metric_enum.rb b/lib/klaviyo-api-sdk/models/metric_enum.rb index e9f980f..bfd3c2b 100644 --- a/lib/klaviyo-api-sdk/models/metric_enum.rb +++ b/lib/klaviyo-api-sdk/models/metric_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb index 6544d55..92b3af3 100644 --- a/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb index e002b25..92790f5 100644 --- a/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb b/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb index 16806ac..4a01e4d 100644 --- a/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +++ b/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb b/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb index f8ff1b6..c965c40 100644 --- a/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_create_query.rb b/lib/klaviyo-api-sdk/models/profile_create_query.rb index 8d0ade7..1f7d925 100644 --- a/lib/klaviyo-api-sdk/models/profile_create_query.rb +++ b/lib/klaviyo-api-sdk/models/profile_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb index 9d7a250..38aeff5 100644 --- a/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb index 834af51..a36e4bb 100644 --- a/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_enum.rb b/lib/klaviyo-api-sdk/models/profile_enum.rb index fa8c92d..8509cfb 100644 --- a/lib/klaviyo-api-sdk/models/profile_enum.rb +++ b/lib/klaviyo-api-sdk/models/profile_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb b/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb index d4dc53e..2d6396b 100644 --- a/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb index e6f3f0a..18d534f 100644 --- a/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb b/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb index 92201db..e52b61e 100644 --- a/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb index 205c4e5..e90b1e5 100644 --- a/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb index a24571f..71f837c 100644 --- a/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb b/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb index 4d6c71d..8af10c4 100644 --- a/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +++ b/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb b/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb index 039009b..9743e05 100644 --- a/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +++ b/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb b/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb index 030691b..90a9060 100644 --- a/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +++ b/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb b/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb index d0b7912..8a19ead 100644 --- a/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +++ b/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_location.rb b/lib/klaviyo-api-sdk/models/profile_location.rb index 43213e7..b81dd63 100644 --- a/lib/klaviyo-api-sdk/models/profile_location.rb +++ b/lib/klaviyo-api-sdk/models/profile_location.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_location_latitude.rb b/lib/klaviyo-api-sdk/models/profile_location_latitude.rb index 7f496d7..2bdae4e 100644 --- a/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +++ b/lib/klaviyo-api-sdk/models/profile_location_latitude.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_location_longitude.rb b/lib/klaviyo-api-sdk/models/profile_location_longitude.rb index d4969a0..401e39a 100644 --- a/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +++ b/lib/klaviyo-api-sdk/models/profile_location_longitude.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_merge_enum.rb b/lib/klaviyo-api-sdk/models/profile_merge_enum.rb index 221610d..864c3d1 100644 --- a/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +++ b/lib/klaviyo-api-sdk/models/profile_merge_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_merge_query.rb b/lib/klaviyo-api-sdk/models/profile_merge_query.rb index 40a5f9c..41ddaa7 100644 --- a/lib/klaviyo-api-sdk/models/profile_merge_query.rb +++ b/lib/klaviyo-api-sdk/models/profile_merge_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb b/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb index 4710bbf..44ddfa3 100644 --- a/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb b/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb index a20ef28..60453d9 100644 --- a/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +++ b/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb b/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb index 790567d..d8f98f9 100644 --- a/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +++ b/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb b/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb index ae3b581..8639f2d 100644 --- a/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +++ b/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_meta.rb b/lib/klaviyo-api-sdk/models/profile_meta.rb index 88a9b07..1564948 100644 --- a/lib/klaviyo-api-sdk/models/profile_meta.rb +++ b/lib/klaviyo-api-sdk/models/profile_meta.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb b/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb index 8c2a2ce..edef2a4 100644 --- a/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +++ b/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb b/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb index 59d2c7b..3395e9d 100644 --- a/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +++ b/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb b/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb index 241e324..3893cc5 100644 --- a/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +++ b/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb index 2635e4b..929289b 100644 --- a/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb index f962b4c..7298f1a 100644 --- a/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb b/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb index 8ef60fb..c8c1690 100644 --- a/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb b/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb index 5943eab..23af78f 100644 --- a/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb index 3891236..d67f4a2 100644 --- a/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb index 5420259..7068489 100644 --- a/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -18,7 +18,7 @@ class ProfileSubscriptionCreateQueryResourceObjectAttributes # The email address to subscribe or to set on the profile if `channels` is specified and the email channel is omitted. attr_accessor :email - # The phone number to subscribe or to set on the profile if `channels` is specified and the SMS channel is omitted. + # The phone number to subscribe or to set on the profile if `channels` is specified and the SMS channel is omitted. This must be in E.164 format. attr_accessor :phone_number attr_accessor :subscriptions diff --git a/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb b/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb index defd36c..4fae7fd 100644 --- a/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb index 30a3dc7..d771280 100644 --- a/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -18,7 +18,7 @@ class ProfileSubscriptionDeleteQueryResourceObjectAttributes # The email address to unsubscribe. attr_accessor :email - # The phone number to unsubscribe. + # The phone number to unsubscribe. This must be in E.164 format. attr_accessor :phone_number # Attribute mapping from ruby-style variable name to JSON key. diff --git a/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb b/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb index a05048b..14a0a17 100644 --- a/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb b/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb index 4146ee4..cdf19e1 100644 --- a/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +++ b/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb index 0021e2d..599f3f3 100644 --- a/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb index d7c8af6..3255806 100644 --- a/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb b/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb index c2a4399..4986bab 100644 --- a/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb index 2a72716..07250da 100644 --- a/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/profile_upsert_query.rb b/lib/klaviyo-api-sdk/models/profile_upsert_query.rb new file mode 100644 index 0000000..2ee2ac9 --- /dev/null +++ b/lib/klaviyo-api-sdk/models/profile_upsert_query.rb @@ -0,0 +1,224 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class ProfileUpsertQuery + attr_accessor :data + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'data' => :'data' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'data' => :'ProfileUpsertQueryResourceObject' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::ProfileUpsertQuery` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::ProfileUpsertQuery`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'data') + self.data = attributes[:'data'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @data.nil? + invalid_properties.push('invalid value for "data", data cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @data.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + data == o.data + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [data].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + self.class.openapi_types.each_pair do |key, type| + if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) + self.send("#{key}=", nil) + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = KlaviyoAPI.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb b/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb index 6b1a5a8..9c748c4 100644 --- a/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -22,12 +22,15 @@ class ProfileUpsertQueryResourceObject attr_accessor :attributes + attr_accessor :meta + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'type' => :'type', :'id' => :'id', - :'attributes' => :'attributes' + :'attributes' => :'attributes', + :'meta' => :'meta' } end @@ -41,7 +44,8 @@ def self.openapi_types { :'type' => :'ProfileEnum', :'id' => :'String', - :'attributes' => :'ProfileUpsertQueryResourceObjectAttributes' + :'attributes' => :'ProfileUpsertQueryResourceObjectAttributes', + :'meta' => :'ProfileMeta' } end @@ -77,6 +81,10 @@ def initialize(attributes = {}) if attributes.key?(:'attributes') self.attributes = attributes[:'attributes'] end + + if attributes.key?(:'meta') + self.meta = attributes[:'meta'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -109,7 +117,8 @@ def ==(o) self.class == o.class && type == o.type && id == o.id && - attributes == o.attributes + attributes == o.attributes && + meta == o.meta end # @see the `==` method @@ -121,7 +130,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, id, attributes].hash + [type, id, attributes, meta].hash end # Builds the object from hash diff --git a/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb index 77c6224..8fed1bc 100644 --- a/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -50,8 +50,6 @@ class ProfileUpsertQueryResourceObjectAttributes # An object containing key/value pairs for any custom properties assigned to this profile attr_accessor :properties - attr_accessor :meta - # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -66,8 +64,7 @@ def self.attribute_map :'title' => :'title', :'image' => :'image', :'location' => :'location', - :'properties' => :'properties', - :'meta' => :'meta' + :'properties' => :'properties' } end @@ -90,8 +87,7 @@ def self.openapi_types :'title' => :'String', :'image' => :'String', :'location' => :'ProfileLocation', - :'properties' => :'Object', - :'meta' => :'ProfileMeta' + :'properties' => :'Object' } end @@ -163,10 +159,6 @@ def initialize(attributes = {}) if attributes.key?(:'properties') self.properties = attributes[:'properties'] end - - if attributes.key?(:'meta') - self.meta = attributes[:'meta'] - end end # Show invalid properties with the reasons. Usually used together with valid? @@ -198,8 +190,7 @@ def ==(o) title == o.title && image == o.image && location == o.location && - properties == o.properties && - meta == o.meta + properties == o.properties end # @see the `==` method @@ -211,7 +202,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [email, phone_number, external_id, anonymous_id, _kx, first_name, last_name, organization, title, image, location, properties, meta].hash + [email, phone_number, external_id, anonymous_id, _kx, first_name, last_name, organization, title, image, location, properties].hash end # Builds the object from hash diff --git a/lib/klaviyo-api-sdk/models/push_token_create_query.rb b/lib/klaviyo-api-sdk/models/push_token_create_query.rb index 76ff3b7..7907ff0 100644 --- a/lib/klaviyo-api-sdk/models/push_token_create_query.rb +++ b/lib/klaviyo-api-sdk/models/push_token_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb index 80a3781..7ba549a 100644 --- a/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb index 154f030..30c62d5 100644 --- a/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb b/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb index f9c3fed..d23929b 100644 --- a/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +++ b/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/push_token_enum.rb b/lib/klaviyo-api-sdk/models/push_token_enum.rb index f110e1f..70d0ae8 100644 --- a/lib/klaviyo-api-sdk/models/push_token_enum.rb +++ b/lib/klaviyo-api-sdk/models/push_token_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/render_options_sub_object.rb b/lib/klaviyo-api-sdk/models/render_options_sub_object.rb index 095e2f8..96af98a 100644 --- a/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +++ b/lib/klaviyo-api-sdk/models/render_options_sub_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/segment_enum.rb b/lib/klaviyo-api-sdk/models/segment_enum.rb index f021060..46db129 100644 --- a/lib/klaviyo-api-sdk/models/segment_enum.rb +++ b/lib/klaviyo-api-sdk/models/segment_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb b/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb index be9a98e..8c02f25 100644 --- a/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +++ b/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb index cf8dd3d..fc4b72e 100644 --- a/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb index 4c54e6a..d17910a 100644 --- a/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 @@ -66,17 +66,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @name.nil? - invalid_properties.push('invalid value for "name", name cannot be nil.') - end - invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? - return false if @name.nil? true end diff --git a/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb b/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb index 3da41c3..758c83f 100644 --- a/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +++ b/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb index d1a2dfb..07d8a6d 100644 --- a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +++ b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb index a1caa89..820bcae 100644 --- a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb index 3e0d3f3..85475c8 100644 --- a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb index 3cd7667..2ec1879 100644 --- a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +++ b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb index 6aee9fa..a3f3b07 100644 --- a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +++ b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb index 1cc6770..7e9d2c5 100644 --- a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +++ b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb index f90b7cd..4d5db01 100644 --- a/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +++ b/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb b/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb index daafd4b..c778f78 100644 --- a/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +++ b/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb b/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb index 0dad28b..334397a 100644 --- a/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +++ b/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb b/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb index b5908f2..91dea9c 100644 --- a/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +++ b/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb b/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb index aa8cf6a..712e1ef 100644 --- a/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +++ b/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/static_schedule_options.rb b/lib/klaviyo-api-sdk/models/static_schedule_options.rb index 4bbe3b6..6ca09b9 100644 --- a/lib/klaviyo-api-sdk/models/static_schedule_options.rb +++ b/lib/klaviyo-api-sdk/models/static_schedule_options.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/sto_schedule_options.rb b/lib/klaviyo-api-sdk/models/sto_schedule_options.rb index 23a8f10..93d5228 100644 --- a/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +++ b/lib/klaviyo-api-sdk/models/sto_schedule_options.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_channels.rb b/lib/klaviyo-api-sdk/models/subscription_channels.rb index f109108..7dea737 100644 --- a/lib/klaviyo-api-sdk/models/subscription_channels.rb +++ b/lib/klaviyo-api-sdk/models/subscription_channels.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb index 90aae9d..50ac7b5 100644 --- a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb index a3b8162..ccf8bbf 100644 --- a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb index b5fec59..30e213a 100644 --- a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb index df80631..e2f3b33 100644 --- a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +++ b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb index df4b0a7..51ca1b3 100644 --- a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +++ b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb index c34bc18..305e12b 100644 --- a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +++ b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb index 5bf5cae..3c17a76 100644 --- a/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +++ b/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb index b6af4e8..9073ad5 100644 --- a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb index 1e8f01e..d5490b6 100644 --- a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb index 4abc1af..fef301f 100644 --- a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb index 8bab1c7..23663b1 100644 --- a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +++ b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb index 0d1ca8d..741d8ef 100644 --- a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +++ b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb index 1969181..d951c9f 100644 --- a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +++ b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb index 72fc317..b616ee2 100644 --- a/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +++ b/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb b/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb index 6bc1596..26f95a4 100644 --- a/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb index e26d8ea..c088490 100644 --- a/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb index 881d8c8..76c9296 100644 --- a/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb b/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb index 99b0d04..ea6e354 100644 --- a/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +++ b/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb b/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb index 61cb97a..0fe7499 100644 --- a/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +++ b/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb index 72aa0e4..ecb8349 100644 --- a/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb index 82c8edb..7a8f5d4 100644 --- a/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb b/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb index 815a9bb..3aa20c3 100644 --- a/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +++ b/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_campaign_op.rb b/lib/klaviyo-api-sdk/models/tag_campaign_op.rb index 715e206..fbfca8c 100644 --- a/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +++ b/lib/klaviyo-api-sdk/models/tag_campaign_op.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb b/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb index c6babfd..1e83914 100644 --- a/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +++ b/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_create_query.rb b/lib/klaviyo-api-sdk/models/tag_create_query.rb index d5685de..5f1e971 100644 --- a/lib/klaviyo-api-sdk/models/tag_create_query.rb +++ b/lib/klaviyo-api-sdk/models/tag_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb index e5152df..4a6a74e 100644 --- a/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb index 3fbe971..c543c9a 100644 --- a/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb b/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb index ecedc7b..c6c10cf 100644 --- a/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +++ b/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb b/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb index bbd17a6..44724e5 100644 --- a/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +++ b/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb b/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb index 7a982e5..48db66b 100644 --- a/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +++ b/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_enum.rb b/lib/klaviyo-api-sdk/models/tag_enum.rb index 0633357..2ae45f2 100644 --- a/lib/klaviyo-api-sdk/models/tag_enum.rb +++ b/lib/klaviyo-api-sdk/models/tag_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_flow_op.rb b/lib/klaviyo-api-sdk/models/tag_flow_op.rb index 327da0b..7b71f41 100644 --- a/lib/klaviyo-api-sdk/models/tag_flow_op.rb +++ b/lib/klaviyo-api-sdk/models/tag_flow_op.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb b/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb index c938f83..8034670 100644 --- a/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +++ b/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_group_create_query.rb b/lib/klaviyo-api-sdk/models/tag_group_create_query.rb index ac92487..031508a 100644 --- a/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +++ b/lib/klaviyo-api-sdk/models/tag_group_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb index 0c92a97..28a644b 100644 --- a/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb index ce0c060..3a8b93a 100644 --- a/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_group_enum.rb b/lib/klaviyo-api-sdk/models/tag_group_enum.rb index 3f3df96..3dbf4dc 100644 --- a/lib/klaviyo-api-sdk/models/tag_group_enum.rb +++ b/lib/klaviyo-api-sdk/models/tag_group_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_group_update_query.rb b/lib/klaviyo-api-sdk/models/tag_group_update_query.rb index a03114a..fce6b3a 100644 --- a/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +++ b/lib/klaviyo-api-sdk/models/tag_group_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb index e663259..a2c151c 100644 --- a/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb index 36828b9..92b3f6c 100644 --- a/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_list_op.rb b/lib/klaviyo-api-sdk/models/tag_list_op.rb index 4970bc8..b5d5309 100644 --- a/lib/klaviyo-api-sdk/models/tag_list_op.rb +++ b/lib/klaviyo-api-sdk/models/tag_list_op.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb b/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb index 650b56b..3187c29 100644 --- a/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +++ b/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_segment_op.rb b/lib/klaviyo-api-sdk/models/tag_segment_op.rb index 929db15..4f17193 100644 --- a/lib/klaviyo-api-sdk/models/tag_segment_op.rb +++ b/lib/klaviyo-api-sdk/models/tag_segment_op.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb b/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb index 1f02067..bad35f5 100644 --- a/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +++ b/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_update_query.rb b/lib/klaviyo-api-sdk/models/tag_update_query.rb index 3c6fa8b..8a35cff 100644 --- a/lib/klaviyo-api-sdk/models/tag_update_query.rb +++ b/lib/klaviyo-api-sdk/models/tag_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb index 8f86d67..d1bb10a 100644 --- a/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_clone_query.rb b/lib/klaviyo-api-sdk/models/template_clone_query.rb index a4be84b..62b1c40 100644 --- a/lib/klaviyo-api-sdk/models/template_clone_query.rb +++ b/lib/klaviyo-api-sdk/models/template_clone_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb b/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb index d8cfc45..3fb9193 100644 --- a/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb index 01e0947..32ed805 100644 --- a/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_create_query.rb b/lib/klaviyo-api-sdk/models/template_create_query.rb index 441bebb..abcf2fe 100644 --- a/lib/klaviyo-api-sdk/models/template_create_query.rb +++ b/lib/klaviyo-api-sdk/models/template_create_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb b/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb index f9115cb..ab11000 100644 --- a/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb index c6ef32c..b89d56a 100644 --- a/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_enum.rb b/lib/klaviyo-api-sdk/models/template_enum.rb index 101b507..89a1f60 100644 --- a/lib/klaviyo-api-sdk/models/template_enum.rb +++ b/lib/klaviyo-api-sdk/models/template_enum.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_render_query.rb b/lib/klaviyo-api-sdk/models/template_render_query.rb index 7aca267..d77d906 100644 --- a/lib/klaviyo-api-sdk/models/template_render_query.rb +++ b/lib/klaviyo-api-sdk/models/template_render_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb b/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb index a30941e..023f427 100644 --- a/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb index b26c724..eae4d38 100644 --- a/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_update_query.rb b/lib/klaviyo-api-sdk/models/template_update_query.rb index 61087cd..46047a9 100644 --- a/lib/klaviyo-api-sdk/models/template_update_query.rb +++ b/lib/klaviyo-api-sdk/models/template_update_query.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb b/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb index 869003e..c65823f 100644 --- a/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +++ b/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb b/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb index b0d9fe9..eb0390c 100644 --- a/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +++ b/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb b/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb index a2ab08d..b4b2c54 100644 --- a/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +++ b/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/models/timeframe.rb b/lib/klaviyo-api-sdk/models/timeframe.rb new file mode 100644 index 0000000..17425c8 --- /dev/null +++ b/lib/klaviyo-api-sdk/models/timeframe.rb @@ -0,0 +1,259 @@ +=begin +#Klaviyo API + +#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + +The version of the OpenAPI document: 2024-02-15 +Contact: developers@klaviyo.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 6.2.1 + +=end + +require 'date' +require 'time' + +module KlaviyoAPI + class Timeframe + # Pre-defined key that represents a set timeframe + attr_accessor :key + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'key' => :'key' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'key' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::Timeframe` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::Timeframe`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'key') + self.key = attributes[:'key'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @key.nil? + invalid_properties.push('invalid value for "key", key cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @key.nil? + key_validator = EnumAttributeValidator.new('String', ["last_12_months", "last_30_days", "last_365_days", "last_3_months", "last_7_days", "last_90_days", "last_month", "last_week", "last_year", "this_month", "this_week", "this_year", "today", "yesterday"]) + return false unless key_validator.valid?(@key) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] key Object to be assigned + def key=(key) + validator = EnumAttributeValidator.new('String', ["last_12_months", "last_30_days", "last_365_days", "last_3_months", "last_7_days", "last_90_days", "last_month", "last_week", "last_year", "this_month", "this_week", "this_year", "today", "yesterday"]) + unless validator.valid?(key) + fail ArgumentError, "invalid value for \"key\", must be one of #{validator.allowable_values}." + end + @key = key + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + key == o.key + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [key].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + self.class.openapi_types.each_pair do |key, type| + if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) + self.send("#{key}=", nil) + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = KlaviyoAPI.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb b/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb index 7c757d5..6ae6de6 100644 --- a/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +++ b/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 diff --git a/lib/klaviyo-api-sdk/version.rb b/lib/klaviyo-api-sdk/version.rb index c4b2b9b..71a6683 100644 --- a/lib/klaviyo-api-sdk/version.rb +++ b/lib/klaviyo-api-sdk/version.rb @@ -3,7 +3,7 @@ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. -The version of the OpenAPI document: 2023-12-15 +The version of the OpenAPI document: 2024-02-15 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1