klaviyo-api-sdk 1.1.0 → 1.2.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 +10 -0
- data/README.md +314 -136
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CampaignTagOp.md +18 -0
- data/docs/CampaignTagOpDataInner.md +20 -0
- data/docs/CampaignsApi.md +1277 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +6 -6
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +2 -2
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +2 -2
- data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +2 -2
- data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +21 -19
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogItemDeleteQueryAsSubResource.md +2 -2
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogItemUpdateQueryAsSubResource.md +2 -2
- data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +18 -16
- data/docs/CatalogJobErrorPayload.md +8 -8
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +27 -27
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +2 -2
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +2 -2
- data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +22 -22
- data/docs/CatalogsApi.md +238 -238
- data/docs/ErrorSource.md +1 -1
- data/docs/EventsApi.md +26 -26
- data/docs/FlowsApi.md +64 -56
- data/docs/GetCampaigns4XXResponse.md +18 -0
- data/docs/GetCampaigns4XXResponseErrorsInner.md +26 -0
- data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +20 -0
- data/docs/IncludedCategories.md +2 -2
- data/docs/IncludedCategoriesAttributes.md +5 -5
- data/docs/IncludedItems.md +2 -2
- data/docs/IncludedItemsAttributes.md +22 -20
- data/docs/IncludedLists.md +2 -2
- data/docs/IncludedListsAttributes.md +4 -4
- data/docs/IncludedProfiles.md +2 -2
- data/docs/IncludedProfilesAttributes.md +21 -21
- data/docs/IncludedSegments.md +1 -1
- data/docs/IncludedSegmentsAttributes.md +22 -0
- data/docs/IncludedTags.md +24 -0
- data/docs/IncludedVariants.md +2 -2
- data/docs/IncludedVariantsAttributes.md +28 -28
- data/docs/ListCreateQueryAsSubResourceAttributes.md +2 -2
- data/docs/ListPartialUpdateQueryAsSubResource.md +2 -2
- data/docs/ListsApi.md +30 -30
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +5 -5
- data/docs/MetricsApi.md +9 -9
- data/docs/OnsiteProfileMetaIdentifiers.md +10 -10
- data/docs/ProfileCreateQueryAsSubResourceAttributes.md +18 -18
- data/docs/ProfileLocation.md +15 -15
- data/docs/ProfileLocationLongitude.md +49 -0
- data/docs/ProfilePartialUpdateQueryAsSubResource.md +2 -2
- data/docs/ProfilesApi.md +26 -26
- data/docs/STOScheduleOptions.md +18 -0
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +1 -1
- data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/SegmentsApi.md +19 -19
- data/docs/SendOptionsSubObject.md +1 -3
- data/docs/SendStrategySubObject.md +4 -2
- data/docs/Subscription.md +8 -4
- data/docs/SubscriptionChannels.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +2 -2
- data/docs/Suppression.md +1 -1
- data/docs/TagsApi.md +24 -24
- data/docs/TemplateCloneQueryAsSubResource.md +0 -2
- data/docs/TemplatesApi.md +11 -11
- data/docs/ThrottledScheduleOptions.md +1 -1
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +1275 -0
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +299 -299
- data/lib/klaviyo-api-sdk/api/client_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/events_api.rb +33 -33
- data/lib/klaviyo-api-sdk/api/flows_api.rb +86 -74
- data/lib/klaviyo-api-sdk/api/lists_api.rb +39 -39
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +34 -34
- data/lib/klaviyo-api-sdk/api/segments_api.rb +25 -25
- data/lib/klaviyo-api-sdk/api/tags_api.rb +41 -41
- data/lib/klaviyo-api-sdk/api/templates_api.rb +18 -18
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_tag_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/campaign_tag_op_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +5 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +23 -3
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +20 -2
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +5 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +16 -8
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +12 -2
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/error_source.rb +2 -1
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response.rb +226 -0
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner.rb +275 -0
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner_source.rb +228 -0
- data/lib/klaviyo-api-sdk/models/included_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +4 -1
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flows.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_items.rb +2 -1
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +23 -2
- data/lib/klaviyo-api-sdk/models/included_lists.rb +2 -1
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +4 -1
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +2 -1
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +13 -1
- data/lib/klaviyo-api-sdk/models/included_segments.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/included_tags.rb +301 -0
- data/lib/klaviyo-api-sdk/models/included_variants.rb +2 -1
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +16 -2
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +2 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +17 -15
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +16 -11
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +10 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +9 -2
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +2 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/send_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +5 -15
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +15 -6
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +225 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +26 -5
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +2 -13
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +1 -1
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +14 -5
- data/spec/api/campaigns_api_spec.rb +284 -0
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_tag_op_data_inner_spec.rb +44 -0
- data/spec/models/campaign_tag_op_spec.rb +34 -0
- data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +40 -0
- data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +58 -0
- data/spec/models/get_campaigns4_xx_response_spec.rb +34 -0
- data/spec/models/included_segments_attributes_spec.rb +46 -0
- data/spec/models/included_tags_spec.rb +56 -0
- data/spec/models/profile_location_longitude_spec.rb +31 -0
- data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/sto_schedule_options_spec.rb +34 -0
- data/spec/models/subscription_channels_spec.rb +48 -0
- data/spec/spec_helper.rb +1 -1
- metadata +51 -6
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2023-
|
6
|
+
The version of the OpenAPI document: 2023-02-22
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -23,9 +23,9 @@ module KlaviyoAPI
|
|
23
23
|
# Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
24
24
|
# @param id [String]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
27
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
28
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
26
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
27
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
28
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
29
29
|
# @return [Hash<String, Object>]
|
30
30
|
def get_flow(id, opts = {})
|
31
31
|
data, _status_code, _headers = get_flow_with_http_info(id, opts)
|
@@ -36,9 +36,9 @@ module KlaviyoAPI
|
|
36
36
|
# Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
37
37
|
# @param id [String]
|
38
38
|
# @param [Hash] opts the optional parameters
|
39
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
40
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
41
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
39
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
40
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
41
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
42
42
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
43
43
|
def get_flow_with_http_info(id, opts = {})
|
44
44
|
if @api_client.config.debugging
|
@@ -72,7 +72,7 @@ module KlaviyoAPI
|
|
72
72
|
# header parameters
|
73
73
|
header_params = opts[:header_params] || {}
|
74
74
|
# klaviyo api revision
|
75
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
75
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
76
76
|
# HTTP header 'Accept' (if needed)
|
77
77
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
78
78
|
|
@@ -109,10 +109,10 @@ module KlaviyoAPI
|
|
109
109
|
# Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
110
110
|
# @param id [String]
|
111
111
|
# @param [Hash] opts the optional parameters
|
112
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
113
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
114
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
115
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
112
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
113
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
114
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
115
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
116
116
|
# @return [Hash<String, Object>]
|
117
117
|
def get_flow_action(id, opts = {})
|
118
118
|
data, _status_code, _headers = get_flow_action_with_http_info(id, opts)
|
@@ -123,10 +123,10 @@ module KlaviyoAPI
|
|
123
123
|
# Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
124
124
|
# @param id [String]
|
125
125
|
# @param [Hash] opts the optional parameters
|
126
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
127
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
128
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
129
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
126
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
127
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
128
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
129
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
130
130
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
131
131
|
def get_flow_action_with_http_info(id, opts = {})
|
132
132
|
if @api_client.config.debugging
|
@@ -165,7 +165,7 @@ module KlaviyoAPI
|
|
165
165
|
# header parameters
|
166
166
|
header_params = opts[:header_params] || {}
|
167
167
|
# klaviyo api revision
|
168
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
168
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
169
169
|
# HTTP header 'Accept' (if needed)
|
170
170
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
171
171
|
|
@@ -202,7 +202,7 @@ module KlaviyoAPI
|
|
202
202
|
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
203
203
|
# @param action_id [String]
|
204
204
|
# @param [Hash] opts the optional parameters
|
205
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
205
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
206
206
|
# @return [Hash<String, Object>]
|
207
207
|
def get_flow_action_flow(action_id, opts = {})
|
208
208
|
data, _status_code, _headers = get_flow_action_flow_with_http_info(action_id, opts)
|
@@ -213,7 +213,7 @@ module KlaviyoAPI
|
|
213
213
|
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
214
214
|
# @param action_id [String]
|
215
215
|
# @param [Hash] opts the optional parameters
|
216
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
216
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
217
217
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
218
218
|
def get_flow_action_flow_with_http_info(action_id, opts = {})
|
219
219
|
if @api_client.config.debugging
|
@@ -237,7 +237,7 @@ module KlaviyoAPI
|
|
237
237
|
# header parameters
|
238
238
|
header_params = opts[:header_params] || {}
|
239
239
|
# klaviyo api revision
|
240
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
240
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
241
241
|
# HTTP header 'Accept' (if needed)
|
242
242
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
243
243
|
|
@@ -271,12 +271,13 @@ module KlaviyoAPI
|
|
271
271
|
end
|
272
272
|
|
273
273
|
# Get Messages For Flow Action
|
274
|
-
# Get all flow messages associated with the given action ID.
|
274
|
+
# Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
275
275
|
# @param action_id [String]
|
276
276
|
# @param [Hash] opts the optional parameters
|
277
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
278
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
279
|
-
# @option opts [String] :
|
277
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
278
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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`
|
279
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
280
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
280
281
|
# @return [Hash<String, Object>]
|
281
282
|
def get_flow_action_messages(action_id, opts = {})
|
282
283
|
data, _status_code, _headers = get_flow_action_messages_with_http_info(action_id, opts)
|
@@ -284,12 +285,13 @@ module KlaviyoAPI
|
|
284
285
|
end
|
285
286
|
|
286
287
|
# Get Messages For Flow Action
|
287
|
-
# Get all flow messages associated with the given action ID.
|
288
|
+
# Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
288
289
|
# @param action_id [String]
|
289
290
|
# @param [Hash] opts the optional parameters
|
290
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
291
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
292
|
-
# @option opts [String] :
|
291
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
292
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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`
|
293
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
294
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
293
295
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
294
296
|
def get_flow_action_messages_with_http_info(action_id, opts = {})
|
295
297
|
if @api_client.config.debugging
|
@@ -314,12 +316,13 @@ module KlaviyoAPI
|
|
314
316
|
query_params = opts[:query_params] || {}
|
315
317
|
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
316
318
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
319
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
317
320
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
318
321
|
|
319
322
|
# header parameters
|
320
323
|
header_params = opts[:header_params] || {}
|
321
324
|
# klaviyo api revision
|
322
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
325
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
323
326
|
# HTTP header 'Accept' (if needed)
|
324
327
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
325
328
|
|
@@ -353,12 +356,13 @@ module KlaviyoAPI
|
|
353
356
|
end
|
354
357
|
|
355
358
|
# Get Flow Action Relationships
|
356
|
-
# Get all
|
359
|
+
# Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
357
360
|
# @param id [String]
|
358
361
|
# @param related_resource [String]
|
359
362
|
# @param [Hash] opts the optional parameters
|
360
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
361
|
-
# @option opts [String] :
|
363
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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`
|
364
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
365
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
362
366
|
# @return [Hash<String, Object>]
|
363
367
|
def get_flow_action_relationships(id, related_resource, opts = {})
|
364
368
|
data, _status_code, _headers = get_flow_action_relationships_with_http_info(id, related_resource, opts)
|
@@ -366,12 +370,13 @@ module KlaviyoAPI
|
|
366
370
|
end
|
367
371
|
|
368
372
|
# Get Flow Action Relationships
|
369
|
-
# Get all
|
373
|
+
# Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
370
374
|
# @param id [String]
|
371
375
|
# @param related_resource [String]
|
372
376
|
# @param [Hash] opts the optional parameters
|
373
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
374
|
-
# @option opts [String] :
|
377
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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`
|
378
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
379
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
375
380
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
376
381
|
def get_flow_action_relationships_with_http_info(id, related_resource, opts = {})
|
377
382
|
if @api_client.config.debugging
|
@@ -400,12 +405,13 @@ module KlaviyoAPI
|
|
400
405
|
# query parameters
|
401
406
|
query_params = opts[:query_params] || {}
|
402
407
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
408
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
403
409
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
404
410
|
|
405
411
|
# header parameters
|
406
412
|
header_params = opts[:header_params] || {}
|
407
413
|
# klaviyo api revision
|
408
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
414
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
409
415
|
# HTTP header 'Accept' (if needed)
|
410
416
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
411
417
|
|
@@ -439,12 +445,13 @@ module KlaviyoAPI
|
|
439
445
|
end
|
440
446
|
|
441
447
|
# Get Flow Actions For Flow
|
442
|
-
# Get all flow actions associated with the given flow ID.
|
448
|
+
# Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
443
449
|
# @param flow_id [String]
|
444
450
|
# @param [Hash] opts the optional parameters
|
445
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
446
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
447
|
-
# @option opts [String] :
|
451
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
452
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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`
|
453
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
454
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
448
455
|
# @return [Hash<String, Object>]
|
449
456
|
def get_flow_flow_actions(flow_id, opts = {})
|
450
457
|
data, _status_code, _headers = get_flow_flow_actions_with_http_info(flow_id, opts)
|
@@ -452,12 +459,13 @@ module KlaviyoAPI
|
|
452
459
|
end
|
453
460
|
|
454
461
|
# Get Flow Actions For Flow
|
455
|
-
# Get all flow actions associated with the given flow ID.
|
462
|
+
# Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
456
463
|
# @param flow_id [String]
|
457
464
|
# @param [Hash] opts the optional parameters
|
458
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
459
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
460
|
-
# @option opts [String] :
|
465
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
466
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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`
|
467
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
468
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
461
469
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
462
470
|
def get_flow_flow_actions_with_http_info(flow_id, opts = {})
|
463
471
|
if @api_client.config.debugging
|
@@ -482,12 +490,13 @@ module KlaviyoAPI
|
|
482
490
|
query_params = opts[:query_params] || {}
|
483
491
|
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
484
492
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
493
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
485
494
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
486
495
|
|
487
496
|
# header parameters
|
488
497
|
header_params = opts[:header_params] || {}
|
489
498
|
# klaviyo api revision
|
490
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
499
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
491
500
|
# HTTP header 'Accept' (if needed)
|
492
501
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
493
502
|
|
@@ -524,9 +533,9 @@ module KlaviyoAPI
|
|
524
533
|
# Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
525
534
|
# @param id [String]
|
526
535
|
# @param [Hash] opts the optional parameters
|
527
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
528
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
529
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
536
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
537
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
538
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
530
539
|
# @return [Hash<String, Object>]
|
531
540
|
def get_flow_message(id, opts = {})
|
532
541
|
data, _status_code, _headers = get_flow_message_with_http_info(id, opts)
|
@@ -537,9 +546,9 @@ module KlaviyoAPI
|
|
537
546
|
# Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
538
547
|
# @param id [String]
|
539
548
|
# @param [Hash] opts the optional parameters
|
540
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
541
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
542
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
549
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
550
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
551
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
543
552
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
544
553
|
def get_flow_message_with_http_info(id, opts = {})
|
545
554
|
if @api_client.config.debugging
|
@@ -573,7 +582,7 @@ module KlaviyoAPI
|
|
573
582
|
# header parameters
|
574
583
|
header_params = opts[:header_params] || {}
|
575
584
|
# klaviyo api revision
|
576
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
585
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
577
586
|
# HTTP header 'Accept' (if needed)
|
578
587
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
579
588
|
|
@@ -610,7 +619,7 @@ module KlaviyoAPI
|
|
610
619
|
# Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
611
620
|
# @param message_id [String]
|
612
621
|
# @param [Hash] opts the optional parameters
|
613
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
622
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
614
623
|
# @return [Hash<String, Object>]
|
615
624
|
def get_flow_message_action(message_id, opts = {})
|
616
625
|
data, _status_code, _headers = get_flow_message_action_with_http_info(message_id, opts)
|
@@ -621,7 +630,7 @@ module KlaviyoAPI
|
|
621
630
|
# Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
622
631
|
# @param message_id [String]
|
623
632
|
# @param [Hash] opts the optional parameters
|
624
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
633
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
625
634
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
626
635
|
def get_flow_message_action_with_http_info(message_id, opts = {})
|
627
636
|
if @api_client.config.debugging
|
@@ -645,7 +654,7 @@ module KlaviyoAPI
|
|
645
654
|
# header parameters
|
646
655
|
header_params = opts[:header_params] || {}
|
647
656
|
# klaviyo api revision
|
648
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
657
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
649
658
|
# HTTP header 'Accept' (if needed)
|
650
659
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
651
660
|
|
@@ -721,7 +730,7 @@ module KlaviyoAPI
|
|
721
730
|
# header parameters
|
722
731
|
header_params = opts[:header_params] || {}
|
723
732
|
# klaviyo api revision
|
724
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
733
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
725
734
|
# HTTP header 'Accept' (if needed)
|
726
735
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
727
736
|
|
@@ -797,7 +806,7 @@ module KlaviyoAPI
|
|
797
806
|
# header parameters
|
798
807
|
header_params = opts[:header_params] || {}
|
799
808
|
# klaviyo api revision
|
800
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
809
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
801
810
|
# HTTP header 'Accept' (if needed)
|
802
811
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
803
812
|
|
@@ -834,7 +843,7 @@ module KlaviyoAPI
|
|
834
843
|
# 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`
|
835
844
|
# @param flow_id [String]
|
836
845
|
# @param [Hash] opts the optional parameters
|
837
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
846
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
838
847
|
# @return [Hash<String, Object>]
|
839
848
|
def get_flow_tags(flow_id, opts = {})
|
840
849
|
data, _status_code, _headers = get_flow_tags_with_http_info(flow_id, opts)
|
@@ -845,7 +854,7 @@ module KlaviyoAPI
|
|
845
854
|
# 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`
|
846
855
|
# @param flow_id [String]
|
847
856
|
# @param [Hash] opts the optional parameters
|
848
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
857
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
849
858
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
850
859
|
def get_flow_tags_with_http_info(flow_id, opts = {})
|
851
860
|
if @api_client.config.debugging
|
@@ -869,7 +878,7 @@ module KlaviyoAPI
|
|
869
878
|
# header parameters
|
870
879
|
header_params = opts[:header_params] || {}
|
871
880
|
# klaviyo api revision
|
872
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
881
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
873
882
|
# HTTP header 'Accept' (if needed)
|
874
883
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
875
884
|
|
@@ -903,13 +912,14 @@ module KlaviyoAPI
|
|
903
912
|
end
|
904
913
|
|
905
914
|
# Get Flows
|
906
|
-
# Get all flows in an account.
|
915
|
+
# Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
907
916
|
# @param [Hash] opts the optional parameters
|
908
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
909
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
910
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
911
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
912
|
-
# @option opts [String] :
|
917
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
918
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
919
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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`
|
920
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
921
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
922
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
913
923
|
# @return [Hash<String, Object>]
|
914
924
|
def get_flows(opts = {})
|
915
925
|
data, _status_code, _headers = get_flows_with_http_info(opts)
|
@@ -917,13 +927,14 @@ module KlaviyoAPI
|
|
917
927
|
end
|
918
928
|
|
919
929
|
# Get Flows
|
920
|
-
# Get all flows in an account.
|
930
|
+
# Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
|
921
931
|
# @param [Hash] opts the optional parameters
|
922
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
923
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
924
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
925
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
926
|
-
# @option opts [String] :
|
932
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
933
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
934
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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`
|
935
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
936
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
937
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
927
938
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
928
939
|
def get_flows_with_http_info(opts = {})
|
929
940
|
if @api_client.config.debugging
|
@@ -954,12 +965,13 @@ module KlaviyoAPI
|
|
954
965
|
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
955
966
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
956
967
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
968
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
957
969
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
958
970
|
|
959
971
|
# header parameters
|
960
972
|
header_params = opts[:header_params] || {}
|
961
973
|
# klaviyo api revision
|
962
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
974
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
963
975
|
# HTTP header 'Accept' (if needed)
|
964
976
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
965
977
|
|
@@ -1030,7 +1042,7 @@ module KlaviyoAPI
|
|
1030
1042
|
# header parameters
|
1031
1043
|
header_params = opts[:header_params] || {}
|
1032
1044
|
# klaviyo api revision
|
1033
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1045
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
1034
1046
|
# HTTP header 'Accept' (if needed)
|
1035
1047
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1036
1048
|
# HTTP header 'Content-Type'
|