klaviyo-api-sdk 1.0.0 → 1.1.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 +14 -0
- data/README.md +335 -119
- data/docs/AudiencesSubObject.md +20 -0
- data/docs/CampaignCloneQuery.md +18 -0
- data/docs/CampaignCloneQueryAsSubResource.md +20 -0
- data/docs/CampaignCloneQueryAsSubResourceAttributes.md +20 -0
- data/docs/CampaignCreateQuery.md +18 -0
- data/docs/CampaignCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignCreateQueryAsSubResourceAttributes.md +28 -0
- data/docs/CampaignMessageAssignTemplateQuery.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +20 -0
- data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +20 -0
- data/docs/CampaignMessagePartialUpdateQuery.md +18 -0
- data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +22 -0
- data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +20 -0
- data/docs/CampaignPartialUpdateQuery.md +18 -0
- data/docs/CampaignPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +26 -0
- data/docs/CampaignSendJobCreateQuery.md +18 -0
- data/docs/CampaignSendJobCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CampaignSendJobPartialUpdateQuery.md +18 -0
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +2 -2
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +1 -1
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +1 -1
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +4 -4
- data/docs/CatalogItemDeleteQueryAsSubResource.md +1 -1
- data/docs/CatalogItemUpdateQueryAsSubResource.md +1 -1
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +4 -4
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +1 -1
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +1 -1
- data/docs/CatalogsApi.md +202 -202
- data/docs/ClientApi.md +11 -11
- data/docs/ContentSubObject.md +28 -0
- data/docs/DataPrivacyApi.md +78 -0
- data/docs/DataPrivacyCreateDeletionJobQuery.md +18 -0
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +20 -0
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +22 -0
- data/docs/ErrorSource.md +2 -2
- data/docs/EventCreateQueryAsSubResourceAttributes.md +8 -8
- data/docs/EventsApi.md +36 -36
- data/docs/FlowsApi.md +139 -69
- data/docs/IncludedCategories.md +1 -1
- data/docs/IncludedMetrics.md +1 -1
- data/docs/IncludedMetricsAttributes.md +4 -4
- data/docs/ListsApi.md +101 -25
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +15 -15
- data/docs/MetricAggregateRowDTO.md +2 -2
- data/docs/MetricCreateQuery.md +3 -3
- data/docs/MetricsApi.md +14 -14
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +10 -10
- data/docs/ProfilesApi.md +31 -31
- data/docs/SegmentsApi.md +102 -23
- data/docs/SendOptionsSubObject.md +20 -0
- data/docs/SendStrategySubObject.md +22 -0
- data/docs/SendTimeSubObject.md +20 -0
- data/docs/StaticScheduleOptions.md +22 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
- data/docs/Suppression.md +1 -1
- data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/TagCreateQuery.md +18 -0
- data/docs/TagCreateQueryAsSubResource.md +20 -0
- data/docs/TagCreateQueryAsSubResourceAttributes.md +20 -0
- data/docs/TagGroupCreateQuery.md +18 -0
- data/docs/TagGroupCreateQueryAsSubResource.md +20 -0
- data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +20 -0
- data/docs/TagGroupUpdateQuery.md +18 -0
- data/docs/TagGroupUpdateQueryAsSubResource.md +22 -0
- data/docs/{V2TemplateRenderQueryAsSubResourceAttributes.md → TagGroupUpdateQueryAsSubResourceAttributes.md} +4 -4
- data/docs/TagSegmentOp.md +18 -0
- data/docs/{ListDeleteQueryAsSubResource.md → TagSegmentOpDataInner.md} +2 -2
- data/docs/TagUpdateQuery.md +18 -0
- data/docs/TagUpdateQueryAsSubResource.md +22 -0
- data/docs/TagUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/TagsApi.md +1205 -0
- data/docs/TemplateCloneQueryAsSubResource.md +2 -0
- data/docs/TemplateCloneQueryAsSubResourceAttributes.md +5 -3
- data/docs/TemplateCreateQueryAsSubResourceAttributes.md +14 -8
- data/docs/TemplateRenderQuery.md +18 -0
- data/docs/TemplateRenderQueryAsSubResource.md +20 -0
- data/docs/TemplateRenderQueryAsSubResourceAttributes.md +22 -0
- data/docs/TemplateUpdateQueryAsSubResource.md +1 -1
- data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +13 -7
- data/docs/TemplatesApi.md +40 -44
- data/docs/ThrottledScheduleOptions.md +20 -0
- data/docs/TrackingOptionsSubObject.md +24 -0
- data/docs/UTMParamsSubObject.md +20 -0
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +1 -1
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/V2TemplateRenderQueryAsSubResource.md +2 -4
- data/klaviyo-api-sdk.gemspec +3 -3
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +277 -277
- data/lib/klaviyo-api-sdk/api/client_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +92 -0
- data/lib/klaviyo-api-sdk/api/events_api.rb +46 -46
- data/lib/klaviyo-api-sdk/api/flows_api.rb +155 -93
- data/lib/klaviyo-api-sdk/api/lists_api.rb +114 -42
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +21 -21
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +51 -51
- data/lib/klaviyo-api-sdk/api/segments_api.rb +112 -33
- data/lib/klaviyo-api-sdk/api/tags_api.rb +1216 -0
- data/lib/klaviyo-api-sdk/api/templates_api.rb +57 -69
- data/lib/klaviyo-api-sdk/api_client.rb +24 -3
- data/lib/klaviyo-api-sdk/api_error.rb +2 -2
- data/lib/klaviyo-api-sdk/configuration.rb +2 -2
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +234 -0
- data/lib/klaviyo-api-sdk/models/{v2_template_render_query.rb → campaign_clone_query.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +291 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/{included_profile.rb → campaign_message_partial_update_query_as_sub_resource.rb} +12 -25
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +256 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +4 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +270 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +2 -2
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/error_source.rb +4 -2
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +7 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +2 -2
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_categories.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flows.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_items.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_lists.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_segments.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_variants.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +14 -8
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +4 -2
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +4 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +7 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_location.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/send_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +230 -0
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +243 -0
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +240 -0
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +2 -2
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +245 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +5 -2
- data/lib/klaviyo-api-sdk/models/suppression.rb +3 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +234 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/{v2_template_render_query_as_sub_resource_attributes.rb → tag_group_update_query_as_sub_resource_attributes.rb} +16 -15
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/{list_delete_query_as_sub_resource.rb → tag_segment_op_data_inner.rb} +7 -7
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +14 -3
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +20 -3
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +7 -2
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/{template_delete_query_as_sub_resource.rb → template_render_query_as_sub_resource.rb} +15 -15
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +240 -0
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +5 -7
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +3 -3
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +2 -2
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +240 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +11 -62
- data/lib/klaviyo-api-sdk/version.rb +2 -2
- data/lib/klaviyo-api-sdk.rb +55 -7
- data/spec/api/catalogs_api_spec.rb +94 -94
- data/spec/api/client_api_spec.rb +5 -5
- data/spec/api/data_privacy_api_spec.rb +47 -0
- data/spec/api/events_api_spec.rb +19 -19
- data/spec/api/flows_api_spec.rb +44 -33
- data/spec/api/lists_api_spec.rb +28 -15
- data/spec/api/metrics_api_spec.rb +8 -8
- data/spec/api/profiles_api_spec.rb +21 -21
- data/spec/api/segments_api_spec.rb +24 -10
- data/spec/api/tags_api_spec.rb +245 -0
- data/spec/api/templates_api_spec.rb +18 -18
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/audiences_sub_object_spec.rb +40 -0
- data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/{v2_template_render_query_spec.rb → campaign_clone_query_spec.rb} +8 -8
- data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +64 -0
- data/spec/models/campaign_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_create_query_spec.rb +34 -0
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_message_assign_template_query_spec.rb +34 -0
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/campaign_message_partial_update_query_spec.rb +34 -0
- data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +58 -0
- data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/campaign_partial_update_query_spec.rb +34 -0
- data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_send_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_create_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_item_op_spec.rb +2 -2
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_update_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_update_query_spec.rb +2 -2
- data/spec/models/catalog_item_category_op_spec.rb +2 -2
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_create_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_update_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_update_query_spec.rb +2 -2
- data/spec/models/catalog_job_error_payload_spec.rb +2 -2
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_update_query_spec.rb +2 -2
- data/spec/models/content_sub_object_spec.rb +64 -0
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +34 -0
- data/spec/models/email_message_content_spec.rb +2 -2
- data/spec/models/email_tracking_options_spec.rb +2 -2
- data/spec/models/error_source_spec.rb +2 -2
- data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/event_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/event_create_query_spec.rb +2 -2
- data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/flow_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/flow_update_query_spec.rb +2 -2
- data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +2 -2
- data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +2 -2
- data/spec/models/get_catalog_items4_xx_response_spec.rb +2 -2
- data/spec/models/included_categories_attributes_spec.rb +2 -2
- data/spec/models/included_categories_spec.rb +2 -2
- data/spec/models/included_flow_action_spec.rb +2 -2
- data/spec/models/included_flow_actions_attributes_spec.rb +2 -2
- data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +2 -2
- data/spec/models/included_flow_actions_spec.rb +2 -2
- data/spec/models/included_flow_messages_attributes_content_spec.rb +2 -2
- data/spec/models/included_flow_messages_attributes_spec.rb +2 -2
- data/spec/models/included_flow_messages_spec.rb +2 -2
- data/spec/models/included_flows_attributes_spec.rb +2 -2
- data/spec/models/included_flows_spec.rb +2 -2
- data/spec/models/included_items_attributes_spec.rb +2 -2
- data/spec/models/included_items_spec.rb +2 -2
- data/spec/models/included_lists_attributes_spec.rb +2 -2
- data/spec/models/included_lists_spec.rb +2 -2
- data/spec/models/included_metrics_attributes_spec.rb +2 -2
- data/spec/models/included_metrics_spec.rb +2 -2
- data/spec/models/included_profiles_attributes_spec.rb +2 -2
- data/spec/models/included_profiles_spec.rb +2 -2
- data/spec/models/included_segments_spec.rb +2 -2
- data/spec/models/included_variants_attributes_spec.rb +2 -2
- data/spec/models/included_variants_links_spec.rb +2 -2
- data/spec/models/included_variants_spec.rb +2 -2
- data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/list_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/list_create_query_spec.rb +2 -2
- data/spec/models/list_members_add_query_data_inner_spec.rb +2 -2
- data/spec/models/list_members_add_query_spec.rb +2 -2
- data/spec/models/list_members_delete_query_spec.rb +2 -2
- data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/list_partial_update_query_spec.rb +2 -2
- data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/metric_aggregate_query_spec.rb +2 -2
- data/spec/models/metric_aggregate_row_dto_spec.rb +2 -2
- data/spec/models/metric_create_query_spec.rb +2 -2
- data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/onsite_profile_create_query_spec.rb +2 -2
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +2 -2
- data/spec/models/onsite_profile_meta_spec.rb +2 -2
- data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/onsite_subscription_create_query_spec.rb +2 -2
- data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/profile_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/profile_create_query_spec.rb +2 -2
- data/spec/models/profile_location_latitude_spec.rb +2 -2
- data/spec/models/profile_location_spec.rb +2 -2
- data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/profile_partial_update_query_spec.rb +2 -2
- data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/segment_partial_update_query_spec.rb +2 -2
- data/spec/models/send_options_spec.rb +2 -2
- data/spec/models/send_options_sub_object_spec.rb +40 -0
- data/spec/models/send_strategy_sub_object_spec.rb +46 -0
- data/spec/models/send_time_sub_object_spec.rb +40 -0
- data/spec/models/sms_message_content_spec.rb +2 -2
- data/spec/models/sms_render_options_spec.rb +2 -2
- data/spec/models/sms_tracking_options_spec.rb +2 -2
- data/spec/models/static_schedule_options_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/subscription_create_job_create_query_spec.rb +2 -2
- data/spec/models/subscription_spec.rb +2 -2
- data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/suppression_create_job_create_query_spec.rb +2 -2
- data/spec/models/suppression_spec.rb +2 -2
- data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/tag_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/tag_create_query_spec.rb +34 -0
- data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/tag_group_create_query_spec.rb +34 -0
- data/spec/models/{v2_template_render_query_as_sub_resource_attributes_spec.rb → tag_group_update_query_as_sub_resource_attributes_spec.rb} +9 -9
- data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/tag_group_update_query_spec.rb +34 -0
- data/spec/models/{list_delete_query_as_sub_resource_spec.rb → tag_segment_op_data_inner_spec.rb} +9 -9
- data/spec/models/tag_segment_op_spec.rb +34 -0
- data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/{included_profile_spec.rb → tag_update_query_as_sub_resource_spec.rb} +9 -15
- data/spec/models/tag_update_query_spec.rb +34 -0
- data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +8 -2
- data/spec/models/template_clone_query_as_sub_resource_spec.rb +8 -2
- data/spec/models/template_clone_query_spec.rb +2 -2
- data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/template_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/template_create_query_spec.rb +2 -2
- data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/{template_delete_query_as_sub_resource_spec.rb → template_render_query_as_sub_resource_spec.rb} +9 -9
- data/spec/models/template_render_query_spec.rb +34 -0
- data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/template_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/template_update_query_spec.rb +2 -2
- data/spec/models/throttled_schedule_options_spec.rb +40 -0
- data/spec/models/tracking_options_sub_object_spec.rb +52 -0
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/unsubscription_create_job_create_query_spec.rb +2 -2
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/unsuppression_create_job_create_query_spec.rb +2 -2
- data/spec/models/utm_param_info_spec.rb +2 -2
- data/spec/models/utm_params_sub_object_spec.rb +40 -0
- data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +3 -13
- data/spec/spec_helper.rb +2 -2
- metadata +165 -21
- data/docs/IncludedProfile.md +0 -24
- data/docs/TemplateDeleteQueryAsSubResource.md +0 -20
- data/docs/V2TemplateRenderQuery.md +0 -18
data/README.md
CHANGED
@@ -1,12 +1,12 @@
|
|
1
1
|
# Klaviyo Ruby SDK
|
2
2
|
|
3
|
-
- SDK version: 1.
|
4
|
-
- API revision:
|
3
|
+
- SDK version: 1.1.0
|
4
|
+
- API revision: 2023-01-24
|
5
5
|
|
6
6
|
## Helpful Resources
|
7
7
|
|
8
|
-
- [API Reference](https://developers.klaviyo.com/en/
|
9
|
-
- [API Guides](https://developers.klaviyo.com/en/
|
8
|
+
- [API Reference](https://developers.klaviyo.com/en/v2023-01-24/reference)
|
9
|
+
- [API Guides](https://developers.klaviyo.com/en/v2023-01-24/docs)
|
10
10
|
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)
|
11
11
|
|
12
12
|
## Design & Approach
|
@@ -27,6 +27,10 @@ This SDK is organized into the following resources:
|
|
27
27
|
|
28
28
|
|
29
29
|
|
30
|
+
- Data Privacy
|
31
|
+
|
32
|
+
|
33
|
+
|
30
34
|
- Events
|
31
35
|
|
32
36
|
|
@@ -51,6 +55,10 @@ This SDK is organized into the following resources:
|
|
51
55
|
|
52
56
|
|
53
57
|
|
58
|
+
- Tags
|
59
|
+
|
60
|
+
|
61
|
+
|
54
62
|
- Templates
|
55
63
|
|
56
64
|
|
@@ -70,13 +78,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
70
78
|
Then install the gem locally:
|
71
79
|
|
72
80
|
```shell
|
73
|
-
gem install ./klaviyo-api-sdk-1.
|
81
|
+
gem install ./klaviyo-api-sdk-1.1.0.gem
|
74
82
|
```
|
75
83
|
|
76
84
|
|
77
85
|
Finally add this to the Gemfile:
|
78
86
|
|
79
|
-
gem 'klaviyo-api-sdk', '~> 1.
|
87
|
+
gem 'klaviyo-api-sdk', '~> 1.1.0'
|
80
88
|
|
81
89
|
To install directly from rubygems:
|
82
90
|
|
@@ -134,7 +142,7 @@ end
|
|
134
142
|
# Comprehensive list of Operations & Parameters
|
135
143
|
|
136
144
|
_**NOTE:**_
|
137
|
-
- 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/
|
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-01-24/reference/get_events).
|
138
146
|
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
139
147
|
- Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.
|
140
148
|
|
@@ -179,7 +187,7 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
179
187
|
## Catalogs
|
180
188
|
|
181
189
|
|
182
|
-
#### [Create Catalog Category](https://developers.klaviyo.com/en/
|
190
|
+
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2023-01-24/reference/create_catalog_category)
|
183
191
|
|
184
192
|
```ruby
|
185
193
|
KlaviyoAPI::Catalogs.create_catalog_category(body)
|
@@ -189,7 +197,7 @@ KlaviyoAPI::Catalogs.create_catalog_category(body)
|
|
189
197
|
|
190
198
|
|
191
199
|
|
192
|
-
#### [Create Catalog Category Relationships](https://developers.klaviyo.com/en/
|
200
|
+
#### [Create Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/create_catalog_category_relationships)
|
193
201
|
|
194
202
|
```ruby
|
195
203
|
KlaviyoAPI::Catalogs.create_catalog_category_relationships(id, related_resource, body)
|
@@ -199,7 +207,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_relationships(id, related_resource,
|
|
199
207
|
|
200
208
|
|
201
209
|
|
202
|
-
#### [Create Catalog Item](https://developers.klaviyo.com/en/
|
210
|
+
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2023-01-24/reference/create_catalog_item)
|
203
211
|
|
204
212
|
```ruby
|
205
213
|
KlaviyoAPI::Catalogs.create_catalog_item(body)
|
@@ -209,7 +217,7 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
209
217
|
|
210
218
|
|
211
219
|
|
212
|
-
#### [Create Catalog Item Relationships](https://developers.klaviyo.com/en/
|
220
|
+
#### [Create Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/create_catalog_item_relationships)
|
213
221
|
|
214
222
|
```ruby
|
215
223
|
KlaviyoAPI::Catalogs.create_catalog_item_relationships(id, related_resource, body)
|
@@ -219,7 +227,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_relationships(id, related_resource, bod
|
|
219
227
|
|
220
228
|
|
221
229
|
|
222
|
-
#### [Create Catalog Variant](https://developers.klaviyo.com/en/
|
230
|
+
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2023-01-24/reference/create_catalog_variant)
|
223
231
|
|
224
232
|
```ruby
|
225
233
|
KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
@@ -229,7 +237,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
|
229
237
|
|
230
238
|
|
231
239
|
|
232
|
-
#### [Delete Catalog Category](https://developers.klaviyo.com/en/
|
240
|
+
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_catalog_category)
|
233
241
|
|
234
242
|
```ruby
|
235
243
|
KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
@@ -239,7 +247,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
|
239
247
|
|
240
248
|
|
241
249
|
|
242
|
-
#### [Delete Catalog Category Relationships](https://developers.klaviyo.com/en/
|
250
|
+
#### [Delete Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_catalog_category_relationships)
|
243
251
|
|
244
252
|
```ruby
|
245
253
|
KlaviyoAPI::Catalogs.delete_catalog_category_relationships(id, related_resource, body)
|
@@ -249,7 +257,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category_relationships(id, related_resource,
|
|
249
257
|
|
250
258
|
|
251
259
|
|
252
|
-
#### [Delete Catalog Item](https://developers.klaviyo.com/en/
|
260
|
+
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_catalog_item)
|
253
261
|
|
254
262
|
```ruby
|
255
263
|
KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
@@ -259,7 +267,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
|
259
267
|
|
260
268
|
|
261
269
|
|
262
|
-
#### [Delete Catalog Item Relationships](https://developers.klaviyo.com/en/
|
270
|
+
#### [Delete Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_catalog_item_relationships)
|
263
271
|
|
264
272
|
```ruby
|
265
273
|
KlaviyoAPI::Catalogs.delete_catalog_item_relationships(id, related_resource, body)
|
@@ -269,7 +277,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item_relationships(id, related_resource, bod
|
|
269
277
|
|
270
278
|
|
271
279
|
|
272
|
-
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/
|
280
|
+
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_catalog_variant)
|
273
281
|
|
274
282
|
```ruby
|
275
283
|
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
@@ -279,7 +287,7 @@ KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
|
279
287
|
|
280
288
|
|
281
289
|
|
282
|
-
#### [Get Catalog Categories](https://developers.klaviyo.com/en/
|
290
|
+
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_categories)
|
283
291
|
|
284
292
|
```ruby
|
285
293
|
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
@@ -289,7 +297,7 @@ KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
|
289
297
|
|
290
298
|
|
291
299
|
|
292
|
-
#### [Get Catalog Category](https://developers.klaviyo.com/en/
|
300
|
+
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_category)
|
293
301
|
|
294
302
|
```ruby
|
295
303
|
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
@@ -299,7 +307,7 @@ KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
|
299
307
|
|
300
308
|
|
301
309
|
|
302
|
-
#### [Get Catalog Category Items](https://developers.klaviyo.com/en/
|
310
|
+
#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_category_items)
|
303
311
|
|
304
312
|
```ruby
|
305
313
|
KlaviyoAPI::Catalogs.get_catalog_category_items(category_id, opts)
|
@@ -309,7 +317,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_items(category_id, opts)
|
|
309
317
|
|
310
318
|
|
311
319
|
|
312
|
-
#### [Get Catalog Category Relationships](https://developers.klaviyo.com/en/
|
320
|
+
#### [Get Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_category_relationships)
|
313
321
|
|
314
322
|
```ruby
|
315
323
|
KlaviyoAPI::Catalogs.get_catalog_category_relationships(id, related_resource, opts)
|
@@ -319,7 +327,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_relationships(id, related_resource, op
|
|
319
327
|
|
320
328
|
|
321
329
|
|
322
|
-
#### [Get Catalog Item](https://developers.klaviyo.com/en/
|
330
|
+
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_item)
|
323
331
|
|
324
332
|
```ruby
|
325
333
|
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
@@ -329,7 +337,7 @@ KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
|
329
337
|
|
330
338
|
|
331
339
|
|
332
|
-
#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/
|
340
|
+
#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_item_categories)
|
333
341
|
|
334
342
|
```ruby
|
335
343
|
KlaviyoAPI::Catalogs.get_catalog_item_categories(item_id, opts)
|
@@ -339,7 +347,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_categories(item_id, opts)
|
|
339
347
|
|
340
348
|
|
341
349
|
|
342
|
-
#### [Get Catalog Item Relationships](https://developers.klaviyo.com/en/
|
350
|
+
#### [Get Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_item_relationships)
|
343
351
|
|
344
352
|
```ruby
|
345
353
|
KlaviyoAPI::Catalogs.get_catalog_item_relationships(id, related_resource, opts)
|
@@ -349,7 +357,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships(id, related_resource, opts)
|
|
349
357
|
|
350
358
|
|
351
359
|
|
352
|
-
#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/
|
360
|
+
#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_item_variants)
|
353
361
|
|
354
362
|
```ruby
|
355
363
|
KlaviyoAPI::Catalogs.get_catalog_item_variants(item_id, opts)
|
@@ -359,7 +367,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_variants(item_id, opts)
|
|
359
367
|
|
360
368
|
|
361
369
|
|
362
|
-
#### [Get Catalog Items](https://developers.klaviyo.com/en/
|
370
|
+
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_items)
|
363
371
|
|
364
372
|
```ruby
|
365
373
|
KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
@@ -369,7 +377,7 @@ KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
|
369
377
|
|
370
378
|
|
371
379
|
|
372
|
-
#### [Get Catalog Variant](https://developers.klaviyo.com/en/
|
380
|
+
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_variant)
|
373
381
|
|
374
382
|
```ruby
|
375
383
|
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
@@ -379,7 +387,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
|
379
387
|
|
380
388
|
|
381
389
|
|
382
|
-
#### [Get Catalog Variants](https://developers.klaviyo.com/en/
|
390
|
+
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_variants)
|
383
391
|
|
384
392
|
```ruby
|
385
393
|
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
@@ -389,7 +397,7 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
|
389
397
|
|
390
398
|
|
391
399
|
|
392
|
-
#### [Get Create Categories Job](https://developers.klaviyo.com/en/
|
400
|
+
#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_create_categories_job)
|
393
401
|
|
394
402
|
```ruby
|
395
403
|
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
@@ -399,7 +407,7 @@ KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
|
399
407
|
|
400
408
|
|
401
409
|
|
402
|
-
#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/
|
410
|
+
#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_create_categories_jobs)
|
403
411
|
|
404
412
|
```ruby
|
405
413
|
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
@@ -409,7 +417,7 @@ KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
|
409
417
|
|
410
418
|
|
411
419
|
|
412
|
-
#### [Get Create Items Job](https://developers.klaviyo.com/en/
|
420
|
+
#### [Get Create Items Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_create_items_job)
|
413
421
|
|
414
422
|
```ruby
|
415
423
|
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
@@ -419,7 +427,7 @@ KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
|
419
427
|
|
420
428
|
|
421
429
|
|
422
|
-
#### [Get Create Items Jobs](https://developers.klaviyo.com/en/
|
430
|
+
#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_create_items_jobs)
|
423
431
|
|
424
432
|
```ruby
|
425
433
|
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
@@ -429,7 +437,7 @@ KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
|
429
437
|
|
430
438
|
|
431
439
|
|
432
|
-
#### [Get Create Variants Job](https://developers.klaviyo.com/en/
|
440
|
+
#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_create_variants_job)
|
433
441
|
|
434
442
|
```ruby
|
435
443
|
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
@@ -439,7 +447,7 @@ KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
|
439
447
|
|
440
448
|
|
441
449
|
|
442
|
-
#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/
|
450
|
+
#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_create_variants_jobs)
|
443
451
|
|
444
452
|
```ruby
|
445
453
|
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
@@ -449,7 +457,7 @@ KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
|
449
457
|
|
450
458
|
|
451
459
|
|
452
|
-
#### [Get Delete Categories Job](https://developers.klaviyo.com/en/
|
460
|
+
#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_delete_categories_job)
|
453
461
|
|
454
462
|
```ruby
|
455
463
|
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
@@ -459,7 +467,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
|
459
467
|
|
460
468
|
|
461
469
|
|
462
|
-
#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/
|
470
|
+
#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_delete_categories_jobs)
|
463
471
|
|
464
472
|
```ruby
|
465
473
|
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
@@ -469,7 +477,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
|
469
477
|
|
470
478
|
|
471
479
|
|
472
|
-
#### [Get Delete Items Job](https://developers.klaviyo.com/en/
|
480
|
+
#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_delete_items_job)
|
473
481
|
|
474
482
|
```ruby
|
475
483
|
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
@@ -479,7 +487,7 @@ KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
|
479
487
|
|
480
488
|
|
481
489
|
|
482
|
-
#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/
|
490
|
+
#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_delete_items_jobs)
|
483
491
|
|
484
492
|
```ruby
|
485
493
|
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
@@ -489,7 +497,7 @@ KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
|
489
497
|
|
490
498
|
|
491
499
|
|
492
|
-
#### [Get Delete Variants Job](https://developers.klaviyo.com/en/
|
500
|
+
#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_delete_variants_job)
|
493
501
|
|
494
502
|
```ruby
|
495
503
|
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
@@ -499,7 +507,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
|
499
507
|
|
500
508
|
|
501
509
|
|
502
|
-
#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/
|
510
|
+
#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_delete_variants_jobs)
|
503
511
|
|
504
512
|
```ruby
|
505
513
|
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
@@ -509,7 +517,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
|
509
517
|
|
510
518
|
|
511
519
|
|
512
|
-
#### [Get Update Categories Job](https://developers.klaviyo.com/en/
|
520
|
+
#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_update_categories_job)
|
513
521
|
|
514
522
|
```ruby
|
515
523
|
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
@@ -519,7 +527,7 @@ KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
|
519
527
|
|
520
528
|
|
521
529
|
|
522
|
-
#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/
|
530
|
+
#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_update_categories_jobs)
|
523
531
|
|
524
532
|
```ruby
|
525
533
|
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
@@ -529,7 +537,7 @@ KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
|
529
537
|
|
530
538
|
|
531
539
|
|
532
|
-
#### [Get Update Items Job](https://developers.klaviyo.com/en/
|
540
|
+
#### [Get Update Items Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_update_items_job)
|
533
541
|
|
534
542
|
```ruby
|
535
543
|
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
@@ -539,7 +547,7 @@ KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
|
539
547
|
|
540
548
|
|
541
549
|
|
542
|
-
#### [Get Update Items Jobs](https://developers.klaviyo.com/en/
|
550
|
+
#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_update_items_jobs)
|
543
551
|
|
544
552
|
```ruby
|
545
553
|
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
@@ -549,7 +557,7 @@ KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
|
549
557
|
|
550
558
|
|
551
559
|
|
552
|
-
#### [Get Update Variants Job](https://developers.klaviyo.com/en/
|
560
|
+
#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_update_variants_job)
|
553
561
|
|
554
562
|
```ruby
|
555
563
|
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
@@ -559,7 +567,7 @@ KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
|
559
567
|
|
560
568
|
|
561
569
|
|
562
|
-
#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/
|
570
|
+
#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_update_variants_jobs)
|
563
571
|
|
564
572
|
```ruby
|
565
573
|
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
@@ -569,7 +577,7 @@ KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
|
569
577
|
|
570
578
|
|
571
579
|
|
572
|
-
#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/
|
580
|
+
#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_create_categories_job)
|
573
581
|
|
574
582
|
```ruby
|
575
583
|
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
@@ -579,7 +587,7 @@ KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
|
579
587
|
|
580
588
|
|
581
589
|
|
582
|
-
#### [Spawn Create Items Job](https://developers.klaviyo.com/en/
|
590
|
+
#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_create_items_job)
|
583
591
|
|
584
592
|
```ruby
|
585
593
|
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
@@ -589,7 +597,7 @@ KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
|
589
597
|
|
590
598
|
|
591
599
|
|
592
|
-
#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/
|
600
|
+
#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_create_variants_job)
|
593
601
|
|
594
602
|
```ruby
|
595
603
|
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
@@ -599,7 +607,7 @@ KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
|
599
607
|
|
600
608
|
|
601
609
|
|
602
|
-
#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/
|
610
|
+
#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_delete_categories_job)
|
603
611
|
|
604
612
|
```ruby
|
605
613
|
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
@@ -609,7 +617,7 @@ KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
|
609
617
|
|
610
618
|
|
611
619
|
|
612
|
-
#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/
|
620
|
+
#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_delete_items_job)
|
613
621
|
|
614
622
|
```ruby
|
615
623
|
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
@@ -619,7 +627,7 @@ KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
|
619
627
|
|
620
628
|
|
621
629
|
|
622
|
-
#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/
|
630
|
+
#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_delete_variants_job)
|
623
631
|
|
624
632
|
```ruby
|
625
633
|
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
@@ -629,7 +637,7 @@ KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
|
629
637
|
|
630
638
|
|
631
639
|
|
632
|
-
#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/
|
640
|
+
#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_update_categories_job)
|
633
641
|
|
634
642
|
```ruby
|
635
643
|
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
@@ -639,7 +647,7 @@ KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
|
639
647
|
|
640
648
|
|
641
649
|
|
642
|
-
#### [Spawn Update Items Job](https://developers.klaviyo.com/en/
|
650
|
+
#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_update_items_job)
|
643
651
|
|
644
652
|
```ruby
|
645
653
|
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
@@ -649,7 +657,7 @@ KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
|
649
657
|
|
650
658
|
|
651
659
|
|
652
|
-
#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/
|
660
|
+
#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_update_variants_job)
|
653
661
|
|
654
662
|
```ruby
|
655
663
|
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
@@ -659,7 +667,7 @@ KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
|
659
667
|
|
660
668
|
|
661
669
|
|
662
|
-
#### [Update Catalog Category](https://developers.klaviyo.com/en/
|
670
|
+
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2023-01-24/reference/update_catalog_category)
|
663
671
|
|
664
672
|
```ruby
|
665
673
|
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
@@ -669,7 +677,7 @@ KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
|
669
677
|
|
670
678
|
|
671
679
|
|
672
|
-
#### [Update Catalog Category Relationships](https://developers.klaviyo.com/en/
|
680
|
+
#### [Update Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/update_catalog_category_relationships)
|
673
681
|
|
674
682
|
```ruby
|
675
683
|
KlaviyoAPI::Catalogs.update_catalog_category_relationships(id, related_resource, body)
|
@@ -679,7 +687,7 @@ KlaviyoAPI::Catalogs.update_catalog_category_relationships(id, related_resource,
|
|
679
687
|
|
680
688
|
|
681
689
|
|
682
|
-
#### [Update Catalog Item](https://developers.klaviyo.com/en/
|
690
|
+
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2023-01-24/reference/update_catalog_item)
|
683
691
|
|
684
692
|
```ruby
|
685
693
|
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
@@ -689,7 +697,7 @@ KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
|
689
697
|
|
690
698
|
|
691
699
|
|
692
|
-
#### [Update Catalog Item Relationships](https://developers.klaviyo.com/en/
|
700
|
+
#### [Update Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/update_catalog_item_relationships)
|
693
701
|
|
694
702
|
```ruby
|
695
703
|
KlaviyoAPI::Catalogs.update_catalog_item_relationships(id, related_resource, body)
|
@@ -699,7 +707,7 @@ KlaviyoAPI::Catalogs.update_catalog_item_relationships(id, related_resource, bod
|
|
699
707
|
|
700
708
|
|
701
709
|
|
702
|
-
#### [Update Catalog Variant](https://developers.klaviyo.com/en/
|
710
|
+
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2023-01-24/reference/update_catalog_variant)
|
703
711
|
|
704
712
|
```ruby
|
705
713
|
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
@@ -713,7 +721,7 @@ KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
|
713
721
|
## Client
|
714
722
|
|
715
723
|
|
716
|
-
#### [Create Client Event](https://developers.klaviyo.com/en/
|
724
|
+
#### [Create Client Event](https://developers.klaviyo.com/en/v2023-01-24/reference/create_client_event)
|
717
725
|
|
718
726
|
```ruby
|
719
727
|
KlaviyoAPI::Client.create_client_event(company_id, body)
|
@@ -723,7 +731,7 @@ KlaviyoAPI::Client.create_client_event(company_id, body)
|
|
723
731
|
|
724
732
|
|
725
733
|
|
726
|
-
#### [Create Client Profile](https://developers.klaviyo.com/en/
|
734
|
+
#### [Create or Update Client Profile](https://developers.klaviyo.com/en/v2023-01-24/reference/create_client_profile)
|
727
735
|
|
728
736
|
```ruby
|
729
737
|
KlaviyoAPI::Client.create_client_profile(company_id, body)
|
@@ -733,7 +741,7 @@ KlaviyoAPI::Client.create_client_profile(company_id, body)
|
|
733
741
|
|
734
742
|
|
735
743
|
|
736
|
-
#### [Create Client Subscription](https://developers.klaviyo.com/en/
|
744
|
+
#### [Create Client Subscription](https://developers.klaviyo.com/en/v2023-01-24/reference/create_client_subscription)
|
737
745
|
|
738
746
|
```ruby
|
739
747
|
KlaviyoAPI::Client.create_client_subscription(company_id, body)
|
@@ -744,10 +752,24 @@ KlaviyoAPI::Client.create_client_subscription(company_id, body)
|
|
744
752
|
|
745
753
|
|
746
754
|
|
755
|
+
## Data Privacy
|
756
|
+
|
757
|
+
|
758
|
+
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2023-01-24/reference/request_profile_deletion)
|
759
|
+
|
760
|
+
```ruby
|
761
|
+
KlaviyoAPI::Data Privacy.request_profile_deletion(body)
|
762
|
+
```
|
763
|
+
|
764
|
+
|
765
|
+
|
766
|
+
|
767
|
+
|
768
|
+
|
747
769
|
## Events
|
748
770
|
|
749
771
|
|
750
|
-
#### [Create Event](https://developers.klaviyo.com/en/
|
772
|
+
#### [Create Event](https://developers.klaviyo.com/en/v2023-01-24/reference/create_event)
|
751
773
|
|
752
774
|
```ruby
|
753
775
|
KlaviyoAPI::Events.create_event(body)
|
@@ -757,7 +779,7 @@ KlaviyoAPI::Events.create_event(body)
|
|
757
779
|
|
758
780
|
|
759
781
|
|
760
|
-
#### [Get Event](https://developers.klaviyo.com/en/
|
782
|
+
#### [Get Event](https://developers.klaviyo.com/en/v2023-01-24/reference/get_event)
|
761
783
|
|
762
784
|
```ruby
|
763
785
|
KlaviyoAPI::Events.get_event(id, opts)
|
@@ -767,7 +789,7 @@ KlaviyoAPI::Events.get_event(id, opts)
|
|
767
789
|
|
768
790
|
|
769
791
|
|
770
|
-
#### [Get Event Metrics](https://developers.klaviyo.com/en/
|
792
|
+
#### [Get Event Metrics](https://developers.klaviyo.com/en/v2023-01-24/reference/get_event_metrics)
|
771
793
|
|
772
794
|
```ruby
|
773
795
|
KlaviyoAPI::Events.get_event_metrics(id, opts)
|
@@ -777,7 +799,7 @@ KlaviyoAPI::Events.get_event_metrics(id, opts)
|
|
777
799
|
|
778
800
|
|
779
801
|
|
780
|
-
#### [Get Event Profiles](https://developers.klaviyo.com/en/
|
802
|
+
#### [Get Event Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/get_event_profiles)
|
781
803
|
|
782
804
|
```ruby
|
783
805
|
KlaviyoAPI::Events.get_event_profiles(id, opts)
|
@@ -787,7 +809,7 @@ KlaviyoAPI::Events.get_event_profiles(id, opts)
|
|
787
809
|
|
788
810
|
|
789
811
|
|
790
|
-
#### [Get Event Relationships](https://developers.klaviyo.com/en/
|
812
|
+
#### [Get Event Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_event_relationships)
|
791
813
|
|
792
814
|
```ruby
|
793
815
|
KlaviyoAPI::Events.get_event_relationships(id, related_resource)
|
@@ -797,7 +819,7 @@ KlaviyoAPI::Events.get_event_relationships(id, related_resource)
|
|
797
819
|
|
798
820
|
|
799
821
|
|
800
|
-
#### [Get Events](https://developers.klaviyo.com/en/
|
822
|
+
#### [Get Events](https://developers.klaviyo.com/en/v2023-01-24/reference/get_events)
|
801
823
|
|
802
824
|
```ruby
|
803
825
|
KlaviyoAPI::Events.get_events(opts)
|
@@ -811,7 +833,7 @@ KlaviyoAPI::Events.get_events(opts)
|
|
811
833
|
## Flows
|
812
834
|
|
813
835
|
|
814
|
-
#### [Get Flow](https://developers.klaviyo.com/en/
|
836
|
+
#### [Get Flow](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow)
|
815
837
|
|
816
838
|
```ruby
|
817
839
|
KlaviyoAPI::Flows.get_flow(id, opts)
|
@@ -821,7 +843,7 @@ KlaviyoAPI::Flows.get_flow(id, opts)
|
|
821
843
|
|
822
844
|
|
823
845
|
|
824
|
-
#### [Get Flow Action](https://developers.klaviyo.com/en/
|
846
|
+
#### [Get Flow Action](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_action)
|
825
847
|
|
826
848
|
```ruby
|
827
849
|
KlaviyoAPI::Flows.get_flow_action(id, opts)
|
@@ -831,7 +853,7 @@ KlaviyoAPI::Flows.get_flow_action(id, opts)
|
|
831
853
|
|
832
854
|
|
833
855
|
|
834
|
-
#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/
|
856
|
+
#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_action_flow)
|
835
857
|
|
836
858
|
```ruby
|
837
859
|
KlaviyoAPI::Flows.get_flow_action_flow(action_id, opts)
|
@@ -841,7 +863,7 @@ KlaviyoAPI::Flows.get_flow_action_flow(action_id, opts)
|
|
841
863
|
|
842
864
|
|
843
865
|
|
844
|
-
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/
|
866
|
+
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_action_messages)
|
845
867
|
|
846
868
|
```ruby
|
847
869
|
KlaviyoAPI::Flows.get_flow_action_messages(action_id, opts)
|
@@ -851,7 +873,7 @@ KlaviyoAPI::Flows.get_flow_action_messages(action_id, opts)
|
|
851
873
|
|
852
874
|
|
853
875
|
|
854
|
-
#### [Get Flow Action Relationships](https://developers.klaviyo.com/en/
|
876
|
+
#### [Get Flow Action Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_action_relationships)
|
855
877
|
|
856
878
|
```ruby
|
857
879
|
KlaviyoAPI::Flows.get_flow_action_relationships(id, related_resource, opts)
|
@@ -861,7 +883,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships(id, related_resource, opts)
|
|
861
883
|
|
862
884
|
|
863
885
|
|
864
|
-
#### [Get Flow Actions For Flow](https://developers.klaviyo.com/en/
|
886
|
+
#### [Get Flow Actions For Flow](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_flow_actions)
|
865
887
|
|
866
888
|
```ruby
|
867
889
|
KlaviyoAPI::Flows.get_flow_flow_actions(flow_id, opts)
|
@@ -871,7 +893,7 @@ KlaviyoAPI::Flows.get_flow_flow_actions(flow_id, opts)
|
|
871
893
|
|
872
894
|
|
873
895
|
|
874
|
-
#### [Get Flow Message](https://developers.klaviyo.com/en/
|
896
|
+
#### [Get Flow Message](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_message)
|
875
897
|
|
876
898
|
```ruby
|
877
899
|
KlaviyoAPI::Flows.get_flow_message(id, opts)
|
@@ -881,7 +903,7 @@ KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
881
903
|
|
882
904
|
|
883
905
|
|
884
|
-
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/
|
906
|
+
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_message_action)
|
885
907
|
|
886
908
|
```ruby
|
887
909
|
KlaviyoAPI::Flows.get_flow_message_action(message_id, opts)
|
@@ -891,7 +913,7 @@ KlaviyoAPI::Flows.get_flow_message_action(message_id, opts)
|
|
891
913
|
|
892
914
|
|
893
915
|
|
894
|
-
#### [Get Flow Message Relationships](https://developers.klaviyo.com/en/
|
916
|
+
#### [Get Flow Message Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_message_relationships)
|
895
917
|
|
896
918
|
```ruby
|
897
919
|
KlaviyoAPI::Flows.get_flow_message_relationships(id, related_resource)
|
@@ -901,17 +923,27 @@ KlaviyoAPI::Flows.get_flow_message_relationships(id, related_resource)
|
|
901
923
|
|
902
924
|
|
903
925
|
|
904
|
-
#### [Get Flow Relationships](https://developers.klaviyo.com/en/
|
926
|
+
#### [Get Flow Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_relationships)
|
905
927
|
|
906
928
|
```ruby
|
907
|
-
KlaviyoAPI::Flows.get_flow_relationships(id, related_resource
|
929
|
+
KlaviyoAPI::Flows.get_flow_relationships(id, related_resource)
|
908
930
|
```
|
909
931
|
|
910
932
|
|
911
933
|
|
912
934
|
|
913
935
|
|
914
|
-
#### [Get
|
936
|
+
#### [Get Flow Tags](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_tags)
|
937
|
+
|
938
|
+
```ruby
|
939
|
+
KlaviyoAPI::Flows.get_flow_tags(flow_id, opts)
|
940
|
+
```
|
941
|
+
|
942
|
+
|
943
|
+
|
944
|
+
|
945
|
+
|
946
|
+
#### [Get Flows](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flows)
|
915
947
|
|
916
948
|
```ruby
|
917
949
|
KlaviyoAPI::Flows.get_flows(opts)
|
@@ -921,7 +953,7 @@ KlaviyoAPI::Flows.get_flows(opts)
|
|
921
953
|
|
922
954
|
|
923
955
|
|
924
|
-
#### [Update Flow Status](https://developers.klaviyo.com/en/
|
956
|
+
#### [Update Flow Status](https://developers.klaviyo.com/en/v2023-01-24/reference/update_flow)
|
925
957
|
|
926
958
|
```ruby
|
927
959
|
KlaviyoAPI::Flows.update_flow(id, body)
|
@@ -935,7 +967,7 @@ KlaviyoAPI::Flows.update_flow(id, body)
|
|
935
967
|
## Lists
|
936
968
|
|
937
969
|
|
938
|
-
#### [Create List](https://developers.klaviyo.com/en/
|
970
|
+
#### [Create List](https://developers.klaviyo.com/en/v2023-01-24/reference/create_list)
|
939
971
|
|
940
972
|
```ruby
|
941
973
|
KlaviyoAPI::Lists.create_list(body)
|
@@ -945,7 +977,7 @@ KlaviyoAPI::Lists.create_list(body)
|
|
945
977
|
|
946
978
|
|
947
979
|
|
948
|
-
#### [Add Profile to List](https://developers.klaviyo.com/en/
|
980
|
+
#### [Add Profile to List](https://developers.klaviyo.com/en/v2023-01-24/reference/create_list_relationships)
|
949
981
|
|
950
982
|
```ruby
|
951
983
|
KlaviyoAPI::Lists.create_list_relationships(id, related_resource, body)
|
@@ -955,7 +987,7 @@ KlaviyoAPI::Lists.create_list_relationships(id, related_resource, body)
|
|
955
987
|
|
956
988
|
|
957
989
|
|
958
|
-
#### [Delete List](https://developers.klaviyo.com/en/
|
990
|
+
#### [Delete List](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_list)
|
959
991
|
|
960
992
|
```ruby
|
961
993
|
KlaviyoAPI::Lists.delete_list(id)
|
@@ -965,7 +997,7 @@ KlaviyoAPI::Lists.delete_list(id)
|
|
965
997
|
|
966
998
|
|
967
999
|
|
968
|
-
#### [Remove Profile from List](https://developers.klaviyo.com/en/
|
1000
|
+
#### [Remove Profile from List](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_list_relationships)
|
969
1001
|
|
970
1002
|
```ruby
|
971
1003
|
KlaviyoAPI::Lists.delete_list_relationships(id, related_resource, body)
|
@@ -975,7 +1007,7 @@ KlaviyoAPI::Lists.delete_list_relationships(id, related_resource, body)
|
|
975
1007
|
|
976
1008
|
|
977
1009
|
|
978
|
-
#### [Get List](https://developers.klaviyo.com/en/
|
1010
|
+
#### [Get List](https://developers.klaviyo.com/en/v2023-01-24/reference/get_list)
|
979
1011
|
|
980
1012
|
```ruby
|
981
1013
|
KlaviyoAPI::Lists.get_list(id, opts)
|
@@ -985,7 +1017,7 @@ KlaviyoAPI::Lists.get_list(id, opts)
|
|
985
1017
|
|
986
1018
|
|
987
1019
|
|
988
|
-
#### [Get List Profiles](https://developers.klaviyo.com/en/
|
1020
|
+
#### [Get List Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/get_list_profiles)
|
989
1021
|
|
990
1022
|
```ruby
|
991
1023
|
KlaviyoAPI::Lists.get_list_profiles(list_id, opts)
|
@@ -995,7 +1027,7 @@ KlaviyoAPI::Lists.get_list_profiles(list_id, opts)
|
|
995
1027
|
|
996
1028
|
|
997
1029
|
|
998
|
-
#### [Get List
|
1030
|
+
#### [Get List Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_list_relationships)
|
999
1031
|
|
1000
1032
|
```ruby
|
1001
1033
|
KlaviyoAPI::Lists.get_list_relationships(id, related_resource, opts)
|
@@ -1005,7 +1037,17 @@ KlaviyoAPI::Lists.get_list_relationships(id, related_resource, opts)
|
|
1005
1037
|
|
1006
1038
|
|
1007
1039
|
|
1008
|
-
#### [Get
|
1040
|
+
#### [Get List Tags](https://developers.klaviyo.com/en/v2023-01-24/reference/get_list_tags)
|
1041
|
+
|
1042
|
+
```ruby
|
1043
|
+
KlaviyoAPI::Lists.get_list_tags(list_id, opts)
|
1044
|
+
```
|
1045
|
+
|
1046
|
+
|
1047
|
+
|
1048
|
+
|
1049
|
+
|
1050
|
+
#### [Get Lists](https://developers.klaviyo.com/en/v2023-01-24/reference/get_lists)
|
1009
1051
|
|
1010
1052
|
```ruby
|
1011
1053
|
KlaviyoAPI::Lists.get_lists(opts)
|
@@ -1015,7 +1057,7 @@ KlaviyoAPI::Lists.get_lists(opts)
|
|
1015
1057
|
|
1016
1058
|
|
1017
1059
|
|
1018
|
-
#### [Update List](https://developers.klaviyo.com/en/
|
1060
|
+
#### [Update List](https://developers.klaviyo.com/en/v2023-01-24/reference/update_list)
|
1019
1061
|
|
1020
1062
|
```ruby
|
1021
1063
|
KlaviyoAPI::Lists.update_list(id, body)
|
@@ -1029,7 +1071,7 @@ KlaviyoAPI::Lists.update_list(id, body)
|
|
1029
1071
|
## Metrics
|
1030
1072
|
|
1031
1073
|
|
1032
|
-
#### [Get Metric](https://developers.klaviyo.com/en/
|
1074
|
+
#### [Get Metric](https://developers.klaviyo.com/en/v2023-01-24/reference/get_metric)
|
1033
1075
|
|
1034
1076
|
```ruby
|
1035
1077
|
KlaviyoAPI::Metrics.get_metric(id, opts)
|
@@ -1039,7 +1081,7 @@ KlaviyoAPI::Metrics.get_metric(id, opts)
|
|
1039
1081
|
|
1040
1082
|
|
1041
1083
|
|
1042
|
-
#### [Get Metrics](https://developers.klaviyo.com/en/
|
1084
|
+
#### [Get Metrics](https://developers.klaviyo.com/en/v2023-01-24/reference/get_metrics)
|
1043
1085
|
|
1044
1086
|
```ruby
|
1045
1087
|
KlaviyoAPI::Metrics.get_metrics(opts)
|
@@ -1049,7 +1091,7 @@ KlaviyoAPI::Metrics.get_metrics(opts)
|
|
1049
1091
|
|
1050
1092
|
|
1051
1093
|
|
1052
|
-
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/
|
1094
|
+
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-01-24/reference/query_metric_aggregates)
|
1053
1095
|
|
1054
1096
|
```ruby
|
1055
1097
|
KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
@@ -1063,7 +1105,7 @@ KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
|
1063
1105
|
## Profiles
|
1064
1106
|
|
1065
1107
|
|
1066
|
-
#### [Create Profile](https://developers.klaviyo.com/en/
|
1108
|
+
#### [Create Profile](https://developers.klaviyo.com/en/v2023-01-24/reference/create_profile)
|
1067
1109
|
|
1068
1110
|
```ruby
|
1069
1111
|
KlaviyoAPI::Profiles.create_profile(body)
|
@@ -1073,7 +1115,7 @@ KlaviyoAPI::Profiles.create_profile(body)
|
|
1073
1115
|
|
1074
1116
|
|
1075
1117
|
|
1076
|
-
#### [Get Profile](https://developers.klaviyo.com/en/
|
1118
|
+
#### [Get Profile](https://developers.klaviyo.com/en/v2023-01-24/reference/get_profile)
|
1077
1119
|
|
1078
1120
|
```ruby
|
1079
1121
|
KlaviyoAPI::Profiles.get_profile(id, opts)
|
@@ -1083,7 +1125,7 @@ KlaviyoAPI::Profiles.get_profile(id, opts)
|
|
1083
1125
|
|
1084
1126
|
|
1085
1127
|
|
1086
|
-
#### [Get Profile Lists](https://developers.klaviyo.com/en/
|
1128
|
+
#### [Get Profile Lists](https://developers.klaviyo.com/en/v2023-01-24/reference/get_profile_lists)
|
1087
1129
|
|
1088
1130
|
```ruby
|
1089
1131
|
KlaviyoAPI::Profiles.get_profile_lists(profile_id, opts)
|
@@ -1093,7 +1135,7 @@ KlaviyoAPI::Profiles.get_profile_lists(profile_id, opts)
|
|
1093
1135
|
|
1094
1136
|
|
1095
1137
|
|
1096
|
-
#### [Get Profile Relationships](https://developers.klaviyo.com/en/
|
1138
|
+
#### [Get Profile Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_profile_relationships)
|
1097
1139
|
|
1098
1140
|
```ruby
|
1099
1141
|
KlaviyoAPI::Profiles.get_profile_relationships(id, related_resource)
|
@@ -1103,7 +1145,7 @@ KlaviyoAPI::Profiles.get_profile_relationships(id, related_resource)
|
|
1103
1145
|
|
1104
1146
|
|
1105
1147
|
|
1106
|
-
#### [Get Profile Segments](https://developers.klaviyo.com/en/
|
1148
|
+
#### [Get Profile Segments](https://developers.klaviyo.com/en/v2023-01-24/reference/get_profile_segments)
|
1107
1149
|
|
1108
1150
|
```ruby
|
1109
1151
|
KlaviyoAPI::Profiles.get_profile_segments(profile_id, opts)
|
@@ -1113,7 +1155,7 @@ KlaviyoAPI::Profiles.get_profile_segments(profile_id, opts)
|
|
1113
1155
|
|
1114
1156
|
|
1115
1157
|
|
1116
|
-
#### [Get Profiles](https://developers.klaviyo.com/en/
|
1158
|
+
#### [Get Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/get_profiles)
|
1117
1159
|
|
1118
1160
|
```ruby
|
1119
1161
|
KlaviyoAPI::Profiles.get_profiles(opts)
|
@@ -1123,7 +1165,7 @@ KlaviyoAPI::Profiles.get_profiles(opts)
|
|
1123
1165
|
|
1124
1166
|
|
1125
1167
|
|
1126
|
-
#### [Subscribe Profiles](https://developers.klaviyo.com/en/
|
1168
|
+
#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/subscribe_profiles)
|
1127
1169
|
|
1128
1170
|
```ruby
|
1129
1171
|
KlaviyoAPI::Profiles.subscribe_profiles(body)
|
@@ -1133,7 +1175,7 @@ KlaviyoAPI::Profiles.subscribe_profiles(body)
|
|
1133
1175
|
|
1134
1176
|
|
1135
1177
|
|
1136
|
-
#### [Suppress Profiles](https://developers.klaviyo.com/en/
|
1178
|
+
#### [Suppress Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/suppress_profiles)
|
1137
1179
|
|
1138
1180
|
```ruby
|
1139
1181
|
KlaviyoAPI::Profiles.suppress_profiles(body)
|
@@ -1143,7 +1185,7 @@ KlaviyoAPI::Profiles.suppress_profiles(body)
|
|
1143
1185
|
|
1144
1186
|
|
1145
1187
|
|
1146
|
-
#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/
|
1188
|
+
#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/unsubscribe_profiles)
|
1147
1189
|
|
1148
1190
|
```ruby
|
1149
1191
|
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
@@ -1153,7 +1195,7 @@ KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
|
1153
1195
|
|
1154
1196
|
|
1155
1197
|
|
1156
|
-
#### [Unsuppress Profiles](https://developers.klaviyo.com/en/
|
1198
|
+
#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/unsuppress_profiles)
|
1157
1199
|
|
1158
1200
|
```ruby
|
1159
1201
|
KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
@@ -1163,7 +1205,7 @@ KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
|
1163
1205
|
|
1164
1206
|
|
1165
1207
|
|
1166
|
-
#### [Update Profile](https://developers.klaviyo.com/en/
|
1208
|
+
#### [Update Profile](https://developers.klaviyo.com/en/v2023-01-24/reference/update_profile)
|
1167
1209
|
|
1168
1210
|
```ruby
|
1169
1211
|
KlaviyoAPI::Profiles.update_profile(id, body)
|
@@ -1177,7 +1219,7 @@ KlaviyoAPI::Profiles.update_profile(id, body)
|
|
1177
1219
|
## Segments
|
1178
1220
|
|
1179
1221
|
|
1180
|
-
#### [Get Segment](https://developers.klaviyo.com/en/
|
1222
|
+
#### [Get Segment](https://developers.klaviyo.com/en/v2023-01-24/reference/get_segment)
|
1181
1223
|
|
1182
1224
|
```ruby
|
1183
1225
|
KlaviyoAPI::Segments.get_segment(id, opts)
|
@@ -1187,7 +1229,7 @@ KlaviyoAPI::Segments.get_segment(id, opts)
|
|
1187
1229
|
|
1188
1230
|
|
1189
1231
|
|
1190
|
-
#### [Get Segment Profiles](https://developers.klaviyo.com/en/
|
1232
|
+
#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/get_segment_profiles)
|
1191
1233
|
|
1192
1234
|
```ruby
|
1193
1235
|
KlaviyoAPI::Segments.get_segment_profiles(segment_id, opts)
|
@@ -1197,7 +1239,7 @@ KlaviyoAPI::Segments.get_segment_profiles(segment_id, opts)
|
|
1197
1239
|
|
1198
1240
|
|
1199
1241
|
|
1200
|
-
#### [Get Segment Relationships](https://developers.klaviyo.com/en/
|
1242
|
+
#### [Get Segment Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_segment_relationships)
|
1201
1243
|
|
1202
1244
|
```ruby
|
1203
1245
|
KlaviyoAPI::Segments.get_segment_relationships(id, related_resource, opts)
|
@@ -1207,7 +1249,17 @@ KlaviyoAPI::Segments.get_segment_relationships(id, related_resource, opts)
|
|
1207
1249
|
|
1208
1250
|
|
1209
1251
|
|
1210
|
-
#### [Get
|
1252
|
+
#### [Get Segment Tags](https://developers.klaviyo.com/en/v2023-01-24/reference/get_segment_tags)
|
1253
|
+
|
1254
|
+
```ruby
|
1255
|
+
KlaviyoAPI::Segments.get_segment_tags(segment_id, opts)
|
1256
|
+
```
|
1257
|
+
|
1258
|
+
|
1259
|
+
|
1260
|
+
|
1261
|
+
|
1262
|
+
#### [Get Segments](https://developers.klaviyo.com/en/v2023-01-24/reference/get_segments)
|
1211
1263
|
|
1212
1264
|
```ruby
|
1213
1265
|
KlaviyoAPI::Segments.get_segments(opts)
|
@@ -1217,7 +1269,7 @@ KlaviyoAPI::Segments.get_segments(opts)
|
|
1217
1269
|
|
1218
1270
|
|
1219
1271
|
|
1220
|
-
#### [Update Segment](https://developers.klaviyo.com/en/
|
1272
|
+
#### [Update Segment](https://developers.klaviyo.com/en/v2023-01-24/reference/update_segment)
|
1221
1273
|
|
1222
1274
|
```ruby
|
1223
1275
|
KlaviyoAPI::Segments.update_segment(id, body)
|
@@ -1228,10 +1280,174 @@ KlaviyoAPI::Segments.update_segment(id, body)
|
|
1228
1280
|
|
1229
1281
|
|
1230
1282
|
|
1283
|
+
## Tags
|
1284
|
+
|
1285
|
+
|
1286
|
+
#### [Create Tag](https://developers.klaviyo.com/en/v2023-01-24/reference/create_tag)
|
1287
|
+
|
1288
|
+
```ruby
|
1289
|
+
KlaviyoAPI::Tags.create_tag(body)
|
1290
|
+
```
|
1291
|
+
|
1292
|
+
|
1293
|
+
|
1294
|
+
|
1295
|
+
|
1296
|
+
#### [Create Tag Group](https://developers.klaviyo.com/en/v2023-01-24/reference/create_tag_group)
|
1297
|
+
|
1298
|
+
```ruby
|
1299
|
+
KlaviyoAPI::Tags.create_tag_group(body)
|
1300
|
+
```
|
1301
|
+
|
1302
|
+
|
1303
|
+
|
1304
|
+
|
1305
|
+
|
1306
|
+
#### [Create Tag Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/create_tag_relationships)
|
1307
|
+
|
1308
|
+
```ruby
|
1309
|
+
KlaviyoAPI::Tags.create_tag_relationships(id, related_resource, body)
|
1310
|
+
```
|
1311
|
+
|
1312
|
+
|
1313
|
+
|
1314
|
+
|
1315
|
+
|
1316
|
+
#### [Delete Tag](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_tag)
|
1317
|
+
|
1318
|
+
```ruby
|
1319
|
+
KlaviyoAPI::Tags.delete_tag(id)
|
1320
|
+
```
|
1321
|
+
|
1322
|
+
|
1323
|
+
|
1324
|
+
|
1325
|
+
|
1326
|
+
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_tag_group)
|
1327
|
+
|
1328
|
+
```ruby
|
1329
|
+
KlaviyoAPI::Tags.delete_tag_group(id)
|
1330
|
+
```
|
1331
|
+
|
1332
|
+
|
1333
|
+
|
1334
|
+
|
1335
|
+
|
1336
|
+
#### [Delete Tag Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_tag_relationships)
|
1337
|
+
|
1338
|
+
```ruby
|
1339
|
+
KlaviyoAPI::Tags.delete_tag_relationships(id, related_resource, body)
|
1340
|
+
```
|
1341
|
+
|
1342
|
+
|
1343
|
+
|
1344
|
+
|
1345
|
+
|
1346
|
+
#### [Get Tag](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag)
|
1347
|
+
|
1348
|
+
```ruby
|
1349
|
+
KlaviyoAPI::Tags.get_tag(id, opts)
|
1350
|
+
```
|
1351
|
+
|
1352
|
+
|
1353
|
+
|
1354
|
+
|
1355
|
+
|
1356
|
+
#### [Get Tag Group](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag_group)
|
1357
|
+
|
1358
|
+
```ruby
|
1359
|
+
KlaviyoAPI::Tags.get_tag_group(id, opts)
|
1360
|
+
```
|
1361
|
+
|
1362
|
+
|
1363
|
+
|
1364
|
+
|
1365
|
+
|
1366
|
+
#### [Get Tag Group Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag_group_relationships)
|
1367
|
+
|
1368
|
+
```ruby
|
1369
|
+
KlaviyoAPI::Tags.get_tag_group_relationships(id, related_resource)
|
1370
|
+
```
|
1371
|
+
|
1372
|
+
|
1373
|
+
|
1374
|
+
|
1375
|
+
|
1376
|
+
#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag_group_tags)
|
1377
|
+
|
1378
|
+
```ruby
|
1379
|
+
KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
|
1380
|
+
```
|
1381
|
+
|
1382
|
+
|
1383
|
+
|
1384
|
+
|
1385
|
+
|
1386
|
+
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag_groups)
|
1387
|
+
|
1388
|
+
```ruby
|
1389
|
+
KlaviyoAPI::Tags.get_tag_groups(opts)
|
1390
|
+
```
|
1391
|
+
|
1392
|
+
|
1393
|
+
|
1394
|
+
|
1395
|
+
|
1396
|
+
#### [Get Tag Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag_relationships)
|
1397
|
+
|
1398
|
+
```ruby
|
1399
|
+
KlaviyoAPI::Tags.get_tag_relationships(id, related_resource)
|
1400
|
+
```
|
1401
|
+
|
1402
|
+
|
1403
|
+
|
1404
|
+
|
1405
|
+
|
1406
|
+
#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag_tag_group)
|
1407
|
+
|
1408
|
+
```ruby
|
1409
|
+
KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
|
1410
|
+
```
|
1411
|
+
|
1412
|
+
|
1413
|
+
|
1414
|
+
|
1415
|
+
|
1416
|
+
#### [Get Tags](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tags)
|
1417
|
+
|
1418
|
+
```ruby
|
1419
|
+
KlaviyoAPI::Tags.get_tags(opts)
|
1420
|
+
```
|
1421
|
+
|
1422
|
+
|
1423
|
+
|
1424
|
+
|
1425
|
+
|
1426
|
+
#### [Update Tag](https://developers.klaviyo.com/en/v2023-01-24/reference/update_tag)
|
1427
|
+
|
1428
|
+
```ruby
|
1429
|
+
KlaviyoAPI::Tags.update_tag(id, body)
|
1430
|
+
```
|
1431
|
+
|
1432
|
+
|
1433
|
+
|
1434
|
+
|
1435
|
+
|
1436
|
+
#### [Update Tag Group](https://developers.klaviyo.com/en/v2023-01-24/reference/update_tag_group)
|
1437
|
+
|
1438
|
+
```ruby
|
1439
|
+
KlaviyoAPI::Tags.update_tag_group(id, body)
|
1440
|
+
```
|
1441
|
+
|
1442
|
+
|
1443
|
+
|
1444
|
+
|
1445
|
+
|
1446
|
+
|
1231
1447
|
## Templates
|
1232
1448
|
|
1233
1449
|
|
1234
|
-
#### [Create Template](https://developers.klaviyo.com/en/
|
1450
|
+
#### [Create Template](https://developers.klaviyo.com/en/v2023-01-24/reference/create_template)
|
1235
1451
|
|
1236
1452
|
```ruby
|
1237
1453
|
KlaviyoAPI::Templates.create_template(body)
|
@@ -1241,27 +1457,27 @@ KlaviyoAPI::Templates.create_template(body)
|
|
1241
1457
|
|
1242
1458
|
|
1243
1459
|
|
1244
|
-
#### [Create Template Clone](https://developers.klaviyo.com/en/
|
1460
|
+
#### [Create Template Clone](https://developers.klaviyo.com/en/v2023-01-24/reference/create_template_clone)
|
1245
1461
|
|
1246
1462
|
```ruby
|
1247
|
-
KlaviyoAPI::Templates.create_template_clone(
|
1463
|
+
KlaviyoAPI::Templates.create_template_clone(body)
|
1248
1464
|
```
|
1249
1465
|
|
1250
1466
|
|
1251
1467
|
|
1252
1468
|
|
1253
1469
|
|
1254
|
-
#### [Create Template Render](https://developers.klaviyo.com/en/
|
1470
|
+
#### [Create Template Render](https://developers.klaviyo.com/en/v2023-01-24/reference/create_template_render)
|
1255
1471
|
|
1256
1472
|
```ruby
|
1257
|
-
KlaviyoAPI::Templates.create_template_render(
|
1473
|
+
KlaviyoAPI::Templates.create_template_render(body)
|
1258
1474
|
```
|
1259
1475
|
|
1260
1476
|
|
1261
1477
|
|
1262
1478
|
|
1263
1479
|
|
1264
|
-
#### [Delete Template](https://developers.klaviyo.com/en/
|
1480
|
+
#### [Delete Template](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_template)
|
1265
1481
|
|
1266
1482
|
```ruby
|
1267
1483
|
KlaviyoAPI::Templates.delete_template(id)
|
@@ -1271,7 +1487,7 @@ KlaviyoAPI::Templates.delete_template(id)
|
|
1271
1487
|
|
1272
1488
|
|
1273
1489
|
|
1274
|
-
#### [Get Template](https://developers.klaviyo.com/en/
|
1490
|
+
#### [Get Template](https://developers.klaviyo.com/en/v2023-01-24/reference/get_template)
|
1275
1491
|
|
1276
1492
|
```ruby
|
1277
1493
|
KlaviyoAPI::Templates.get_template(id, opts)
|
@@ -1281,7 +1497,7 @@ KlaviyoAPI::Templates.get_template(id, opts)
|
|
1281
1497
|
|
1282
1498
|
|
1283
1499
|
|
1284
|
-
#### [Get Templates](https://developers.klaviyo.com/en/
|
1500
|
+
#### [Get Templates](https://developers.klaviyo.com/en/v2023-01-24/reference/get_templates)
|
1285
1501
|
|
1286
1502
|
```ruby
|
1287
1503
|
KlaviyoAPI::Templates.get_templates(opts)
|
@@ -1291,7 +1507,7 @@ KlaviyoAPI::Templates.get_templates(opts)
|
|
1291
1507
|
|
1292
1508
|
|
1293
1509
|
|
1294
|
-
#### [Update Template](https://developers.klaviyo.com/en/
|
1510
|
+
#### [Update Template](https://developers.klaviyo.com/en/v2023-01-24/reference/update_template)
|
1295
1511
|
|
1296
1512
|
```ruby
|
1297
1513
|
KlaviyoAPI::Templates.update_template(id, body)
|