klaviyo-api-sdk 1.0.1 → 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 +19 -0
- data/README.md +513 -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/CampaignRecipientEstimationJobCreateQuery.md +18 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +18 -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/CampaignTagOp.md +18 -0
- data/docs/{ListDeleteQueryAsSubResource.md → CampaignTagOpDataInner.md} +2 -2
- data/docs/CampaignsApi.md +1277 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +7 -7
- 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 +23 -21
- 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 +29 -29
- 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 +256 -256
- 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 +147 -69
- 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/IncludedMetrics.md +1 -1
- data/docs/IncludedMetricsAttributes.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/{IncludedProfile.md → IncludedTags.md} +5 -5
- 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 +111 -35
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +19 -19
- data/docs/MetricAggregateRowDTO.md +2 -2
- data/docs/MetricCreateQuery.md +3 -3
- data/docs/MetricsApi.md +14 -14
- data/docs/OnsiteProfileMetaIdentifiers.md +10 -10
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.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 +36 -36
- data/docs/STOScheduleOptions.md +18 -0
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +1 -1
- data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/SegmentsApi.md +103 -24
- data/docs/SendOptionsSubObject.md +18 -0
- data/docs/SendStrategySubObject.md +24 -0
- data/docs/SendTimeSubObject.md +20 -0
- data/docs/StaticScheduleOptions.md +22 -0
- data/docs/Subscription.md +8 -4
- data/docs/SubscriptionChannels.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +5 -5
- data/docs/Suppression.md +2 -2
- 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/{TemplateDeleteQueryAsSubResource.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/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 +6 -6
- 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/campaigns_api.rb +1275 -0
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +338 -338
- 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 +167 -93
- data/lib/klaviyo-api-sdk/api/lists_api.rb +122 -50
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +21 -21
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +53 -53
- 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 +3 -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/campaign_message_partial_update_query_as_sub_resource.rb +287 -0
- 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_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 +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/campaign_tag_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/{list_delete_query_as_sub_resource.rb → campaign_tag_op_data_inner.rb} +7 -7
- 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 +3 -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 +8 -3
- 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 +3 -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 +3 -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 +3 -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 +3 -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 +28 -4
- 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 +3 -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 +3 -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 +21 -3
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +6 -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 +3 -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 +21 -9
- 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 +3 -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 +3 -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 +13 -3
- 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 +5 -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_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/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 +5 -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 +3 -2
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +24 -3
- data/lib/klaviyo-api-sdk/models/included_lists.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +5 -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 +3 -2
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +14 -2
- data/lib/klaviyo-api-sdk/models/included_segments.rb +3 -3
- data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/{included_profile.rb → included_tags.rb} +9 -8
- data/lib/klaviyo-api-sdk/models/included_variants.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +17 -3
- 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 +3 -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 +3 -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 +29 -21
- 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 +17 -12
- 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 +11 -2
- data/lib/klaviyo-api-sdk/models/profile_location.rb +10 -3
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +3 -2
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
- 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 +3 -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 +3 -3
- 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 +2 -2
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +220 -0
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +252 -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/sto_schedule_options.rb +225 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +27 -6
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
- 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/{template_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 +2 -2
- 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_render_query_as_sub_resource.rb +272 -0
- 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 +68 -11
- data/spec/api/campaigns_api_spec.rb +284 -0
- 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_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_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/{list_delete_query_as_sub_resource_spec.rb → campaign_tag_op_data_inner_spec.rb} +9 -9
- data/spec/models/campaign_tag_op_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_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/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_attributes_spec.rb +46 -0
- data/spec/models/included_segments_spec.rb +2 -2
- data/spec/models/{included_profile_spec.rb → included_tags_spec.rb} +9 -9
- 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_longitude_spec.rb +31 -0
- 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_attributes_spec.rb +34 -0
- 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/sto_schedule_options_spec.rb +34 -0
- data/spec/models/subscription_channels_spec.rb +48 -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/tag_segment_op_data_inner_spec.rb +44 -0
- 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/tag_update_query_as_sub_resource_spec.rb +50 -0
- 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 +207 -19
- data/docs/V2TemplateRenderQuery.md +0 -18
- data/test.rb +0 -50
data/README.md
CHANGED
@@ -1,12 +1,12 @@
|
|
1
1
|
# Klaviyo Ruby SDK
|
2
2
|
|
3
|
-
- SDK version: 1.0
|
4
|
-
- API revision:
|
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/
|
9
|
-
- [API Guides](https://developers.klaviyo.com/en/
|
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
|
|
@@ -27,6 +31,10 @@ This SDK is organized into the following resources:
|
|
27
31
|
|
28
32
|
|
29
33
|
|
34
|
+
- Data Privacy
|
35
|
+
|
36
|
+
|
37
|
+
|
30
38
|
- Events
|
31
39
|
|
32
40
|
|
@@ -51,6 +59,10 @@ This SDK is organized into the following resources:
|
|
51
59
|
|
52
60
|
|
53
61
|
|
62
|
+
- Tags
|
63
|
+
|
64
|
+
|
65
|
+
|
54
66
|
- Templates
|
55
67
|
|
56
68
|
|
@@ -70,13 +82,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
70
82
|
Then install the gem locally:
|
71
83
|
|
72
84
|
```shell
|
73
|
-
gem install ./klaviyo-api-sdk-1.0.
|
85
|
+
gem install ./klaviyo-api-sdk-1.2.0.gem
|
74
86
|
```
|
75
87
|
|
76
88
|
|
77
89
|
Finally add this to the Gemfile:
|
78
90
|
|
79
|
-
gem 'klaviyo-api-sdk', '~> 1.0
|
91
|
+
gem 'klaviyo-api-sdk', '~> 1.2.0'
|
80
92
|
|
81
93
|
To install directly from rubygems:
|
82
94
|
|
@@ -134,7 +146,7 @@ end
|
|
134
146
|
# Comprehensive list of Operations & Parameters
|
135
147
|
|
136
148
|
_**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/
|
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).
|
138
150
|
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
139
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.
|
140
152
|
|
@@ -176,10 +188,184 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
176
188
|
|
177
189
|
|
178
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
|
+
|
179
365
|
## Catalogs
|
180
366
|
|
181
367
|
|
182
|
-
#### [Create Catalog Category](https://developers.klaviyo.com/en/
|
368
|
+
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2023-02-22/reference/create_catalog_category)
|
183
369
|
|
184
370
|
```ruby
|
185
371
|
KlaviyoAPI::Catalogs.create_catalog_category(body)
|
@@ -189,7 +375,7 @@ KlaviyoAPI::Catalogs.create_catalog_category(body)
|
|
189
375
|
|
190
376
|
|
191
377
|
|
192
|
-
#### [Create Catalog Category Relationships](https://developers.klaviyo.com/en/
|
378
|
+
#### [Create Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/create_catalog_category_relationships)
|
193
379
|
|
194
380
|
```ruby
|
195
381
|
KlaviyoAPI::Catalogs.create_catalog_category_relationships(id, related_resource, body)
|
@@ -199,7 +385,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_relationships(id, related_resource,
|
|
199
385
|
|
200
386
|
|
201
387
|
|
202
|
-
#### [Create Catalog Item](https://developers.klaviyo.com/en/
|
388
|
+
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2023-02-22/reference/create_catalog_item)
|
203
389
|
|
204
390
|
```ruby
|
205
391
|
KlaviyoAPI::Catalogs.create_catalog_item(body)
|
@@ -209,7 +395,7 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
209
395
|
|
210
396
|
|
211
397
|
|
212
|
-
#### [Create Catalog Item Relationships](https://developers.klaviyo.com/en/
|
398
|
+
#### [Create Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/create_catalog_item_relationships)
|
213
399
|
|
214
400
|
```ruby
|
215
401
|
KlaviyoAPI::Catalogs.create_catalog_item_relationships(id, related_resource, body)
|
@@ -219,7 +405,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_relationships(id, related_resource, bod
|
|
219
405
|
|
220
406
|
|
221
407
|
|
222
|
-
#### [Create Catalog Variant](https://developers.klaviyo.com/en/
|
408
|
+
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2023-02-22/reference/create_catalog_variant)
|
223
409
|
|
224
410
|
```ruby
|
225
411
|
KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
@@ -229,7 +415,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
|
229
415
|
|
230
416
|
|
231
417
|
|
232
|
-
#### [Delete Catalog Category](https://developers.klaviyo.com/en/
|
418
|
+
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_catalog_category)
|
233
419
|
|
234
420
|
```ruby
|
235
421
|
KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
@@ -239,7 +425,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
|
239
425
|
|
240
426
|
|
241
427
|
|
242
|
-
#### [Delete Catalog Category Relationships](https://developers.klaviyo.com/en/
|
428
|
+
#### [Delete Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_catalog_category_relationships)
|
243
429
|
|
244
430
|
```ruby
|
245
431
|
KlaviyoAPI::Catalogs.delete_catalog_category_relationships(id, related_resource, body)
|
@@ -249,7 +435,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category_relationships(id, related_resource,
|
|
249
435
|
|
250
436
|
|
251
437
|
|
252
|
-
#### [Delete Catalog Item](https://developers.klaviyo.com/en/
|
438
|
+
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_catalog_item)
|
253
439
|
|
254
440
|
```ruby
|
255
441
|
KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
@@ -259,7 +445,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
|
259
445
|
|
260
446
|
|
261
447
|
|
262
|
-
#### [Delete Catalog Item Relationships](https://developers.klaviyo.com/en/
|
448
|
+
#### [Delete Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_catalog_item_relationships)
|
263
449
|
|
264
450
|
```ruby
|
265
451
|
KlaviyoAPI::Catalogs.delete_catalog_item_relationships(id, related_resource, body)
|
@@ -269,7 +455,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item_relationships(id, related_resource, bod
|
|
269
455
|
|
270
456
|
|
271
457
|
|
272
|
-
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/
|
458
|
+
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_catalog_variant)
|
273
459
|
|
274
460
|
```ruby
|
275
461
|
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
@@ -279,7 +465,7 @@ KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
|
279
465
|
|
280
466
|
|
281
467
|
|
282
|
-
#### [Get Catalog Categories](https://developers.klaviyo.com/en/
|
468
|
+
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_categories)
|
283
469
|
|
284
470
|
```ruby
|
285
471
|
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
@@ -289,7 +475,7 @@ KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
|
289
475
|
|
290
476
|
|
291
477
|
|
292
|
-
#### [Get Catalog Category](https://developers.klaviyo.com/en/
|
478
|
+
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_category)
|
293
479
|
|
294
480
|
```ruby
|
295
481
|
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
@@ -299,7 +485,7 @@ KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
|
299
485
|
|
300
486
|
|
301
487
|
|
302
|
-
#### [Get Catalog Category Items](https://developers.klaviyo.com/en/
|
488
|
+
#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_category_items)
|
303
489
|
|
304
490
|
```ruby
|
305
491
|
KlaviyoAPI::Catalogs.get_catalog_category_items(category_id, opts)
|
@@ -309,7 +495,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_items(category_id, opts)
|
|
309
495
|
|
310
496
|
|
311
497
|
|
312
|
-
#### [Get Catalog Category Relationships](https://developers.klaviyo.com/en/
|
498
|
+
#### [Get Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_category_relationships)
|
313
499
|
|
314
500
|
```ruby
|
315
501
|
KlaviyoAPI::Catalogs.get_catalog_category_relationships(id, related_resource, opts)
|
@@ -319,7 +505,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_relationships(id, related_resource, op
|
|
319
505
|
|
320
506
|
|
321
507
|
|
322
|
-
#### [Get Catalog Item](https://developers.klaviyo.com/en/
|
508
|
+
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_item)
|
323
509
|
|
324
510
|
```ruby
|
325
511
|
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
@@ -329,7 +515,7 @@ KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
|
329
515
|
|
330
516
|
|
331
517
|
|
332
|
-
#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/
|
518
|
+
#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_item_categories)
|
333
519
|
|
334
520
|
```ruby
|
335
521
|
KlaviyoAPI::Catalogs.get_catalog_item_categories(item_id, opts)
|
@@ -339,7 +525,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_categories(item_id, opts)
|
|
339
525
|
|
340
526
|
|
341
527
|
|
342
|
-
#### [Get Catalog Item Relationships](https://developers.klaviyo.com/en/
|
528
|
+
#### [Get Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_item_relationships)
|
343
529
|
|
344
530
|
```ruby
|
345
531
|
KlaviyoAPI::Catalogs.get_catalog_item_relationships(id, related_resource, opts)
|
@@ -349,7 +535,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships(id, related_resource, opts)
|
|
349
535
|
|
350
536
|
|
351
537
|
|
352
|
-
#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/
|
538
|
+
#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_item_variants)
|
353
539
|
|
354
540
|
```ruby
|
355
541
|
KlaviyoAPI::Catalogs.get_catalog_item_variants(item_id, opts)
|
@@ -359,7 +545,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_variants(item_id, opts)
|
|
359
545
|
|
360
546
|
|
361
547
|
|
362
|
-
#### [Get Catalog Items](https://developers.klaviyo.com/en/
|
548
|
+
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_items)
|
363
549
|
|
364
550
|
```ruby
|
365
551
|
KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
@@ -369,7 +555,7 @@ KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
|
369
555
|
|
370
556
|
|
371
557
|
|
372
|
-
#### [Get Catalog Variant](https://developers.klaviyo.com/en/
|
558
|
+
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_variant)
|
373
559
|
|
374
560
|
```ruby
|
375
561
|
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
@@ -379,7 +565,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
|
379
565
|
|
380
566
|
|
381
567
|
|
382
|
-
#### [Get Catalog Variants](https://developers.klaviyo.com/en/
|
568
|
+
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2023-02-22/reference/get_catalog_variants)
|
383
569
|
|
384
570
|
```ruby
|
385
571
|
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
@@ -389,7 +575,7 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
|
389
575
|
|
390
576
|
|
391
577
|
|
392
|
-
#### [Get Create Categories Job](https://developers.klaviyo.com/en/
|
578
|
+
#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_create_categories_job)
|
393
579
|
|
394
580
|
```ruby
|
395
581
|
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
@@ -399,7 +585,7 @@ KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
|
399
585
|
|
400
586
|
|
401
587
|
|
402
|
-
#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/
|
588
|
+
#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_create_categories_jobs)
|
403
589
|
|
404
590
|
```ruby
|
405
591
|
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
@@ -409,7 +595,7 @@ KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
|
409
595
|
|
410
596
|
|
411
597
|
|
412
|
-
#### [Get Create Items Job](https://developers.klaviyo.com/en/
|
598
|
+
#### [Get Create Items Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_create_items_job)
|
413
599
|
|
414
600
|
```ruby
|
415
601
|
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
@@ -419,7 +605,7 @@ KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
|
419
605
|
|
420
606
|
|
421
607
|
|
422
|
-
#### [Get Create Items Jobs](https://developers.klaviyo.com/en/
|
608
|
+
#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_create_items_jobs)
|
423
609
|
|
424
610
|
```ruby
|
425
611
|
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
@@ -429,7 +615,7 @@ KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
|
429
615
|
|
430
616
|
|
431
617
|
|
432
|
-
#### [Get Create Variants Job](https://developers.klaviyo.com/en/
|
618
|
+
#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_create_variants_job)
|
433
619
|
|
434
620
|
```ruby
|
435
621
|
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
@@ -439,7 +625,7 @@ KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
|
439
625
|
|
440
626
|
|
441
627
|
|
442
|
-
#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/
|
628
|
+
#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_create_variants_jobs)
|
443
629
|
|
444
630
|
```ruby
|
445
631
|
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
@@ -449,7 +635,7 @@ KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
|
449
635
|
|
450
636
|
|
451
637
|
|
452
|
-
#### [Get Delete Categories Job](https://developers.klaviyo.com/en/
|
638
|
+
#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_delete_categories_job)
|
453
639
|
|
454
640
|
```ruby
|
455
641
|
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
@@ -459,7 +645,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
|
459
645
|
|
460
646
|
|
461
647
|
|
462
|
-
#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/
|
648
|
+
#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_delete_categories_jobs)
|
463
649
|
|
464
650
|
```ruby
|
465
651
|
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
@@ -469,7 +655,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
|
469
655
|
|
470
656
|
|
471
657
|
|
472
|
-
#### [Get Delete Items Job](https://developers.klaviyo.com/en/
|
658
|
+
#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_delete_items_job)
|
473
659
|
|
474
660
|
```ruby
|
475
661
|
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
@@ -479,7 +665,7 @@ KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
|
479
665
|
|
480
666
|
|
481
667
|
|
482
|
-
#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/
|
668
|
+
#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_delete_items_jobs)
|
483
669
|
|
484
670
|
```ruby
|
485
671
|
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
@@ -489,7 +675,7 @@ KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
|
489
675
|
|
490
676
|
|
491
677
|
|
492
|
-
#### [Get Delete Variants Job](https://developers.klaviyo.com/en/
|
678
|
+
#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_delete_variants_job)
|
493
679
|
|
494
680
|
```ruby
|
495
681
|
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
@@ -499,7 +685,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
|
499
685
|
|
500
686
|
|
501
687
|
|
502
|
-
#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/
|
688
|
+
#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_delete_variants_jobs)
|
503
689
|
|
504
690
|
```ruby
|
505
691
|
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
@@ -509,7 +695,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
|
509
695
|
|
510
696
|
|
511
697
|
|
512
|
-
#### [Get Update Categories Job](https://developers.klaviyo.com/en/
|
698
|
+
#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_update_categories_job)
|
513
699
|
|
514
700
|
```ruby
|
515
701
|
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
@@ -519,7 +705,7 @@ KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
|
519
705
|
|
520
706
|
|
521
707
|
|
522
|
-
#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/
|
708
|
+
#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_update_categories_jobs)
|
523
709
|
|
524
710
|
```ruby
|
525
711
|
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
@@ -529,7 +715,7 @@ KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
|
529
715
|
|
530
716
|
|
531
717
|
|
532
|
-
#### [Get Update Items Job](https://developers.klaviyo.com/en/
|
718
|
+
#### [Get Update Items Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_update_items_job)
|
533
719
|
|
534
720
|
```ruby
|
535
721
|
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
@@ -539,7 +725,7 @@ KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
|
539
725
|
|
540
726
|
|
541
727
|
|
542
|
-
#### [Get Update Items Jobs](https://developers.klaviyo.com/en/
|
728
|
+
#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_update_items_jobs)
|
543
729
|
|
544
730
|
```ruby
|
545
731
|
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
@@ -549,7 +735,7 @@ KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
|
549
735
|
|
550
736
|
|
551
737
|
|
552
|
-
#### [Get Update Variants Job](https://developers.klaviyo.com/en/
|
738
|
+
#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2023-02-22/reference/get_update_variants_job)
|
553
739
|
|
554
740
|
```ruby
|
555
741
|
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
@@ -559,7 +745,7 @@ KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
|
559
745
|
|
560
746
|
|
561
747
|
|
562
|
-
#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/
|
748
|
+
#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-02-22/reference/get_update_variants_jobs)
|
563
749
|
|
564
750
|
```ruby
|
565
751
|
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
@@ -569,7 +755,7 @@ KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
|
569
755
|
|
570
756
|
|
571
757
|
|
572
|
-
#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/
|
758
|
+
#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_create_categories_job)
|
573
759
|
|
574
760
|
```ruby
|
575
761
|
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
@@ -579,7 +765,7 @@ KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
|
579
765
|
|
580
766
|
|
581
767
|
|
582
|
-
#### [Spawn Create Items Job](https://developers.klaviyo.com/en/
|
768
|
+
#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_create_items_job)
|
583
769
|
|
584
770
|
```ruby
|
585
771
|
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
@@ -589,7 +775,7 @@ KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
|
589
775
|
|
590
776
|
|
591
777
|
|
592
|
-
#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/
|
778
|
+
#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_create_variants_job)
|
593
779
|
|
594
780
|
```ruby
|
595
781
|
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
@@ -599,7 +785,7 @@ KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
|
599
785
|
|
600
786
|
|
601
787
|
|
602
|
-
#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/
|
788
|
+
#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_delete_categories_job)
|
603
789
|
|
604
790
|
```ruby
|
605
791
|
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
@@ -609,7 +795,7 @@ KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
|
609
795
|
|
610
796
|
|
611
797
|
|
612
|
-
#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/
|
798
|
+
#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_delete_items_job)
|
613
799
|
|
614
800
|
```ruby
|
615
801
|
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
@@ -619,7 +805,7 @@ KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
|
619
805
|
|
620
806
|
|
621
807
|
|
622
|
-
#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/
|
808
|
+
#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_delete_variants_job)
|
623
809
|
|
624
810
|
```ruby
|
625
811
|
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
@@ -629,7 +815,7 @@ KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
|
629
815
|
|
630
816
|
|
631
817
|
|
632
|
-
#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/
|
818
|
+
#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_update_categories_job)
|
633
819
|
|
634
820
|
```ruby
|
635
821
|
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
@@ -639,7 +825,7 @@ KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
|
639
825
|
|
640
826
|
|
641
827
|
|
642
|
-
#### [Spawn Update Items Job](https://developers.klaviyo.com/en/
|
828
|
+
#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_update_items_job)
|
643
829
|
|
644
830
|
```ruby
|
645
831
|
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
@@ -649,7 +835,7 @@ KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
|
649
835
|
|
650
836
|
|
651
837
|
|
652
|
-
#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/
|
838
|
+
#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-02-22/reference/spawn_update_variants_job)
|
653
839
|
|
654
840
|
```ruby
|
655
841
|
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
@@ -659,7 +845,7 @@ KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
|
659
845
|
|
660
846
|
|
661
847
|
|
662
|
-
#### [Update Catalog Category](https://developers.klaviyo.com/en/
|
848
|
+
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2023-02-22/reference/update_catalog_category)
|
663
849
|
|
664
850
|
```ruby
|
665
851
|
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
@@ -669,7 +855,7 @@ KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
|
669
855
|
|
670
856
|
|
671
857
|
|
672
|
-
#### [Update Catalog Category Relationships](https://developers.klaviyo.com/en/
|
858
|
+
#### [Update Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/update_catalog_category_relationships)
|
673
859
|
|
674
860
|
```ruby
|
675
861
|
KlaviyoAPI::Catalogs.update_catalog_category_relationships(id, related_resource, body)
|
@@ -679,7 +865,7 @@ KlaviyoAPI::Catalogs.update_catalog_category_relationships(id, related_resource,
|
|
679
865
|
|
680
866
|
|
681
867
|
|
682
|
-
#### [Update Catalog Item](https://developers.klaviyo.com/en/
|
868
|
+
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2023-02-22/reference/update_catalog_item)
|
683
869
|
|
684
870
|
```ruby
|
685
871
|
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
@@ -689,7 +875,7 @@ KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
|
689
875
|
|
690
876
|
|
691
877
|
|
692
|
-
#### [Update Catalog Item Relationships](https://developers.klaviyo.com/en/
|
878
|
+
#### [Update Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/update_catalog_item_relationships)
|
693
879
|
|
694
880
|
```ruby
|
695
881
|
KlaviyoAPI::Catalogs.update_catalog_item_relationships(id, related_resource, body)
|
@@ -699,7 +885,7 @@ KlaviyoAPI::Catalogs.update_catalog_item_relationships(id, related_resource, bod
|
|
699
885
|
|
700
886
|
|
701
887
|
|
702
|
-
#### [Update Catalog Variant](https://developers.klaviyo.com/en/
|
888
|
+
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2023-02-22/reference/update_catalog_variant)
|
703
889
|
|
704
890
|
```ruby
|
705
891
|
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
@@ -713,7 +899,7 @@ KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
|
713
899
|
## Client
|
714
900
|
|
715
901
|
|
716
|
-
#### [Create Client Event](https://developers.klaviyo.com/en/
|
902
|
+
#### [Create Client Event](https://developers.klaviyo.com/en/v2023-02-22/reference/create_client_event)
|
717
903
|
|
718
904
|
```ruby
|
719
905
|
KlaviyoAPI::Client.create_client_event(company_id, body)
|
@@ -723,7 +909,7 @@ KlaviyoAPI::Client.create_client_event(company_id, body)
|
|
723
909
|
|
724
910
|
|
725
911
|
|
726
|
-
#### [Create Client Profile](https://developers.klaviyo.com/en/
|
912
|
+
#### [Create or Update Client Profile](https://developers.klaviyo.com/en/v2023-02-22/reference/create_client_profile)
|
727
913
|
|
728
914
|
```ruby
|
729
915
|
KlaviyoAPI::Client.create_client_profile(company_id, body)
|
@@ -733,7 +919,7 @@ KlaviyoAPI::Client.create_client_profile(company_id, body)
|
|
733
919
|
|
734
920
|
|
735
921
|
|
736
|
-
#### [Create Client Subscription](https://developers.klaviyo.com/en/
|
922
|
+
#### [Create Client Subscription](https://developers.klaviyo.com/en/v2023-02-22/reference/create_client_subscription)
|
737
923
|
|
738
924
|
```ruby
|
739
925
|
KlaviyoAPI::Client.create_client_subscription(company_id, body)
|
@@ -744,10 +930,24 @@ KlaviyoAPI::Client.create_client_subscription(company_id, body)
|
|
744
930
|
|
745
931
|
|
746
932
|
|
933
|
+
## Data Privacy
|
934
|
+
|
935
|
+
|
936
|
+
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2023-02-22/reference/request_profile_deletion)
|
937
|
+
|
938
|
+
```ruby
|
939
|
+
KlaviyoAPI::Data Privacy.request_profile_deletion(body)
|
940
|
+
```
|
941
|
+
|
942
|
+
|
943
|
+
|
944
|
+
|
945
|
+
|
946
|
+
|
747
947
|
## Events
|
748
948
|
|
749
949
|
|
750
|
-
#### [Create Event](https://developers.klaviyo.com/en/
|
950
|
+
#### [Create Event](https://developers.klaviyo.com/en/v2023-02-22/reference/create_event)
|
751
951
|
|
752
952
|
```ruby
|
753
953
|
KlaviyoAPI::Events.create_event(body)
|
@@ -757,7 +957,7 @@ KlaviyoAPI::Events.create_event(body)
|
|
757
957
|
|
758
958
|
|
759
959
|
|
760
|
-
#### [Get Event](https://developers.klaviyo.com/en/
|
960
|
+
#### [Get Event](https://developers.klaviyo.com/en/v2023-02-22/reference/get_event)
|
761
961
|
|
762
962
|
```ruby
|
763
963
|
KlaviyoAPI::Events.get_event(id, opts)
|
@@ -767,7 +967,7 @@ KlaviyoAPI::Events.get_event(id, opts)
|
|
767
967
|
|
768
968
|
|
769
969
|
|
770
|
-
#### [Get Event Metrics](https://developers.klaviyo.com/en/
|
970
|
+
#### [Get Event Metrics](https://developers.klaviyo.com/en/v2023-02-22/reference/get_event_metrics)
|
771
971
|
|
772
972
|
```ruby
|
773
973
|
KlaviyoAPI::Events.get_event_metrics(id, opts)
|
@@ -777,7 +977,7 @@ KlaviyoAPI::Events.get_event_metrics(id, opts)
|
|
777
977
|
|
778
978
|
|
779
979
|
|
780
|
-
#### [Get Event Profiles](https://developers.klaviyo.com/en/
|
980
|
+
#### [Get Event Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/get_event_profiles)
|
781
981
|
|
782
982
|
```ruby
|
783
983
|
KlaviyoAPI::Events.get_event_profiles(id, opts)
|
@@ -787,7 +987,7 @@ KlaviyoAPI::Events.get_event_profiles(id, opts)
|
|
787
987
|
|
788
988
|
|
789
989
|
|
790
|
-
#### [Get Event Relationships](https://developers.klaviyo.com/en/
|
990
|
+
#### [Get Event Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_event_relationships)
|
791
991
|
|
792
992
|
```ruby
|
793
993
|
KlaviyoAPI::Events.get_event_relationships(id, related_resource)
|
@@ -797,7 +997,7 @@ KlaviyoAPI::Events.get_event_relationships(id, related_resource)
|
|
797
997
|
|
798
998
|
|
799
999
|
|
800
|
-
#### [Get Events](https://developers.klaviyo.com/en/
|
1000
|
+
#### [Get Events](https://developers.klaviyo.com/en/v2023-02-22/reference/get_events)
|
801
1001
|
|
802
1002
|
```ruby
|
803
1003
|
KlaviyoAPI::Events.get_events(opts)
|
@@ -811,7 +1011,7 @@ KlaviyoAPI::Events.get_events(opts)
|
|
811
1011
|
## Flows
|
812
1012
|
|
813
1013
|
|
814
|
-
#### [Get Flow](https://developers.klaviyo.com/en/
|
1014
|
+
#### [Get Flow](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow)
|
815
1015
|
|
816
1016
|
```ruby
|
817
1017
|
KlaviyoAPI::Flows.get_flow(id, opts)
|
@@ -821,7 +1021,7 @@ KlaviyoAPI::Flows.get_flow(id, opts)
|
|
821
1021
|
|
822
1022
|
|
823
1023
|
|
824
|
-
#### [Get Flow Action](https://developers.klaviyo.com/en/
|
1024
|
+
#### [Get Flow Action](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_action)
|
825
1025
|
|
826
1026
|
```ruby
|
827
1027
|
KlaviyoAPI::Flows.get_flow_action(id, opts)
|
@@ -831,7 +1031,7 @@ KlaviyoAPI::Flows.get_flow_action(id, opts)
|
|
831
1031
|
|
832
1032
|
|
833
1033
|
|
834
|
-
#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/
|
1034
|
+
#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_action_flow)
|
835
1035
|
|
836
1036
|
```ruby
|
837
1037
|
KlaviyoAPI::Flows.get_flow_action_flow(action_id, opts)
|
@@ -841,7 +1041,7 @@ KlaviyoAPI::Flows.get_flow_action_flow(action_id, opts)
|
|
841
1041
|
|
842
1042
|
|
843
1043
|
|
844
|
-
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/
|
1044
|
+
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_action_messages)
|
845
1045
|
|
846
1046
|
```ruby
|
847
1047
|
KlaviyoAPI::Flows.get_flow_action_messages(action_id, opts)
|
@@ -851,7 +1051,7 @@ KlaviyoAPI::Flows.get_flow_action_messages(action_id, opts)
|
|
851
1051
|
|
852
1052
|
|
853
1053
|
|
854
|
-
#### [Get Flow Action Relationships](https://developers.klaviyo.com/en/
|
1054
|
+
#### [Get Flow Action Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_action_relationships)
|
855
1055
|
|
856
1056
|
```ruby
|
857
1057
|
KlaviyoAPI::Flows.get_flow_action_relationships(id, related_resource, opts)
|
@@ -861,7 +1061,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships(id, related_resource, opts)
|
|
861
1061
|
|
862
1062
|
|
863
1063
|
|
864
|
-
#### [Get Flow Actions For Flow](https://developers.klaviyo.com/en/
|
1064
|
+
#### [Get Flow Actions For Flow](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_flow_actions)
|
865
1065
|
|
866
1066
|
```ruby
|
867
1067
|
KlaviyoAPI::Flows.get_flow_flow_actions(flow_id, opts)
|
@@ -871,7 +1071,7 @@ KlaviyoAPI::Flows.get_flow_flow_actions(flow_id, opts)
|
|
871
1071
|
|
872
1072
|
|
873
1073
|
|
874
|
-
#### [Get Flow Message](https://developers.klaviyo.com/en/
|
1074
|
+
#### [Get Flow Message](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_message)
|
875
1075
|
|
876
1076
|
```ruby
|
877
1077
|
KlaviyoAPI::Flows.get_flow_message(id, opts)
|
@@ -881,7 +1081,7 @@ KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
881
1081
|
|
882
1082
|
|
883
1083
|
|
884
|
-
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/
|
1084
|
+
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_message_action)
|
885
1085
|
|
886
1086
|
```ruby
|
887
1087
|
KlaviyoAPI::Flows.get_flow_message_action(message_id, opts)
|
@@ -891,7 +1091,7 @@ KlaviyoAPI::Flows.get_flow_message_action(message_id, opts)
|
|
891
1091
|
|
892
1092
|
|
893
1093
|
|
894
|
-
#### [Get Flow Message Relationships](https://developers.klaviyo.com/en/
|
1094
|
+
#### [Get Flow Message Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_message_relationships)
|
895
1095
|
|
896
1096
|
```ruby
|
897
1097
|
KlaviyoAPI::Flows.get_flow_message_relationships(id, related_resource)
|
@@ -901,17 +1101,27 @@ KlaviyoAPI::Flows.get_flow_message_relationships(id, related_resource)
|
|
901
1101
|
|
902
1102
|
|
903
1103
|
|
904
|
-
#### [Get Flow Relationships](https://developers.klaviyo.com/en/
|
1104
|
+
#### [Get Flow Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_relationships)
|
1105
|
+
|
1106
|
+
```ruby
|
1107
|
+
KlaviyoAPI::Flows.get_flow_relationships(id, related_resource)
|
1108
|
+
```
|
1109
|
+
|
1110
|
+
|
1111
|
+
|
1112
|
+
|
1113
|
+
|
1114
|
+
#### [Get Flow Tags](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flow_tags)
|
905
1115
|
|
906
1116
|
```ruby
|
907
|
-
KlaviyoAPI::Flows.
|
1117
|
+
KlaviyoAPI::Flows.get_flow_tags(flow_id, opts)
|
908
1118
|
```
|
909
1119
|
|
910
1120
|
|
911
1121
|
|
912
1122
|
|
913
1123
|
|
914
|
-
#### [Get Flows](https://developers.klaviyo.com/en/
|
1124
|
+
#### [Get Flows](https://developers.klaviyo.com/en/v2023-02-22/reference/get_flows)
|
915
1125
|
|
916
1126
|
```ruby
|
917
1127
|
KlaviyoAPI::Flows.get_flows(opts)
|
@@ -921,7 +1131,7 @@ KlaviyoAPI::Flows.get_flows(opts)
|
|
921
1131
|
|
922
1132
|
|
923
1133
|
|
924
|
-
#### [Update Flow Status](https://developers.klaviyo.com/en/
|
1134
|
+
#### [Update Flow Status](https://developers.klaviyo.com/en/v2023-02-22/reference/update_flow)
|
925
1135
|
|
926
1136
|
```ruby
|
927
1137
|
KlaviyoAPI::Flows.update_flow(id, body)
|
@@ -935,7 +1145,7 @@ KlaviyoAPI::Flows.update_flow(id, body)
|
|
935
1145
|
## Lists
|
936
1146
|
|
937
1147
|
|
938
|
-
#### [Create List](https://developers.klaviyo.com/en/
|
1148
|
+
#### [Create List](https://developers.klaviyo.com/en/v2023-02-22/reference/create_list)
|
939
1149
|
|
940
1150
|
```ruby
|
941
1151
|
KlaviyoAPI::Lists.create_list(body)
|
@@ -945,7 +1155,7 @@ KlaviyoAPI::Lists.create_list(body)
|
|
945
1155
|
|
946
1156
|
|
947
1157
|
|
948
|
-
#### [Add Profile to List](https://developers.klaviyo.com/en/
|
1158
|
+
#### [Add Profile to List](https://developers.klaviyo.com/en/v2023-02-22/reference/create_list_relationships)
|
949
1159
|
|
950
1160
|
```ruby
|
951
1161
|
KlaviyoAPI::Lists.create_list_relationships(id, related_resource, body)
|
@@ -955,7 +1165,7 @@ KlaviyoAPI::Lists.create_list_relationships(id, related_resource, body)
|
|
955
1165
|
|
956
1166
|
|
957
1167
|
|
958
|
-
#### [Delete List](https://developers.klaviyo.com/en/
|
1168
|
+
#### [Delete List](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_list)
|
959
1169
|
|
960
1170
|
```ruby
|
961
1171
|
KlaviyoAPI::Lists.delete_list(id)
|
@@ -965,7 +1175,7 @@ KlaviyoAPI::Lists.delete_list(id)
|
|
965
1175
|
|
966
1176
|
|
967
1177
|
|
968
|
-
#### [Remove Profile from List](https://developers.klaviyo.com/en/
|
1178
|
+
#### [Remove Profile from List](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_list_relationships)
|
969
1179
|
|
970
1180
|
```ruby
|
971
1181
|
KlaviyoAPI::Lists.delete_list_relationships(id, related_resource, body)
|
@@ -975,7 +1185,7 @@ KlaviyoAPI::Lists.delete_list_relationships(id, related_resource, body)
|
|
975
1185
|
|
976
1186
|
|
977
1187
|
|
978
|
-
#### [Get List](https://developers.klaviyo.com/en/
|
1188
|
+
#### [Get List](https://developers.klaviyo.com/en/v2023-02-22/reference/get_list)
|
979
1189
|
|
980
1190
|
```ruby
|
981
1191
|
KlaviyoAPI::Lists.get_list(id, opts)
|
@@ -985,7 +1195,7 @@ KlaviyoAPI::Lists.get_list(id, opts)
|
|
985
1195
|
|
986
1196
|
|
987
1197
|
|
988
|
-
#### [Get List Profiles](https://developers.klaviyo.com/en/
|
1198
|
+
#### [Get List Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/get_list_profiles)
|
989
1199
|
|
990
1200
|
```ruby
|
991
1201
|
KlaviyoAPI::Lists.get_list_profiles(list_id, opts)
|
@@ -995,7 +1205,7 @@ KlaviyoAPI::Lists.get_list_profiles(list_id, opts)
|
|
995
1205
|
|
996
1206
|
|
997
1207
|
|
998
|
-
#### [Get List
|
1208
|
+
#### [Get List Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_list_relationships)
|
999
1209
|
|
1000
1210
|
```ruby
|
1001
1211
|
KlaviyoAPI::Lists.get_list_relationships(id, related_resource, opts)
|
@@ -1005,7 +1215,17 @@ KlaviyoAPI::Lists.get_list_relationships(id, related_resource, opts)
|
|
1005
1215
|
|
1006
1216
|
|
1007
1217
|
|
1008
|
-
#### [Get
|
1218
|
+
#### [Get List Tags](https://developers.klaviyo.com/en/v2023-02-22/reference/get_list_tags)
|
1219
|
+
|
1220
|
+
```ruby
|
1221
|
+
KlaviyoAPI::Lists.get_list_tags(list_id, opts)
|
1222
|
+
```
|
1223
|
+
|
1224
|
+
|
1225
|
+
|
1226
|
+
|
1227
|
+
|
1228
|
+
#### [Get Lists](https://developers.klaviyo.com/en/v2023-02-22/reference/get_lists)
|
1009
1229
|
|
1010
1230
|
```ruby
|
1011
1231
|
KlaviyoAPI::Lists.get_lists(opts)
|
@@ -1015,7 +1235,7 @@ KlaviyoAPI::Lists.get_lists(opts)
|
|
1015
1235
|
|
1016
1236
|
|
1017
1237
|
|
1018
|
-
#### [Update List](https://developers.klaviyo.com/en/
|
1238
|
+
#### [Update List](https://developers.klaviyo.com/en/v2023-02-22/reference/update_list)
|
1019
1239
|
|
1020
1240
|
```ruby
|
1021
1241
|
KlaviyoAPI::Lists.update_list(id, body)
|
@@ -1029,7 +1249,7 @@ KlaviyoAPI::Lists.update_list(id, body)
|
|
1029
1249
|
## Metrics
|
1030
1250
|
|
1031
1251
|
|
1032
|
-
#### [Get Metric](https://developers.klaviyo.com/en/
|
1252
|
+
#### [Get Metric](https://developers.klaviyo.com/en/v2023-02-22/reference/get_metric)
|
1033
1253
|
|
1034
1254
|
```ruby
|
1035
1255
|
KlaviyoAPI::Metrics.get_metric(id, opts)
|
@@ -1039,7 +1259,7 @@ KlaviyoAPI::Metrics.get_metric(id, opts)
|
|
1039
1259
|
|
1040
1260
|
|
1041
1261
|
|
1042
|
-
#### [Get Metrics](https://developers.klaviyo.com/en/
|
1262
|
+
#### [Get Metrics](https://developers.klaviyo.com/en/v2023-02-22/reference/get_metrics)
|
1043
1263
|
|
1044
1264
|
```ruby
|
1045
1265
|
KlaviyoAPI::Metrics.get_metrics(opts)
|
@@ -1049,7 +1269,7 @@ KlaviyoAPI::Metrics.get_metrics(opts)
|
|
1049
1269
|
|
1050
1270
|
|
1051
1271
|
|
1052
|
-
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/
|
1272
|
+
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-02-22/reference/query_metric_aggregates)
|
1053
1273
|
|
1054
1274
|
```ruby
|
1055
1275
|
KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
@@ -1063,7 +1283,7 @@ KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
|
1063
1283
|
## Profiles
|
1064
1284
|
|
1065
1285
|
|
1066
|
-
#### [Create Profile](https://developers.klaviyo.com/en/
|
1286
|
+
#### [Create Profile](https://developers.klaviyo.com/en/v2023-02-22/reference/create_profile)
|
1067
1287
|
|
1068
1288
|
```ruby
|
1069
1289
|
KlaviyoAPI::Profiles.create_profile(body)
|
@@ -1073,7 +1293,7 @@ KlaviyoAPI::Profiles.create_profile(body)
|
|
1073
1293
|
|
1074
1294
|
|
1075
1295
|
|
1076
|
-
#### [Get Profile](https://developers.klaviyo.com/en/
|
1296
|
+
#### [Get Profile](https://developers.klaviyo.com/en/v2023-02-22/reference/get_profile)
|
1077
1297
|
|
1078
1298
|
```ruby
|
1079
1299
|
KlaviyoAPI::Profiles.get_profile(id, opts)
|
@@ -1083,7 +1303,7 @@ KlaviyoAPI::Profiles.get_profile(id, opts)
|
|
1083
1303
|
|
1084
1304
|
|
1085
1305
|
|
1086
|
-
#### [Get Profile Lists](https://developers.klaviyo.com/en/
|
1306
|
+
#### [Get Profile Lists](https://developers.klaviyo.com/en/v2023-02-22/reference/get_profile_lists)
|
1087
1307
|
|
1088
1308
|
```ruby
|
1089
1309
|
KlaviyoAPI::Profiles.get_profile_lists(profile_id, opts)
|
@@ -1093,7 +1313,7 @@ KlaviyoAPI::Profiles.get_profile_lists(profile_id, opts)
|
|
1093
1313
|
|
1094
1314
|
|
1095
1315
|
|
1096
|
-
#### [Get Profile Relationships](https://developers.klaviyo.com/en/
|
1316
|
+
#### [Get Profile Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_profile_relationships)
|
1097
1317
|
|
1098
1318
|
```ruby
|
1099
1319
|
KlaviyoAPI::Profiles.get_profile_relationships(id, related_resource)
|
@@ -1103,7 +1323,7 @@ KlaviyoAPI::Profiles.get_profile_relationships(id, related_resource)
|
|
1103
1323
|
|
1104
1324
|
|
1105
1325
|
|
1106
|
-
#### [Get Profile Segments](https://developers.klaviyo.com/en/
|
1326
|
+
#### [Get Profile Segments](https://developers.klaviyo.com/en/v2023-02-22/reference/get_profile_segments)
|
1107
1327
|
|
1108
1328
|
```ruby
|
1109
1329
|
KlaviyoAPI::Profiles.get_profile_segments(profile_id, opts)
|
@@ -1113,7 +1333,7 @@ KlaviyoAPI::Profiles.get_profile_segments(profile_id, opts)
|
|
1113
1333
|
|
1114
1334
|
|
1115
1335
|
|
1116
|
-
#### [Get Profiles](https://developers.klaviyo.com/en/
|
1336
|
+
#### [Get Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/get_profiles)
|
1117
1337
|
|
1118
1338
|
```ruby
|
1119
1339
|
KlaviyoAPI::Profiles.get_profiles(opts)
|
@@ -1123,7 +1343,7 @@ KlaviyoAPI::Profiles.get_profiles(opts)
|
|
1123
1343
|
|
1124
1344
|
|
1125
1345
|
|
1126
|
-
#### [Subscribe Profiles](https://developers.klaviyo.com/en/
|
1346
|
+
#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/subscribe_profiles)
|
1127
1347
|
|
1128
1348
|
```ruby
|
1129
1349
|
KlaviyoAPI::Profiles.subscribe_profiles(body)
|
@@ -1133,7 +1353,7 @@ KlaviyoAPI::Profiles.subscribe_profiles(body)
|
|
1133
1353
|
|
1134
1354
|
|
1135
1355
|
|
1136
|
-
#### [Suppress Profiles](https://developers.klaviyo.com/en/
|
1356
|
+
#### [Suppress Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/suppress_profiles)
|
1137
1357
|
|
1138
1358
|
```ruby
|
1139
1359
|
KlaviyoAPI::Profiles.suppress_profiles(body)
|
@@ -1143,7 +1363,7 @@ KlaviyoAPI::Profiles.suppress_profiles(body)
|
|
1143
1363
|
|
1144
1364
|
|
1145
1365
|
|
1146
|
-
#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/
|
1366
|
+
#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/unsubscribe_profiles)
|
1147
1367
|
|
1148
1368
|
```ruby
|
1149
1369
|
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
@@ -1153,7 +1373,7 @@ KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
|
1153
1373
|
|
1154
1374
|
|
1155
1375
|
|
1156
|
-
#### [Unsuppress Profiles](https://developers.klaviyo.com/en/
|
1376
|
+
#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/unsuppress_profiles)
|
1157
1377
|
|
1158
1378
|
```ruby
|
1159
1379
|
KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
@@ -1163,7 +1383,7 @@ KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
|
1163
1383
|
|
1164
1384
|
|
1165
1385
|
|
1166
|
-
#### [Update Profile](https://developers.klaviyo.com/en/
|
1386
|
+
#### [Update Profile](https://developers.klaviyo.com/en/v2023-02-22/reference/update_profile)
|
1167
1387
|
|
1168
1388
|
```ruby
|
1169
1389
|
KlaviyoAPI::Profiles.update_profile(id, body)
|
@@ -1177,7 +1397,7 @@ KlaviyoAPI::Profiles.update_profile(id, body)
|
|
1177
1397
|
## Segments
|
1178
1398
|
|
1179
1399
|
|
1180
|
-
#### [Get Segment](https://developers.klaviyo.com/en/
|
1400
|
+
#### [Get Segment](https://developers.klaviyo.com/en/v2023-02-22/reference/get_segment)
|
1181
1401
|
|
1182
1402
|
```ruby
|
1183
1403
|
KlaviyoAPI::Segments.get_segment(id, opts)
|
@@ -1187,7 +1407,7 @@ KlaviyoAPI::Segments.get_segment(id, opts)
|
|
1187
1407
|
|
1188
1408
|
|
1189
1409
|
|
1190
|
-
#### [Get Segment Profiles](https://developers.klaviyo.com/en/
|
1410
|
+
#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2023-02-22/reference/get_segment_profiles)
|
1191
1411
|
|
1192
1412
|
```ruby
|
1193
1413
|
KlaviyoAPI::Segments.get_segment_profiles(segment_id, opts)
|
@@ -1197,7 +1417,7 @@ KlaviyoAPI::Segments.get_segment_profiles(segment_id, opts)
|
|
1197
1417
|
|
1198
1418
|
|
1199
1419
|
|
1200
|
-
#### [Get Segment Relationships](https://developers.klaviyo.com/en/
|
1420
|
+
#### [Get Segment Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_segment_relationships)
|
1201
1421
|
|
1202
1422
|
```ruby
|
1203
1423
|
KlaviyoAPI::Segments.get_segment_relationships(id, related_resource, opts)
|
@@ -1207,7 +1427,17 @@ KlaviyoAPI::Segments.get_segment_relationships(id, related_resource, opts)
|
|
1207
1427
|
|
1208
1428
|
|
1209
1429
|
|
1210
|
-
#### [Get
|
1430
|
+
#### [Get Segment Tags](https://developers.klaviyo.com/en/v2023-02-22/reference/get_segment_tags)
|
1431
|
+
|
1432
|
+
```ruby
|
1433
|
+
KlaviyoAPI::Segments.get_segment_tags(segment_id, opts)
|
1434
|
+
```
|
1435
|
+
|
1436
|
+
|
1437
|
+
|
1438
|
+
|
1439
|
+
|
1440
|
+
#### [Get Segments](https://developers.klaviyo.com/en/v2023-02-22/reference/get_segments)
|
1211
1441
|
|
1212
1442
|
```ruby
|
1213
1443
|
KlaviyoAPI::Segments.get_segments(opts)
|
@@ -1217,7 +1447,7 @@ KlaviyoAPI::Segments.get_segments(opts)
|
|
1217
1447
|
|
1218
1448
|
|
1219
1449
|
|
1220
|
-
#### [Update Segment](https://developers.klaviyo.com/en/
|
1450
|
+
#### [Update Segment](https://developers.klaviyo.com/en/v2023-02-22/reference/update_segment)
|
1221
1451
|
|
1222
1452
|
```ruby
|
1223
1453
|
KlaviyoAPI::Segments.update_segment(id, body)
|
@@ -1228,10 +1458,174 @@ KlaviyoAPI::Segments.update_segment(id, body)
|
|
1228
1458
|
|
1229
1459
|
|
1230
1460
|
|
1461
|
+
## Tags
|
1462
|
+
|
1463
|
+
|
1464
|
+
#### [Create Tag](https://developers.klaviyo.com/en/v2023-02-22/reference/create_tag)
|
1465
|
+
|
1466
|
+
```ruby
|
1467
|
+
KlaviyoAPI::Tags.create_tag(body)
|
1468
|
+
```
|
1469
|
+
|
1470
|
+
|
1471
|
+
|
1472
|
+
|
1473
|
+
|
1474
|
+
#### [Create Tag Group](https://developers.klaviyo.com/en/v2023-02-22/reference/create_tag_group)
|
1475
|
+
|
1476
|
+
```ruby
|
1477
|
+
KlaviyoAPI::Tags.create_tag_group(body)
|
1478
|
+
```
|
1479
|
+
|
1480
|
+
|
1481
|
+
|
1482
|
+
|
1483
|
+
|
1484
|
+
#### [Create Tag Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/create_tag_relationships)
|
1485
|
+
|
1486
|
+
```ruby
|
1487
|
+
KlaviyoAPI::Tags.create_tag_relationships(id, related_resource, body)
|
1488
|
+
```
|
1489
|
+
|
1490
|
+
|
1491
|
+
|
1492
|
+
|
1493
|
+
|
1494
|
+
#### [Delete Tag](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_tag)
|
1495
|
+
|
1496
|
+
```ruby
|
1497
|
+
KlaviyoAPI::Tags.delete_tag(id)
|
1498
|
+
```
|
1499
|
+
|
1500
|
+
|
1501
|
+
|
1502
|
+
|
1503
|
+
|
1504
|
+
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_tag_group)
|
1505
|
+
|
1506
|
+
```ruby
|
1507
|
+
KlaviyoAPI::Tags.delete_tag_group(id)
|
1508
|
+
```
|
1509
|
+
|
1510
|
+
|
1511
|
+
|
1512
|
+
|
1513
|
+
|
1514
|
+
#### [Delete Tag Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_tag_relationships)
|
1515
|
+
|
1516
|
+
```ruby
|
1517
|
+
KlaviyoAPI::Tags.delete_tag_relationships(id, related_resource, body)
|
1518
|
+
```
|
1519
|
+
|
1520
|
+
|
1521
|
+
|
1522
|
+
|
1523
|
+
|
1524
|
+
#### [Get Tag](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag)
|
1525
|
+
|
1526
|
+
```ruby
|
1527
|
+
KlaviyoAPI::Tags.get_tag(id, opts)
|
1528
|
+
```
|
1529
|
+
|
1530
|
+
|
1531
|
+
|
1532
|
+
|
1533
|
+
|
1534
|
+
#### [Get Tag Group](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag_group)
|
1535
|
+
|
1536
|
+
```ruby
|
1537
|
+
KlaviyoAPI::Tags.get_tag_group(id, opts)
|
1538
|
+
```
|
1539
|
+
|
1540
|
+
|
1541
|
+
|
1542
|
+
|
1543
|
+
|
1544
|
+
#### [Get Tag Group Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag_group_relationships)
|
1545
|
+
|
1546
|
+
```ruby
|
1547
|
+
KlaviyoAPI::Tags.get_tag_group_relationships(id, related_resource)
|
1548
|
+
```
|
1549
|
+
|
1550
|
+
|
1551
|
+
|
1552
|
+
|
1553
|
+
|
1554
|
+
#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag_group_tags)
|
1555
|
+
|
1556
|
+
```ruby
|
1557
|
+
KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
|
1558
|
+
```
|
1559
|
+
|
1560
|
+
|
1561
|
+
|
1562
|
+
|
1563
|
+
|
1564
|
+
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag_groups)
|
1565
|
+
|
1566
|
+
```ruby
|
1567
|
+
KlaviyoAPI::Tags.get_tag_groups(opts)
|
1568
|
+
```
|
1569
|
+
|
1570
|
+
|
1571
|
+
|
1572
|
+
|
1573
|
+
|
1574
|
+
#### [Get Tag Relationships](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag_relationships)
|
1575
|
+
|
1576
|
+
```ruby
|
1577
|
+
KlaviyoAPI::Tags.get_tag_relationships(id, related_resource)
|
1578
|
+
```
|
1579
|
+
|
1580
|
+
|
1581
|
+
|
1582
|
+
|
1583
|
+
|
1584
|
+
#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tag_tag_group)
|
1585
|
+
|
1586
|
+
```ruby
|
1587
|
+
KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
|
1588
|
+
```
|
1589
|
+
|
1590
|
+
|
1591
|
+
|
1592
|
+
|
1593
|
+
|
1594
|
+
#### [Get Tags](https://developers.klaviyo.com/en/v2023-02-22/reference/get_tags)
|
1595
|
+
|
1596
|
+
```ruby
|
1597
|
+
KlaviyoAPI::Tags.get_tags(opts)
|
1598
|
+
```
|
1599
|
+
|
1600
|
+
|
1601
|
+
|
1602
|
+
|
1603
|
+
|
1604
|
+
#### [Update Tag](https://developers.klaviyo.com/en/v2023-02-22/reference/update_tag)
|
1605
|
+
|
1606
|
+
```ruby
|
1607
|
+
KlaviyoAPI::Tags.update_tag(id, body)
|
1608
|
+
```
|
1609
|
+
|
1610
|
+
|
1611
|
+
|
1612
|
+
|
1613
|
+
|
1614
|
+
#### [Update Tag Group](https://developers.klaviyo.com/en/v2023-02-22/reference/update_tag_group)
|
1615
|
+
|
1616
|
+
```ruby
|
1617
|
+
KlaviyoAPI::Tags.update_tag_group(id, body)
|
1618
|
+
```
|
1619
|
+
|
1620
|
+
|
1621
|
+
|
1622
|
+
|
1623
|
+
|
1624
|
+
|
1231
1625
|
## Templates
|
1232
1626
|
|
1233
1627
|
|
1234
|
-
#### [Create Template](https://developers.klaviyo.com/en/
|
1628
|
+
#### [Create Template](https://developers.klaviyo.com/en/v2023-02-22/reference/create_template)
|
1235
1629
|
|
1236
1630
|
```ruby
|
1237
1631
|
KlaviyoAPI::Templates.create_template(body)
|
@@ -1241,27 +1635,27 @@ KlaviyoAPI::Templates.create_template(body)
|
|
1241
1635
|
|
1242
1636
|
|
1243
1637
|
|
1244
|
-
#### [Create Template Clone](https://developers.klaviyo.com/en/
|
1638
|
+
#### [Create Template Clone](https://developers.klaviyo.com/en/v2023-02-22/reference/create_template_clone)
|
1245
1639
|
|
1246
1640
|
```ruby
|
1247
|
-
KlaviyoAPI::Templates.create_template_clone(
|
1641
|
+
KlaviyoAPI::Templates.create_template_clone(body)
|
1248
1642
|
```
|
1249
1643
|
|
1250
1644
|
|
1251
1645
|
|
1252
1646
|
|
1253
1647
|
|
1254
|
-
#### [Create Template Render](https://developers.klaviyo.com/en/
|
1648
|
+
#### [Create Template Render](https://developers.klaviyo.com/en/v2023-02-22/reference/create_template_render)
|
1255
1649
|
|
1256
1650
|
```ruby
|
1257
|
-
KlaviyoAPI::Templates.create_template_render(
|
1651
|
+
KlaviyoAPI::Templates.create_template_render(body)
|
1258
1652
|
```
|
1259
1653
|
|
1260
1654
|
|
1261
1655
|
|
1262
1656
|
|
1263
1657
|
|
1264
|
-
#### [Delete Template](https://developers.klaviyo.com/en/
|
1658
|
+
#### [Delete Template](https://developers.klaviyo.com/en/v2023-02-22/reference/delete_template)
|
1265
1659
|
|
1266
1660
|
```ruby
|
1267
1661
|
KlaviyoAPI::Templates.delete_template(id)
|
@@ -1271,7 +1665,7 @@ KlaviyoAPI::Templates.delete_template(id)
|
|
1271
1665
|
|
1272
1666
|
|
1273
1667
|
|
1274
|
-
#### [Get Template](https://developers.klaviyo.com/en/
|
1668
|
+
#### [Get Template](https://developers.klaviyo.com/en/v2023-02-22/reference/get_template)
|
1275
1669
|
|
1276
1670
|
```ruby
|
1277
1671
|
KlaviyoAPI::Templates.get_template(id, opts)
|
@@ -1281,7 +1675,7 @@ KlaviyoAPI::Templates.get_template(id, opts)
|
|
1281
1675
|
|
1282
1676
|
|
1283
1677
|
|
1284
|
-
#### [Get Templates](https://developers.klaviyo.com/en/
|
1678
|
+
#### [Get Templates](https://developers.klaviyo.com/en/v2023-02-22/reference/get_templates)
|
1285
1679
|
|
1286
1680
|
```ruby
|
1287
1681
|
KlaviyoAPI::Templates.get_templates(opts)
|
@@ -1291,7 +1685,7 @@ KlaviyoAPI::Templates.get_templates(opts)
|
|
1291
1685
|
|
1292
1686
|
|
1293
1687
|
|
1294
|
-
#### [Update Template](https://developers.klaviyo.com/en/
|
1688
|
+
#### [Update Template](https://developers.klaviyo.com/en/v2023-02-22/reference/update_template)
|
1295
1689
|
|
1296
1690
|
```ruby
|
1297
1691
|
KlaviyoAPI::Templates.update_template(id, body)
|