klaviyo-api-sdk 1.1.0 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +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
data/README.md
CHANGED
@@ -1,12 +1,12 @@
|
|
1
1
|
# Klaviyo Ruby SDK
|
2
2
|
|
3
|
-
- SDK version: 1.
|
4
|
-
- API revision: 2023-
|
3
|
+
- SDK version: 1.2.0
|
4
|
+
- API revision: 2023-02-22
|
5
5
|
|
6
6
|
## Helpful Resources
|
7
7
|
|
8
|
-
- [API Reference](https://developers.klaviyo.com/en/v2023-
|
9
|
-
- [API Guides](https://developers.klaviyo.com/en/v2023-
|
8
|
+
- [API Reference](https://developers.klaviyo.com/en/v2023-02-22/reference)
|
9
|
+
- [API Guides](https://developers.klaviyo.com/en/v2023-02-22/docs)
|
10
10
|
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)
|
11
11
|
|
12
12
|
## Design & Approach
|
@@ -19,6 +19,10 @@ This SDK is organized into the following resources:
|
|
19
19
|
|
20
20
|
|
21
21
|
|
22
|
+
- Campaigns
|
23
|
+
|
24
|
+
|
25
|
+
|
22
26
|
- Catalogs
|
23
27
|
|
24
28
|
|
@@ -78,13 +82,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
78
82
|
Then install the gem locally:
|
79
83
|
|
80
84
|
```shell
|
81
|
-
gem install ./klaviyo-api-sdk-1.
|
85
|
+
gem install ./klaviyo-api-sdk-1.2.0.gem
|
82
86
|
```
|
83
87
|
|
84
88
|
|
85
89
|
Finally add this to the Gemfile:
|
86
90
|
|
87
|
-
gem 'klaviyo-api-sdk', '~> 1.
|
91
|
+
gem 'klaviyo-api-sdk', '~> 1.2.0'
|
88
92
|
|
89
93
|
To install directly from rubygems:
|
90
94
|
|
@@ -142,7 +146,7 @@ end
|
|
142
146
|
# Comprehensive list of Operations & Parameters
|
143
147
|
|
144
148
|
_**NOTE:**_
|
145
|
-
- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2023-
|
149
|
+
- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2023-02-22/reference/get_events).
|
146
150
|
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
147
151
|
- Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.
|
148
152
|
|
@@ -184,10 +188,184 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
184
188
|
|
185
189
|
|
186
190
|
|
191
|
+
## Campaigns
|
192
|
+
|
193
|
+
|
194
|
+
#### [Create Campaign](https://developers.klaviyo.com/en/v2023-02-22/reference/create_campaign)
|
195
|
+
|
196
|
+
```ruby
|
197
|
+
KlaviyoAPI::Campaigns.create_campaign(body)
|
198
|
+
```
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2023-02-22/reference/create_campaign_clone)
|
205
|
+
|
206
|
+
```ruby
|
207
|
+
KlaviyoAPI::Campaigns.create_campaign_clone(body)
|
208
|
+
```
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
#### [Create Campaign Message Assign Template](https://developers.klaviyo.com/en/v2023-02-22/reference/create_campaign_message_assign_template)
|
215
|
+
|
216
|
+
```ruby
|
217
|
+
KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
|
218
|
+
```
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-02-22/reference/create_campaign_recipient_estimation_job)
|
225
|
+
|
226
|
+
```ruby
|
227
|
+
KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
|
228
|
+
```
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2023-02-22/reference/create_campaign_send_job)
|
235
|
+
|
236
|
+
```ruby
|
237
|
+
KlaviyoAPI::Campaigns.create_campaign_send_job(body)
|
238
|
+
```
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
#### [Delete Campaign](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_campaign)
|
245
|
+
|
246
|
+
```ruby
|
247
|
+
KlaviyoAPI::Campaigns.delete_campaign(id)
|
248
|
+
```
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
#### [Get Campaign](https://developers.klaviyo.com/en/v2023-02-22/reference/get_campaign)
|
255
|
+
|
256
|
+
```ruby
|
257
|
+
KlaviyoAPI::Campaigns.get_campaign(id, opts)
|
258
|
+
```
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
#### [Get Campaign Message](https://developers.klaviyo.com/en/v2023-02-22/reference/get_campaign_message)
|
265
|
+
|
266
|
+
```ruby
|
267
|
+
KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
|
268
|
+
```
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2023-02-22/reference/get_campaign_recipient_estimation)
|
275
|
+
|
276
|
+
```ruby
|
277
|
+
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
|
278
|
+
```
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_campaign_recipient_estimation_job)
|
285
|
+
|
286
|
+
```ruby
|
287
|
+
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
|
288
|
+
```
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
#### [Get Campaign Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_campaign_relationships)
|
295
|
+
|
296
|
+
```ruby
|
297
|
+
KlaviyoAPI::Campaigns.get_campaign_relationships(id, related_resource)
|
298
|
+
```
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_campaign_send_job)
|
305
|
+
|
306
|
+
```ruby
|
307
|
+
KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
308
|
+
```
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2023-02-22/reference/get_campaign_tags)
|
315
|
+
|
316
|
+
```ruby
|
317
|
+
KlaviyoAPI::Campaigns.get_campaign_tags(campaign_id, opts)
|
318
|
+
```
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
#### [Get Campaigns](https://developers.klaviyo.com/en/v2023-02-22/reference/get_campaigns)
|
325
|
+
|
326
|
+
```ruby
|
327
|
+
KlaviyoAPI::Campaigns.get_campaigns(opts)
|
328
|
+
```
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
|
333
|
+
|
334
|
+
#### [Update Campaign](https://developers.klaviyo.com/en/v2023-02-22/reference/update_campaign)
|
335
|
+
|
336
|
+
```ruby
|
337
|
+
KlaviyoAPI::Campaigns.update_campaign(id, body)
|
338
|
+
```
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
#### [Update Campaign Message](https://developers.klaviyo.com/en/v2023-02-22/reference/update_campaign_message)
|
345
|
+
|
346
|
+
```ruby
|
347
|
+
KlaviyoAPI::Campaigns.update_campaign_message(id, body)
|
348
|
+
```
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
|
353
|
+
|
354
|
+
#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2023-02-22/reference/update_campaign_send_job)
|
355
|
+
|
356
|
+
```ruby
|
357
|
+
KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
|
358
|
+
```
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
|
364
|
+
|
187
365
|
## Catalogs
|
188
366
|
|
189
367
|
|
190
|
-
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2023-
|
368
|
+
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2023-02-22/reference/create_catalog_category)
|
191
369
|
|
192
370
|
```ruby
|
193
371
|
KlaviyoAPI::Catalogs.create_catalog_category(body)
|
@@ -197,7 +375,7 @@ KlaviyoAPI::Catalogs.create_catalog_category(body)
|
|
197
375
|
|
198
376
|
|
199
377
|
|
200
|
-
#### [Create Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-
|
378
|
+
#### [Create Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/create_catalog_category_relationships)
|
201
379
|
|
202
380
|
```ruby
|
203
381
|
KlaviyoAPI::Catalogs.create_catalog_category_relationships(id, related_resource, body)
|
@@ -207,7 +385,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_relationships(id, related_resource,
|
|
207
385
|
|
208
386
|
|
209
387
|
|
210
|
-
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2023-
|
388
|
+
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2023-02-22/reference/create_catalog_item)
|
211
389
|
|
212
390
|
```ruby
|
213
391
|
KlaviyoAPI::Catalogs.create_catalog_item(body)
|
@@ -217,7 +395,7 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
217
395
|
|
218
396
|
|
219
397
|
|
220
|
-
#### [Create Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-
|
398
|
+
#### [Create Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/create_catalog_item_relationships)
|
221
399
|
|
222
400
|
```ruby
|
223
401
|
KlaviyoAPI::Catalogs.create_catalog_item_relationships(id, related_resource, body)
|
@@ -227,7 +405,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_relationships(id, related_resource, bod
|
|
227
405
|
|
228
406
|
|
229
407
|
|
230
|
-
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2023-
|
408
|
+
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2023-02-22/reference/create_catalog_variant)
|
231
409
|
|
232
410
|
```ruby
|
233
411
|
KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
@@ -237,7 +415,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
|
237
415
|
|
238
416
|
|
239
417
|
|
240
|
-
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2023-
|
418
|
+
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_catalog_category)
|
241
419
|
|
242
420
|
```ruby
|
243
421
|
KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
@@ -247,7 +425,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
|
247
425
|
|
248
426
|
|
249
427
|
|
250
|
-
#### [Delete Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-
|
428
|
+
#### [Delete Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_catalog_category_relationships)
|
251
429
|
|
252
430
|
```ruby
|
253
431
|
KlaviyoAPI::Catalogs.delete_catalog_category_relationships(id, related_resource, body)
|
@@ -257,7 +435,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category_relationships(id, related_resource,
|
|
257
435
|
|
258
436
|
|
259
437
|
|
260
|
-
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2023-
|
438
|
+
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_catalog_item)
|
261
439
|
|
262
440
|
```ruby
|
263
441
|
KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
@@ -267,7 +445,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
|
267
445
|
|
268
446
|
|
269
447
|
|
270
|
-
#### [Delete Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-
|
448
|
+
#### [Delete Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_catalog_item_relationships)
|
271
449
|
|
272
450
|
```ruby
|
273
451
|
KlaviyoAPI::Catalogs.delete_catalog_item_relationships(id, related_resource, body)
|
@@ -277,7 +455,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item_relationships(id, related_resource, bod
|
|
277
455
|
|
278
456
|
|
279
457
|
|
280
|
-
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-
|
458
|
+
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_catalog_variant)
|
281
459
|
|
282
460
|
```ruby
|
283
461
|
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
@@ -287,7 +465,7 @@ KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
|
287
465
|
|
288
466
|
|
289
467
|
|
290
|
-
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2023-
|
468
|
+
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_categories)
|
291
469
|
|
292
470
|
```ruby
|
293
471
|
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
@@ -297,7 +475,7 @@ KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
|
297
475
|
|
298
476
|
|
299
477
|
|
300
|
-
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2023-
|
478
|
+
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_category)
|
301
479
|
|
302
480
|
```ruby
|
303
481
|
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
@@ -307,7 +485,7 @@ KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
|
307
485
|
|
308
486
|
|
309
487
|
|
310
|
-
#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-
|
488
|
+
#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_category_items)
|
311
489
|
|
312
490
|
```ruby
|
313
491
|
KlaviyoAPI::Catalogs.get_catalog_category_items(category_id, opts)
|
@@ -317,7 +495,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_items(category_id, opts)
|
|
317
495
|
|
318
496
|
|
319
497
|
|
320
|
-
#### [Get Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-
|
498
|
+
#### [Get Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_category_relationships)
|
321
499
|
|
322
500
|
```ruby
|
323
501
|
KlaviyoAPI::Catalogs.get_catalog_category_relationships(id, related_resource, opts)
|
@@ -327,7 +505,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_relationships(id, related_resource, op
|
|
327
505
|
|
328
506
|
|
329
507
|
|
330
|
-
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2023-
|
508
|
+
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_item)
|
331
509
|
|
332
510
|
```ruby
|
333
511
|
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
@@ -337,7 +515,7 @@ KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
|
337
515
|
|
338
516
|
|
339
517
|
|
340
|
-
#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-
|
518
|
+
#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_item_categories)
|
341
519
|
|
342
520
|
```ruby
|
343
521
|
KlaviyoAPI::Catalogs.get_catalog_item_categories(item_id, opts)
|
@@ -347,7 +525,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_categories(item_id, opts)
|
|
347
525
|
|
348
526
|
|
349
527
|
|
350
|
-
#### [Get Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-
|
528
|
+
#### [Get Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_item_relationships)
|
351
529
|
|
352
530
|
```ruby
|
353
531
|
KlaviyoAPI::Catalogs.get_catalog_item_relationships(id, related_resource, opts)
|
@@ -357,7 +535,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships(id, related_resource, opts)
|
|
357
535
|
|
358
536
|
|
359
537
|
|
360
|
-
#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-
|
538
|
+
#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_item_variants)
|
361
539
|
|
362
540
|
```ruby
|
363
541
|
KlaviyoAPI::Catalogs.get_catalog_item_variants(item_id, opts)
|
@@ -367,7 +545,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_variants(item_id, opts)
|
|
367
545
|
|
368
546
|
|
369
547
|
|
370
|
-
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2023-
|
548
|
+
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_items)
|
371
549
|
|
372
550
|
```ruby
|
373
551
|
KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
@@ -377,7 +555,7 @@ KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
|
377
555
|
|
378
556
|
|
379
557
|
|
380
|
-
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2023-
|
558
|
+
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_variant)
|
381
559
|
|
382
560
|
```ruby
|
383
561
|
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
@@ -387,7 +565,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
|
387
565
|
|
388
566
|
|
389
567
|
|
390
|
-
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2023-
|
568
|
+
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_variants)
|
391
569
|
|
392
570
|
```ruby
|
393
571
|
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
@@ -397,7 +575,7 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
|
397
575
|
|
398
576
|
|
399
577
|
|
400
|
-
#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2023-
|
578
|
+
#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_create_categories_job)
|
401
579
|
|
402
580
|
```ruby
|
403
581
|
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
@@ -407,7 +585,7 @@ KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
|
407
585
|
|
408
586
|
|
409
587
|
|
410
|
-
#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-
|
588
|
+
#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_create_categories_jobs)
|
411
589
|
|
412
590
|
```ruby
|
413
591
|
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
@@ -417,7 +595,7 @@ KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
|
417
595
|
|
418
596
|
|
419
597
|
|
420
|
-
#### [Get Create Items Job](https://developers.klaviyo.com/en/v2023-
|
598
|
+
#### [Get Create Items Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_create_items_job)
|
421
599
|
|
422
600
|
```ruby
|
423
601
|
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
@@ -427,7 +605,7 @@ KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
|
427
605
|
|
428
606
|
|
429
607
|
|
430
|
-
#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-
|
608
|
+
#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_create_items_jobs)
|
431
609
|
|
432
610
|
```ruby
|
433
611
|
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
@@ -437,7 +615,7 @@ KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
|
437
615
|
|
438
616
|
|
439
617
|
|
440
|
-
#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2023-
|
618
|
+
#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_create_variants_job)
|
441
619
|
|
442
620
|
```ruby
|
443
621
|
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
@@ -447,7 +625,7 @@ KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
|
447
625
|
|
448
626
|
|
449
627
|
|
450
|
-
#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-
|
628
|
+
#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_create_variants_jobs)
|
451
629
|
|
452
630
|
```ruby
|
453
631
|
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
@@ -457,7 +635,7 @@ KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
|
457
635
|
|
458
636
|
|
459
637
|
|
460
|
-
#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-
|
638
|
+
#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_delete_categories_job)
|
461
639
|
|
462
640
|
```ruby
|
463
641
|
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
@@ -467,7 +645,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
|
467
645
|
|
468
646
|
|
469
647
|
|
470
|
-
#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-
|
648
|
+
#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_delete_categories_jobs)
|
471
649
|
|
472
650
|
```ruby
|
473
651
|
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
@@ -477,7 +655,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
|
477
655
|
|
478
656
|
|
479
657
|
|
480
|
-
#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2023-
|
658
|
+
#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_delete_items_job)
|
481
659
|
|
482
660
|
```ruby
|
483
661
|
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
@@ -487,7 +665,7 @@ KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
|
487
665
|
|
488
666
|
|
489
667
|
|
490
|
-
#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-
|
668
|
+
#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_delete_items_jobs)
|
491
669
|
|
492
670
|
```ruby
|
493
671
|
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
@@ -497,7 +675,7 @@ KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
|
497
675
|
|
498
676
|
|
499
677
|
|
500
|
-
#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-
|
678
|
+
#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_delete_variants_job)
|
501
679
|
|
502
680
|
```ruby
|
503
681
|
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
@@ -507,7 +685,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
|
507
685
|
|
508
686
|
|
509
687
|
|
510
|
-
#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-
|
688
|
+
#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_delete_variants_jobs)
|
511
689
|
|
512
690
|
```ruby
|
513
691
|
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
@@ -517,7 +695,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
|
517
695
|
|
518
696
|
|
519
697
|
|
520
|
-
#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2023-
|
698
|
+
#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_update_categories_job)
|
521
699
|
|
522
700
|
```ruby
|
523
701
|
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
@@ -527,7 +705,7 @@ KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
|
527
705
|
|
528
706
|
|
529
707
|
|
530
|
-
#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-
|
708
|
+
#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_update_categories_jobs)
|
531
709
|
|
532
710
|
```ruby
|
533
711
|
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
@@ -537,7 +715,7 @@ KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
|
537
715
|
|
538
716
|
|
539
717
|
|
540
|
-
#### [Get Update Items Job](https://developers.klaviyo.com/en/v2023-
|
718
|
+
#### [Get Update Items Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_update_items_job)
|
541
719
|
|
542
720
|
```ruby
|
543
721
|
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
@@ -547,7 +725,7 @@ KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
|
547
725
|
|
548
726
|
|
549
727
|
|
550
|
-
#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-
|
728
|
+
#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_update_items_jobs)
|
551
729
|
|
552
730
|
```ruby
|
553
731
|
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
@@ -557,7 +735,7 @@ KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
|
557
735
|
|
558
736
|
|
559
737
|
|
560
|
-
#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2023-
|
738
|
+
#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_update_variants_job)
|
561
739
|
|
562
740
|
```ruby
|
563
741
|
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
@@ -567,7 +745,7 @@ KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
|
567
745
|
|
568
746
|
|
569
747
|
|
570
|
-
#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-
|
748
|
+
#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_update_variants_jobs)
|
571
749
|
|
572
750
|
```ruby
|
573
751
|
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
@@ -577,7 +755,7 @@ KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
|
577
755
|
|
578
756
|
|
579
757
|
|
580
|
-
#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-
|
758
|
+
#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_create_categories_job)
|
581
759
|
|
582
760
|
```ruby
|
583
761
|
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
@@ -587,7 +765,7 @@ KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
|
587
765
|
|
588
766
|
|
589
767
|
|
590
|
-
#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-
|
768
|
+
#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_create_items_job)
|
591
769
|
|
592
770
|
```ruby
|
593
771
|
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
@@ -597,7 +775,7 @@ KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
|
597
775
|
|
598
776
|
|
599
777
|
|
600
|
-
#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-
|
778
|
+
#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_create_variants_job)
|
601
779
|
|
602
780
|
```ruby
|
603
781
|
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
@@ -607,7 +785,7 @@ KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
|
607
785
|
|
608
786
|
|
609
787
|
|
610
|
-
#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-
|
788
|
+
#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_delete_categories_job)
|
611
789
|
|
612
790
|
```ruby
|
613
791
|
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
@@ -617,7 +795,7 @@ KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
|
617
795
|
|
618
796
|
|
619
797
|
|
620
|
-
#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-
|
798
|
+
#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_delete_items_job)
|
621
799
|
|
622
800
|
```ruby
|
623
801
|
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
@@ -627,7 +805,7 @@ KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
|
627
805
|
|
628
806
|
|
629
807
|
|
630
|
-
#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-
|
808
|
+
#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_delete_variants_job)
|
631
809
|
|
632
810
|
```ruby
|
633
811
|
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
@@ -637,7 +815,7 @@ KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
|
637
815
|
|
638
816
|
|
639
817
|
|
640
|
-
#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-
|
818
|
+
#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_update_categories_job)
|
641
819
|
|
642
820
|
```ruby
|
643
821
|
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
@@ -647,7 +825,7 @@ KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
|
647
825
|
|
648
826
|
|
649
827
|
|
650
|
-
#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-
|
828
|
+
#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_update_items_job)
|
651
829
|
|
652
830
|
```ruby
|
653
831
|
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
@@ -657,7 +835,7 @@ KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
|
657
835
|
|
658
836
|
|
659
837
|
|
660
|
-
#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-
|
838
|
+
#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_update_variants_job)
|
661
839
|
|
662
840
|
```ruby
|
663
841
|
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
@@ -667,7 +845,7 @@ KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
|
667
845
|
|
668
846
|
|
669
847
|
|
670
|
-
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2023-
|
848
|
+
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2023-02-22/reference/update_catalog_category)
|
671
849
|
|
672
850
|
```ruby
|
673
851
|
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
@@ -677,7 +855,7 @@ KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
|
677
855
|
|
678
856
|
|
679
857
|
|
680
|
-
#### [Update Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-
|
858
|
+
#### [Update Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/update_catalog_category_relationships)
|
681
859
|
|
682
860
|
```ruby
|
683
861
|
KlaviyoAPI::Catalogs.update_catalog_category_relationships(id, related_resource, body)
|
@@ -687,7 +865,7 @@ KlaviyoAPI::Catalogs.update_catalog_category_relationships(id, related_resource,
|
|
687
865
|
|
688
866
|
|
689
867
|
|
690
|
-
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2023-
|
868
|
+
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2023-02-22/reference/update_catalog_item)
|
691
869
|
|
692
870
|
```ruby
|
693
871
|
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
@@ -697,7 +875,7 @@ KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
|
697
875
|
|
698
876
|
|
699
877
|
|
700
|
-
#### [Update Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-
|
878
|
+
#### [Update Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/update_catalog_item_relationships)
|
701
879
|
|
702
880
|
```ruby
|
703
881
|
KlaviyoAPI::Catalogs.update_catalog_item_relationships(id, related_resource, body)
|
@@ -707,7 +885,7 @@ KlaviyoAPI::Catalogs.update_catalog_item_relationships(id, related_resource, bod
|
|
707
885
|
|
708
886
|
|
709
887
|
|
710
|
-
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2023-
|
888
|
+
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2023-02-22/reference/update_catalog_variant)
|
711
889
|
|
712
890
|
```ruby
|
713
891
|
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
@@ -721,7 +899,7 @@ KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
|
721
899
|
## Client
|
722
900
|
|
723
901
|
|
724
|
-
#### [Create Client Event](https://developers.klaviyo.com/en/v2023-
|
902
|
+
#### [Create Client Event](https://developers.klaviyo.com/en/v2023-02-22/reference/create_client_event)
|
725
903
|
|
726
904
|
```ruby
|
727
905
|
KlaviyoAPI::Client.create_client_event(company_id, body)
|
@@ -731,7 +909,7 @@ KlaviyoAPI::Client.create_client_event(company_id, body)
|
|
731
909
|
|
732
910
|
|
733
911
|
|
734
|
-
#### [Create or Update Client Profile](https://developers.klaviyo.com/en/v2023-
|
912
|
+
#### [Create or Update Client Profile](https://developers.klaviyo.com/en/v2023-02-22/reference/create_client_profile)
|
735
913
|
|
736
914
|
```ruby
|
737
915
|
KlaviyoAPI::Client.create_client_profile(company_id, body)
|
@@ -741,7 +919,7 @@ KlaviyoAPI::Client.create_client_profile(company_id, body)
|
|
741
919
|
|
742
920
|
|
743
921
|
|
744
|
-
#### [Create Client Subscription](https://developers.klaviyo.com/en/v2023-
|
922
|
+
#### [Create Client Subscription](https://developers.klaviyo.com/en/v2023-02-22/reference/create_client_subscription)
|
745
923
|
|
746
924
|
```ruby
|
747
925
|
KlaviyoAPI::Client.create_client_subscription(company_id, body)
|
@@ -755,7 +933,7 @@ KlaviyoAPI::Client.create_client_subscription(company_id, body)
|
|
755
933
|
## Data Privacy
|
756
934
|
|
757
935
|
|
758
|
-
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2023-
|
936
|
+
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2023-02-22/reference/request_profile_deletion)
|
759
937
|
|
760
938
|
```ruby
|
761
939
|
KlaviyoAPI::Data Privacy.request_profile_deletion(body)
|
@@ -769,7 +947,7 @@ KlaviyoAPI::Data Privacy.request_profile_deletion(body)
|
|
769
947
|
## Events
|
770
948
|
|
771
949
|
|
772
|
-
#### [Create Event](https://developers.klaviyo.com/en/v2023-
|
950
|
+
#### [Create Event](https://developers.klaviyo.com/en/v2023-02-22/reference/create_event)
|
773
951
|
|
774
952
|
```ruby
|
775
953
|
KlaviyoAPI::Events.create_event(body)
|
@@ -779,7 +957,7 @@ KlaviyoAPI::Events.create_event(body)
|
|
779
957
|
|
780
958
|
|
781
959
|
|
782
|
-
#### [Get Event](https://developers.klaviyo.com/en/v2023-
|
960
|
+
#### [Get Event](https://developers.klaviyo.com/en/v2023-02-22/reference/get_event)
|
783
961
|
|
784
962
|
```ruby
|
785
963
|
KlaviyoAPI::Events.get_event(id, opts)
|
@@ -789,7 +967,7 @@ KlaviyoAPI::Events.get_event(id, opts)
|
|
789
967
|
|
790
968
|
|
791
969
|
|
792
|
-
#### [Get Event Metrics](https://developers.klaviyo.com/en/v2023-
|
970
|
+
#### [Get Event Metrics](https://developers.klaviyo.com/en/v2023-02-22/reference/get_event_metrics)
|
793
971
|
|
794
972
|
```ruby
|
795
973
|
KlaviyoAPI::Events.get_event_metrics(id, opts)
|
@@ -799,7 +977,7 @@ KlaviyoAPI::Events.get_event_metrics(id, opts)
|
|
799
977
|
|
800
978
|
|
801
979
|
|
802
|
-
#### [Get Event Profiles](https://developers.klaviyo.com/en/v2023-
|
980
|
+
#### [Get Event Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/get_event_profiles)
|
803
981
|
|
804
982
|
```ruby
|
805
983
|
KlaviyoAPI::Events.get_event_profiles(id, opts)
|
@@ -809,7 +987,7 @@ KlaviyoAPI::Events.get_event_profiles(id, opts)
|
|
809
987
|
|
810
988
|
|
811
989
|
|
812
|
-
#### [Get Event Relationships](https://developers.klaviyo.com/en/v2023-
|
990
|
+
#### [Get Event Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_event_relationships)
|
813
991
|
|
814
992
|
```ruby
|
815
993
|
KlaviyoAPI::Events.get_event_relationships(id, related_resource)
|
@@ -819,7 +997,7 @@ KlaviyoAPI::Events.get_event_relationships(id, related_resource)
|
|
819
997
|
|
820
998
|
|
821
999
|
|
822
|
-
#### [Get Events](https://developers.klaviyo.com/en/v2023-
|
1000
|
+
#### [Get Events](https://developers.klaviyo.com/en/v2023-02-22/reference/get_events)
|
823
1001
|
|
824
1002
|
```ruby
|
825
1003
|
KlaviyoAPI::Events.get_events(opts)
|
@@ -833,7 +1011,7 @@ KlaviyoAPI::Events.get_events(opts)
|
|
833
1011
|
## Flows
|
834
1012
|
|
835
1013
|
|
836
|
-
#### [Get Flow](https://developers.klaviyo.com/en/v2023-
|
1014
|
+
#### [Get Flow](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow)
|
837
1015
|
|
838
1016
|
```ruby
|
839
1017
|
KlaviyoAPI::Flows.get_flow(id, opts)
|
@@ -843,7 +1021,7 @@ KlaviyoAPI::Flows.get_flow(id, opts)
|
|
843
1021
|
|
844
1022
|
|
845
1023
|
|
846
|
-
#### [Get Flow Action](https://developers.klaviyo.com/en/v2023-
|
1024
|
+
#### [Get Flow Action](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_action)
|
847
1025
|
|
848
1026
|
```ruby
|
849
1027
|
KlaviyoAPI::Flows.get_flow_action(id, opts)
|
@@ -853,7 +1031,7 @@ KlaviyoAPI::Flows.get_flow_action(id, opts)
|
|
853
1031
|
|
854
1032
|
|
855
1033
|
|
856
|
-
#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-
|
1034
|
+
#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_action_flow)
|
857
1035
|
|
858
1036
|
```ruby
|
859
1037
|
KlaviyoAPI::Flows.get_flow_action_flow(action_id, opts)
|
@@ -863,7 +1041,7 @@ KlaviyoAPI::Flows.get_flow_action_flow(action_id, opts)
|
|
863
1041
|
|
864
1042
|
|
865
1043
|
|
866
|
-
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2023-
|
1044
|
+
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_action_messages)
|
867
1045
|
|
868
1046
|
```ruby
|
869
1047
|
KlaviyoAPI::Flows.get_flow_action_messages(action_id, opts)
|
@@ -873,7 +1051,7 @@ KlaviyoAPI::Flows.get_flow_action_messages(action_id, opts)
|
|
873
1051
|
|
874
1052
|
|
875
1053
|
|
876
|
-
#### [Get Flow Action Relationships](https://developers.klaviyo.com/en/v2023-
|
1054
|
+
#### [Get Flow Action Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_action_relationships)
|
877
1055
|
|
878
1056
|
```ruby
|
879
1057
|
KlaviyoAPI::Flows.get_flow_action_relationships(id, related_resource, opts)
|
@@ -883,7 +1061,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships(id, related_resource, opts)
|
|
883
1061
|
|
884
1062
|
|
885
1063
|
|
886
|
-
#### [Get Flow Actions For Flow](https://developers.klaviyo.com/en/v2023-
|
1064
|
+
#### [Get Flow Actions For Flow](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_flow_actions)
|
887
1065
|
|
888
1066
|
```ruby
|
889
1067
|
KlaviyoAPI::Flows.get_flow_flow_actions(flow_id, opts)
|
@@ -893,7 +1071,7 @@ KlaviyoAPI::Flows.get_flow_flow_actions(flow_id, opts)
|
|
893
1071
|
|
894
1072
|
|
895
1073
|
|
896
|
-
#### [Get Flow Message](https://developers.klaviyo.com/en/v2023-
|
1074
|
+
#### [Get Flow Message](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_message)
|
897
1075
|
|
898
1076
|
```ruby
|
899
1077
|
KlaviyoAPI::Flows.get_flow_message(id, opts)
|
@@ -903,7 +1081,7 @@ KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
903
1081
|
|
904
1082
|
|
905
1083
|
|
906
|
-
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-
|
1084
|
+
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_message_action)
|
907
1085
|
|
908
1086
|
```ruby
|
909
1087
|
KlaviyoAPI::Flows.get_flow_message_action(message_id, opts)
|
@@ -913,7 +1091,7 @@ KlaviyoAPI::Flows.get_flow_message_action(message_id, opts)
|
|
913
1091
|
|
914
1092
|
|
915
1093
|
|
916
|
-
#### [Get Flow Message Relationships](https://developers.klaviyo.com/en/v2023-
|
1094
|
+
#### [Get Flow Message Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_message_relationships)
|
917
1095
|
|
918
1096
|
```ruby
|
919
1097
|
KlaviyoAPI::Flows.get_flow_message_relationships(id, related_resource)
|
@@ -923,7 +1101,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships(id, related_resource)
|
|
923
1101
|
|
924
1102
|
|
925
1103
|
|
926
|
-
#### [Get Flow Relationships](https://developers.klaviyo.com/en/v2023-
|
1104
|
+
#### [Get Flow Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_relationships)
|
927
1105
|
|
928
1106
|
```ruby
|
929
1107
|
KlaviyoAPI::Flows.get_flow_relationships(id, related_resource)
|
@@ -933,7 +1111,7 @@ KlaviyoAPI::Flows.get_flow_relationships(id, related_resource)
|
|
933
1111
|
|
934
1112
|
|
935
1113
|
|
936
|
-
#### [Get Flow Tags](https://developers.klaviyo.com/en/v2023-
|
1114
|
+
#### [Get Flow Tags](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_tags)
|
937
1115
|
|
938
1116
|
```ruby
|
939
1117
|
KlaviyoAPI::Flows.get_flow_tags(flow_id, opts)
|
@@ -943,7 +1121,7 @@ KlaviyoAPI::Flows.get_flow_tags(flow_id, opts)
|
|
943
1121
|
|
944
1122
|
|
945
1123
|
|
946
|
-
#### [Get Flows](https://developers.klaviyo.com/en/v2023-
|
1124
|
+
#### [Get Flows](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flows)
|
947
1125
|
|
948
1126
|
```ruby
|
949
1127
|
KlaviyoAPI::Flows.get_flows(opts)
|
@@ -953,7 +1131,7 @@ KlaviyoAPI::Flows.get_flows(opts)
|
|
953
1131
|
|
954
1132
|
|
955
1133
|
|
956
|
-
#### [Update Flow Status](https://developers.klaviyo.com/en/v2023-
|
1134
|
+
#### [Update Flow Status](https://developers.klaviyo.com/en/v2023-02-22/reference/update_flow)
|
957
1135
|
|
958
1136
|
```ruby
|
959
1137
|
KlaviyoAPI::Flows.update_flow(id, body)
|
@@ -967,7 +1145,7 @@ KlaviyoAPI::Flows.update_flow(id, body)
|
|
967
1145
|
## Lists
|
968
1146
|
|
969
1147
|
|
970
|
-
#### [Create List](https://developers.klaviyo.com/en/v2023-
|
1148
|
+
#### [Create List](https://developers.klaviyo.com/en/v2023-02-22/reference/create_list)
|
971
1149
|
|
972
1150
|
```ruby
|
973
1151
|
KlaviyoAPI::Lists.create_list(body)
|
@@ -977,7 +1155,7 @@ KlaviyoAPI::Lists.create_list(body)
|
|
977
1155
|
|
978
1156
|
|
979
1157
|
|
980
|
-
#### [Add Profile to List](https://developers.klaviyo.com/en/v2023-
|
1158
|
+
#### [Add Profile to List](https://developers.klaviyo.com/en/v2023-02-22/reference/create_list_relationships)
|
981
1159
|
|
982
1160
|
```ruby
|
983
1161
|
KlaviyoAPI::Lists.create_list_relationships(id, related_resource, body)
|
@@ -987,7 +1165,7 @@ KlaviyoAPI::Lists.create_list_relationships(id, related_resource, body)
|
|
987
1165
|
|
988
1166
|
|
989
1167
|
|
990
|
-
#### [Delete List](https://developers.klaviyo.com/en/v2023-
|
1168
|
+
#### [Delete List](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_list)
|
991
1169
|
|
992
1170
|
```ruby
|
993
1171
|
KlaviyoAPI::Lists.delete_list(id)
|
@@ -997,7 +1175,7 @@ KlaviyoAPI::Lists.delete_list(id)
|
|
997
1175
|
|
998
1176
|
|
999
1177
|
|
1000
|
-
#### [Remove Profile from List](https://developers.klaviyo.com/en/v2023-
|
1178
|
+
#### [Remove Profile from List](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_list_relationships)
|
1001
1179
|
|
1002
1180
|
```ruby
|
1003
1181
|
KlaviyoAPI::Lists.delete_list_relationships(id, related_resource, body)
|
@@ -1007,7 +1185,7 @@ KlaviyoAPI::Lists.delete_list_relationships(id, related_resource, body)
|
|
1007
1185
|
|
1008
1186
|
|
1009
1187
|
|
1010
|
-
#### [Get List](https://developers.klaviyo.com/en/v2023-
|
1188
|
+
#### [Get List](https://developers.klaviyo.com/en/v2023-02-22/reference/get_list)
|
1011
1189
|
|
1012
1190
|
```ruby
|
1013
1191
|
KlaviyoAPI::Lists.get_list(id, opts)
|
@@ -1017,7 +1195,7 @@ KlaviyoAPI::Lists.get_list(id, opts)
|
|
1017
1195
|
|
1018
1196
|
|
1019
1197
|
|
1020
|
-
#### [Get List Profiles](https://developers.klaviyo.com/en/v2023-
|
1198
|
+
#### [Get List Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/get_list_profiles)
|
1021
1199
|
|
1022
1200
|
```ruby
|
1023
1201
|
KlaviyoAPI::Lists.get_list_profiles(list_id, opts)
|
@@ -1027,7 +1205,7 @@ KlaviyoAPI::Lists.get_list_profiles(list_id, opts)
|
|
1027
1205
|
|
1028
1206
|
|
1029
1207
|
|
1030
|
-
#### [Get List Relationships](https://developers.klaviyo.com/en/v2023-
|
1208
|
+
#### [Get List Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_list_relationships)
|
1031
1209
|
|
1032
1210
|
```ruby
|
1033
1211
|
KlaviyoAPI::Lists.get_list_relationships(id, related_resource, opts)
|
@@ -1037,7 +1215,7 @@ KlaviyoAPI::Lists.get_list_relationships(id, related_resource, opts)
|
|
1037
1215
|
|
1038
1216
|
|
1039
1217
|
|
1040
|
-
#### [Get List Tags](https://developers.klaviyo.com/en/v2023-
|
1218
|
+
#### [Get List Tags](https://developers.klaviyo.com/en/v2023-02-22/reference/get_list_tags)
|
1041
1219
|
|
1042
1220
|
```ruby
|
1043
1221
|
KlaviyoAPI::Lists.get_list_tags(list_id, opts)
|
@@ -1047,7 +1225,7 @@ KlaviyoAPI::Lists.get_list_tags(list_id, opts)
|
|
1047
1225
|
|
1048
1226
|
|
1049
1227
|
|
1050
|
-
#### [Get Lists](https://developers.klaviyo.com/en/v2023-
|
1228
|
+
#### [Get Lists](https://developers.klaviyo.com/en/v2023-02-22/reference/get_lists)
|
1051
1229
|
|
1052
1230
|
```ruby
|
1053
1231
|
KlaviyoAPI::Lists.get_lists(opts)
|
@@ -1057,7 +1235,7 @@ KlaviyoAPI::Lists.get_lists(opts)
|
|
1057
1235
|
|
1058
1236
|
|
1059
1237
|
|
1060
|
-
#### [Update List](https://developers.klaviyo.com/en/v2023-
|
1238
|
+
#### [Update List](https://developers.klaviyo.com/en/v2023-02-22/reference/update_list)
|
1061
1239
|
|
1062
1240
|
```ruby
|
1063
1241
|
KlaviyoAPI::Lists.update_list(id, body)
|
@@ -1071,7 +1249,7 @@ KlaviyoAPI::Lists.update_list(id, body)
|
|
1071
1249
|
## Metrics
|
1072
1250
|
|
1073
1251
|
|
1074
|
-
#### [Get Metric](https://developers.klaviyo.com/en/v2023-
|
1252
|
+
#### [Get Metric](https://developers.klaviyo.com/en/v2023-02-22/reference/get_metric)
|
1075
1253
|
|
1076
1254
|
```ruby
|
1077
1255
|
KlaviyoAPI::Metrics.get_metric(id, opts)
|
@@ -1081,7 +1259,7 @@ KlaviyoAPI::Metrics.get_metric(id, opts)
|
|
1081
1259
|
|
1082
1260
|
|
1083
1261
|
|
1084
|
-
#### [Get Metrics](https://developers.klaviyo.com/en/v2023-
|
1262
|
+
#### [Get Metrics](https://developers.klaviyo.com/en/v2023-02-22/reference/get_metrics)
|
1085
1263
|
|
1086
1264
|
```ruby
|
1087
1265
|
KlaviyoAPI::Metrics.get_metrics(opts)
|
@@ -1091,7 +1269,7 @@ KlaviyoAPI::Metrics.get_metrics(opts)
|
|
1091
1269
|
|
1092
1270
|
|
1093
1271
|
|
1094
|
-
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-
|
1272
|
+
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-02-22/reference/query_metric_aggregates)
|
1095
1273
|
|
1096
1274
|
```ruby
|
1097
1275
|
KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
@@ -1105,7 +1283,7 @@ KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
|
1105
1283
|
## Profiles
|
1106
1284
|
|
1107
1285
|
|
1108
|
-
#### [Create Profile](https://developers.klaviyo.com/en/v2023-
|
1286
|
+
#### [Create Profile](https://developers.klaviyo.com/en/v2023-02-22/reference/create_profile)
|
1109
1287
|
|
1110
1288
|
```ruby
|
1111
1289
|
KlaviyoAPI::Profiles.create_profile(body)
|
@@ -1115,7 +1293,7 @@ KlaviyoAPI::Profiles.create_profile(body)
|
|
1115
1293
|
|
1116
1294
|
|
1117
1295
|
|
1118
|
-
#### [Get Profile](https://developers.klaviyo.com/en/v2023-
|
1296
|
+
#### [Get Profile](https://developers.klaviyo.com/en/v2023-02-22/reference/get_profile)
|
1119
1297
|
|
1120
1298
|
```ruby
|
1121
1299
|
KlaviyoAPI::Profiles.get_profile(id, opts)
|
@@ -1125,7 +1303,7 @@ KlaviyoAPI::Profiles.get_profile(id, opts)
|
|
1125
1303
|
|
1126
1304
|
|
1127
1305
|
|
1128
|
-
#### [Get Profile Lists](https://developers.klaviyo.com/en/v2023-
|
1306
|
+
#### [Get Profile Lists](https://developers.klaviyo.com/en/v2023-02-22/reference/get_profile_lists)
|
1129
1307
|
|
1130
1308
|
```ruby
|
1131
1309
|
KlaviyoAPI::Profiles.get_profile_lists(profile_id, opts)
|
@@ -1135,7 +1313,7 @@ KlaviyoAPI::Profiles.get_profile_lists(profile_id, opts)
|
|
1135
1313
|
|
1136
1314
|
|
1137
1315
|
|
1138
|
-
#### [Get Profile Relationships](https://developers.klaviyo.com/en/v2023-
|
1316
|
+
#### [Get Profile Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_profile_relationships)
|
1139
1317
|
|
1140
1318
|
```ruby
|
1141
1319
|
KlaviyoAPI::Profiles.get_profile_relationships(id, related_resource)
|
@@ -1145,7 +1323,7 @@ KlaviyoAPI::Profiles.get_profile_relationships(id, related_resource)
|
|
1145
1323
|
|
1146
1324
|
|
1147
1325
|
|
1148
|
-
#### [Get Profile Segments](https://developers.klaviyo.com/en/v2023-
|
1326
|
+
#### [Get Profile Segments](https://developers.klaviyo.com/en/v2023-02-22/reference/get_profile_segments)
|
1149
1327
|
|
1150
1328
|
```ruby
|
1151
1329
|
KlaviyoAPI::Profiles.get_profile_segments(profile_id, opts)
|
@@ -1155,7 +1333,7 @@ KlaviyoAPI::Profiles.get_profile_segments(profile_id, opts)
|
|
1155
1333
|
|
1156
1334
|
|
1157
1335
|
|
1158
|
-
#### [Get Profiles](https://developers.klaviyo.com/en/v2023-
|
1336
|
+
#### [Get Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/get_profiles)
|
1159
1337
|
|
1160
1338
|
```ruby
|
1161
1339
|
KlaviyoAPI::Profiles.get_profiles(opts)
|
@@ -1165,7 +1343,7 @@ KlaviyoAPI::Profiles.get_profiles(opts)
|
|
1165
1343
|
|
1166
1344
|
|
1167
1345
|
|
1168
|
-
#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2023-
|
1346
|
+
#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/subscribe_profiles)
|
1169
1347
|
|
1170
1348
|
```ruby
|
1171
1349
|
KlaviyoAPI::Profiles.subscribe_profiles(body)
|
@@ -1175,7 +1353,7 @@ KlaviyoAPI::Profiles.subscribe_profiles(body)
|
|
1175
1353
|
|
1176
1354
|
|
1177
1355
|
|
1178
|
-
#### [Suppress Profiles](https://developers.klaviyo.com/en/v2023-
|
1356
|
+
#### [Suppress Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/suppress_profiles)
|
1179
1357
|
|
1180
1358
|
```ruby
|
1181
1359
|
KlaviyoAPI::Profiles.suppress_profiles(body)
|
@@ -1185,7 +1363,7 @@ KlaviyoAPI::Profiles.suppress_profiles(body)
|
|
1185
1363
|
|
1186
1364
|
|
1187
1365
|
|
1188
|
-
#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-
|
1366
|
+
#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/unsubscribe_profiles)
|
1189
1367
|
|
1190
1368
|
```ruby
|
1191
1369
|
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
@@ -1195,7 +1373,7 @@ KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
|
1195
1373
|
|
1196
1374
|
|
1197
1375
|
|
1198
|
-
#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-
|
1376
|
+
#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/unsuppress_profiles)
|
1199
1377
|
|
1200
1378
|
```ruby
|
1201
1379
|
KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
@@ -1205,7 +1383,7 @@ KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
|
1205
1383
|
|
1206
1384
|
|
1207
1385
|
|
1208
|
-
#### [Update Profile](https://developers.klaviyo.com/en/v2023-
|
1386
|
+
#### [Update Profile](https://developers.klaviyo.com/en/v2023-02-22/reference/update_profile)
|
1209
1387
|
|
1210
1388
|
```ruby
|
1211
1389
|
KlaviyoAPI::Profiles.update_profile(id, body)
|
@@ -1219,7 +1397,7 @@ KlaviyoAPI::Profiles.update_profile(id, body)
|
|
1219
1397
|
## Segments
|
1220
1398
|
|
1221
1399
|
|
1222
|
-
#### [Get Segment](https://developers.klaviyo.com/en/v2023-
|
1400
|
+
#### [Get Segment](https://developers.klaviyo.com/en/v2023-02-22/reference/get_segment)
|
1223
1401
|
|
1224
1402
|
```ruby
|
1225
1403
|
KlaviyoAPI::Segments.get_segment(id, opts)
|
@@ -1229,7 +1407,7 @@ KlaviyoAPI::Segments.get_segment(id, opts)
|
|
1229
1407
|
|
1230
1408
|
|
1231
1409
|
|
1232
|
-
#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2023-
|
1410
|
+
#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/get_segment_profiles)
|
1233
1411
|
|
1234
1412
|
```ruby
|
1235
1413
|
KlaviyoAPI::Segments.get_segment_profiles(segment_id, opts)
|
@@ -1239,7 +1417,7 @@ KlaviyoAPI::Segments.get_segment_profiles(segment_id, opts)
|
|
1239
1417
|
|
1240
1418
|
|
1241
1419
|
|
1242
|
-
#### [Get Segment Relationships](https://developers.klaviyo.com/en/v2023-
|
1420
|
+
#### [Get Segment Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_segment_relationships)
|
1243
1421
|
|
1244
1422
|
```ruby
|
1245
1423
|
KlaviyoAPI::Segments.get_segment_relationships(id, related_resource, opts)
|
@@ -1249,7 +1427,7 @@ KlaviyoAPI::Segments.get_segment_relationships(id, related_resource, opts)
|
|
1249
1427
|
|
1250
1428
|
|
1251
1429
|
|
1252
|
-
#### [Get Segment Tags](https://developers.klaviyo.com/en/v2023-
|
1430
|
+
#### [Get Segment Tags](https://developers.klaviyo.com/en/v2023-02-22/reference/get_segment_tags)
|
1253
1431
|
|
1254
1432
|
```ruby
|
1255
1433
|
KlaviyoAPI::Segments.get_segment_tags(segment_id, opts)
|
@@ -1259,7 +1437,7 @@ KlaviyoAPI::Segments.get_segment_tags(segment_id, opts)
|
|
1259
1437
|
|
1260
1438
|
|
1261
1439
|
|
1262
|
-
#### [Get Segments](https://developers.klaviyo.com/en/v2023-
|
1440
|
+
#### [Get Segments](https://developers.klaviyo.com/en/v2023-02-22/reference/get_segments)
|
1263
1441
|
|
1264
1442
|
```ruby
|
1265
1443
|
KlaviyoAPI::Segments.get_segments(opts)
|
@@ -1269,7 +1447,7 @@ KlaviyoAPI::Segments.get_segments(opts)
|
|
1269
1447
|
|
1270
1448
|
|
1271
1449
|
|
1272
|
-
#### [Update Segment](https://developers.klaviyo.com/en/v2023-
|
1450
|
+
#### [Update Segment](https://developers.klaviyo.com/en/v2023-02-22/reference/update_segment)
|
1273
1451
|
|
1274
1452
|
```ruby
|
1275
1453
|
KlaviyoAPI::Segments.update_segment(id, body)
|
@@ -1283,7 +1461,7 @@ KlaviyoAPI::Segments.update_segment(id, body)
|
|
1283
1461
|
## Tags
|
1284
1462
|
|
1285
1463
|
|
1286
|
-
#### [Create Tag](https://developers.klaviyo.com/en/v2023-
|
1464
|
+
#### [Create Tag](https://developers.klaviyo.com/en/v2023-02-22/reference/create_tag)
|
1287
1465
|
|
1288
1466
|
```ruby
|
1289
1467
|
KlaviyoAPI::Tags.create_tag(body)
|
@@ -1293,7 +1471,7 @@ KlaviyoAPI::Tags.create_tag(body)
|
|
1293
1471
|
|
1294
1472
|
|
1295
1473
|
|
1296
|
-
#### [Create Tag Group](https://developers.klaviyo.com/en/v2023-
|
1474
|
+
#### [Create Tag Group](https://developers.klaviyo.com/en/v2023-02-22/reference/create_tag_group)
|
1297
1475
|
|
1298
1476
|
```ruby
|
1299
1477
|
KlaviyoAPI::Tags.create_tag_group(body)
|
@@ -1303,7 +1481,7 @@ KlaviyoAPI::Tags.create_tag_group(body)
|
|
1303
1481
|
|
1304
1482
|
|
1305
1483
|
|
1306
|
-
#### [Create Tag Relationships](https://developers.klaviyo.com/en/v2023-
|
1484
|
+
#### [Create Tag Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/create_tag_relationships)
|
1307
1485
|
|
1308
1486
|
```ruby
|
1309
1487
|
KlaviyoAPI::Tags.create_tag_relationships(id, related_resource, body)
|
@@ -1313,7 +1491,7 @@ KlaviyoAPI::Tags.create_tag_relationships(id, related_resource, body)
|
|
1313
1491
|
|
1314
1492
|
|
1315
1493
|
|
1316
|
-
#### [Delete Tag](https://developers.klaviyo.com/en/v2023-
|
1494
|
+
#### [Delete Tag](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_tag)
|
1317
1495
|
|
1318
1496
|
```ruby
|
1319
1497
|
KlaviyoAPI::Tags.delete_tag(id)
|
@@ -1323,7 +1501,7 @@ KlaviyoAPI::Tags.delete_tag(id)
|
|
1323
1501
|
|
1324
1502
|
|
1325
1503
|
|
1326
|
-
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2023-
|
1504
|
+
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_tag_group)
|
1327
1505
|
|
1328
1506
|
```ruby
|
1329
1507
|
KlaviyoAPI::Tags.delete_tag_group(id)
|
@@ -1333,7 +1511,7 @@ KlaviyoAPI::Tags.delete_tag_group(id)
|
|
1333
1511
|
|
1334
1512
|
|
1335
1513
|
|
1336
|
-
#### [Delete Tag Relationships](https://developers.klaviyo.com/en/v2023-
|
1514
|
+
#### [Delete Tag Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_tag_relationships)
|
1337
1515
|
|
1338
1516
|
```ruby
|
1339
1517
|
KlaviyoAPI::Tags.delete_tag_relationships(id, related_resource, body)
|
@@ -1343,7 +1521,7 @@ KlaviyoAPI::Tags.delete_tag_relationships(id, related_resource, body)
|
|
1343
1521
|
|
1344
1522
|
|
1345
1523
|
|
1346
|
-
#### [Get Tag](https://developers.klaviyo.com/en/v2023-
|
1524
|
+
#### [Get Tag](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag)
|
1347
1525
|
|
1348
1526
|
```ruby
|
1349
1527
|
KlaviyoAPI::Tags.get_tag(id, opts)
|
@@ -1353,7 +1531,7 @@ KlaviyoAPI::Tags.get_tag(id, opts)
|
|
1353
1531
|
|
1354
1532
|
|
1355
1533
|
|
1356
|
-
#### [Get Tag Group](https://developers.klaviyo.com/en/v2023-
|
1534
|
+
#### [Get Tag Group](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag_group)
|
1357
1535
|
|
1358
1536
|
```ruby
|
1359
1537
|
KlaviyoAPI::Tags.get_tag_group(id, opts)
|
@@ -1363,7 +1541,7 @@ KlaviyoAPI::Tags.get_tag_group(id, opts)
|
|
1363
1541
|
|
1364
1542
|
|
1365
1543
|
|
1366
|
-
#### [Get Tag Group Relationships](https://developers.klaviyo.com/en/v2023-
|
1544
|
+
#### [Get Tag Group Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag_group_relationships)
|
1367
1545
|
|
1368
1546
|
```ruby
|
1369
1547
|
KlaviyoAPI::Tags.get_tag_group_relationships(id, related_resource)
|
@@ -1373,7 +1551,7 @@ KlaviyoAPI::Tags.get_tag_group_relationships(id, related_resource)
|
|
1373
1551
|
|
1374
1552
|
|
1375
1553
|
|
1376
|
-
#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-
|
1554
|
+
#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag_group_tags)
|
1377
1555
|
|
1378
1556
|
```ruby
|
1379
1557
|
KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
|
@@ -1383,7 +1561,7 @@ KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
|
|
1383
1561
|
|
1384
1562
|
|
1385
1563
|
|
1386
|
-
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2023-
|
1564
|
+
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag_groups)
|
1387
1565
|
|
1388
1566
|
```ruby
|
1389
1567
|
KlaviyoAPI::Tags.get_tag_groups(opts)
|
@@ -1393,7 +1571,7 @@ KlaviyoAPI::Tags.get_tag_groups(opts)
|
|
1393
1571
|
|
1394
1572
|
|
1395
1573
|
|
1396
|
-
#### [Get Tag Relationships](https://developers.klaviyo.com/en/v2023-
|
1574
|
+
#### [Get Tag Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag_relationships)
|
1397
1575
|
|
1398
1576
|
```ruby
|
1399
1577
|
KlaviyoAPI::Tags.get_tag_relationships(id, related_resource)
|
@@ -1403,7 +1581,7 @@ KlaviyoAPI::Tags.get_tag_relationships(id, related_resource)
|
|
1403
1581
|
|
1404
1582
|
|
1405
1583
|
|
1406
|
-
#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-
|
1584
|
+
#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag_tag_group)
|
1407
1585
|
|
1408
1586
|
```ruby
|
1409
1587
|
KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
|
@@ -1413,7 +1591,7 @@ KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
|
|
1413
1591
|
|
1414
1592
|
|
1415
1593
|
|
1416
|
-
#### [Get Tags](https://developers.klaviyo.com/en/v2023-
|
1594
|
+
#### [Get Tags](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tags)
|
1417
1595
|
|
1418
1596
|
```ruby
|
1419
1597
|
KlaviyoAPI::Tags.get_tags(opts)
|
@@ -1423,7 +1601,7 @@ KlaviyoAPI::Tags.get_tags(opts)
|
|
1423
1601
|
|
1424
1602
|
|
1425
1603
|
|
1426
|
-
#### [Update Tag](https://developers.klaviyo.com/en/v2023-
|
1604
|
+
#### [Update Tag](https://developers.klaviyo.com/en/v2023-02-22/reference/update_tag)
|
1427
1605
|
|
1428
1606
|
```ruby
|
1429
1607
|
KlaviyoAPI::Tags.update_tag(id, body)
|
@@ -1433,7 +1611,7 @@ KlaviyoAPI::Tags.update_tag(id, body)
|
|
1433
1611
|
|
1434
1612
|
|
1435
1613
|
|
1436
|
-
#### [Update Tag Group](https://developers.klaviyo.com/en/v2023-
|
1614
|
+
#### [Update Tag Group](https://developers.klaviyo.com/en/v2023-02-22/reference/update_tag_group)
|
1437
1615
|
|
1438
1616
|
```ruby
|
1439
1617
|
KlaviyoAPI::Tags.update_tag_group(id, body)
|
@@ -1447,7 +1625,7 @@ KlaviyoAPI::Tags.update_tag_group(id, body)
|
|
1447
1625
|
## Templates
|
1448
1626
|
|
1449
1627
|
|
1450
|
-
#### [Create Template](https://developers.klaviyo.com/en/v2023-
|
1628
|
+
#### [Create Template](https://developers.klaviyo.com/en/v2023-02-22/reference/create_template)
|
1451
1629
|
|
1452
1630
|
```ruby
|
1453
1631
|
KlaviyoAPI::Templates.create_template(body)
|
@@ -1457,7 +1635,7 @@ KlaviyoAPI::Templates.create_template(body)
|
|
1457
1635
|
|
1458
1636
|
|
1459
1637
|
|
1460
|
-
#### [Create Template Clone](https://developers.klaviyo.com/en/v2023-
|
1638
|
+
#### [Create Template Clone](https://developers.klaviyo.com/en/v2023-02-22/reference/create_template_clone)
|
1461
1639
|
|
1462
1640
|
```ruby
|
1463
1641
|
KlaviyoAPI::Templates.create_template_clone(body)
|
@@ -1467,7 +1645,7 @@ KlaviyoAPI::Templates.create_template_clone(body)
|
|
1467
1645
|
|
1468
1646
|
|
1469
1647
|
|
1470
|
-
#### [Create Template Render](https://developers.klaviyo.com/en/v2023-
|
1648
|
+
#### [Create Template Render](https://developers.klaviyo.com/en/v2023-02-22/reference/create_template_render)
|
1471
1649
|
|
1472
1650
|
```ruby
|
1473
1651
|
KlaviyoAPI::Templates.create_template_render(body)
|
@@ -1477,7 +1655,7 @@ KlaviyoAPI::Templates.create_template_render(body)
|
|
1477
1655
|
|
1478
1656
|
|
1479
1657
|
|
1480
|
-
#### [Delete Template](https://developers.klaviyo.com/en/v2023-
|
1658
|
+
#### [Delete Template](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_template)
|
1481
1659
|
|
1482
1660
|
```ruby
|
1483
1661
|
KlaviyoAPI::Templates.delete_template(id)
|
@@ -1487,7 +1665,7 @@ KlaviyoAPI::Templates.delete_template(id)
|
|
1487
1665
|
|
1488
1666
|
|
1489
1667
|
|
1490
|
-
#### [Get Template](https://developers.klaviyo.com/en/v2023-
|
1668
|
+
#### [Get Template](https://developers.klaviyo.com/en/v2023-02-22/reference/get_template)
|
1491
1669
|
|
1492
1670
|
```ruby
|
1493
1671
|
KlaviyoAPI::Templates.get_template(id, opts)
|
@@ -1497,7 +1675,7 @@ KlaviyoAPI::Templates.get_template(id, opts)
|
|
1497
1675
|
|
1498
1676
|
|
1499
1677
|
|
1500
|
-
#### [Get Templates](https://developers.klaviyo.com/en/v2023-
|
1678
|
+
#### [Get Templates](https://developers.klaviyo.com/en/v2023-02-22/reference/get_templates)
|
1501
1679
|
|
1502
1680
|
```ruby
|
1503
1681
|
KlaviyoAPI::Templates.get_templates(opts)
|
@@ -1507,7 +1685,7 @@ KlaviyoAPI::Templates.get_templates(opts)
|
|
1507
1685
|
|
1508
1686
|
|
1509
1687
|
|
1510
|
-
#### [Update Template](https://developers.klaviyo.com/en/v2023-
|
1688
|
+
#### [Update Template](https://developers.klaviyo.com/en/v2023-02-22/reference/update_template)
|
1511
1689
|
|
1512
1690
|
```ruby
|
1513
1691
|
KlaviyoAPI::Templates.update_template(id, body)
|