klaviyo-api-sdk 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +335 -119
- data/docs/AudiencesSubObject.md +20 -0
- data/docs/CampaignCloneQuery.md +18 -0
- data/docs/CampaignCloneQueryAsSubResource.md +20 -0
- data/docs/CampaignCloneQueryAsSubResourceAttributes.md +20 -0
- data/docs/CampaignCreateQuery.md +18 -0
- data/docs/CampaignCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignCreateQueryAsSubResourceAttributes.md +28 -0
- data/docs/CampaignMessageAssignTemplateQuery.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +20 -0
- data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +20 -0
- data/docs/CampaignMessagePartialUpdateQuery.md +18 -0
- data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +22 -0
- data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +20 -0
- data/docs/CampaignPartialUpdateQuery.md +18 -0
- data/docs/CampaignPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +26 -0
- data/docs/CampaignSendJobCreateQuery.md +18 -0
- data/docs/CampaignSendJobCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CampaignSendJobPartialUpdateQuery.md +18 -0
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +2 -2
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +1 -1
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +1 -1
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +4 -4
- data/docs/CatalogItemDeleteQueryAsSubResource.md +1 -1
- data/docs/CatalogItemUpdateQueryAsSubResource.md +1 -1
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +4 -4
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +1 -1
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +1 -1
- data/docs/CatalogsApi.md +202 -202
- data/docs/ClientApi.md +11 -11
- data/docs/ContentSubObject.md +28 -0
- data/docs/DataPrivacyApi.md +78 -0
- data/docs/DataPrivacyCreateDeletionJobQuery.md +18 -0
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +20 -0
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +22 -0
- data/docs/ErrorSource.md +2 -2
- data/docs/EventCreateQueryAsSubResourceAttributes.md +8 -8
- data/docs/EventsApi.md +36 -36
- data/docs/FlowsApi.md +139 -69
- data/docs/IncludedCategories.md +1 -1
- data/docs/IncludedMetrics.md +1 -1
- data/docs/IncludedMetricsAttributes.md +4 -4
- data/docs/ListsApi.md +101 -25
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +15 -15
- data/docs/MetricAggregateRowDTO.md +2 -2
- data/docs/MetricCreateQuery.md +3 -3
- data/docs/MetricsApi.md +14 -14
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +10 -10
- data/docs/ProfilesApi.md +31 -31
- data/docs/SegmentsApi.md +102 -23
- data/docs/SendOptionsSubObject.md +20 -0
- data/docs/SendStrategySubObject.md +22 -0
- data/docs/SendTimeSubObject.md +20 -0
- data/docs/StaticScheduleOptions.md +22 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
- data/docs/Suppression.md +1 -1
- data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/TagCreateQuery.md +18 -0
- data/docs/TagCreateQueryAsSubResource.md +20 -0
- data/docs/TagCreateQueryAsSubResourceAttributes.md +20 -0
- data/docs/TagGroupCreateQuery.md +18 -0
- data/docs/TagGroupCreateQueryAsSubResource.md +20 -0
- data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +20 -0
- data/docs/TagGroupUpdateQuery.md +18 -0
- data/docs/TagGroupUpdateQueryAsSubResource.md +22 -0
- data/docs/{V2TemplateRenderQueryAsSubResourceAttributes.md → TagGroupUpdateQueryAsSubResourceAttributes.md} +4 -4
- data/docs/TagSegmentOp.md +18 -0
- data/docs/{ListDeleteQueryAsSubResource.md → TagSegmentOpDataInner.md} +2 -2
- data/docs/TagUpdateQuery.md +18 -0
- data/docs/TagUpdateQueryAsSubResource.md +22 -0
- data/docs/TagUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/TagsApi.md +1205 -0
- data/docs/TemplateCloneQueryAsSubResource.md +2 -0
- data/docs/TemplateCloneQueryAsSubResourceAttributes.md +5 -3
- data/docs/TemplateCreateQueryAsSubResourceAttributes.md +14 -8
- data/docs/TemplateRenderQuery.md +18 -0
- data/docs/TemplateRenderQueryAsSubResource.md +20 -0
- data/docs/TemplateRenderQueryAsSubResourceAttributes.md +22 -0
- data/docs/TemplateUpdateQueryAsSubResource.md +1 -1
- data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +13 -7
- data/docs/TemplatesApi.md +40 -44
- data/docs/ThrottledScheduleOptions.md +20 -0
- data/docs/TrackingOptionsSubObject.md +24 -0
- data/docs/UTMParamsSubObject.md +20 -0
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +1 -1
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/V2TemplateRenderQueryAsSubResource.md +2 -4
- data/klaviyo-api-sdk.gemspec +3 -3
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +277 -277
- data/lib/klaviyo-api-sdk/api/client_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +92 -0
- data/lib/klaviyo-api-sdk/api/events_api.rb +46 -46
- data/lib/klaviyo-api-sdk/api/flows_api.rb +155 -93
- data/lib/klaviyo-api-sdk/api/lists_api.rb +114 -42
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +21 -21
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +51 -51
- data/lib/klaviyo-api-sdk/api/segments_api.rb +112 -33
- data/lib/klaviyo-api-sdk/api/tags_api.rb +1216 -0
- data/lib/klaviyo-api-sdk/api/templates_api.rb +57 -69
- data/lib/klaviyo-api-sdk/api_client.rb +24 -3
- data/lib/klaviyo-api-sdk/api_error.rb +2 -2
- data/lib/klaviyo-api-sdk/configuration.rb +2 -2
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +234 -0
- data/lib/klaviyo-api-sdk/models/{v2_template_render_query.rb → campaign_clone_query.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +291 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/{included_profile.rb → campaign_message_partial_update_query_as_sub_resource.rb} +12 -25
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +256 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +4 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +3 -2
- 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 +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +270 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +2 -2
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/error_source.rb +4 -2
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +7 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +2 -2
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_categories.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flows.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_items.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_lists.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_segments.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_variants.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +14 -8
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +4 -2
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +4 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +7 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_location.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/send_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +230 -0
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +243 -0
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +240 -0
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +2 -2
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +245 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +5 -2
- data/lib/klaviyo-api-sdk/models/suppression.rb +3 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +234 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/{v2_template_render_query_as_sub_resource_attributes.rb → tag_group_update_query_as_sub_resource_attributes.rb} +16 -15
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/{list_delete_query_as_sub_resource.rb → tag_segment_op_data_inner.rb} +7 -7
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +14 -3
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +20 -3
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +7 -2
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/{template_delete_query_as_sub_resource.rb → template_render_query_as_sub_resource.rb} +15 -15
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +240 -0
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +5 -7
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +3 -3
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +2 -2
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +240 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +11 -62
- data/lib/klaviyo-api-sdk/version.rb +2 -2
- data/lib/klaviyo-api-sdk.rb +55 -7
- data/spec/api/catalogs_api_spec.rb +94 -94
- data/spec/api/client_api_spec.rb +5 -5
- data/spec/api/data_privacy_api_spec.rb +47 -0
- data/spec/api/events_api_spec.rb +19 -19
- data/spec/api/flows_api_spec.rb +44 -33
- data/spec/api/lists_api_spec.rb +28 -15
- data/spec/api/metrics_api_spec.rb +8 -8
- data/spec/api/profiles_api_spec.rb +21 -21
- data/spec/api/segments_api_spec.rb +24 -10
- data/spec/api/tags_api_spec.rb +245 -0
- data/spec/api/templates_api_spec.rb +18 -18
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/audiences_sub_object_spec.rb +40 -0
- data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/{v2_template_render_query_spec.rb → campaign_clone_query_spec.rb} +8 -8
- data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +64 -0
- data/spec/models/campaign_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_create_query_spec.rb +34 -0
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_message_assign_template_query_spec.rb +34 -0
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/campaign_message_partial_update_query_spec.rb +34 -0
- data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +58 -0
- data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/campaign_partial_update_query_spec.rb +34 -0
- data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_send_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_create_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_item_op_spec.rb +2 -2
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_update_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_update_query_spec.rb +2 -2
- data/spec/models/catalog_item_category_op_spec.rb +2 -2
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_create_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_update_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_update_query_spec.rb +2 -2
- data/spec/models/catalog_job_error_payload_spec.rb +2 -2
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_update_query_spec.rb +2 -2
- data/spec/models/content_sub_object_spec.rb +64 -0
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +34 -0
- data/spec/models/email_message_content_spec.rb +2 -2
- data/spec/models/email_tracking_options_spec.rb +2 -2
- data/spec/models/error_source_spec.rb +2 -2
- data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/event_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/event_create_query_spec.rb +2 -2
- data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/flow_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/flow_update_query_spec.rb +2 -2
- data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +2 -2
- data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +2 -2
- data/spec/models/get_catalog_items4_xx_response_spec.rb +2 -2
- data/spec/models/included_categories_attributes_spec.rb +2 -2
- data/spec/models/included_categories_spec.rb +2 -2
- data/spec/models/included_flow_action_spec.rb +2 -2
- data/spec/models/included_flow_actions_attributes_spec.rb +2 -2
- data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +2 -2
- data/spec/models/included_flow_actions_spec.rb +2 -2
- data/spec/models/included_flow_messages_attributes_content_spec.rb +2 -2
- data/spec/models/included_flow_messages_attributes_spec.rb +2 -2
- data/spec/models/included_flow_messages_spec.rb +2 -2
- data/spec/models/included_flows_attributes_spec.rb +2 -2
- data/spec/models/included_flows_spec.rb +2 -2
- data/spec/models/included_items_attributes_spec.rb +2 -2
- data/spec/models/included_items_spec.rb +2 -2
- data/spec/models/included_lists_attributes_spec.rb +2 -2
- data/spec/models/included_lists_spec.rb +2 -2
- data/spec/models/included_metrics_attributes_spec.rb +2 -2
- data/spec/models/included_metrics_spec.rb +2 -2
- data/spec/models/included_profiles_attributes_spec.rb +2 -2
- data/spec/models/included_profiles_spec.rb +2 -2
- data/spec/models/included_segments_spec.rb +2 -2
- data/spec/models/included_variants_attributes_spec.rb +2 -2
- data/spec/models/included_variants_links_spec.rb +2 -2
- data/spec/models/included_variants_spec.rb +2 -2
- data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/list_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/list_create_query_spec.rb +2 -2
- data/spec/models/list_members_add_query_data_inner_spec.rb +2 -2
- data/spec/models/list_members_add_query_spec.rb +2 -2
- data/spec/models/list_members_delete_query_spec.rb +2 -2
- data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/list_partial_update_query_spec.rb +2 -2
- data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/metric_aggregate_query_spec.rb +2 -2
- data/spec/models/metric_aggregate_row_dto_spec.rb +2 -2
- data/spec/models/metric_create_query_spec.rb +2 -2
- data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/onsite_profile_create_query_spec.rb +2 -2
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +2 -2
- data/spec/models/onsite_profile_meta_spec.rb +2 -2
- data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/onsite_subscription_create_query_spec.rb +2 -2
- data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/profile_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/profile_create_query_spec.rb +2 -2
- data/spec/models/profile_location_latitude_spec.rb +2 -2
- data/spec/models/profile_location_spec.rb +2 -2
- data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/profile_partial_update_query_spec.rb +2 -2
- data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/segment_partial_update_query_spec.rb +2 -2
- data/spec/models/send_options_spec.rb +2 -2
- data/spec/models/send_options_sub_object_spec.rb +40 -0
- data/spec/models/send_strategy_sub_object_spec.rb +46 -0
- data/spec/models/send_time_sub_object_spec.rb +40 -0
- data/spec/models/sms_message_content_spec.rb +2 -2
- data/spec/models/sms_render_options_spec.rb +2 -2
- data/spec/models/sms_tracking_options_spec.rb +2 -2
- data/spec/models/static_schedule_options_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/subscription_create_job_create_query_spec.rb +2 -2
- data/spec/models/subscription_spec.rb +2 -2
- data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/suppression_create_job_create_query_spec.rb +2 -2
- data/spec/models/suppression_spec.rb +2 -2
- data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/tag_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/tag_create_query_spec.rb +34 -0
- data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/tag_group_create_query_spec.rb +34 -0
- data/spec/models/{v2_template_render_query_as_sub_resource_attributes_spec.rb → tag_group_update_query_as_sub_resource_attributes_spec.rb} +9 -9
- data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/tag_group_update_query_spec.rb +34 -0
- data/spec/models/{list_delete_query_as_sub_resource_spec.rb → tag_segment_op_data_inner_spec.rb} +9 -9
- data/spec/models/tag_segment_op_spec.rb +34 -0
- data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/{included_profile_spec.rb → tag_update_query_as_sub_resource_spec.rb} +9 -15
- data/spec/models/tag_update_query_spec.rb +34 -0
- data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +8 -2
- data/spec/models/template_clone_query_as_sub_resource_spec.rb +8 -2
- data/spec/models/template_clone_query_spec.rb +2 -2
- data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/template_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/template_create_query_spec.rb +2 -2
- data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/{template_delete_query_as_sub_resource_spec.rb → template_render_query_as_sub_resource_spec.rb} +9 -9
- data/spec/models/template_render_query_spec.rb +34 -0
- data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/template_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/template_update_query_spec.rb +2 -2
- data/spec/models/throttled_schedule_options_spec.rb +40 -0
- data/spec/models/tracking_options_sub_object_spec.rb +52 -0
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/unsubscription_create_job_create_query_spec.rb +2 -2
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/unsuppression_create_job_create_query_spec.rb +2 -2
- data/spec/models/utm_param_info_spec.rb +2 -2
- data/spec/models/utm_params_sub_object_spec.rb +40 -0
- data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +3 -13
- data/spec/spec_helper.rb +2 -2
- metadata +165 -21
- data/docs/IncludedProfile.md +0 -24
- data/docs/TemplateDeleteQueryAsSubResource.md +0 -20
- data/docs/V2TemplateRenderQuery.md +0 -18
data/spec/api/events_api_spec.rb
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
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:
|
|
6
|
+
The version of the OpenAPI document: 2023-01-24
|
|
7
7
|
Contact: developers@klaviyo.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 6.
|
|
9
|
+
OpenAPI Generator version: 6.2.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -47,12 +47,12 @@ describe 'EventsApi' do
|
|
|
47
47
|
# unit tests for get_event
|
|
48
48
|
# Get Event
|
|
49
49
|
# Get an event with the given event ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: `metrics`, `profiles`<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Events Read`
|
|
50
|
-
# @param id
|
|
50
|
+
# @param id ID of the event
|
|
51
51
|
# @param [Hash] opts the optional parameters
|
|
52
|
-
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/
|
|
53
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/
|
|
54
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
|
55
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
52
|
+
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
53
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
54
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
55
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
56
56
|
# @return [Hash<String, Object>]
|
|
57
57
|
describe 'get_event test' do
|
|
58
58
|
it 'should work' do
|
|
@@ -63,9 +63,9 @@ describe 'EventsApi' do
|
|
|
63
63
|
# unit tests for get_event_metrics
|
|
64
64
|
# Get Event Metrics
|
|
65
65
|
# Get the metric for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Events Read` `Metrics Read`
|
|
66
|
-
# @param id
|
|
66
|
+
# @param id ID of the event
|
|
67
67
|
# @param [Hash] opts the optional parameters
|
|
68
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/
|
|
68
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
69
69
|
# @return [Hash<String, Object>]
|
|
70
70
|
describe 'get_event_metrics test' do
|
|
71
71
|
it 'should work' do
|
|
@@ -76,9 +76,9 @@ describe 'EventsApi' do
|
|
|
76
76
|
# unit tests for get_event_profiles
|
|
77
77
|
# Get Event Profiles
|
|
78
78
|
# Get the profile associated with an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Events Read` `Profiles Read`
|
|
79
|
-
# @param id
|
|
79
|
+
# @param id ID of the event
|
|
80
80
|
# @param [Hash] opts the optional parameters
|
|
81
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
|
81
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
82
82
|
# @return [Hash<String, Object>]
|
|
83
83
|
describe 'get_event_profiles test' do
|
|
84
84
|
it 'should work' do
|
|
@@ -88,7 +88,7 @@ describe 'EventsApi' do
|
|
|
88
88
|
|
|
89
89
|
# unit tests for get_event_relationships
|
|
90
90
|
# Get Event Relationships
|
|
91
|
-
# Get metrics or profile [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Events Read` `Profiles Read`
|
|
91
|
+
# Get metrics or profile [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Events Read` `Metrics Read` `Profiles Read`
|
|
92
92
|
# @param id
|
|
93
93
|
# @param related_resource
|
|
94
94
|
# @param [Hash] opts the optional parameters
|
|
@@ -103,13 +103,13 @@ describe 'EventsApi' do
|
|
|
103
103
|
# Get Events
|
|
104
104
|
# Get all events in an account Requests can be sorted by the following fields: `datetime`, `timestamp` Use filters to narrow your results to specific metrics. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: `metrics`, `profiles` Returns a maximum of 200 events per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Events Read`
|
|
105
105
|
# @param [Hash] opts the optional parameters
|
|
106
|
-
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/
|
|
107
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/
|
|
108
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
|
109
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
110
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
111
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
112
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
106
|
+
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
107
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
108
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
109
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
110
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
111
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
112
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
113
113
|
# @return [Hash<String, Object>]
|
|
114
114
|
describe 'get_events test' do
|
|
115
115
|
it 'should work' do
|
data/spec/api/flows_api_spec.rb
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
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:
|
|
6
|
+
The version of the OpenAPI document: 2023-01-24
|
|
7
7
|
Contact: developers@klaviyo.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 6.
|
|
9
|
+
OpenAPI Generator version: 6.2.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -37,9 +37,9 @@ describe 'FlowsApi' do
|
|
|
37
37
|
# Get a flow with the given flow ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). 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`
|
|
38
38
|
# @param id
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
|
41
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/
|
|
42
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
40
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
41
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
42
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
43
43
|
# @return [Hash<String, Object>]
|
|
44
44
|
describe 'get_flow test' do
|
|
45
45
|
it 'should work' do
|
|
@@ -49,13 +49,13 @@ describe 'FlowsApi' do
|
|
|
49
49
|
|
|
50
50
|
# unit tests for get_flow_action
|
|
51
51
|
# Get Flow Action
|
|
52
|
-
# 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: &#
|
|
52
|
+
# 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`
|
|
53
53
|
# @param id
|
|
54
54
|
# @param [Hash] opts the optional parameters
|
|
55
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
|
56
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/
|
|
57
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/
|
|
58
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
55
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
56
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
57
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
58
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
59
59
|
# @return [Hash<String, Object>]
|
|
60
60
|
describe 'get_flow_action test' do
|
|
61
61
|
it 'should work' do
|
|
@@ -68,7 +68,7 @@ describe 'FlowsApi' do
|
|
|
68
68
|
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
|
69
69
|
# @param action_id
|
|
70
70
|
# @param [Hash] opts the optional parameters
|
|
71
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/
|
|
71
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
72
72
|
# @return [Hash<String, Object>]
|
|
73
73
|
describe 'get_flow_action_flow test' do
|
|
74
74
|
it 'should work' do
|
|
@@ -78,12 +78,12 @@ describe 'FlowsApi' do
|
|
|
78
78
|
|
|
79
79
|
# unit tests for get_flow_action_messages
|
|
80
80
|
# Get Messages For Flow Action
|
|
81
|
-
# Get all flow messages associated with the given action ID.
|
|
81
|
+
# 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` Use filters to narrow your results. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 50 flows per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#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`
|
|
82
82
|
# @param action_id
|
|
83
83
|
# @param [Hash] opts the optional parameters
|
|
84
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/
|
|
85
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
86
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
84
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
85
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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`
|
|
86
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
87
87
|
# @return [Hash<String, Object>]
|
|
88
88
|
describe 'get_flow_action_messages test' do
|
|
89
89
|
it 'should work' do
|
|
@@ -93,12 +93,12 @@ describe 'FlowsApi' do
|
|
|
93
93
|
|
|
94
94
|
# unit tests for get_flow_action_relationships
|
|
95
95
|
# Get Flow Action Relationships
|
|
96
|
-
# Get all [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for flow messages associated with the given flow action ID.
|
|
96
|
+
# Get all [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for flow messages associated with the given flow action ID. Flow message relationships can be sorted by the following fields, in ascending and descending order: `id`, `name`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow message relationships per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#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`
|
|
97
97
|
# @param id
|
|
98
98
|
# @param related_resource
|
|
99
99
|
# @param [Hash] opts the optional parameters
|
|
100
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
101
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
100
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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`
|
|
101
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
102
102
|
# @return [Hash<String, Object>]
|
|
103
103
|
describe 'get_flow_action_relationships test' do
|
|
104
104
|
it 'should work' do
|
|
@@ -111,9 +111,9 @@ describe 'FlowsApi' do
|
|
|
111
111
|
# Get all flow actions associated with the given flow ID. Flow actions can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated`, `action_type` Use filters to narrow your results. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 50 flows per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#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`
|
|
112
112
|
# @param flow_id
|
|
113
113
|
# @param [Hash] opts the optional parameters
|
|
114
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
|
115
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
116
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
114
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
115
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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`
|
|
116
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
117
117
|
# @return [Hash<String, Object>]
|
|
118
118
|
describe 'get_flow_flow_actions test' do
|
|
119
119
|
it 'should work' do
|
|
@@ -126,9 +126,9 @@ describe 'FlowsApi' do
|
|
|
126
126
|
# Get the flow message of a flow with the given message ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). 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`
|
|
127
127
|
# @param id
|
|
128
128
|
# @param [Hash] opts the optional parameters
|
|
129
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
|
130
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/
|
|
131
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
129
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
130
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
131
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
132
132
|
# @return [Hash<String, Object>]
|
|
133
133
|
describe 'get_flow_message test' do
|
|
134
134
|
it 'should work' do
|
|
@@ -141,7 +141,7 @@ describe 'FlowsApi' do
|
|
|
141
141
|
# Get the flow action for a flow message with the given message ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
|
142
142
|
# @param message_id
|
|
143
143
|
# @param [Hash] opts the optional parameters
|
|
144
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
|
144
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
145
145
|
# @return [Hash<String, Object>]
|
|
146
146
|
describe 'get_flow_message_action test' do
|
|
147
147
|
it 'should work' do
|
|
@@ -164,12 +164,10 @@ describe 'FlowsApi' do
|
|
|
164
164
|
|
|
165
165
|
# unit tests for get_flow_relationships
|
|
166
166
|
# Get Flow Relationships
|
|
167
|
-
#
|
|
167
|
+
# If the `related_resource` is `tags`, returns 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`
|
|
168
168
|
# @param id
|
|
169
169
|
# @param related_resource
|
|
170
170
|
# @param [Hash] opts the optional parameters
|
|
171
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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`
|
|
172
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
|
173
171
|
# @return [Hash<String, Object>]
|
|
174
172
|
describe 'get_flow_relationships test' do
|
|
175
173
|
it 'should work' do
|
|
@@ -177,15 +175,28 @@ describe 'FlowsApi' do
|
|
|
177
175
|
end
|
|
178
176
|
end
|
|
179
177
|
|
|
178
|
+
# unit tests for get_flow_tags
|
|
179
|
+
# Get Flow Tags
|
|
180
|
+
# 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`
|
|
181
|
+
# @param flow_id
|
|
182
|
+
# @param [Hash] opts the optional parameters
|
|
183
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
184
|
+
# @return [Hash<String, Object>]
|
|
185
|
+
describe 'get_flow_tags test' do
|
|
186
|
+
it 'should work' do
|
|
187
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
188
|
+
end
|
|
189
|
+
end
|
|
190
|
+
|
|
180
191
|
# unit tests for get_flows
|
|
181
192
|
# Get Flows
|
|
182
193
|
# Get all flows in an account. Flows can be sorted by the following fields, in ascending and descending order: `id`, `name`, `status`, `trigger_type`, `created`, `updated` Use filters to narrow your results. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: `flow-actions` Returns a maximum of 50 flows per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination)<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
|
183
194
|
# @param [Hash] opts the optional parameters
|
|
184
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
|
185
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/
|
|
186
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
187
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
188
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
195
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
196
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
197
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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`
|
|
198
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
199
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
189
200
|
# @return [Hash<String, Object>]
|
|
190
201
|
describe 'get_flows test' do
|
|
191
202
|
it 'should work' do
|
data/spec/api/lists_api_spec.rb
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
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:
|
|
6
|
+
The version of the OpenAPI document: 2023-01-24
|
|
7
7
|
Contact: developers@klaviyo.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 6.
|
|
9
|
+
OpenAPI Generator version: 6.2.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -46,7 +46,7 @@ describe 'ListsApi' do
|
|
|
46
46
|
|
|
47
47
|
# unit tests for create_list_relationships
|
|
48
48
|
# Add Profile to List
|
|
49
|
-
# Add a profile to a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
|
|
49
|
+
# Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
|
|
50
50
|
# @param id
|
|
51
51
|
# @param related_resource
|
|
52
52
|
# @param list_members_add_query
|
|
@@ -72,7 +72,7 @@ describe 'ListsApi' do
|
|
|
72
72
|
|
|
73
73
|
# unit tests for delete_list_relationships
|
|
74
74
|
# Remove Profile from List
|
|
75
|
-
# Remove a profile from a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
|
|
75
|
+
# Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
|
|
76
76
|
# @param id
|
|
77
77
|
# @param related_resource
|
|
78
78
|
# @param list_members_delete_query
|
|
@@ -89,7 +89,7 @@ describe 'ListsApi' do
|
|
|
89
89
|
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write`
|
|
90
90
|
# @param id
|
|
91
91
|
# @param [Hash] opts the optional parameters
|
|
92
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
|
92
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
93
93
|
# @return [Hash<String, Object>]
|
|
94
94
|
describe 'get_list test' do
|
|
95
95
|
it 'should work' do
|
|
@@ -99,12 +99,12 @@ describe 'ListsApi' do
|
|
|
99
99
|
|
|
100
100
|
# unit tests for get_list_profiles
|
|
101
101
|
# Get List Profiles
|
|
102
|
-
# Get all profiles within a list with the given list ID.
|
|
102
|
+
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read` `Profiles Read`
|
|
103
103
|
# @param list_id
|
|
104
104
|
# @param [Hash] opts the optional parameters
|
|
105
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
|
106
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
107
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
105
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
106
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
|
|
107
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
108
108
|
# @return [Hash<String, Object>]
|
|
109
109
|
describe 'get_list_profiles test' do
|
|
110
110
|
it 'should work' do
|
|
@@ -113,12 +113,12 @@ describe 'ListsApi' do
|
|
|
113
113
|
end
|
|
114
114
|
|
|
115
115
|
# unit tests for get_list_relationships
|
|
116
|
-
# Get List
|
|
116
|
+
# Get List Relationships
|
|
117
117
|
# Get profile membership [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for a list with the given list ID. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read` `Profiles Read`
|
|
118
118
|
# @param id
|
|
119
119
|
# @param related_resource
|
|
120
120
|
# @param [Hash] opts the optional parameters
|
|
121
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
121
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
122
122
|
# @return [Hash<String, Object>]
|
|
123
123
|
describe 'get_list_relationships test' do
|
|
124
124
|
it 'should work' do
|
|
@@ -126,13 +126,26 @@ describe 'ListsApi' do
|
|
|
126
126
|
end
|
|
127
127
|
end
|
|
128
128
|
|
|
129
|
+
# unit tests for get_list_tags
|
|
130
|
+
# Get List Tags
|
|
131
|
+
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `List Read` `Tags Read`
|
|
132
|
+
# @param list_id
|
|
133
|
+
# @param [Hash] opts the optional parameters
|
|
134
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
135
|
+
# @return [Hash<String, Object>]
|
|
136
|
+
describe 'get_list_tags test' do
|
|
137
|
+
it 'should work' do
|
|
138
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
139
|
+
end
|
|
140
|
+
end
|
|
141
|
+
|
|
129
142
|
# unit tests for get_lists
|
|
130
143
|
# Get Lists
|
|
131
|
-
# Get all lists in an account.
|
|
144
|
+
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read`
|
|
132
145
|
# @param [Hash] opts the optional parameters
|
|
133
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
|
134
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
135
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
146
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
147
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
|
|
148
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
136
149
|
# @return [Hash<String, Object>]
|
|
137
150
|
describe 'get_lists test' do
|
|
138
151
|
it 'should work' do
|
|
@@ -3,10 +3,10 @@
|
|
|
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:
|
|
6
|
+
The version of the OpenAPI document: 2023-01-24
|
|
7
7
|
Contact: developers@klaviyo.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 6.
|
|
9
|
+
OpenAPI Generator version: 6.2.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -35,9 +35,9 @@ describe 'MetricsApi' do
|
|
|
35
35
|
# unit tests for get_metric
|
|
36
36
|
# Get Metric
|
|
37
37
|
# Get a metric with the given metric ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets)<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Metrics Read`
|
|
38
|
-
# @param id
|
|
38
|
+
# @param id Metric ID
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/
|
|
40
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
41
41
|
# @return [Hash<String, Object>]
|
|
42
42
|
describe 'get_metric test' do
|
|
43
43
|
it 'should work' do
|
|
@@ -49,9 +49,9 @@ describe 'MetricsApi' do
|
|
|
49
49
|
# Get Metrics
|
|
50
50
|
# Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 200 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination)<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Metrics Read`
|
|
51
51
|
# @param [Hash] opts the optional parameters
|
|
52
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/
|
|
53
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
54
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
52
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
53
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`
|
|
54
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
55
55
|
# @return [Hash<String, Object>]
|
|
56
56
|
describe 'get_metrics test' do
|
|
57
57
|
it 'should work' do
|
|
@@ -61,7 +61,7 @@ describe 'MetricsApi' do
|
|
|
61
61
|
|
|
62
62
|
# unit tests for query_metric_aggregates
|
|
63
63
|
# Query Metric Aggregates
|
|
64
|
-
# Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request.
|
|
64
|
+
# Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request. Results can be filtered and grouped by time, event, or profile dimensions. **Request body parameters** (nested under `attributes`): * `return_fields`: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets) * `sort`: sort results by a specified field, such as `\"-timestamp\"` * `page_cursor`: results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination) * `page_size`: limit the number of returned results per page * `by`: optional attributes used to group by the aggregation function * When using `by` attributes, an empty `dimensions` response is expected when the counts for the events do not have the associated dimension requested by the set `by` attribute. For example, a query including `\"by\": [\"$flow\"]` will return an empty dimensions response for counts of metrics not associated with a `$flow` * `measurement`: the measurement key supports the following values: * `\"sum_value\"`: perform a summation of the `_Event Value_`, optionally partitioned over any dimension provided in the `by` field * `\"count\"`: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the `by` field * `\"unique\"` counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the `by` field * `interval`: aggregation interval, such as `\"hour\"`,`\"day\"`,`\"week\"`, and `\"month\"` * `metric_id`: the metric ID used in the aggregation * `filter`: list of filters for specific fields, must include time range using ISO 8601 format (`\"YYYY-MM-DDTHH:MM:SS.mmmmmm\"`) * The time range can be filtered by providing a `greater_or_equal` filter on the datetime field, such as `\"greater-or-equal(datetime,2021-07-01T00:00:00)\"` and a `less-than` filter on the same datetime field, such as `\"less-than(datetime,2022-07-01T00:00:00)\"` * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date * Filter the list of supported aggregate dimensions using the common filter syntax, such as `\"equals(URL,\\\"https://www.klaviyo.com/\\\")\"` * `timezone`: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones) For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/v2022-10-17/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Metrics Read`
|
|
65
65
|
# @param metric_aggregate_query Retrieve Metric Aggregations
|
|
66
66
|
# @param [Hash] opts the optional parameters
|
|
67
67
|
# @return [Hash<String, Object>]
|