klaviyo-api-sdk 2.0.0 → 4.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +91 -0
- data/README.md +562 -235
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +160 -0
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +569 -98
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +427 -357
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +108 -108
- data/lib/klaviyo-api-sdk/api/flows_api.rb +229 -163
- data/lib/klaviyo-api-sdk/api/lists_api.rb +117 -74
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +18 -18
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +108 -114
- data/lib/klaviyo-api-sdk/api/segments_api.rb +105 -62
- data/lib/klaviyo-api-sdk/api/tags_api.rb +145 -117
- data/lib/klaviyo-api-sdk/api/templates_api.rb +39 -39
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{subscription_enum.rb → back_in_stock_subscription_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +32 -38
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +227 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +25 -16
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +5 -20
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object.rb → campaign_message_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{collection_links.rb → campaign_message_create_query_resource_object_attributes.rb} +34 -41
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +23 -14
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +18 -16
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships_items.rb +226 -0
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_update_query_resource_object_relationships_items_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_resource_object_relationships_categories_data_inner.rb → catalog_item_category_op_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +72 -70
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +43 -43
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +115 -113
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +8 -8
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items.rb → catalog_variant_create_query_resource_object_relationships_item.rb} +6 -8
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +57 -57
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +13 -29
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/{content_sub_object.rb → email_content_sub_object.rb} +12 -32
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +220 -0
- data/lib/klaviyo-api-sdk/models/{tracking_options_sub_object.rb → email_tracking_options_sub_object.rb} +28 -28
- data/lib/klaviyo-api-sdk/models/{event_create_query.rb → event_create_query_v2.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object.rb → event_create_query_v2_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object_attributes.rb → event_create_query_v2_resource_object_attributes.rb} +21 -22
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query.rb → event_create_query_v2_resource_object_attributes_metric.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{onsite_profile_create_query.rb → event_create_query_v2_resource_object_attributes_profile.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response.rb → get_create_variants_jobs5_xx_response.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner.rb → get_create_variants_jobs5_xx_response_errors_inner.rb} +40 -40
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner_source.rb → get_create_variants_jobs5_xx_response_errors_inner_source.rb} +17 -17
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +64 -67
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object.rb → metric_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{metric_create_query.rb → metric_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +29 -19
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +55 -45
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +8 -13
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +39 -39
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/{onsite_profile_meta_identifiers.rb → profile_identifier_dto_resource_object_attributes.rb} +18 -38
- data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{object_links.rb → profile_meta.rb} +11 -16
- data/lib/klaviyo-api-sdk/models/{sms_message_content.rb → profile_meta_patch_properties.rb} +28 -27
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +106 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +28 -19
- data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query_resource_object_attributes.rb → profile_partial_update_query_resource_object_attributes.rb} +92 -39
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{flow_action_enum.rb → profile_subscription_bulk_delete_job_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/{subscription.rb → profile_subscription_create_query_resource_object_attributes.rb} +18 -28
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{campaign_recipient_estimation_enum.rb → profile_suppression_bulk_delete_job_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query_resource_object.rb → profile_suppression_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{suppression.rb → profile_suppression_create_query_resource_object_attributes.rb} +5 -10
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{subscriptions.rb → profile_suppression_delete_query_resource_object_attributes.rb} +9 -17
- data/lib/klaviyo-api-sdk/models/{sms_render_options.rb → render_options_sub_object.rb} +32 -37
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query.rb → server_bis_subscription_create_query.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object_attributes.rb → server_bis_subscription_create_query_resource_object_attributes.rb} +46 -32
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +224 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/{sms_channel.rb → sms_content_sub_object_create.rb} +12 -11
- data/lib/klaviyo-api-sdk/models/{send_options_sub_object.rb → sms_send_options_sub_object.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{sms_tracking_options.rb → sms_tracking_options_sub_object.rb} +19 -27
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +25 -16
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +14 -32
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +11 -14
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query.rb → suppression_delete_job_create_query.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{error_source.rb → suppression_delete_job_create_query_resource_object_attributes.rb} +14 -17
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +25 -16
- data/lib/klaviyo-api-sdk/models/{email_channel.rb → tag_create_query_resource_object_relationships.rb} +11 -11
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +5 -17
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +23 -35
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +5 -17
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -28
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +85 -59
- metadata +91 -571
- data/Gemfile +0 -9
- data/Rakefile +0 -10
- data/docs/AudiencesSubObject.md +0 -20
- data/docs/CampaignCloneQuery.md +0 -18
- data/docs/CampaignCloneQueryResourceObject.md +0 -20
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignCreateQuery.md +0 -18
- data/docs/CampaignCreateQueryResourceObject.md +0 -20
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/CampaignEnum.md +0 -15
- data/docs/CampaignMessageAssignTemplateQuery.md +0 -18
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +0 -20
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignMessageEnum.md +0 -15
- data/docs/CampaignMessagePartialUpdateQuery.md +0 -18
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignPartialUpdateQuery.md +0 -18
- data/docs/CampaignPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +0 -26
- data/docs/CampaignRecipientEstimationEnum.md +0 -15
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +0 -18
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignRecipientEstimationJobEnum.md +0 -15
- data/docs/CampaignSendJobCreateQuery.md +0 -18
- data/docs/CampaignSendJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignSendJobEnum.md +0 -15
- data/docs/CampaignSendJobPartialUpdateQuery.md +0 -18
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignsApi.md +0 -1275
- data/docs/CatalogCategoryBulkCreateJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogCategoryCreateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateQueryResourceObject.md +0 -22
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +0 -24
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryEnum.md +0 -15
- data/docs/CatalogCategoryItemOp.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryUpdateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemBulkCreateJobEnum.md +0 -15
- data/docs/CatalogItemBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogItemBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogItemCategoryOp.md +0 -18
- data/docs/CatalogItemCreateJobCreateQuery.md +0 -18
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemCreateQuery.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObject.md +0 -22
- data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogItemEnum.md +0 -15
- data/docs/CatalogItemUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemUpdateQuery.md +0 -18
- data/docs/CatalogItemUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +0 -34
- data/docs/CatalogJobErrorPayload.md +0 -26
- data/docs/CatalogVariantBulkCreateJobEnum.md +0 -15
- data/docs/CatalogVariantBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogVariantBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogVariantCreateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +0 -46
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItems.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogVariantEnum.md +0 -15
- data/docs/CatalogVariantUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantUpdateQuery.md +0 -18
- data/docs/CatalogVariantUpdateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogsApi.md +0 -4032
- data/docs/ClientApi.md +0 -205
- data/docs/CollectionLinks.md +0 -26
- data/docs/ContentSubObject.md +0 -28
- data/docs/DataPrivacyApi.md +0 -78
- data/docs/DataPrivacyCreateDeletionJobQuery.md +0 -18
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +0 -20
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +0 -22
- data/docs/DataPrivacyDeletionJobEnum.md +0 -15
- data/docs/EmailChannel.md +0 -18
- data/docs/EmailMarketing.md +0 -32
- data/docs/EmailMarketingListSuppression.md +0 -22
- data/docs/EmailMarketingSuppression.md +0 -20
- data/docs/EmailMessageContent.md +0 -24
- data/docs/EmailTrackingOptions.md +0 -24
- data/docs/ErrorSource.md +0 -18
- data/docs/EventCreateQuery.md +0 -18
- data/docs/EventCreateQueryResourceObject.md +0 -20
- data/docs/EventCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/EventEnum.md +0 -15
- data/docs/EventsApi.md +0 -544
- data/docs/FlowActionEnum.md +0 -15
- data/docs/FlowEnum.md +0 -15
- data/docs/FlowMessageEnum.md +0 -15
- data/docs/FlowUpdateQuery.md +0 -18
- data/docs/FlowUpdateQueryResourceObject.md +0 -22
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/FlowsApi.md +0 -1173
- data/docs/GetCampaigns4XXResponse.md +0 -18
- data/docs/GetCampaigns4XXResponseErrorsInner.md +0 -26
- data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +0 -20
- data/docs/ListCreateQuery.md +0 -18
- data/docs/ListCreateQueryResourceObject.md +0 -20
- data/docs/ListCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/ListEnum.md +0 -15
- data/docs/ListMembersAddQuery.md +0 -18
- data/docs/ListMembersAddQueryDataInner.md +0 -20
- data/docs/ListMembersDeleteQuery.md +0 -18
- data/docs/ListPartialUpdateQuery.md +0 -18
- data/docs/ListPartialUpdateQueryResourceObject.md +0 -22
- data/docs/ListsApi.md +0 -832
- data/docs/MetricAggregateEnum.md +0 -15
- data/docs/MetricAggregateQuery.md +0 -18
- data/docs/MetricAggregateQueryResourceObject.md +0 -20
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +0 -36
- data/docs/MetricAggregateRowDTO.md +0 -20
- data/docs/MetricCreateQuery.md +0 -20
- data/docs/MetricEnum.md +0 -15
- data/docs/MetricsApi.md +0 -233
- data/docs/ObjectLinks.md +0 -18
- data/docs/OnsiteProfileCreateQuery.md +0 -18
- data/docs/OnsiteProfileCreateQueryResourceObject.md +0 -22
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +0 -38
- data/docs/OnsiteProfileMeta.md +0 -18
- data/docs/OnsiteProfileMetaIdentifiers.md +0 -28
- data/docs/OnsiteSubscriptionCreateQuery.md +0 -18
- data/docs/OnsiteSubscriptionCreateQueryResourceObject.md +0 -20
- data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md +0 -26
- data/docs/PredictiveAnalytics.md +0 -34
- data/docs/ProfileAggregateEnum.md +0 -15
- data/docs/ProfileCreateQuery.md +0 -18
- data/docs/ProfileCreateQueryResourceObject.md +0 -20
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +0 -36
- data/docs/ProfileEnum.md +0 -15
- data/docs/ProfileLocation.md +0 -34
- data/docs/ProfileLocationLatitude.md +0 -49
- data/docs/ProfileLocationLongitude.md +0 -49
- data/docs/ProfilePartialUpdateQuery.md +0 -18
- data/docs/ProfilePartialUpdateQueryResourceObject.md +0 -22
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileUnsubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileUnsuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfilesApi.md +0 -909
- data/docs/SMSChannel.md +0 -18
- data/docs/SMSMarketing.md +0 -24
- data/docs/SMSMessageContent.md +0 -20
- data/docs/SMSRenderOptions.md +0 -24
- data/docs/SMSTrackingOptions.md +0 -20
- data/docs/STOScheduleOptions.md +0 -18
- data/docs/SegmentEnum.md +0 -15
- data/docs/SegmentPartialUpdateQuery.md +0 -18
- data/docs/SegmentPartialUpdateQueryResourceObject.md +0 -22
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/SegmentsApi.md +0 -543
- data/docs/SendOptions.md +0 -20
- data/docs/SendOptionsSubObject.md +0 -18
- data/docs/SendStrategySubObject.md +0 -24
- data/docs/SendTimeSubObject.md +0 -20
- data/docs/StaticScheduleOptions.md +0 -22
- data/docs/Subscription.md +0 -24
- data/docs/SubscriptionChannels.md +0 -20
- data/docs/SubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/SubscriptionEnum.md +0 -15
- data/docs/Subscriptions.md +0 -20
- data/docs/Suppression.md +0 -18
- data/docs/SuppressionCreateJobCreateQuery.md +0 -18
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagCampaignOp.md +0 -18
- data/docs/TagCampaignOpDataInner.md +0 -20
- data/docs/TagCreateQuery.md +0 -18
- data/docs/TagCreateQueryResourceObject.md +0 -20
- data/docs/TagCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagEnum.md +0 -15
- data/docs/TagFlowOp.md +0 -18
- data/docs/TagFlowOpDataInner.md +0 -20
- data/docs/TagGroupCreateQuery.md +0 -18
- data/docs/TagGroupCreateQueryResourceObject.md +0 -20
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagGroupEnum.md +0 -15
- data/docs/TagGroupUpdateQuery.md +0 -18
- data/docs/TagGroupUpdateQueryResourceObject.md +0 -22
- data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagListOp.md +0 -18
- data/docs/TagListOpDataInner.md +0 -20
- data/docs/TagSegmentOp.md +0 -18
- data/docs/TagSegmentOpDataInner.md +0 -20
- data/docs/TagUpdateQuery.md +0 -18
- data/docs/TagUpdateQueryResourceObject.md +0 -22
- data/docs/TagUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagsApi.md +0 -1923
- data/docs/TemplateCloneQuery.md +0 -18
- data/docs/TemplateCloneQueryResourceObject.md +0 -20
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +0 -22
- data/docs/TemplateCreateQuery.md +0 -18
- data/docs/TemplateCreateQueryResourceObject.md +0 -20
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +0 -32
- data/docs/TemplateEnum.md +0 -15
- data/docs/TemplateRenderQuery.md +0 -18
- data/docs/TemplateRenderQueryResourceObject.md +0 -20
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +0 -22
- data/docs/TemplateUpdateQuery.md +0 -18
- data/docs/TemplateUpdateQueryResourceObject.md +0 -22
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +0 -30
- data/docs/TemplatesApi.md +0 -525
- data/docs/TestApiAnalyticsSampleEnum.md +0 -15
- data/docs/TestListEnum.md +0 -15
- data/docs/ThrottledScheduleOptions.md +0 -20
- data/docs/TrackingOptionsSubObject.md +0 -24
- data/docs/UTMParamsSubObject.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/UnsuppressionCreateJobCreateQuery.md +0 -18
- data/docs/UnsuppressionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/UnsuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/UtmParamInfo.md +0 -20
- data/git_push.sh +0 -57
- data/lib/klaviyo-api-sdk/api/client_api.rb +0 -249
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +0 -284
- data/lib/klaviyo-api-sdk/models/email_marketing.rb +0 -298
- data/lib/klaviyo-api-sdk/models/email_marketing_list_suppression.rb +0 -255
- data/lib/klaviyo-api-sdk/models/email_marketing_suppression.rb +0 -240
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +0 -266
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +0 -268
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +0 -242
- data/lib/klaviyo-api-sdk/models/predictive_analytics.rb +0 -300
- data/lib/klaviyo-api-sdk/models/profile_aggregate_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/send_options.rb +0 -238
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +0 -240
- data/lib/klaviyo-api-sdk/models/sms_marketing.rb +0 -270
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +0 -235
- data/lib/klaviyo-api-sdk/models/test_api_analytics_sample_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/test_list_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +0 -238
- data/spec/api/campaigns_api_spec.rb +0 -255
- data/spec/api/catalogs_api_spec.rb +0 -751
- data/spec/api/client_api_spec.rb +0 -74
- data/spec/api/data_privacy_api_spec.rb +0 -47
- data/spec/api/events_api_spec.rb +0 -132
- data/spec/api/flows_api_spec.rb +0 -247
- data/spec/api/lists_api_spec.rb +0 -180
- data/spec/api/metrics_api_spec.rb +0 -74
- data/spec/api/profiles_api_spec.rb +0 -194
- data/spec/api/segments_api_spec.rb +0 -130
- data/spec/api/tags_api_spec.rb +0 -367
- data/spec/api/templates_api_spec.rb +0 -124
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/audiences_sub_object_spec.rb +0 -40
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_clone_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_clone_query_spec.rb +0 -34
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/campaign_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_create_query_spec.rb +0 -34
- data/spec/models/campaign_enum_spec.rb +0 -28
- data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_spec.rb +0 -34
- data/spec/models/campaign_message_enum_spec.rb +0 -28
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_message_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_enum_spec.rb +0 -28
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_send_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_send_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +0 -34
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +0 -56
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_category_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_enum_spec.rb +0 -28
- data/spec/models/catalog_category_item_op_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_category_update_query_spec.rb +0 -34
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_category_op_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_item_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_enum_spec.rb +0 -28
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +0 -82
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_item_update_query_spec.rb +0 -34
- data/spec/models/catalog_job_error_payload_spec.rb +0 -58
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +0 -126
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_data_inner_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_update_query_spec.rb +0 -34
- data/spec/models/collection_links_spec.rb +0 -58
- data/spec/models/content_sub_object_spec.rb +0 -64
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +0 -40
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +0 -34
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +0 -28
- data/spec/models/email_channel_spec.rb +0 -34
- data/spec/models/email_marketing_list_suppression_spec.rb +0 -46
- data/spec/models/email_marketing_spec.rb +0 -76
- data/spec/models/email_marketing_suppression_spec.rb +0 -40
- data/spec/models/email_message_content_spec.rb +0 -52
- data/spec/models/email_tracking_options_spec.rb +0 -52
- data/spec/models/error_source_spec.rb +0 -34
- data/spec/models/event_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/event_create_query_resource_object_spec.rb +0 -40
- data/spec/models/event_create_query_spec.rb +0 -34
- data/spec/models/event_enum_spec.rb +0 -28
- data/spec/models/flow_action_enum_spec.rb +0 -28
- data/spec/models/flow_enum_spec.rb +0 -28
- data/spec/models/flow_message_enum_spec.rb +0 -28
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/flow_update_query_resource_object_spec.rb +0 -46
- data/spec/models/flow_update_query_spec.rb +0 -34
- data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +0 -40
- data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +0 -58
- data/spec/models/get_campaigns4_xx_response_spec.rb +0 -34
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/list_create_query_resource_object_spec.rb +0 -40
- data/spec/models/list_create_query_spec.rb +0 -34
- data/spec/models/list_enum_spec.rb +0 -28
- data/spec/models/list_members_add_query_data_inner_spec.rb +0 -44
- data/spec/models/list_members_add_query_spec.rb +0 -34
- data/spec/models/list_members_delete_query_spec.rb +0 -34
- data/spec/models/list_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/list_partial_update_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_enum_spec.rb +0 -28
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +0 -40
- data/spec/models/metric_aggregate_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_row_dto_spec.rb +0 -40
- data/spec/models/metric_create_query_spec.rb +0 -40
- data/spec/models/metric_enum_spec.rb +0 -28
- data/spec/models/object_links_spec.rb +0 -34
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +0 -94
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +0 -46
- data/spec/models/onsite_profile_create_query_spec.rb +0 -34
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +0 -64
- data/spec/models/onsite_profile_meta_spec.rb +0 -34
- data/spec/models/onsite_subscription_create_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/onsite_subscription_create_query_resource_object_spec.rb +0 -40
- data/spec/models/onsite_subscription_create_query_spec.rb +0 -34
- data/spec/models/predictive_analytics_spec.rb +0 -82
- data/spec/models/profile_aggregate_enum_spec.rb +0 -28
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +0 -88
- data/spec/models/profile_create_query_resource_object_spec.rb +0 -40
- data/spec/models/profile_create_query_spec.rb +0 -34
- data/spec/models/profile_enum_spec.rb +0 -28
- data/spec/models/profile_location_latitude_spec.rb +0 -31
- data/spec/models/profile_location_longitude_spec.rb +0 -31
- data/spec/models/profile_location_spec.rb +0 -82
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/profile_partial_update_query_spec.rb +0 -34
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_unsubscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_unsuppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/segment_enum_spec.rb +0 -28
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/segment_partial_update_query_spec.rb +0 -34
- data/spec/models/send_options_spec.rb +0 -40
- data/spec/models/send_options_sub_object_spec.rb +0 -34
- data/spec/models/send_strategy_sub_object_spec.rb +0 -52
- data/spec/models/send_time_sub_object_spec.rb +0 -40
- data/spec/models/sms_channel_spec.rb +0 -34
- data/spec/models/sms_marketing_spec.rb +0 -52
- data/spec/models/sms_message_content_spec.rb +0 -40
- data/spec/models/sms_render_options_spec.rb +0 -52
- data/spec/models/sms_tracking_options_spec.rb +0 -40
- data/spec/models/static_schedule_options_spec.rb +0 -46
- data/spec/models/sto_schedule_options_spec.rb +0 -34
- data/spec/models/subscription_channels_spec.rb +0 -48
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/subscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/subscription_enum_spec.rb +0 -28
- data/spec/models/subscription_spec.rb +0 -52
- data/spec/models/subscriptions_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/suppression_spec.rb +0 -34
- data/spec/models/tag_campaign_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_campaign_op_spec.rb +0 -34
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_create_query_spec.rb +0 -34
- data/spec/models/tag_enum_spec.rb +0 -28
- data/spec/models/tag_flow_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_flow_op_spec.rb +0 -34
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_group_create_query_spec.rb +0 -34
- data/spec/models/tag_group_enum_spec.rb +0 -28
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_group_update_query_spec.rb +0 -34
- data/spec/models/tag_list_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_list_op_spec.rb +0 -34
- data/spec/models/tag_segment_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_segment_op_spec.rb +0 -34
- data/spec/models/tag_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/tag_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_update_query_spec.rb +0 -34
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_clone_query_resource_object_spec.rb +0 -40
- data/spec/models/template_clone_query_spec.rb +0 -34
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/template_create_query_resource_object_spec.rb +0 -40
- data/spec/models/template_create_query_spec.rb +0 -34
- data/spec/models/template_enum_spec.rb +0 -28
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_render_query_resource_object_spec.rb +0 -40
- data/spec/models/template_render_query_spec.rb +0 -34
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +0 -52
- data/spec/models/template_update_query_resource_object_spec.rb +0 -46
- data/spec/models/template_update_query_spec.rb +0 -34
- data/spec/models/test_api_analytics_sample_enum_spec.rb +0 -28
- data/spec/models/test_list_enum_spec.rb +0 -28
- data/spec/models/throttled_schedule_options_spec.rb +0 -40
- data/spec/models/tracking_options_sub_object_spec.rb +0 -52
- data/spec/models/unsubscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/unsubscription_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/unsubscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/unsuppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/utm_param_info_spec.rb +0 -40
- data/spec/models/utm_params_sub_object_spec.rb +0 -40
- data/spec/spec_helper.rb +0 -111
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2023-
|
6
|
+
The version of the OpenAPI document: 2023-07-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -20,12 +20,13 @@ module KlaviyoAPI
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Get Flow
|
23
|
-
# Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
23
|
+
# Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
24
24
|
# @param id [String]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
27
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
28
|
-
# @option opts [Array<String>] :
|
26
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
27
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
28
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
29
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
29
30
|
# @return [Hash<String, Object>]
|
30
31
|
def get_flow(id, opts = {})
|
31
32
|
data, _status_code, _headers = get_flow_with_http_info(id, opts)
|
@@ -33,12 +34,13 @@ module KlaviyoAPI
|
|
33
34
|
end
|
34
35
|
|
35
36
|
# Get Flow
|
36
|
-
# Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
37
|
+
# Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
37
38
|
# @param id [String]
|
38
39
|
# @param [Hash] opts the optional parameters
|
39
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
40
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
41
|
-
# @option opts [Array<String>] :
|
40
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
41
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
42
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
43
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
42
44
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
43
45
|
def get_flow_with_http_info(id, opts = {})
|
44
46
|
if @api_client.config.debugging
|
@@ -56,7 +58,11 @@ module KlaviyoAPI
|
|
56
58
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
57
59
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
58
60
|
end
|
59
|
-
allowable_values = ["
|
61
|
+
allowable_values = ["name"]
|
62
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
63
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
64
|
+
end
|
65
|
+
allowable_values = ["flow-actions", "tags"]
|
60
66
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
61
67
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
62
68
|
end
|
@@ -67,12 +73,13 @@ module KlaviyoAPI
|
|
67
73
|
query_params = opts[:query_params] || {}
|
68
74
|
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
69
75
|
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
76
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
70
77
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
71
78
|
|
72
79
|
# header parameters
|
73
80
|
header_params = opts[:header_params] || {}
|
74
81
|
# klaviyo api revision
|
75
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
82
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
76
83
|
# HTTP header 'Accept' (if needed)
|
77
84
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
78
85
|
|
@@ -106,13 +113,13 @@ module KlaviyoAPI
|
|
106
113
|
end
|
107
114
|
|
108
115
|
# Get Flow Action
|
109
|
-
# Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
116
|
+
# Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
110
117
|
# @param id [String]
|
111
118
|
# @param [Hash] opts the optional parameters
|
112
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
113
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
114
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
115
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
119
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
120
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
121
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
122
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
116
123
|
# @return [Hash<String, Object>]
|
117
124
|
def get_flow_action(id, opts = {})
|
118
125
|
data, _status_code, _headers = get_flow_action_with_http_info(id, opts)
|
@@ -120,13 +127,13 @@ module KlaviyoAPI
|
|
120
127
|
end
|
121
128
|
|
122
129
|
# Get Flow Action
|
123
|
-
# Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
130
|
+
# Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
124
131
|
# @param id [String]
|
125
132
|
# @param [Hash] opts the optional parameters
|
126
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
127
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
128
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
129
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
133
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
134
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
135
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
136
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
130
137
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
131
138
|
def get_flow_action_with_http_info(id, opts = {})
|
132
139
|
if @api_client.config.debugging
|
@@ -148,7 +155,7 @@ module KlaviyoAPI
|
|
148
155
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
149
156
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
150
157
|
end
|
151
|
-
allowable_values = ["flow
|
158
|
+
allowable_values = ["flow", "flow-messages"]
|
152
159
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
153
160
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
154
161
|
end
|
@@ -165,7 +172,7 @@ module KlaviyoAPI
|
|
165
172
|
# header parameters
|
166
173
|
header_params = opts[:header_params] || {}
|
167
174
|
# klaviyo api revision
|
168
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
175
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
169
176
|
# HTTP header 'Accept' (if needed)
|
170
177
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
171
178
|
|
@@ -199,36 +206,36 @@ module KlaviyoAPI
|
|
199
206
|
end
|
200
207
|
|
201
208
|
# Get Flow For Flow Action
|
202
|
-
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
203
|
-
# @param
|
209
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
210
|
+
# @param id [String]
|
204
211
|
# @param [Hash] opts the optional parameters
|
205
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
212
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
206
213
|
# @return [Hash<String, Object>]
|
207
|
-
def get_flow_action_flow(
|
208
|
-
data, _status_code, _headers = get_flow_action_flow_with_http_info(
|
214
|
+
def get_flow_action_flow(id, opts = {})
|
215
|
+
data, _status_code, _headers = get_flow_action_flow_with_http_info(id, opts)
|
209
216
|
data
|
210
217
|
end
|
211
218
|
|
212
219
|
# Get Flow For Flow Action
|
213
|
-
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
214
|
-
# @param
|
220
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
221
|
+
# @param id [String]
|
215
222
|
# @param [Hash] opts the optional parameters
|
216
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
223
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
217
224
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
218
|
-
def get_flow_action_flow_with_http_info(
|
225
|
+
def get_flow_action_flow_with_http_info(id, opts = {})
|
219
226
|
if @api_client.config.debugging
|
220
227
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_action_flow ...'
|
221
228
|
end
|
222
|
-
# verify the required parameter '
|
223
|
-
if @api_client.config.client_side_validation &&
|
224
|
-
fail ArgumentError, "Missing the required parameter '
|
229
|
+
# verify the required parameter 'id' is set
|
230
|
+
if @api_client.config.client_side_validation && id.nil?
|
231
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action_flow"
|
225
232
|
end
|
226
233
|
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
227
234
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
228
235
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
229
236
|
end
|
230
237
|
# resource path
|
231
|
-
local_var_path = '/api/flow-actions/{
|
238
|
+
local_var_path = '/api/flow-actions/{id}/flow/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
232
239
|
|
233
240
|
# query parameters
|
234
241
|
query_params = opts[:query_params] || {}
|
@@ -237,7 +244,7 @@ module KlaviyoAPI
|
|
237
244
|
# header parameters
|
238
245
|
header_params = opts[:header_params] || {}
|
239
246
|
# klaviyo api revision
|
240
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
247
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
241
248
|
# HTTP header 'Accept' (if needed)
|
242
249
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
243
250
|
|
@@ -270,59 +277,67 @@ module KlaviyoAPI
|
|
270
277
|
return data, status_code, headers
|
271
278
|
end
|
272
279
|
|
273
|
-
# Get
|
274
|
-
# Get all flow messages associated with the given
|
275
|
-
# @param
|
280
|
+
# Get Flow Action Messages
|
281
|
+
# 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`
|
282
|
+
# @param id [String]
|
276
283
|
# @param [Hash] opts the optional parameters
|
277
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
278
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
279
|
-
# @option opts [
|
280
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
284
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
285
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-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`
|
286
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
287
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
281
288
|
# @return [Hash<String, Object>]
|
282
|
-
def get_flow_action_messages(
|
283
|
-
data, _status_code, _headers = get_flow_action_messages_with_http_info(
|
289
|
+
def get_flow_action_messages(id, opts = {})
|
290
|
+
data, _status_code, _headers = get_flow_action_messages_with_http_info(id, opts)
|
284
291
|
data
|
285
292
|
end
|
286
293
|
|
287
|
-
# Get
|
288
|
-
# Get all flow messages associated with the given
|
289
|
-
# @param
|
294
|
+
# Get Flow Action Messages
|
295
|
+
# 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`
|
296
|
+
# @param id [String]
|
290
297
|
# @param [Hash] opts the optional parameters
|
291
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
292
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
293
|
-
# @option opts [
|
294
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
298
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
299
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-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`
|
300
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
301
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
295
302
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
296
|
-
def get_flow_action_messages_with_http_info(
|
303
|
+
def get_flow_action_messages_with_http_info(id, opts = {})
|
297
304
|
if @api_client.config.debugging
|
298
305
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_action_messages ...'
|
299
306
|
end
|
300
|
-
# verify the required parameter '
|
301
|
-
if @api_client.config.client_side_validation &&
|
302
|
-
fail ArgumentError, "Missing the required parameter '
|
307
|
+
# verify the required parameter 'id' is set
|
308
|
+
if @api_client.config.client_side_validation && id.nil?
|
309
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action_messages"
|
303
310
|
end
|
304
311
|
allowable_values = ["name", "channel", "content", "created", "updated"]
|
305
312
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
306
313
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
307
314
|
end
|
315
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
316
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_messages, must be smaller than or equal to 100.'
|
317
|
+
end
|
318
|
+
|
319
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
320
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_messages, must be greater than or equal to 1.'
|
321
|
+
end
|
322
|
+
|
308
323
|
allowable_values = ["created", "-created", "id", "-id", "name", "-name", "updated", "-updated"]
|
309
324
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
310
325
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
311
326
|
end
|
312
327
|
# resource path
|
313
|
-
local_var_path = '/api/flow-actions/{
|
328
|
+
local_var_path = '/api/flow-actions/{id}/flow-messages/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
314
329
|
|
315
330
|
# query parameters
|
316
331
|
query_params = opts[:query_params] || {}
|
317
332
|
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
318
333
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
319
|
-
query_params[:'page[
|
334
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
320
335
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
321
336
|
|
322
337
|
# header parameters
|
323
338
|
header_params = opts[:header_params] || {}
|
324
339
|
# klaviyo api revision
|
325
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
340
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
326
341
|
# HTTP header 'Accept' (if needed)
|
327
342
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
328
343
|
|
@@ -356,7 +371,7 @@ module KlaviyoAPI
|
|
356
371
|
end
|
357
372
|
|
358
373
|
# Get Flow Action Relationships Flow
|
359
|
-
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
374
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
360
375
|
# @param id [String]
|
361
376
|
# @param [Hash] opts the optional parameters
|
362
377
|
# @return [Hash<String, Object>]
|
@@ -366,7 +381,7 @@ module KlaviyoAPI
|
|
366
381
|
end
|
367
382
|
|
368
383
|
# Get Flow Action Relationships Flow
|
369
|
-
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
384
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
370
385
|
# @param id [String]
|
371
386
|
# @param [Hash] opts the optional parameters
|
372
387
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -387,7 +402,7 @@ module KlaviyoAPI
|
|
387
402
|
# header parameters
|
388
403
|
header_params = opts[:header_params] || {}
|
389
404
|
# klaviyo api revision
|
390
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
405
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
391
406
|
# HTTP header 'Accept' (if needed)
|
392
407
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
393
408
|
|
@@ -421,12 +436,13 @@ module KlaviyoAPI
|
|
421
436
|
end
|
422
437
|
|
423
438
|
# Get Flow Action Relationships Messages
|
424
|
-
# 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:** `
|
439
|
+
# 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`
|
425
440
|
# @param id [String]
|
426
441
|
# @param [Hash] opts the optional parameters
|
427
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
428
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
429
|
-
# @option opts [
|
442
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-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`
|
443
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
444
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
445
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
430
446
|
# @return [Hash<String, Object>]
|
431
447
|
def get_flow_action_relationships_messages(id, opts = {})
|
432
448
|
data, _status_code, _headers = get_flow_action_relationships_messages_with_http_info(id, opts)
|
@@ -434,12 +450,13 @@ module KlaviyoAPI
|
|
434
450
|
end
|
435
451
|
|
436
452
|
# Get Flow Action Relationships Messages
|
437
|
-
# 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:** `
|
453
|
+
# 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`
|
438
454
|
# @param id [String]
|
439
455
|
# @param [Hash] opts the optional parameters
|
440
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
441
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
442
|
-
# @option opts [
|
456
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-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`
|
457
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
458
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
459
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
443
460
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
444
461
|
def get_flow_action_relationships_messages_with_http_info(id, opts = {})
|
445
462
|
if @api_client.config.debugging
|
@@ -449,6 +466,14 @@ module KlaviyoAPI
|
|
449
466
|
if @api_client.config.client_side_validation && id.nil?
|
450
467
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action_relationships_messages"
|
451
468
|
end
|
469
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
470
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_relationships_messages, must be smaller than or equal to 50.'
|
471
|
+
end
|
472
|
+
|
473
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
474
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_relationships_messages, must be greater than or equal to 1.'
|
475
|
+
end
|
476
|
+
|
452
477
|
allowable_values = ["created", "-created", "id", "-id", "name", "-name", "updated", "-updated"]
|
453
478
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
454
479
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
@@ -460,12 +485,13 @@ module KlaviyoAPI
|
|
460
485
|
query_params = opts[:query_params] || {}
|
461
486
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
462
487
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
488
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
463
489
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
464
490
|
|
465
491
|
# header parameters
|
466
492
|
header_params = opts[:header_params] || {}
|
467
493
|
# klaviyo api revision
|
468
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
494
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
469
495
|
# HTTP header 'Accept' (if needed)
|
470
496
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
471
497
|
|
@@ -498,59 +524,70 @@ module KlaviyoAPI
|
|
498
524
|
return data, status_code, headers
|
499
525
|
end
|
500
526
|
|
501
|
-
# Get Flow Actions
|
502
|
-
# 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:** `
|
503
|
-
# @param
|
527
|
+
# Get Flow Flow Actions
|
528
|
+
# 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`
|
529
|
+
# @param id [String]
|
504
530
|
# @param [Hash] opts the optional parameters
|
505
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
506
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
507
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
508
|
-
# @option opts [
|
531
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
532
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-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`
|
533
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
534
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
535
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
509
536
|
# @return [Hash<String, Object>]
|
510
|
-
def get_flow_flow_actions(
|
511
|
-
data, _status_code, _headers = get_flow_flow_actions_with_http_info(
|
537
|
+
def get_flow_flow_actions(id, opts = {})
|
538
|
+
data, _status_code, _headers = get_flow_flow_actions_with_http_info(id, opts)
|
512
539
|
data
|
513
540
|
end
|
514
541
|
|
515
|
-
# Get Flow Actions
|
516
|
-
# 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:** `
|
517
|
-
# @param
|
542
|
+
# Get Flow Flow Actions
|
543
|
+
# 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`
|
544
|
+
# @param id [String]
|
518
545
|
# @param [Hash] opts the optional parameters
|
519
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
520
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
521
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
522
|
-
# @option opts [
|
546
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
547
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-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`
|
548
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
549
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
550
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
523
551
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
524
|
-
def get_flow_flow_actions_with_http_info(
|
552
|
+
def get_flow_flow_actions_with_http_info(id, opts = {})
|
525
553
|
if @api_client.config.debugging
|
526
554
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_flow_actions ...'
|
527
555
|
end
|
528
|
-
# verify the required parameter '
|
529
|
-
if @api_client.config.client_side_validation &&
|
530
|
-
fail ArgumentError, "Missing the required parameter '
|
556
|
+
# verify the required parameter 'id' is set
|
557
|
+
if @api_client.config.client_side_validation && id.nil?
|
558
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_flow_actions"
|
531
559
|
end
|
532
560
|
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "send_options", "send_options.use_smart_sending", "send_options.is_transactional", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language"]
|
533
561
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
534
562
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
535
563
|
end
|
564
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
565
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_flow_actions, must be smaller than or equal to 50.'
|
566
|
+
end
|
567
|
+
|
568
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
569
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_flow_actions, must be greater than or equal to 1.'
|
570
|
+
end
|
571
|
+
|
536
572
|
allowable_values = ["action_type", "-action_type", "created", "-created", "id", "-id", "status", "-status", "updated", "-updated"]
|
537
573
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
538
574
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
539
575
|
end
|
540
576
|
# resource path
|
541
|
-
local_var_path = '/api/flows/{
|
577
|
+
local_var_path = '/api/flows/{id}/flow-actions/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
542
578
|
|
543
579
|
# query parameters
|
544
580
|
query_params = opts[:query_params] || {}
|
545
581
|
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
546
582
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
547
583
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
584
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
548
585
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
549
586
|
|
550
587
|
# header parameters
|
551
588
|
header_params = opts[:header_params] || {}
|
552
589
|
# klaviyo api revision
|
553
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
590
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
554
591
|
# HTTP header 'Accept' (if needed)
|
555
592
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
556
593
|
|
@@ -584,12 +621,12 @@ module KlaviyoAPI
|
|
584
621
|
end
|
585
622
|
|
586
623
|
# Get Flow Message
|
587
|
-
# Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
624
|
+
# Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
588
625
|
# @param id [String]
|
589
626
|
# @param [Hash] opts the optional parameters
|
590
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
591
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
592
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
627
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
628
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
629
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
593
630
|
# @return [Hash<String, Object>]
|
594
631
|
def get_flow_message(id, opts = {})
|
595
632
|
data, _status_code, _headers = get_flow_message_with_http_info(id, opts)
|
@@ -597,12 +634,12 @@ module KlaviyoAPI
|
|
597
634
|
end
|
598
635
|
|
599
636
|
# Get Flow Message
|
600
|
-
# Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
637
|
+
# Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
601
638
|
# @param id [String]
|
602
639
|
# @param [Hash] opts the optional parameters
|
603
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
604
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
605
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
640
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
641
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
642
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
606
643
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
607
644
|
def get_flow_message_with_http_info(id, opts = {})
|
608
645
|
if @api_client.config.debugging
|
@@ -636,7 +673,7 @@ module KlaviyoAPI
|
|
636
673
|
# header parameters
|
637
674
|
header_params = opts[:header_params] || {}
|
638
675
|
# klaviyo api revision
|
639
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
676
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
640
677
|
# HTTP header 'Accept' (if needed)
|
641
678
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
642
679
|
|
@@ -670,36 +707,36 @@ module KlaviyoAPI
|
|
670
707
|
end
|
671
708
|
|
672
709
|
# Get Flow Action For Message
|
673
|
-
# 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:** `
|
674
|
-
# @param
|
710
|
+
# 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`
|
711
|
+
# @param id [String]
|
675
712
|
# @param [Hash] opts the optional parameters
|
676
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
713
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
677
714
|
# @return [Hash<String, Object>]
|
678
|
-
def get_flow_message_action(
|
679
|
-
data, _status_code, _headers = get_flow_message_action_with_http_info(
|
715
|
+
def get_flow_message_action(id, opts = {})
|
716
|
+
data, _status_code, _headers = get_flow_message_action_with_http_info(id, opts)
|
680
717
|
data
|
681
718
|
end
|
682
719
|
|
683
720
|
# Get Flow Action For Message
|
684
|
-
# 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:** `
|
685
|
-
# @param
|
721
|
+
# 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`
|
722
|
+
# @param id [String]
|
686
723
|
# @param [Hash] opts the optional parameters
|
687
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
724
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
688
725
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
689
|
-
def get_flow_message_action_with_http_info(
|
726
|
+
def get_flow_message_action_with_http_info(id, opts = {})
|
690
727
|
if @api_client.config.debugging
|
691
728
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_message_action ...'
|
692
729
|
end
|
693
|
-
# verify the required parameter '
|
694
|
-
if @api_client.config.client_side_validation &&
|
695
|
-
fail ArgumentError, "Missing the required parameter '
|
730
|
+
# verify the required parameter 'id' is set
|
731
|
+
if @api_client.config.client_side_validation && id.nil?
|
732
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_message_action"
|
696
733
|
end
|
697
734
|
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "send_options", "send_options.use_smart_sending", "send_options.is_transactional", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language"]
|
698
735
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
699
736
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
700
737
|
end
|
701
738
|
# resource path
|
702
|
-
local_var_path = '/api/flow-messages/{
|
739
|
+
local_var_path = '/api/flow-messages/{id}/flow-action/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
703
740
|
|
704
741
|
# query parameters
|
705
742
|
query_params = opts[:query_params] || {}
|
@@ -708,7 +745,7 @@ module KlaviyoAPI
|
|
708
745
|
# header parameters
|
709
746
|
header_params = opts[:header_params] || {}
|
710
747
|
# klaviyo api revision
|
711
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
748
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
712
749
|
# HTTP header 'Accept' (if needed)
|
713
750
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
714
751
|
|
@@ -742,7 +779,7 @@ module KlaviyoAPI
|
|
742
779
|
end
|
743
780
|
|
744
781
|
# Get Flow Message Relationships Action
|
745
|
-
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
782
|
+
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
746
783
|
# @param id [String]
|
747
784
|
# @param [Hash] opts the optional parameters
|
748
785
|
# @return [Hash<String, Object>]
|
@@ -752,7 +789,7 @@ module KlaviyoAPI
|
|
752
789
|
end
|
753
790
|
|
754
791
|
# Get Flow Message Relationships Action
|
755
|
-
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
792
|
+
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
756
793
|
# @param id [String]
|
757
794
|
# @param [Hash] opts the optional parameters
|
758
795
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -773,7 +810,7 @@ module KlaviyoAPI
|
|
773
810
|
# header parameters
|
774
811
|
header_params = opts[:header_params] || {}
|
775
812
|
# klaviyo api revision
|
776
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
813
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
777
814
|
# HTTP header 'Accept' (if needed)
|
778
815
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
779
816
|
|
@@ -807,11 +844,12 @@ module KlaviyoAPI
|
|
807
844
|
end
|
808
845
|
|
809
846
|
# Get Flow Relationships Flow Actions
|
810
|
-
# 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:** `
|
847
|
+
# 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`
|
811
848
|
# @param id [String]
|
812
849
|
# @param [Hash] opts the optional parameters
|
813
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
814
|
-
# @option opts [
|
850
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-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`
|
851
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
852
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
815
853
|
# @return [Hash<String, Object>]
|
816
854
|
def get_flow_relationships_flow_actions(id, opts = {})
|
817
855
|
data, _status_code, _headers = get_flow_relationships_flow_actions_with_http_info(id, opts)
|
@@ -819,11 +857,12 @@ module KlaviyoAPI
|
|
819
857
|
end
|
820
858
|
|
821
859
|
# Get Flow Relationships Flow Actions
|
822
|
-
# 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:** `
|
860
|
+
# 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`
|
823
861
|
# @param id [String]
|
824
862
|
# @param [Hash] opts the optional parameters
|
825
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
826
|
-
# @option opts [
|
863
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-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`
|
864
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
865
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
827
866
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
828
867
|
def get_flow_relationships_flow_actions_with_http_info(id, opts = {})
|
829
868
|
if @api_client.config.debugging
|
@@ -833,6 +872,14 @@ module KlaviyoAPI
|
|
833
872
|
if @api_client.config.client_side_validation && id.nil?
|
834
873
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_relationships_flow_actions"
|
835
874
|
end
|
875
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
876
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_relationships_flow_actions, must be smaller than or equal to 100.'
|
877
|
+
end
|
878
|
+
|
879
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
880
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_relationships_flow_actions, must be greater than or equal to 1.'
|
881
|
+
end
|
882
|
+
|
836
883
|
allowable_values = ["created", "-created", "id", "-id", "status", "-status", "updated", "-updated"]
|
837
884
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
838
885
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
@@ -843,12 +890,13 @@ module KlaviyoAPI
|
|
843
890
|
# query parameters
|
844
891
|
query_params = opts[:query_params] || {}
|
845
892
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
893
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
846
894
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
847
895
|
|
848
896
|
# header parameters
|
849
897
|
header_params = opts[:header_params] || {}
|
850
898
|
# klaviyo api revision
|
851
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
899
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
852
900
|
# HTTP header 'Accept' (if needed)
|
853
901
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
854
902
|
|
@@ -882,7 +930,7 @@ module KlaviyoAPI
|
|
882
930
|
end
|
883
931
|
|
884
932
|
# Get Flow Relationships Tags
|
885
|
-
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
933
|
+
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
886
934
|
# @param id [String]
|
887
935
|
# @param [Hash] opts the optional parameters
|
888
936
|
# @return [Hash<String, Object>]
|
@@ -892,7 +940,7 @@ module KlaviyoAPI
|
|
892
940
|
end
|
893
941
|
|
894
942
|
# Get Flow Relationships Tags
|
895
|
-
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
943
|
+
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
896
944
|
# @param id [String]
|
897
945
|
# @param [Hash] opts the optional parameters
|
898
946
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -913,7 +961,7 @@ module KlaviyoAPI
|
|
913
961
|
# header parameters
|
914
962
|
header_params = opts[:header_params] || {}
|
915
963
|
# klaviyo api revision
|
916
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
964
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
917
965
|
# HTTP header 'Accept' (if needed)
|
918
966
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
919
967
|
|
@@ -947,36 +995,36 @@ module KlaviyoAPI
|
|
947
995
|
end
|
948
996
|
|
949
997
|
# Get Flow Tags
|
950
|
-
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
951
|
-
# @param
|
998
|
+
# 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`
|
999
|
+
# @param id [String]
|
952
1000
|
# @param [Hash] opts the optional parameters
|
953
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
1001
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
954
1002
|
# @return [Hash<String, Object>]
|
955
|
-
def get_flow_tags(
|
956
|
-
data, _status_code, _headers = get_flow_tags_with_http_info(
|
1003
|
+
def get_flow_tags(id, opts = {})
|
1004
|
+
data, _status_code, _headers = get_flow_tags_with_http_info(id, opts)
|
957
1005
|
data
|
958
1006
|
end
|
959
1007
|
|
960
1008
|
# Get Flow Tags
|
961
|
-
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
962
|
-
# @param
|
1009
|
+
# 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`
|
1010
|
+
# @param id [String]
|
963
1011
|
# @param [Hash] opts the optional parameters
|
964
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
1012
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
965
1013
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
966
|
-
def get_flow_tags_with_http_info(
|
1014
|
+
def get_flow_tags_with_http_info(id, opts = {})
|
967
1015
|
if @api_client.config.debugging
|
968
1016
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_tags ...'
|
969
1017
|
end
|
970
|
-
# verify the required parameter '
|
971
|
-
if @api_client.config.client_side_validation &&
|
972
|
-
fail ArgumentError, "Missing the required parameter '
|
1018
|
+
# verify the required parameter 'id' is set
|
1019
|
+
if @api_client.config.client_side_validation && id.nil?
|
1020
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_tags"
|
973
1021
|
end
|
974
1022
|
allowable_values = ["name"]
|
975
1023
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
976
1024
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
977
1025
|
end
|
978
1026
|
# resource path
|
979
|
-
local_var_path = '/api/flows/{
|
1027
|
+
local_var_path = '/api/flows/{id}/tags/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
980
1028
|
|
981
1029
|
# query parameters
|
982
1030
|
query_params = opts[:query_params] || {}
|
@@ -985,7 +1033,7 @@ module KlaviyoAPI
|
|
985
1033
|
# header parameters
|
986
1034
|
header_params = opts[:header_params] || {}
|
987
1035
|
# klaviyo api revision
|
988
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1036
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
989
1037
|
# HTTP header 'Accept' (if needed)
|
990
1038
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
991
1039
|
|
@@ -1019,14 +1067,16 @@ module KlaviyoAPI
|
|
1019
1067
|
end
|
1020
1068
|
|
1021
1069
|
# Get Flows
|
1022
|
-
# 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:** `
|
1070
|
+
# 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`
|
1023
1071
|
# @param [Hash] opts the optional parameters
|
1024
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
1025
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
1026
|
-
# @option opts [String] :
|
1027
|
-
# @option opts [
|
1028
|
-
# @option opts [String] :
|
1029
|
-
# @option opts [String] :
|
1072
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1073
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1074
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1075
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-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`
|
1076
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1077
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1078
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
1079
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1030
1080
|
# @return [Hash<String, Object>]
|
1031
1081
|
def get_flows(opts = {})
|
1032
1082
|
data, _status_code, _headers = get_flows_with_http_info(opts)
|
@@ -1034,14 +1084,16 @@ module KlaviyoAPI
|
|
1034
1084
|
end
|
1035
1085
|
|
1036
1086
|
# Get Flows
|
1037
|
-
# 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:** `
|
1087
|
+
# 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`
|
1038
1088
|
# @param [Hash] opts the optional parameters
|
1039
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
1040
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
1041
|
-
# @option opts [String] :
|
1042
|
-
# @option opts [
|
1043
|
-
# @option opts [String] :
|
1044
|
-
# @option opts [String] :
|
1089
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1090
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1091
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
|
1092
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-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`
|
1093
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
|
1094
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
|
1095
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
1096
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
|
1045
1097
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1046
1098
|
def get_flows_with_http_info(opts = {})
|
1047
1099
|
if @api_client.config.debugging
|
@@ -1055,10 +1107,22 @@ module KlaviyoAPI
|
|
1055
1107
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
1056
1108
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
1057
1109
|
end
|
1058
|
-
allowable_values = ["
|
1110
|
+
allowable_values = ["name"]
|
1111
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
1112
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1113
|
+
end
|
1114
|
+
allowable_values = ["flow-actions", "tags"]
|
1059
1115
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1060
1116
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1061
1117
|
end
|
1118
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
1119
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flows, must be smaller than or equal to 50.'
|
1120
|
+
end
|
1121
|
+
|
1122
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
1123
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flows, must be greater than or equal to 1.'
|
1124
|
+
end
|
1125
|
+
|
1062
1126
|
allowable_values = ["created", "-created", "id", "-id", "name", "-name", "status", "-status", "trigger_type", "-trigger_type", "updated", "-updated"]
|
1063
1127
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1064
1128
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
@@ -1070,15 +1134,17 @@ module KlaviyoAPI
|
|
1070
1134
|
query_params = opts[:query_params] || {}
|
1071
1135
|
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
1072
1136
|
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
1137
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1073
1138
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1074
1139
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1075
1140
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1141
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
1076
1142
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1077
1143
|
|
1078
1144
|
# header parameters
|
1079
1145
|
header_params = opts[:header_params] || {}
|
1080
1146
|
# klaviyo api revision
|
1081
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1147
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1082
1148
|
# HTTP header 'Accept' (if needed)
|
1083
1149
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1084
1150
|
|
@@ -1112,7 +1178,7 @@ module KlaviyoAPI
|
|
1112
1178
|
end
|
1113
1179
|
|
1114
1180
|
# Update Flow Status
|
1115
|
-
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1181
|
+
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
1116
1182
|
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
1117
1183
|
# @param flow_update_query [FlowUpdateQuery]
|
1118
1184
|
# @param [Hash] opts the optional parameters
|
@@ -1123,7 +1189,7 @@ module KlaviyoAPI
|
|
1123
1189
|
end
|
1124
1190
|
|
1125
1191
|
# Update Flow Status
|
1126
|
-
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1192
|
+
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
1127
1193
|
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
1128
1194
|
# @param flow_update_query [FlowUpdateQuery]
|
1129
1195
|
# @param [Hash] opts the optional parameters
|
@@ -1149,7 +1215,7 @@ module KlaviyoAPI
|
|
1149
1215
|
# header parameters
|
1150
1216
|
header_params = opts[:header_params] || {}
|
1151
1217
|
# klaviyo api revision
|
1152
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1218
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
|
1153
1219
|
# HTTP header 'Accept' (if needed)
|
1154
1220
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1155
1221
|
# HTTP header 'Content-Type'
|