klaviyo-api-sdk 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +17 -0
- data/Gemfile +9 -0
- data/LICENSE.md +21 -0
- data/README.md +1316 -0
- data/Rakefile +10 -0
- data/docs/CatalogCategoryCreateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateQueryAsSubResource.md +22 -0
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +24 -0
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryItemOp.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryUpdateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +24 -0
- data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemCategoryOp.md +18 -0
- data/docs/CatalogItemCreateJobCreateQuery.md +18 -0
- data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemCreateQuery.md +18 -0
- data/docs/CatalogItemCreateQueryAsSubResource.md +22 -0
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +38 -0
- data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md +18 -0
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md +18 -0
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemDeleteQueryAsSubResource.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemUpdateQuery.md +18 -0
- data/docs/CatalogItemUpdateQueryAsSubResource.md +24 -0
- data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +32 -0
- data/docs/CatalogJobErrorPayload.md +26 -0
- data/docs/CatalogVariantCreateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogVariantCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateQueryAsSubResource.md +22 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +46 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md +18 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md +18 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogVariantUpdateQuery.md +18 -0
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +22 -0
- data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +38 -0
- data/docs/CatalogsApi.md +4048 -0
- data/docs/ClientApi.md +205 -0
- data/docs/EmailMessageContent.md +24 -0
- data/docs/EmailTrackingOptions.md +24 -0
- data/docs/ErrorSource.md +18 -0
- data/docs/EventCreateQuery.md +18 -0
- data/docs/EventCreateQueryAsSubResource.md +20 -0
- data/docs/EventCreateQueryAsSubResourceAttributes.md +28 -0
- data/docs/EventsApi.md +472 -0
- data/docs/FlowUpdateQuery.md +18 -0
- data/docs/FlowUpdateQueryAsSubResource.md +22 -0
- data/docs/FlowUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/FlowsApi.md +951 -0
- data/docs/GetCatalogItems4XXResponse.md +18 -0
- data/docs/GetCatalogItems4XXResponseErrorsInner.md +26 -0
- data/docs/GetCatalogItems4XXResponseErrorsInnerSource.md +20 -0
- data/docs/IncludedCategories.md +24 -0
- data/docs/IncludedCategoriesAttributes.md +22 -0
- data/docs/IncludedFlowAction.md +24 -0
- data/docs/IncludedFlowActions.md +24 -0
- data/docs/IncludedFlowActionsAttributes.md +32 -0
- data/docs/IncludedFlowActionsAttributesTrackingOptions.md +49 -0
- data/docs/IncludedFlowMessages.md +24 -0
- data/docs/IncludedFlowMessagesAttributes.md +26 -0
- data/docs/IncludedFlowMessagesAttributesContent.md +49 -0
- data/docs/IncludedFlows.md +24 -0
- data/docs/IncludedFlowsAttributes.md +28 -0
- data/docs/IncludedItems.md +24 -0
- data/docs/IncludedItemsAttributes.md +38 -0
- data/docs/IncludedLists.md +24 -0
- data/docs/IncludedListsAttributes.md +22 -0
- data/docs/IncludedMetrics.md +24 -0
- data/docs/IncludedMetricsAttributes.md +24 -0
- data/docs/IncludedProfile.md +24 -0
- data/docs/IncludedProfiles.md +24 -0
- data/docs/IncludedProfilesAttributes.md +44 -0
- data/docs/IncludedSegments.md +24 -0
- data/docs/IncludedVariants.md +24 -0
- data/docs/IncludedVariantsAttributes.md +46 -0
- data/docs/IncludedVariantsLinks.md +18 -0
- data/docs/ListCreateQuery.md +18 -0
- data/docs/ListCreateQueryAsSubResource.md +20 -0
- data/docs/ListCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/ListDeleteQueryAsSubResource.md +20 -0
- data/docs/ListMembersAddQuery.md +18 -0
- data/docs/ListMembersAddQueryDataInner.md +20 -0
- data/docs/ListMembersDeleteQuery.md +18 -0
- data/docs/ListPartialUpdateQuery.md +18 -0
- data/docs/ListPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/ListsApi.md +686 -0
- data/docs/MetricAggregateQuery.md +18 -0
- data/docs/MetricAggregateQueryAsSubResource.md +20 -0
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +36 -0
- data/docs/MetricAggregateRowDTO.md +20 -0
- data/docs/MetricCreateQuery.md +20 -0
- data/docs/MetricsApi.md +233 -0
- data/docs/OnsiteProfileCreateQuery.md +18 -0
- data/docs/OnsiteProfileCreateQueryAsSubResource.md +22 -0
- data/docs/OnsiteProfileMeta.md +18 -0
- data/docs/OnsiteProfileMetaIdentifiers.md +28 -0
- data/docs/OnsiteSubscriptionCreateQuery.md +18 -0
- data/docs/OnsiteSubscriptionCreateQueryAsSubResource.md +20 -0
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +26 -0
- data/docs/ProfileCreateQuery.md +18 -0
- data/docs/ProfileCreateQueryAsSubResource.md +20 -0
- data/docs/ProfileCreateQueryAsSubResourceAttributes.md +38 -0
- data/docs/ProfileLocation.md +34 -0
- data/docs/ProfileLocationLatitude.md +49 -0
- data/docs/ProfilePartialUpdateQuery.md +18 -0
- data/docs/ProfilePartialUpdateQueryAsSubResource.md +22 -0
- data/docs/ProfilesApi.md +825 -0
- data/docs/SMSMessageContent.md +20 -0
- data/docs/SMSRenderOptions.md +24 -0
- data/docs/SMSTrackingOptions.md +20 -0
- data/docs/SegmentPartialUpdateQuery.md +18 -0
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/SegmentsApi.md +390 -0
- data/docs/SendOptions.md +20 -0
- data/docs/Subscription.md +20 -0
- data/docs/SubscriptionCreateJobCreateQuery.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +22 -0
- data/docs/Suppression.md +18 -0
- data/docs/SuppressionCreateJobCreateQuery.md +18 -0
- data/docs/SuppressionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/TemplateCloneQuery.md +18 -0
- data/docs/TemplateCloneQueryAsSubResource.md +20 -0
- data/docs/TemplateCloneQueryAsSubResourceAttributes.md +20 -0
- data/docs/TemplateCreateQuery.md +18 -0
- data/docs/TemplateCreateQueryAsSubResource.md +20 -0
- data/docs/TemplateCreateQueryAsSubResourceAttributes.md +26 -0
- data/docs/TemplateDeleteQueryAsSubResource.md +20 -0
- data/docs/TemplateUpdateQuery.md +18 -0
- data/docs/TemplateUpdateQueryAsSubResource.md +22 -0
- data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +24 -0
- data/docs/TemplatesApi.md +529 -0
- data/docs/UnsubscriptionCreateJobCreateQuery.md +18 -0
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +22 -0
- data/docs/UnsuppressionCreateJobCreateQuery.md +18 -0
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/UtmParamInfo.md +20 -0
- data/docs/V2TemplateRenderQuery.md +18 -0
- data/docs/V2TemplateRenderQueryAsSubResource.md +20 -0
- data/docs/V2TemplateRenderQueryAsSubResourceAttributes.md +20 -0
- data/git_push.sh +57 -0
- data/klaviyo-api-sdk.gemspec +40 -0
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +4095 -0
- data/lib/klaviyo-api-sdk/api/client_api.rb +249 -0
- data/lib/klaviyo-api-sdk/api/events_api.rb +505 -0
- data/lib/klaviyo-api-sdk/api/flows_api.rb +1009 -0
- data/lib/klaviyo-api-sdk/api/lists_api.rb +708 -0
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +236 -0
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +840 -0
- data/lib/klaviyo-api-sdk/api/segments_api.rb +392 -0
- data/lib/klaviyo-api-sdk/api/templates_api.rb +536 -0
- data/lib/klaviyo-api-sdk/api_client.rb +390 -0
- data/lib/klaviyo-api-sdk/api_error.rb +57 -0
- data/lib/klaviyo-api-sdk/configuration.rb +283 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +291 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +295 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +366 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +295 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +284 -0
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +280 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +435 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +346 -0
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +266 -0
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +268 -0
- data/lib/klaviyo-api-sdk/models/error_source.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +279 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +226 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +275 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +228 -0
- data/lib/klaviyo-api-sdk/models/included_categories.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +282 -0
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +105 -0
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +270 -0
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +105 -0
- data/lib/klaviyo-api-sdk/models/included_flows.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +264 -0
- data/lib/klaviyo-api-sdk/models/included_items.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +311 -0
- data/lib/klaviyo-api-sdk/models/included_lists.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +246 -0
- data/lib/klaviyo-api-sdk/models/included_profile.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +336 -0
- data/lib/klaviyo-api-sdk/models/included_segments.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_variants.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +382 -0
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +226 -0
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +226 -0
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +380 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +240 -0
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +233 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +264 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +260 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +309 -0
- data/lib/klaviyo-api-sdk/models/profile_location.rb +291 -0
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +105 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/send_options.rb +238 -0
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +238 -0
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +266 -0
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +240 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +228 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +249 -0
- data/lib/klaviyo-api-sdk/models/suppression.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +267 -0
- data/lib/klaviyo-api-sdk/models/template_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +248 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +246 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +238 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/version.rb +15 -0
- data/lib/klaviyo-api-sdk.rb +253 -0
- data/spec/api/catalogs_api_spec.rb +759 -0
- data/spec/api/client_api_spec.rb +74 -0
- data/spec/api/events_api_spec.rb +120 -0
- data/spec/api/flows_api_spec.rb +209 -0
- data/spec/api/lists_api_spec.rb +156 -0
- data/spec/api/metrics_api_spec.rb +74 -0
- data/spec/api/profiles_api_spec.rb +178 -0
- data/spec/api/segments_api_spec.rb +103 -0
- data/spec/api/templates_api_spec.rb +126 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +56 -0
- data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_category_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_item_op_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +56 -0
- data/spec/models/catalog_category_update_query_spec.rb +34 -0
- data/spec/models/catalog_item_category_op_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +98 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +44 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_item_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +76 -0
- data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +56 -0
- data/spec/models/catalog_item_update_query_spec.rb +34 -0
- data/spec/models/catalog_job_error_payload_spec.rb +58 -0
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +126 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +44 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_variant_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +98 -0
- data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_variant_update_query_spec.rb +34 -0
- data/spec/models/email_message_content_spec.rb +52 -0
- data/spec/models/email_tracking_options_spec.rb +52 -0
- data/spec/models/error_source_spec.rb +34 -0
- data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +64 -0
- data/spec/models/event_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/event_create_query_spec.rb +34 -0
- data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/flow_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/flow_update_query_spec.rb +34 -0
- data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +40 -0
- data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +58 -0
- data/spec/models/get_catalog_items4_xx_response_spec.rb +34 -0
- data/spec/models/included_categories_attributes_spec.rb +46 -0
- data/spec/models/included_categories_spec.rb +56 -0
- data/spec/models/included_flow_action_spec.rb +56 -0
- data/spec/models/included_flow_actions_attributes_spec.rb +76 -0
- data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +31 -0
- data/spec/models/included_flow_actions_spec.rb +56 -0
- data/spec/models/included_flow_messages_attributes_content_spec.rb +31 -0
- data/spec/models/included_flow_messages_attributes_spec.rb +58 -0
- data/spec/models/included_flow_messages_spec.rb +56 -0
- data/spec/models/included_flows_attributes_spec.rb +64 -0
- data/spec/models/included_flows_spec.rb +56 -0
- data/spec/models/included_items_attributes_spec.rb +94 -0
- data/spec/models/included_items_spec.rb +56 -0
- data/spec/models/included_lists_attributes_spec.rb +46 -0
- data/spec/models/included_lists_spec.rb +56 -0
- data/spec/models/included_metrics_attributes_spec.rb +52 -0
- data/spec/models/included_metrics_spec.rb +56 -0
- data/spec/models/included_profile_spec.rb +56 -0
- data/spec/models/included_profiles_attributes_spec.rb +112 -0
- data/spec/models/included_profiles_spec.rb +56 -0
- data/spec/models/included_segments_spec.rb +56 -0
- data/spec/models/included_variants_attributes_spec.rb +122 -0
- data/spec/models/included_variants_links_spec.rb +34 -0
- data/spec/models/included_variants_spec.rb +56 -0
- data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/list_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/list_create_query_spec.rb +34 -0
- data/spec/models/list_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/list_members_add_query_data_inner_spec.rb +44 -0
- data/spec/models/list_members_add_query_spec.rb +34 -0
- data/spec/models/list_members_delete_query_spec.rb +34 -0
- data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/list_partial_update_query_spec.rb +34 -0
- data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +104 -0
- data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/metric_aggregate_query_spec.rb +34 -0
- data/spec/models/metric_aggregate_row_dto_spec.rb +40 -0
- data/spec/models/metric_create_query_spec.rb +40 -0
- data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/onsite_profile_create_query_spec.rb +34 -0
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +64 -0
- data/spec/models/onsite_profile_meta_spec.rb +34 -0
- data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +58 -0
- data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/onsite_subscription_create_query_spec.rb +34 -0
- data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +94 -0
- data/spec/models/profile_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/profile_create_query_spec.rb +34 -0
- data/spec/models/profile_location_latitude_spec.rb +31 -0
- data/spec/models/profile_location_spec.rb +82 -0
- data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/profile_partial_update_query_spec.rb +34 -0
- data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/segment_partial_update_query_spec.rb +34 -0
- data/spec/models/send_options_spec.rb +40 -0
- data/spec/models/sms_message_content_spec.rb +40 -0
- data/spec/models/sms_render_options_spec.rb +52 -0
- data/spec/models/sms_tracking_options_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/subscription_create_job_create_query_spec.rb +34 -0
- data/spec/models/subscription_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/suppression_create_job_create_query_spec.rb +34 -0
- data/spec/models/suppression_spec.rb +34 -0
- data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/template_clone_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/template_clone_query_spec.rb +34 -0
- data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +58 -0
- data/spec/models/template_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/template_create_query_spec.rb +34 -0
- data/spec/models/template_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +52 -0
- data/spec/models/template_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/template_update_query_spec.rb +34 -0
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/unsubscription_create_job_create_query_spec.rb +34 -0
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/unsuppression_create_job_create_query_spec.rb +34 -0
- data/spec/models/utm_param_info_spec.rb +40 -0
- data/spec/models/v2_template_render_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/v2_template_render_query_spec.rb +34 -0
- data/spec/spec_helper.rb +111 -0
- metadata +583 -0
data/docs/FlowsApi.md
ADDED
@@ -0,0 +1,951 @@
|
|
1
|
+
# KlaviyoAPI::FlowsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://a.klaviyo.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_flow**](FlowsApi.md#get_flow) | **GET** /api/flows/{id}/ | Get Flow |
|
8
|
+
| [**get_flow_action**](FlowsApi.md#get_flow_action) | **GET** /api/flow-actions/{id}/ | Get Flow Action |
|
9
|
+
| [**get_flow_action_flow**](FlowsApi.md#get_flow_action_flow) | **GET** /api/flow-actions/{action_id}/flow/ | Get Flow For Flow Action |
|
10
|
+
| [**get_flow_action_messages**](FlowsApi.md#get_flow_action_messages) | **GET** /api/flow-actions/{action_id}/flow-messages/ | Get Messages For Flow Action |
|
11
|
+
| [**get_flow_action_relationships**](FlowsApi.md#get_flow_action_relationships) | **GET** /api/flow-actions/{id}/relationships/{related_resource}/ | Get Flow Action Relationships |
|
12
|
+
| [**get_flow_flow_actions**](FlowsApi.md#get_flow_flow_actions) | **GET** /api/flows/{flow_id}/flow-actions/ | Get Flow Actions For Flow |
|
13
|
+
| [**get_flow_message**](FlowsApi.md#get_flow_message) | **GET** /api/flow-messages/{id}/ | Get Flow Message |
|
14
|
+
| [**get_flow_message_action**](FlowsApi.md#get_flow_message_action) | **GET** /api/flow-messages/{message_id}/flow-action/ | Get Flow Action For Message |
|
15
|
+
| [**get_flow_message_relationships**](FlowsApi.md#get_flow_message_relationships) | **GET** /api/flow-messages/{id}/relationships/{related_resource}/ | Get Flow Message Relationships |
|
16
|
+
| [**get_flow_relationships**](FlowsApi.md#get_flow_relationships) | **GET** /api/flows/{id}/relationships/{related_resource}/ | Get Flow Relationships |
|
17
|
+
| [**get_flows**](FlowsApi.md#get_flows) | **GET** /api/flows/ | Get Flows |
|
18
|
+
| [**update_flow**](FlowsApi.md#update_flow) | **PATCH** /api/flows/{id}/ | Update Flow Status |
|
19
|
+
|
20
|
+
|
21
|
+
## get_flow
|
22
|
+
|
23
|
+
> Hash<String, Object> get_flow(id, opts)
|
24
|
+
|
25
|
+
Get Flow
|
26
|
+
|
27
|
+
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`
|
28
|
+
|
29
|
+
### Examples
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
require 'time'
|
33
|
+
require 'klaviyo-api-sdk'
|
34
|
+
# setup authorization
|
35
|
+
KlaviyoAPI.configure do |config|
|
36
|
+
# Configure API key authorization: Klaviyo-API-Key
|
37
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
38
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
39
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
40
|
+
end
|
41
|
+
|
42
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
43
|
+
id = 'id_example' # String |
|
44
|
+
opts = {
|
45
|
+
fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
46
|
+
fields_flow: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
47
|
+
include: ['flow-actions'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
48
|
+
}
|
49
|
+
|
50
|
+
begin
|
51
|
+
# Get Flow
|
52
|
+
result = api_instance.get_flow(id, opts)
|
53
|
+
p result
|
54
|
+
rescue KlaviyoAPI::ApiError => e
|
55
|
+
puts "Error when calling FlowsApi->get_flow: #{e}"
|
56
|
+
end
|
57
|
+
```
|
58
|
+
|
59
|
+
#### Using the get_flow_with_http_info variant
|
60
|
+
|
61
|
+
This returns an Array which contains the response data, status code and headers.
|
62
|
+
|
63
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_with_http_info(id, opts)
|
64
|
+
|
65
|
+
```ruby
|
66
|
+
begin
|
67
|
+
# Get Flow
|
68
|
+
data, status_code, headers = api_instance.get_flow_with_http_info(id, opts)
|
69
|
+
p status_code # => 2xx
|
70
|
+
p headers # => { ... }
|
71
|
+
p data # => Hash<String, Object>
|
72
|
+
rescue KlaviyoAPI::ApiError => e
|
73
|
+
puts "Error when calling FlowsApi->get_flow_with_http_info: #{e}"
|
74
|
+
end
|
75
|
+
```
|
76
|
+
|
77
|
+
### Parameters
|
78
|
+
|
79
|
+
| Name | Type | Description | Notes |
|
80
|
+
| ---- | ---- | ----------- | ----- |
|
81
|
+
| **id** | **String** | | |
|
82
|
+
| **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
83
|
+
| **fields_flow** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
84
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
85
|
+
|
86
|
+
### Return type
|
87
|
+
|
88
|
+
**Hash<String, Object>**
|
89
|
+
|
90
|
+
### Authorization
|
91
|
+
|
92
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
93
|
+
|
94
|
+
### HTTP request headers
|
95
|
+
|
96
|
+
- **Content-Type**: Not defined
|
97
|
+
- **Accept**: application/json
|
98
|
+
|
99
|
+
|
100
|
+
## get_flow_action
|
101
|
+
|
102
|
+
> Hash<String, Object> get_flow_action(id, opts)
|
103
|
+
|
104
|
+
Get Flow Action
|
105
|
+
|
106
|
+
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`
|
107
|
+
|
108
|
+
### Examples
|
109
|
+
|
110
|
+
```ruby
|
111
|
+
require 'time'
|
112
|
+
require 'klaviyo-api-sdk'
|
113
|
+
# setup authorization
|
114
|
+
KlaviyoAPI.configure do |config|
|
115
|
+
# Configure API key authorization: Klaviyo-API-Key
|
116
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
117
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
118
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
119
|
+
end
|
120
|
+
|
121
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
122
|
+
id = 'id_example' # String |
|
123
|
+
opts = {
|
124
|
+
fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
125
|
+
fields_flow_message: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
126
|
+
fields_flow: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
127
|
+
include: ['flow-messages'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
128
|
+
}
|
129
|
+
|
130
|
+
begin
|
131
|
+
# Get Flow Action
|
132
|
+
result = api_instance.get_flow_action(id, opts)
|
133
|
+
p result
|
134
|
+
rescue KlaviyoAPI::ApiError => e
|
135
|
+
puts "Error when calling FlowsApi->get_flow_action: #{e}"
|
136
|
+
end
|
137
|
+
```
|
138
|
+
|
139
|
+
#### Using the get_flow_action_with_http_info variant
|
140
|
+
|
141
|
+
This returns an Array which contains the response data, status code and headers.
|
142
|
+
|
143
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_action_with_http_info(id, opts)
|
144
|
+
|
145
|
+
```ruby
|
146
|
+
begin
|
147
|
+
# Get Flow Action
|
148
|
+
data, status_code, headers = api_instance.get_flow_action_with_http_info(id, opts)
|
149
|
+
p status_code # => 2xx
|
150
|
+
p headers # => { ... }
|
151
|
+
p data # => Hash<String, Object>
|
152
|
+
rescue KlaviyoAPI::ApiError => e
|
153
|
+
puts "Error when calling FlowsApi->get_flow_action_with_http_info: #{e}"
|
154
|
+
end
|
155
|
+
```
|
156
|
+
|
157
|
+
### Parameters
|
158
|
+
|
159
|
+
| Name | Type | Description | Notes |
|
160
|
+
| ---- | ---- | ----------- | ----- |
|
161
|
+
| **id** | **String** | | |
|
162
|
+
| **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
163
|
+
| **fields_flow_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
164
|
+
| **fields_flow** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
165
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
166
|
+
|
167
|
+
### Return type
|
168
|
+
|
169
|
+
**Hash<String, Object>**
|
170
|
+
|
171
|
+
### Authorization
|
172
|
+
|
173
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
174
|
+
|
175
|
+
### HTTP request headers
|
176
|
+
|
177
|
+
- **Content-Type**: Not defined
|
178
|
+
- **Accept**: application/json
|
179
|
+
|
180
|
+
|
181
|
+
## get_flow_action_flow
|
182
|
+
|
183
|
+
> Hash<String, Object> get_flow_action_flow(action_id, opts)
|
184
|
+
|
185
|
+
Get Flow For Flow Action
|
186
|
+
|
187
|
+
Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
188
|
+
|
189
|
+
### Examples
|
190
|
+
|
191
|
+
```ruby
|
192
|
+
require 'time'
|
193
|
+
require 'klaviyo-api-sdk'
|
194
|
+
# setup authorization
|
195
|
+
KlaviyoAPI.configure do |config|
|
196
|
+
# Configure API key authorization: Klaviyo-API-Key
|
197
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
198
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
199
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
200
|
+
end
|
201
|
+
|
202
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
203
|
+
action_id = 'action_id_example' # String |
|
204
|
+
opts = {
|
205
|
+
fields_flow: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
206
|
+
}
|
207
|
+
|
208
|
+
begin
|
209
|
+
# Get Flow For Flow Action
|
210
|
+
result = api_instance.get_flow_action_flow(action_id, opts)
|
211
|
+
p result
|
212
|
+
rescue KlaviyoAPI::ApiError => e
|
213
|
+
puts "Error when calling FlowsApi->get_flow_action_flow: #{e}"
|
214
|
+
end
|
215
|
+
```
|
216
|
+
|
217
|
+
#### Using the get_flow_action_flow_with_http_info variant
|
218
|
+
|
219
|
+
This returns an Array which contains the response data, status code and headers.
|
220
|
+
|
221
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_action_flow_with_http_info(action_id, opts)
|
222
|
+
|
223
|
+
```ruby
|
224
|
+
begin
|
225
|
+
# Get Flow For Flow Action
|
226
|
+
data, status_code, headers = api_instance.get_flow_action_flow_with_http_info(action_id, opts)
|
227
|
+
p status_code # => 2xx
|
228
|
+
p headers # => { ... }
|
229
|
+
p data # => Hash<String, Object>
|
230
|
+
rescue KlaviyoAPI::ApiError => e
|
231
|
+
puts "Error when calling FlowsApi->get_flow_action_flow_with_http_info: #{e}"
|
232
|
+
end
|
233
|
+
```
|
234
|
+
|
235
|
+
### Parameters
|
236
|
+
|
237
|
+
| Name | Type | Description | Notes |
|
238
|
+
| ---- | ---- | ----------- | ----- |
|
239
|
+
| **action_id** | **String** | | |
|
240
|
+
| **fields_flow** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
241
|
+
|
242
|
+
### Return type
|
243
|
+
|
244
|
+
**Hash<String, Object>**
|
245
|
+
|
246
|
+
### Authorization
|
247
|
+
|
248
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
249
|
+
|
250
|
+
### HTTP request headers
|
251
|
+
|
252
|
+
- **Content-Type**: Not defined
|
253
|
+
- **Accept**: application/json
|
254
|
+
|
255
|
+
|
256
|
+
## get_flow_action_messages
|
257
|
+
|
258
|
+
> Hash<String, Object> get_flow_action_messages(action_id, opts)
|
259
|
+
|
260
|
+
Get Messages For Flow Action
|
261
|
+
|
262
|
+
Get all flow messages associated with the given action ID. Flow messages can be sorted by the following fields, in ascending and descending order: `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`
|
263
|
+
|
264
|
+
### Examples
|
265
|
+
|
266
|
+
```ruby
|
267
|
+
require 'time'
|
268
|
+
require 'klaviyo-api-sdk'
|
269
|
+
# setup authorization
|
270
|
+
KlaviyoAPI.configure do |config|
|
271
|
+
# Configure API key authorization: Klaviyo-API-Key
|
272
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
273
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
274
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
275
|
+
end
|
276
|
+
|
277
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
278
|
+
action_id = 'action_id_example' # String |
|
279
|
+
opts = {
|
280
|
+
fields_flow_message: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
281
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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`
|
282
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
283
|
+
}
|
284
|
+
|
285
|
+
begin
|
286
|
+
# Get Messages For Flow Action
|
287
|
+
result = api_instance.get_flow_action_messages(action_id, opts)
|
288
|
+
p result
|
289
|
+
rescue KlaviyoAPI::ApiError => e
|
290
|
+
puts "Error when calling FlowsApi->get_flow_action_messages: #{e}"
|
291
|
+
end
|
292
|
+
```
|
293
|
+
|
294
|
+
#### Using the get_flow_action_messages_with_http_info variant
|
295
|
+
|
296
|
+
This returns an Array which contains the response data, status code and headers.
|
297
|
+
|
298
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_action_messages_with_http_info(action_id, opts)
|
299
|
+
|
300
|
+
```ruby
|
301
|
+
begin
|
302
|
+
# Get Messages For Flow Action
|
303
|
+
data, status_code, headers = api_instance.get_flow_action_messages_with_http_info(action_id, opts)
|
304
|
+
p status_code # => 2xx
|
305
|
+
p headers # => { ... }
|
306
|
+
p data # => Hash<String, Object>
|
307
|
+
rescue KlaviyoAPI::ApiError => e
|
308
|
+
puts "Error when calling FlowsApi->get_flow_action_messages_with_http_info: #{e}"
|
309
|
+
end
|
310
|
+
```
|
311
|
+
|
312
|
+
### Parameters
|
313
|
+
|
314
|
+
| Name | Type | Description | Notes |
|
315
|
+
| ---- | ---- | ----------- | ----- |
|
316
|
+
| **action_id** | **String** | | |
|
317
|
+
| **fields_flow_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
318
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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` | [optional] |
|
319
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
|
320
|
+
|
321
|
+
### Return type
|
322
|
+
|
323
|
+
**Hash<String, Object>**
|
324
|
+
|
325
|
+
### Authorization
|
326
|
+
|
327
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
328
|
+
|
329
|
+
### HTTP request headers
|
330
|
+
|
331
|
+
- **Content-Type**: Not defined
|
332
|
+
- **Accept**: application/json
|
333
|
+
|
334
|
+
|
335
|
+
## get_flow_action_relationships
|
336
|
+
|
337
|
+
> Hash<String, Object> get_flow_action_relationships(id, related_resource, opts)
|
338
|
+
|
339
|
+
Get Flow Action Relationships
|
340
|
+
|
341
|
+
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`
|
342
|
+
|
343
|
+
### Examples
|
344
|
+
|
345
|
+
```ruby
|
346
|
+
require 'time'
|
347
|
+
require 'klaviyo-api-sdk'
|
348
|
+
# setup authorization
|
349
|
+
KlaviyoAPI.configure do |config|
|
350
|
+
# Configure API key authorization: Klaviyo-API-Key
|
351
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
352
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
353
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
354
|
+
end
|
355
|
+
|
356
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
357
|
+
id = 'id_example' # String |
|
358
|
+
related_resource = 'flow' # String |
|
359
|
+
opts = {
|
360
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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`
|
361
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
362
|
+
}
|
363
|
+
|
364
|
+
begin
|
365
|
+
# Get Flow Action Relationships
|
366
|
+
result = api_instance.get_flow_action_relationships(id, related_resource, opts)
|
367
|
+
p result
|
368
|
+
rescue KlaviyoAPI::ApiError => e
|
369
|
+
puts "Error when calling FlowsApi->get_flow_action_relationships: #{e}"
|
370
|
+
end
|
371
|
+
```
|
372
|
+
|
373
|
+
#### Using the get_flow_action_relationships_with_http_info variant
|
374
|
+
|
375
|
+
This returns an Array which contains the response data, status code and headers.
|
376
|
+
|
377
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_action_relationships_with_http_info(id, related_resource, opts)
|
378
|
+
|
379
|
+
```ruby
|
380
|
+
begin
|
381
|
+
# Get Flow Action Relationships
|
382
|
+
data, status_code, headers = api_instance.get_flow_action_relationships_with_http_info(id, related_resource, opts)
|
383
|
+
p status_code # => 2xx
|
384
|
+
p headers # => { ... }
|
385
|
+
p data # => Hash<String, Object>
|
386
|
+
rescue KlaviyoAPI::ApiError => e
|
387
|
+
puts "Error when calling FlowsApi->get_flow_action_relationships_with_http_info: #{e}"
|
388
|
+
end
|
389
|
+
```
|
390
|
+
|
391
|
+
### Parameters
|
392
|
+
|
393
|
+
| Name | Type | Description | Notes |
|
394
|
+
| ---- | ---- | ----------- | ----- |
|
395
|
+
| **id** | **String** | | |
|
396
|
+
| **related_resource** | **String** | | |
|
397
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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` | [optional] |
|
398
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
|
399
|
+
|
400
|
+
### Return type
|
401
|
+
|
402
|
+
**Hash<String, Object>**
|
403
|
+
|
404
|
+
### Authorization
|
405
|
+
|
406
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
407
|
+
|
408
|
+
### HTTP request headers
|
409
|
+
|
410
|
+
- **Content-Type**: Not defined
|
411
|
+
- **Accept**: application/json
|
412
|
+
|
413
|
+
|
414
|
+
## get_flow_flow_actions
|
415
|
+
|
416
|
+
> Hash<String, Object> get_flow_flow_actions(flow_id, opts)
|
417
|
+
|
418
|
+
Get Flow Actions For Flow
|
419
|
+
|
420
|
+
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`
|
421
|
+
|
422
|
+
### Examples
|
423
|
+
|
424
|
+
```ruby
|
425
|
+
require 'time'
|
426
|
+
require 'klaviyo-api-sdk'
|
427
|
+
# setup authorization
|
428
|
+
KlaviyoAPI.configure do |config|
|
429
|
+
# Configure API key authorization: Klaviyo-API-Key
|
430
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
431
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
432
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
433
|
+
end
|
434
|
+
|
435
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
436
|
+
flow_id = 'flow_id_example' # String |
|
437
|
+
opts = {
|
438
|
+
fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
439
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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`
|
440
|
+
sort: 'action_type' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
441
|
+
}
|
442
|
+
|
443
|
+
begin
|
444
|
+
# Get Flow Actions For Flow
|
445
|
+
result = api_instance.get_flow_flow_actions(flow_id, opts)
|
446
|
+
p result
|
447
|
+
rescue KlaviyoAPI::ApiError => e
|
448
|
+
puts "Error when calling FlowsApi->get_flow_flow_actions: #{e}"
|
449
|
+
end
|
450
|
+
```
|
451
|
+
|
452
|
+
#### Using the get_flow_flow_actions_with_http_info variant
|
453
|
+
|
454
|
+
This returns an Array which contains the response data, status code and headers.
|
455
|
+
|
456
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_flow_actions_with_http_info(flow_id, opts)
|
457
|
+
|
458
|
+
```ruby
|
459
|
+
begin
|
460
|
+
# Get Flow Actions For Flow
|
461
|
+
data, status_code, headers = api_instance.get_flow_flow_actions_with_http_info(flow_id, opts)
|
462
|
+
p status_code # => 2xx
|
463
|
+
p headers # => { ... }
|
464
|
+
p data # => Hash<String, Object>
|
465
|
+
rescue KlaviyoAPI::ApiError => e
|
466
|
+
puts "Error when calling FlowsApi->get_flow_flow_actions_with_http_info: #{e}"
|
467
|
+
end
|
468
|
+
```
|
469
|
+
|
470
|
+
### Parameters
|
471
|
+
|
472
|
+
| Name | Type | Description | Notes |
|
473
|
+
| ---- | ---- | ----------- | ----- |
|
474
|
+
| **flow_id** | **String** | | |
|
475
|
+
| **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
476
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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` | [optional] |
|
477
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
|
478
|
+
|
479
|
+
### Return type
|
480
|
+
|
481
|
+
**Hash<String, Object>**
|
482
|
+
|
483
|
+
### Authorization
|
484
|
+
|
485
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
486
|
+
|
487
|
+
### HTTP request headers
|
488
|
+
|
489
|
+
- **Content-Type**: Not defined
|
490
|
+
- **Accept**: application/json
|
491
|
+
|
492
|
+
|
493
|
+
## get_flow_message
|
494
|
+
|
495
|
+
> Hash<String, Object> get_flow_message(id, opts)
|
496
|
+
|
497
|
+
Get Flow Message
|
498
|
+
|
499
|
+
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`
|
500
|
+
|
501
|
+
### Examples
|
502
|
+
|
503
|
+
```ruby
|
504
|
+
require 'time'
|
505
|
+
require 'klaviyo-api-sdk'
|
506
|
+
# setup authorization
|
507
|
+
KlaviyoAPI.configure do |config|
|
508
|
+
# Configure API key authorization: Klaviyo-API-Key
|
509
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
510
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
511
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
512
|
+
end
|
513
|
+
|
514
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
515
|
+
id = 'id_example' # String |
|
516
|
+
opts = {
|
517
|
+
fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
518
|
+
fields_flow_message: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
519
|
+
include: ['flow-action'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
520
|
+
}
|
521
|
+
|
522
|
+
begin
|
523
|
+
# Get Flow Message
|
524
|
+
result = api_instance.get_flow_message(id, opts)
|
525
|
+
p result
|
526
|
+
rescue KlaviyoAPI::ApiError => e
|
527
|
+
puts "Error when calling FlowsApi->get_flow_message: #{e}"
|
528
|
+
end
|
529
|
+
```
|
530
|
+
|
531
|
+
#### Using the get_flow_message_with_http_info variant
|
532
|
+
|
533
|
+
This returns an Array which contains the response data, status code and headers.
|
534
|
+
|
535
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_message_with_http_info(id, opts)
|
536
|
+
|
537
|
+
```ruby
|
538
|
+
begin
|
539
|
+
# Get Flow Message
|
540
|
+
data, status_code, headers = api_instance.get_flow_message_with_http_info(id, opts)
|
541
|
+
p status_code # => 2xx
|
542
|
+
p headers # => { ... }
|
543
|
+
p data # => Hash<String, Object>
|
544
|
+
rescue KlaviyoAPI::ApiError => e
|
545
|
+
puts "Error when calling FlowsApi->get_flow_message_with_http_info: #{e}"
|
546
|
+
end
|
547
|
+
```
|
548
|
+
|
549
|
+
### Parameters
|
550
|
+
|
551
|
+
| Name | Type | Description | Notes |
|
552
|
+
| ---- | ---- | ----------- | ----- |
|
553
|
+
| **id** | **String** | | |
|
554
|
+
| **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
555
|
+
| **fields_flow_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
556
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
557
|
+
|
558
|
+
### Return type
|
559
|
+
|
560
|
+
**Hash<String, Object>**
|
561
|
+
|
562
|
+
### Authorization
|
563
|
+
|
564
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
565
|
+
|
566
|
+
### HTTP request headers
|
567
|
+
|
568
|
+
- **Content-Type**: Not defined
|
569
|
+
- **Accept**: application/json
|
570
|
+
|
571
|
+
|
572
|
+
## get_flow_message_action
|
573
|
+
|
574
|
+
> Hash<String, Object> get_flow_message_action(message_id, opts)
|
575
|
+
|
576
|
+
Get Flow Action For Message
|
577
|
+
|
578
|
+
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`
|
579
|
+
|
580
|
+
### Examples
|
581
|
+
|
582
|
+
```ruby
|
583
|
+
require 'time'
|
584
|
+
require 'klaviyo-api-sdk'
|
585
|
+
# setup authorization
|
586
|
+
KlaviyoAPI.configure do |config|
|
587
|
+
# Configure API key authorization: Klaviyo-API-Key
|
588
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
589
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
590
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
591
|
+
end
|
592
|
+
|
593
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
594
|
+
message_id = 'message_id_example' # String |
|
595
|
+
opts = {
|
596
|
+
fields_flow_action: ['action_type'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
597
|
+
}
|
598
|
+
|
599
|
+
begin
|
600
|
+
# Get Flow Action For Message
|
601
|
+
result = api_instance.get_flow_message_action(message_id, opts)
|
602
|
+
p result
|
603
|
+
rescue KlaviyoAPI::ApiError => e
|
604
|
+
puts "Error when calling FlowsApi->get_flow_message_action: #{e}"
|
605
|
+
end
|
606
|
+
```
|
607
|
+
|
608
|
+
#### Using the get_flow_message_action_with_http_info variant
|
609
|
+
|
610
|
+
This returns an Array which contains the response data, status code and headers.
|
611
|
+
|
612
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_message_action_with_http_info(message_id, opts)
|
613
|
+
|
614
|
+
```ruby
|
615
|
+
begin
|
616
|
+
# Get Flow Action For Message
|
617
|
+
data, status_code, headers = api_instance.get_flow_message_action_with_http_info(message_id, opts)
|
618
|
+
p status_code # => 2xx
|
619
|
+
p headers # => { ... }
|
620
|
+
p data # => Hash<String, Object>
|
621
|
+
rescue KlaviyoAPI::ApiError => e
|
622
|
+
puts "Error when calling FlowsApi->get_flow_message_action_with_http_info: #{e}"
|
623
|
+
end
|
624
|
+
```
|
625
|
+
|
626
|
+
### Parameters
|
627
|
+
|
628
|
+
| Name | Type | Description | Notes |
|
629
|
+
| ---- | ---- | ----------- | ----- |
|
630
|
+
| **message_id** | **String** | | |
|
631
|
+
| **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
632
|
+
|
633
|
+
### Return type
|
634
|
+
|
635
|
+
**Hash<String, Object>**
|
636
|
+
|
637
|
+
### Authorization
|
638
|
+
|
639
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
640
|
+
|
641
|
+
### HTTP request headers
|
642
|
+
|
643
|
+
- **Content-Type**: Not defined
|
644
|
+
- **Accept**: application/json
|
645
|
+
|
646
|
+
|
647
|
+
## get_flow_message_relationships
|
648
|
+
|
649
|
+
> Hash<String, Object> get_flow_message_relationships(id, related_resource)
|
650
|
+
|
651
|
+
Get Flow Message Relationships
|
652
|
+
|
653
|
+
Get the [relationship](https://developers.klaviyo.com/en/v2022-10-17/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`
|
654
|
+
|
655
|
+
### Examples
|
656
|
+
|
657
|
+
```ruby
|
658
|
+
require 'time'
|
659
|
+
require 'klaviyo-api-sdk'
|
660
|
+
# setup authorization
|
661
|
+
KlaviyoAPI.configure do |config|
|
662
|
+
# Configure API key authorization: Klaviyo-API-Key
|
663
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
664
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
665
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
666
|
+
end
|
667
|
+
|
668
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
669
|
+
id = 'id_example' # String |
|
670
|
+
related_resource = 'flow-action' # String |
|
671
|
+
|
672
|
+
begin
|
673
|
+
# Get Flow Message Relationships
|
674
|
+
result = api_instance.get_flow_message_relationships(id, related_resource)
|
675
|
+
p result
|
676
|
+
rescue KlaviyoAPI::ApiError => e
|
677
|
+
puts "Error when calling FlowsApi->get_flow_message_relationships: #{e}"
|
678
|
+
end
|
679
|
+
```
|
680
|
+
|
681
|
+
#### Using the get_flow_message_relationships_with_http_info variant
|
682
|
+
|
683
|
+
This returns an Array which contains the response data, status code and headers.
|
684
|
+
|
685
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_message_relationships_with_http_info(id, related_resource)
|
686
|
+
|
687
|
+
```ruby
|
688
|
+
begin
|
689
|
+
# Get Flow Message Relationships
|
690
|
+
data, status_code, headers = api_instance.get_flow_message_relationships_with_http_info(id, related_resource)
|
691
|
+
p status_code # => 2xx
|
692
|
+
p headers # => { ... }
|
693
|
+
p data # => Hash<String, Object>
|
694
|
+
rescue KlaviyoAPI::ApiError => e
|
695
|
+
puts "Error when calling FlowsApi->get_flow_message_relationships_with_http_info: #{e}"
|
696
|
+
end
|
697
|
+
```
|
698
|
+
|
699
|
+
### Parameters
|
700
|
+
|
701
|
+
| Name | Type | Description | Notes |
|
702
|
+
| ---- | ---- | ----------- | ----- |
|
703
|
+
| **id** | **String** | | |
|
704
|
+
| **related_resource** | **String** | | |
|
705
|
+
|
706
|
+
### Return type
|
707
|
+
|
708
|
+
**Hash<String, Object>**
|
709
|
+
|
710
|
+
### Authorization
|
711
|
+
|
712
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
713
|
+
|
714
|
+
### HTTP request headers
|
715
|
+
|
716
|
+
- **Content-Type**: Not defined
|
717
|
+
- **Accept**: application/json
|
718
|
+
|
719
|
+
|
720
|
+
## get_flow_relationships
|
721
|
+
|
722
|
+
> Hash<String, Object> get_flow_relationships(id, related_resource, opts)
|
723
|
+
|
724
|
+
Get Flow Relationships
|
725
|
+
|
726
|
+
Get all [relationships](https://developers.klaviyo.com/en/v2022-10-17/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](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`
|
727
|
+
|
728
|
+
### Examples
|
729
|
+
|
730
|
+
```ruby
|
731
|
+
require 'time'
|
732
|
+
require 'klaviyo-api-sdk'
|
733
|
+
# setup authorization
|
734
|
+
KlaviyoAPI.configure do |config|
|
735
|
+
# Configure API key authorization: Klaviyo-API-Key
|
736
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
737
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
738
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
739
|
+
end
|
740
|
+
|
741
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
742
|
+
id = 'id_example' # String |
|
743
|
+
related_resource = 'flow-actions' # String |
|
744
|
+
opts = {
|
745
|
+
filter: 'filter_example', # String | 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`
|
746
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
747
|
+
}
|
748
|
+
|
749
|
+
begin
|
750
|
+
# Get Flow Relationships
|
751
|
+
result = api_instance.get_flow_relationships(id, related_resource, opts)
|
752
|
+
p result
|
753
|
+
rescue KlaviyoAPI::ApiError => e
|
754
|
+
puts "Error when calling FlowsApi->get_flow_relationships: #{e}"
|
755
|
+
end
|
756
|
+
```
|
757
|
+
|
758
|
+
#### Using the get_flow_relationships_with_http_info variant
|
759
|
+
|
760
|
+
This returns an Array which contains the response data, status code and headers.
|
761
|
+
|
762
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_relationships_with_http_info(id, related_resource, opts)
|
763
|
+
|
764
|
+
```ruby
|
765
|
+
begin
|
766
|
+
# Get Flow Relationships
|
767
|
+
data, status_code, headers = api_instance.get_flow_relationships_with_http_info(id, related_resource, opts)
|
768
|
+
p status_code # => 2xx
|
769
|
+
p headers # => { ... }
|
770
|
+
p data # => Hash<String, Object>
|
771
|
+
rescue KlaviyoAPI::ApiError => e
|
772
|
+
puts "Error when calling FlowsApi->get_flow_relationships_with_http_info: #{e}"
|
773
|
+
end
|
774
|
+
```
|
775
|
+
|
776
|
+
### Parameters
|
777
|
+
|
778
|
+
| Name | Type | Description | Notes |
|
779
|
+
| ---- | ---- | ----------- | ----- |
|
780
|
+
| **id** | **String** | | |
|
781
|
+
| **related_resource** | **String** | | |
|
782
|
+
| **filter** | **String** | 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` | [optional] |
|
783
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
|
784
|
+
|
785
|
+
### Return type
|
786
|
+
|
787
|
+
**Hash<String, Object>**
|
788
|
+
|
789
|
+
### Authorization
|
790
|
+
|
791
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
792
|
+
|
793
|
+
### HTTP request headers
|
794
|
+
|
795
|
+
- **Content-Type**: Not defined
|
796
|
+
- **Accept**: application/json
|
797
|
+
|
798
|
+
|
799
|
+
## get_flows
|
800
|
+
|
801
|
+
> Hash<String, Object> get_flows(opts)
|
802
|
+
|
803
|
+
Get Flows
|
804
|
+
|
805
|
+
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`
|
806
|
+
|
807
|
+
### Examples
|
808
|
+
|
809
|
+
```ruby
|
810
|
+
require 'time'
|
811
|
+
require 'klaviyo-api-sdk'
|
812
|
+
# setup authorization
|
813
|
+
KlaviyoAPI.configure do |config|
|
814
|
+
# Configure API key authorization: Klaviyo-API-Key
|
815
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
816
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
817
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
818
|
+
end
|
819
|
+
|
820
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
821
|
+
opts = {
|
822
|
+
fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
823
|
+
fields_flow: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
824
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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`
|
825
|
+
include: ['flow-actions'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
826
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
827
|
+
}
|
828
|
+
|
829
|
+
begin
|
830
|
+
# Get Flows
|
831
|
+
result = api_instance.get_flows(opts)
|
832
|
+
p result
|
833
|
+
rescue KlaviyoAPI::ApiError => e
|
834
|
+
puts "Error when calling FlowsApi->get_flows: #{e}"
|
835
|
+
end
|
836
|
+
```
|
837
|
+
|
838
|
+
#### Using the get_flows_with_http_info variant
|
839
|
+
|
840
|
+
This returns an Array which contains the response data, status code and headers.
|
841
|
+
|
842
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flows_with_http_info(opts)
|
843
|
+
|
844
|
+
```ruby
|
845
|
+
begin
|
846
|
+
# Get Flows
|
847
|
+
data, status_code, headers = api_instance.get_flows_with_http_info(opts)
|
848
|
+
p status_code # => 2xx
|
849
|
+
p headers # => { ... }
|
850
|
+
p data # => Hash<String, Object>
|
851
|
+
rescue KlaviyoAPI::ApiError => e
|
852
|
+
puts "Error when calling FlowsApi->get_flows_with_http_info: #{e}"
|
853
|
+
end
|
854
|
+
```
|
855
|
+
|
856
|
+
### Parameters
|
857
|
+
|
858
|
+
| Name | Type | Description | Notes |
|
859
|
+
| ---- | ---- | ----------- | ----- |
|
860
|
+
| **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
861
|
+
| **fields_flow** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
862
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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` | [optional] |
|
863
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
864
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
|
865
|
+
|
866
|
+
### Return type
|
867
|
+
|
868
|
+
**Hash<String, Object>**
|
869
|
+
|
870
|
+
### Authorization
|
871
|
+
|
872
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
873
|
+
|
874
|
+
### HTTP request headers
|
875
|
+
|
876
|
+
- **Content-Type**: Not defined
|
877
|
+
- **Accept**: application/json
|
878
|
+
|
879
|
+
|
880
|
+
## update_flow
|
881
|
+
|
882
|
+
> Hash<String, Object> update_flow(id, flow_update_query)
|
883
|
+
|
884
|
+
Update Flow Status
|
885
|
+
|
886
|
+
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`
|
887
|
+
|
888
|
+
### Examples
|
889
|
+
|
890
|
+
```ruby
|
891
|
+
require 'time'
|
892
|
+
require 'klaviyo-api-sdk'
|
893
|
+
# setup authorization
|
894
|
+
KlaviyoAPI.configure do |config|
|
895
|
+
# Configure API key authorization: Klaviyo-API-Key
|
896
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
897
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
898
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
899
|
+
end
|
900
|
+
|
901
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
902
|
+
id = 'id_example' # String |
|
903
|
+
flow_update_query = KlaviyoAPI::FlowUpdateQuery.new({data: KlaviyoAPI::FlowUpdateQueryAsSubResource.new({type: 'flow', id: 'id_example', attributes: KlaviyoAPI::FlowUpdateQueryAsSubResourceAttributes.new({status: 'status_example'})})}) # FlowUpdateQuery |
|
904
|
+
|
905
|
+
begin
|
906
|
+
# Update Flow Status
|
907
|
+
result = api_instance.update_flow(id, flow_update_query)
|
908
|
+
p result
|
909
|
+
rescue KlaviyoAPI::ApiError => e
|
910
|
+
puts "Error when calling FlowsApi->update_flow: #{e}"
|
911
|
+
end
|
912
|
+
```
|
913
|
+
|
914
|
+
#### Using the update_flow_with_http_info variant
|
915
|
+
|
916
|
+
This returns an Array which contains the response data, status code and headers.
|
917
|
+
|
918
|
+
> <Array(Hash<String, Object>, Integer, Hash)> update_flow_with_http_info(id, flow_update_query)
|
919
|
+
|
920
|
+
```ruby
|
921
|
+
begin
|
922
|
+
# Update Flow Status
|
923
|
+
data, status_code, headers = api_instance.update_flow_with_http_info(id, flow_update_query)
|
924
|
+
p status_code # => 2xx
|
925
|
+
p headers # => { ... }
|
926
|
+
p data # => Hash<String, Object>
|
927
|
+
rescue KlaviyoAPI::ApiError => e
|
928
|
+
puts "Error when calling FlowsApi->update_flow_with_http_info: #{e}"
|
929
|
+
end
|
930
|
+
```
|
931
|
+
|
932
|
+
### Parameters
|
933
|
+
|
934
|
+
| Name | Type | Description | Notes |
|
935
|
+
| ---- | ---- | ----------- | ----- |
|
936
|
+
| **id** | **String** | | |
|
937
|
+
| **flow_update_query** | [**FlowUpdateQuery**](FlowUpdateQuery.md) | | |
|
938
|
+
|
939
|
+
### Return type
|
940
|
+
|
941
|
+
**Hash<String, Object>**
|
942
|
+
|
943
|
+
### Authorization
|
944
|
+
|
945
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
946
|
+
|
947
|
+
### HTTP request headers
|
948
|
+
|
949
|
+
- **Content-Type**: application/json
|
950
|
+
- **Accept**: application/json
|
951
|
+
|