klaviyo-api-sdk 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +17 -0
- data/Gemfile +9 -0
- data/LICENSE.md +21 -0
- data/README.md +1316 -0
- data/Rakefile +10 -0
- data/docs/CatalogCategoryCreateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateQueryAsSubResource.md +22 -0
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +24 -0
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryItemOp.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryUpdateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +24 -0
- data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemCategoryOp.md +18 -0
- data/docs/CatalogItemCreateJobCreateQuery.md +18 -0
- data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemCreateQuery.md +18 -0
- data/docs/CatalogItemCreateQueryAsSubResource.md +22 -0
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +38 -0
- data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md +18 -0
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md +18 -0
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemDeleteQueryAsSubResource.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemUpdateQuery.md +18 -0
- data/docs/CatalogItemUpdateQueryAsSubResource.md +24 -0
- data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +32 -0
- data/docs/CatalogJobErrorPayload.md +26 -0
- data/docs/CatalogVariantCreateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogVariantCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateQueryAsSubResource.md +22 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +46 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md +18 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md +18 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogVariantUpdateQuery.md +18 -0
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +22 -0
- data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +38 -0
- data/docs/CatalogsApi.md +4048 -0
- data/docs/ClientApi.md +205 -0
- data/docs/EmailMessageContent.md +24 -0
- data/docs/EmailTrackingOptions.md +24 -0
- data/docs/ErrorSource.md +18 -0
- data/docs/EventCreateQuery.md +18 -0
- data/docs/EventCreateQueryAsSubResource.md +20 -0
- data/docs/EventCreateQueryAsSubResourceAttributes.md +28 -0
- data/docs/EventsApi.md +472 -0
- data/docs/FlowUpdateQuery.md +18 -0
- data/docs/FlowUpdateQueryAsSubResource.md +22 -0
- data/docs/FlowUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/FlowsApi.md +951 -0
- data/docs/GetCatalogItems4XXResponse.md +18 -0
- data/docs/GetCatalogItems4XXResponseErrorsInner.md +26 -0
- data/docs/GetCatalogItems4XXResponseErrorsInnerSource.md +20 -0
- data/docs/IncludedCategories.md +24 -0
- data/docs/IncludedCategoriesAttributes.md +22 -0
- data/docs/IncludedFlowAction.md +24 -0
- data/docs/IncludedFlowActions.md +24 -0
- data/docs/IncludedFlowActionsAttributes.md +32 -0
- data/docs/IncludedFlowActionsAttributesTrackingOptions.md +49 -0
- data/docs/IncludedFlowMessages.md +24 -0
- data/docs/IncludedFlowMessagesAttributes.md +26 -0
- data/docs/IncludedFlowMessagesAttributesContent.md +49 -0
- data/docs/IncludedFlows.md +24 -0
- data/docs/IncludedFlowsAttributes.md +28 -0
- data/docs/IncludedItems.md +24 -0
- data/docs/IncludedItemsAttributes.md +38 -0
- data/docs/IncludedLists.md +24 -0
- data/docs/IncludedListsAttributes.md +22 -0
- data/docs/IncludedMetrics.md +24 -0
- data/docs/IncludedMetricsAttributes.md +24 -0
- data/docs/IncludedProfile.md +24 -0
- data/docs/IncludedProfiles.md +24 -0
- data/docs/IncludedProfilesAttributes.md +44 -0
- data/docs/IncludedSegments.md +24 -0
- data/docs/IncludedVariants.md +24 -0
- data/docs/IncludedVariantsAttributes.md +46 -0
- data/docs/IncludedVariantsLinks.md +18 -0
- data/docs/ListCreateQuery.md +18 -0
- data/docs/ListCreateQueryAsSubResource.md +20 -0
- data/docs/ListCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/ListDeleteQueryAsSubResource.md +20 -0
- data/docs/ListMembersAddQuery.md +18 -0
- data/docs/ListMembersAddQueryDataInner.md +20 -0
- data/docs/ListMembersDeleteQuery.md +18 -0
- data/docs/ListPartialUpdateQuery.md +18 -0
- data/docs/ListPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/ListsApi.md +686 -0
- data/docs/MetricAggregateQuery.md +18 -0
- data/docs/MetricAggregateQueryAsSubResource.md +20 -0
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +36 -0
- data/docs/MetricAggregateRowDTO.md +20 -0
- data/docs/MetricCreateQuery.md +20 -0
- data/docs/MetricsApi.md +233 -0
- data/docs/OnsiteProfileCreateQuery.md +18 -0
- data/docs/OnsiteProfileCreateQueryAsSubResource.md +22 -0
- data/docs/OnsiteProfileMeta.md +18 -0
- data/docs/OnsiteProfileMetaIdentifiers.md +28 -0
- data/docs/OnsiteSubscriptionCreateQuery.md +18 -0
- data/docs/OnsiteSubscriptionCreateQueryAsSubResource.md +20 -0
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +26 -0
- data/docs/ProfileCreateQuery.md +18 -0
- data/docs/ProfileCreateQueryAsSubResource.md +20 -0
- data/docs/ProfileCreateQueryAsSubResourceAttributes.md +38 -0
- data/docs/ProfileLocation.md +34 -0
- data/docs/ProfileLocationLatitude.md +49 -0
- data/docs/ProfilePartialUpdateQuery.md +18 -0
- data/docs/ProfilePartialUpdateQueryAsSubResource.md +22 -0
- data/docs/ProfilesApi.md +825 -0
- data/docs/SMSMessageContent.md +20 -0
- data/docs/SMSRenderOptions.md +24 -0
- data/docs/SMSTrackingOptions.md +20 -0
- data/docs/SegmentPartialUpdateQuery.md +18 -0
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/SegmentsApi.md +390 -0
- data/docs/SendOptions.md +20 -0
- data/docs/Subscription.md +20 -0
- data/docs/SubscriptionCreateJobCreateQuery.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +22 -0
- data/docs/Suppression.md +18 -0
- data/docs/SuppressionCreateJobCreateQuery.md +18 -0
- data/docs/SuppressionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/TemplateCloneQuery.md +18 -0
- data/docs/TemplateCloneQueryAsSubResource.md +20 -0
- data/docs/TemplateCloneQueryAsSubResourceAttributes.md +20 -0
- data/docs/TemplateCreateQuery.md +18 -0
- data/docs/TemplateCreateQueryAsSubResource.md +20 -0
- data/docs/TemplateCreateQueryAsSubResourceAttributes.md +26 -0
- data/docs/TemplateDeleteQueryAsSubResource.md +20 -0
- data/docs/TemplateUpdateQuery.md +18 -0
- data/docs/TemplateUpdateQueryAsSubResource.md +22 -0
- data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +24 -0
- data/docs/TemplatesApi.md +529 -0
- data/docs/UnsubscriptionCreateJobCreateQuery.md +18 -0
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +22 -0
- data/docs/UnsuppressionCreateJobCreateQuery.md +18 -0
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/UtmParamInfo.md +20 -0
- data/docs/V2TemplateRenderQuery.md +18 -0
- data/docs/V2TemplateRenderQueryAsSubResource.md +20 -0
- data/docs/V2TemplateRenderQueryAsSubResourceAttributes.md +20 -0
- data/git_push.sh +57 -0
- data/klaviyo-api-sdk.gemspec +40 -0
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +4095 -0
- data/lib/klaviyo-api-sdk/api/client_api.rb +249 -0
- data/lib/klaviyo-api-sdk/api/events_api.rb +505 -0
- data/lib/klaviyo-api-sdk/api/flows_api.rb +1009 -0
- data/lib/klaviyo-api-sdk/api/lists_api.rb +708 -0
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +236 -0
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +840 -0
- data/lib/klaviyo-api-sdk/api/segments_api.rb +392 -0
- data/lib/klaviyo-api-sdk/api/templates_api.rb +536 -0
- data/lib/klaviyo-api-sdk/api_client.rb +390 -0
- data/lib/klaviyo-api-sdk/api_error.rb +57 -0
- data/lib/klaviyo-api-sdk/configuration.rb +283 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +291 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +295 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +366 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +295 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +284 -0
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +280 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +435 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +346 -0
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +266 -0
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +268 -0
- data/lib/klaviyo-api-sdk/models/error_source.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +279 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +226 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +275 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +228 -0
- data/lib/klaviyo-api-sdk/models/included_categories.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +282 -0
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +105 -0
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +270 -0
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +105 -0
- data/lib/klaviyo-api-sdk/models/included_flows.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +264 -0
- data/lib/klaviyo-api-sdk/models/included_items.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +311 -0
- data/lib/klaviyo-api-sdk/models/included_lists.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +246 -0
- data/lib/klaviyo-api-sdk/models/included_profile.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +336 -0
- data/lib/klaviyo-api-sdk/models/included_segments.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_variants.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +382 -0
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +226 -0
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +226 -0
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +380 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +240 -0
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +233 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +264 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +260 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +309 -0
- data/lib/klaviyo-api-sdk/models/profile_location.rb +291 -0
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +105 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/send_options.rb +238 -0
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +238 -0
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +266 -0
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +240 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +228 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +249 -0
- data/lib/klaviyo-api-sdk/models/suppression.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +267 -0
- data/lib/klaviyo-api-sdk/models/template_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +248 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +246 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +238 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/version.rb +15 -0
- data/lib/klaviyo-api-sdk.rb +253 -0
- data/spec/api/catalogs_api_spec.rb +759 -0
- data/spec/api/client_api_spec.rb +74 -0
- data/spec/api/events_api_spec.rb +120 -0
- data/spec/api/flows_api_spec.rb +209 -0
- data/spec/api/lists_api_spec.rb +156 -0
- data/spec/api/metrics_api_spec.rb +74 -0
- data/spec/api/profiles_api_spec.rb +178 -0
- data/spec/api/segments_api_spec.rb +103 -0
- data/spec/api/templates_api_spec.rb +126 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +56 -0
- data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_category_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_item_op_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +56 -0
- data/spec/models/catalog_category_update_query_spec.rb +34 -0
- data/spec/models/catalog_item_category_op_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +98 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +44 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_item_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +76 -0
- data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +56 -0
- data/spec/models/catalog_item_update_query_spec.rb +34 -0
- data/spec/models/catalog_job_error_payload_spec.rb +58 -0
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +126 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +44 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_variant_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +98 -0
- data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_variant_update_query_spec.rb +34 -0
- data/spec/models/email_message_content_spec.rb +52 -0
- data/spec/models/email_tracking_options_spec.rb +52 -0
- data/spec/models/error_source_spec.rb +34 -0
- data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +64 -0
- data/spec/models/event_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/event_create_query_spec.rb +34 -0
- data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/flow_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/flow_update_query_spec.rb +34 -0
- data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +40 -0
- data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +58 -0
- data/spec/models/get_catalog_items4_xx_response_spec.rb +34 -0
- data/spec/models/included_categories_attributes_spec.rb +46 -0
- data/spec/models/included_categories_spec.rb +56 -0
- data/spec/models/included_flow_action_spec.rb +56 -0
- data/spec/models/included_flow_actions_attributes_spec.rb +76 -0
- data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +31 -0
- data/spec/models/included_flow_actions_spec.rb +56 -0
- data/spec/models/included_flow_messages_attributes_content_spec.rb +31 -0
- data/spec/models/included_flow_messages_attributes_spec.rb +58 -0
- data/spec/models/included_flow_messages_spec.rb +56 -0
- data/spec/models/included_flows_attributes_spec.rb +64 -0
- data/spec/models/included_flows_spec.rb +56 -0
- data/spec/models/included_items_attributes_spec.rb +94 -0
- data/spec/models/included_items_spec.rb +56 -0
- data/spec/models/included_lists_attributes_spec.rb +46 -0
- data/spec/models/included_lists_spec.rb +56 -0
- data/spec/models/included_metrics_attributes_spec.rb +52 -0
- data/spec/models/included_metrics_spec.rb +56 -0
- data/spec/models/included_profile_spec.rb +56 -0
- data/spec/models/included_profiles_attributes_spec.rb +112 -0
- data/spec/models/included_profiles_spec.rb +56 -0
- data/spec/models/included_segments_spec.rb +56 -0
- data/spec/models/included_variants_attributes_spec.rb +122 -0
- data/spec/models/included_variants_links_spec.rb +34 -0
- data/spec/models/included_variants_spec.rb +56 -0
- data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/list_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/list_create_query_spec.rb +34 -0
- data/spec/models/list_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/list_members_add_query_data_inner_spec.rb +44 -0
- data/spec/models/list_members_add_query_spec.rb +34 -0
- data/spec/models/list_members_delete_query_spec.rb +34 -0
- data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/list_partial_update_query_spec.rb +34 -0
- data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +104 -0
- data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/metric_aggregate_query_spec.rb +34 -0
- data/spec/models/metric_aggregate_row_dto_spec.rb +40 -0
- data/spec/models/metric_create_query_spec.rb +40 -0
- data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/onsite_profile_create_query_spec.rb +34 -0
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +64 -0
- data/spec/models/onsite_profile_meta_spec.rb +34 -0
- data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +58 -0
- data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/onsite_subscription_create_query_spec.rb +34 -0
- data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +94 -0
- data/spec/models/profile_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/profile_create_query_spec.rb +34 -0
- data/spec/models/profile_location_latitude_spec.rb +31 -0
- data/spec/models/profile_location_spec.rb +82 -0
- data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/profile_partial_update_query_spec.rb +34 -0
- data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/segment_partial_update_query_spec.rb +34 -0
- data/spec/models/send_options_spec.rb +40 -0
- data/spec/models/sms_message_content_spec.rb +40 -0
- data/spec/models/sms_render_options_spec.rb +52 -0
- data/spec/models/sms_tracking_options_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/subscription_create_job_create_query_spec.rb +34 -0
- data/spec/models/subscription_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/suppression_create_job_create_query_spec.rb +34 -0
- data/spec/models/suppression_spec.rb +34 -0
- data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/template_clone_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/template_clone_query_spec.rb +34 -0
- data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +58 -0
- data/spec/models/template_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/template_create_query_spec.rb +34 -0
- data/spec/models/template_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +52 -0
- data/spec/models/template_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/template_update_query_spec.rb +34 -0
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/unsubscription_create_job_create_query_spec.rb +34 -0
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/unsuppression_create_job_create_query_spec.rb +34 -0
- data/spec/models/utm_param_info_spec.rb +40 -0
- data/spec/models/v2_template_render_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/v2_template_render_query_spec.rb +34 -0
- data/spec/spec_helper.rb +111 -0
- metadata +583 -0
data/README.md
ADDED
@@ -0,0 +1,1316 @@
|
|
1
|
+
# Klaviyo Ruby SDK
|
2
|
+
|
3
|
+
- SDK version: 1.0.0
|
4
|
+
- API revision: 2022-10-17
|
5
|
+
|
6
|
+
## Helpful Resources
|
7
|
+
|
8
|
+
- [API Reference](https://developers.klaviyo.com/en/v2022-10-17/reference)
|
9
|
+
- [API Guides](https://developers.klaviyo.com/en/v2022-10-17/docs)
|
10
|
+
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)
|
11
|
+
|
12
|
+
## Design & Approach
|
13
|
+
|
14
|
+
This SDK is a thin wrapper around our API. See our API Reference for full documentation on API behavior.
|
15
|
+
|
16
|
+
## Organization
|
17
|
+
|
18
|
+
This SDK is organized into the following resources:
|
19
|
+
|
20
|
+
|
21
|
+
|
22
|
+
- Catalogs
|
23
|
+
|
24
|
+
|
25
|
+
|
26
|
+
- Client
|
27
|
+
|
28
|
+
|
29
|
+
|
30
|
+
- Events
|
31
|
+
|
32
|
+
|
33
|
+
|
34
|
+
- Flows
|
35
|
+
|
36
|
+
|
37
|
+
|
38
|
+
- Lists
|
39
|
+
|
40
|
+
|
41
|
+
|
42
|
+
- Metrics
|
43
|
+
|
44
|
+
|
45
|
+
|
46
|
+
- Profiles
|
47
|
+
|
48
|
+
|
49
|
+
|
50
|
+
- Segments
|
51
|
+
|
52
|
+
|
53
|
+
|
54
|
+
- Templates
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
|
59
|
+
# Installation
|
60
|
+
|
61
|
+
|
62
|
+
## Build
|
63
|
+
|
64
|
+
To build the Ruby code into a gem:
|
65
|
+
|
66
|
+
```shell
|
67
|
+
gem build klaviyo-api-sdk.gemspec
|
68
|
+
```
|
69
|
+
|
70
|
+
Then install the gem locally:
|
71
|
+
|
72
|
+
```shell
|
73
|
+
gem install ./klaviyo-api-sdk-1.0.0.gem
|
74
|
+
```
|
75
|
+
|
76
|
+
|
77
|
+
Finally add this to the Gemfile:
|
78
|
+
|
79
|
+
gem 'klaviyo-api-sdk', '~> 1.0.0'
|
80
|
+
|
81
|
+
To install directly from rubygems:
|
82
|
+
|
83
|
+
```shell
|
84
|
+
gem install klaviyo-api-sdk
|
85
|
+
```
|
86
|
+
|
87
|
+
# Usage Example
|
88
|
+
|
89
|
+
### To load the gem
|
90
|
+
|
91
|
+
```ruby
|
92
|
+
# Load the gem
|
93
|
+
require 'klaviyo-api-sdk'
|
94
|
+
|
95
|
+
# Setup authorization
|
96
|
+
KlaviyoAPI.configure do |config|
|
97
|
+
config.api_key['Klaviyo-API-Key'] = 'Klaviyo-API-Key your-api-key'
|
98
|
+
#config.max_retries = 5 # optional
|
99
|
+
#config.max_delay = 60 # optional
|
100
|
+
end
|
101
|
+
```
|
102
|
+
|
103
|
+
NOTE:
|
104
|
+
* The SDK retries on resolvable errors, namely: rate limits (common) and server errors on klaviyo (rare).
|
105
|
+
* `max_retry` denotes number of attempts the client will make in order to execute the request successfully.
|
106
|
+
* `max_delay` denotes total delay (in seconds) across all attempts.
|
107
|
+
|
108
|
+
### To call the `get_catalog_items` operation:
|
109
|
+
|
110
|
+
```ruby
|
111
|
+
opts = {
|
112
|
+
include: ['variants'],
|
113
|
+
sort: 'created',
|
114
|
+
filter: 'equals(published,false)',
|
115
|
+
fields_catalog_item: ['external_id','title']
|
116
|
+
}
|
117
|
+
|
118
|
+
begin
|
119
|
+
result = KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
120
|
+
end
|
121
|
+
```
|
122
|
+
|
123
|
+
# Error Handling
|
124
|
+
|
125
|
+
This SDK throws an `ApiException` error when the server returns a non-`2XX` response.
|
126
|
+
```ruby
|
127
|
+
begin
|
128
|
+
result = KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
129
|
+
rescue KlaviyoAPI::ApiError => e
|
130
|
+
puts "Error when calling get_catalog_items #{e}"
|
131
|
+
end
|
132
|
+
```
|
133
|
+
|
134
|
+
# Comprehensive list of Operations & Parameters
|
135
|
+
|
136
|
+
_**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/v2022-10-17/reference/get_events).
|
138
|
+
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
139
|
+
- 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
|
+
|
141
|
+
## Method signatures
|
142
|
+
- `get` operations can be passed an optional `opts` object (e.g. `get_list_profiles(opts)`).
|
143
|
+
`opts` describes the available options for fetching data (some operations only support a subset of these or none).
|
144
|
+
i.e.
|
145
|
+
```ruby
|
146
|
+
opts = {
|
147
|
+
include: ['variants'],
|
148
|
+
sort: '-created',
|
149
|
+
filter: 'equals(published,false)',
|
150
|
+
page_cursor: 'page_cursor_example',
|
151
|
+
fields_catalog_item: ['external_id','title'],
|
152
|
+
fields_catalog_variant: ['external_id','title']
|
153
|
+
}
|
154
|
+
```
|
155
|
+
**Note, for parameters that use square brackets such as `page[cursor]` or `fields[catalog-item]` ruby will replace the square brackets `[]` with `_` underscores.
|
156
|
+
|
157
|
+
- For `create`, `update` & some `delete` operations (i.e. `create_catalog_item` or `update_catalog_item` or `delete_catalog_category_relationships`)
|
158
|
+
the `body` object is required in the method signature (i.e. `create_catalog_item(body)`).
|
159
|
+
```ruby
|
160
|
+
body = {
|
161
|
+
data: {
|
162
|
+
type: "catalog-item",
|
163
|
+
attributes: {
|
164
|
+
external_id: "catalog-item-test",
|
165
|
+
title: "Catalog Item Test",
|
166
|
+
description: "this is a description",
|
167
|
+
url: "http://catalog-item.klaviyo.com",
|
168
|
+
published: true
|
169
|
+
}
|
170
|
+
}
|
171
|
+
}
|
172
|
+
KlaviyoAPI::Catalogs.create_catalog_item(body)
|
173
|
+
```
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
## Catalogs
|
180
|
+
|
181
|
+
|
182
|
+
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2022-10-17/reference/create_catalog_category)
|
183
|
+
|
184
|
+
```ruby
|
185
|
+
KlaviyoAPI::Catalogs.create_catalog_category(body)
|
186
|
+
```
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
#### [Create Catalog Category Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/create_catalog_category_relationships)
|
193
|
+
|
194
|
+
```ruby
|
195
|
+
KlaviyoAPI::Catalogs.create_catalog_category_relationships(id, related_resource, body)
|
196
|
+
```
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2022-10-17/reference/create_catalog_item)
|
203
|
+
|
204
|
+
```ruby
|
205
|
+
KlaviyoAPI::Catalogs.create_catalog_item(body)
|
206
|
+
```
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
#### [Create Catalog Item Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/create_catalog_item_relationships)
|
213
|
+
|
214
|
+
```ruby
|
215
|
+
KlaviyoAPI::Catalogs.create_catalog_item_relationships(id, related_resource, body)
|
216
|
+
```
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2022-10-17/reference/create_catalog_variant)
|
223
|
+
|
224
|
+
```ruby
|
225
|
+
KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
226
|
+
```
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_catalog_category)
|
233
|
+
|
234
|
+
```ruby
|
235
|
+
KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
236
|
+
```
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
#### [Delete Catalog Category Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_catalog_category_relationships)
|
243
|
+
|
244
|
+
```ruby
|
245
|
+
KlaviyoAPI::Catalogs.delete_catalog_category_relationships(id, related_resource, body)
|
246
|
+
```
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_catalog_item)
|
253
|
+
|
254
|
+
```ruby
|
255
|
+
KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
256
|
+
```
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
#### [Delete Catalog Item Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_catalog_item_relationships)
|
263
|
+
|
264
|
+
```ruby
|
265
|
+
KlaviyoAPI::Catalogs.delete_catalog_item_relationships(id, related_resource, body)
|
266
|
+
```
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_catalog_variant)
|
273
|
+
|
274
|
+
```ruby
|
275
|
+
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
276
|
+
```
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_categories)
|
283
|
+
|
284
|
+
```ruby
|
285
|
+
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
286
|
+
```
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_category)
|
293
|
+
|
294
|
+
```ruby
|
295
|
+
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
296
|
+
```
|
297
|
+
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_category_items)
|
303
|
+
|
304
|
+
```ruby
|
305
|
+
KlaviyoAPI::Catalogs.get_catalog_category_items(category_id, opts)
|
306
|
+
```
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
#### [Get Catalog Category Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_category_relationships)
|
313
|
+
|
314
|
+
```ruby
|
315
|
+
KlaviyoAPI::Catalogs.get_catalog_category_relationships(id, related_resource, opts)
|
316
|
+
```
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_item)
|
323
|
+
|
324
|
+
```ruby
|
325
|
+
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
326
|
+
```
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_item_categories)
|
333
|
+
|
334
|
+
```ruby
|
335
|
+
KlaviyoAPI::Catalogs.get_catalog_item_categories(item_id, opts)
|
336
|
+
```
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
#### [Get Catalog Item Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_item_relationships)
|
343
|
+
|
344
|
+
```ruby
|
345
|
+
KlaviyoAPI::Catalogs.get_catalog_item_relationships(id, related_resource, opts)
|
346
|
+
```
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_item_variants)
|
353
|
+
|
354
|
+
```ruby
|
355
|
+
KlaviyoAPI::Catalogs.get_catalog_item_variants(item_id, opts)
|
356
|
+
```
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_items)
|
363
|
+
|
364
|
+
```ruby
|
365
|
+
KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
366
|
+
```
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
|
371
|
+
|
372
|
+
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_variant)
|
373
|
+
|
374
|
+
```ruby
|
375
|
+
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
376
|
+
```
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_variants)
|
383
|
+
|
384
|
+
```ruby
|
385
|
+
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
386
|
+
```
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_create_categories_job)
|
393
|
+
|
394
|
+
```ruby
|
395
|
+
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
396
|
+
```
|
397
|
+
|
398
|
+
|
399
|
+
|
400
|
+
|
401
|
+
|
402
|
+
#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_create_categories_jobs)
|
403
|
+
|
404
|
+
```ruby
|
405
|
+
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
406
|
+
```
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
#### [Get Create Items Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_create_items_job)
|
413
|
+
|
414
|
+
```ruby
|
415
|
+
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
416
|
+
```
|
417
|
+
|
418
|
+
|
419
|
+
|
420
|
+
|
421
|
+
|
422
|
+
#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_create_items_jobs)
|
423
|
+
|
424
|
+
```ruby
|
425
|
+
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
426
|
+
```
|
427
|
+
|
428
|
+
|
429
|
+
|
430
|
+
|
431
|
+
|
432
|
+
#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_create_variants_job)
|
433
|
+
|
434
|
+
```ruby
|
435
|
+
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
436
|
+
```
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_create_variants_jobs)
|
443
|
+
|
444
|
+
```ruby
|
445
|
+
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
446
|
+
```
|
447
|
+
|
448
|
+
|
449
|
+
|
450
|
+
|
451
|
+
|
452
|
+
#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_delete_categories_job)
|
453
|
+
|
454
|
+
```ruby
|
455
|
+
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
456
|
+
```
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
|
462
|
+
#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_delete_categories_jobs)
|
463
|
+
|
464
|
+
```ruby
|
465
|
+
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
466
|
+
```
|
467
|
+
|
468
|
+
|
469
|
+
|
470
|
+
|
471
|
+
|
472
|
+
#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_delete_items_job)
|
473
|
+
|
474
|
+
```ruby
|
475
|
+
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
476
|
+
```
|
477
|
+
|
478
|
+
|
479
|
+
|
480
|
+
|
481
|
+
|
482
|
+
#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_delete_items_jobs)
|
483
|
+
|
484
|
+
```ruby
|
485
|
+
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
486
|
+
```
|
487
|
+
|
488
|
+
|
489
|
+
|
490
|
+
|
491
|
+
|
492
|
+
#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_delete_variants_job)
|
493
|
+
|
494
|
+
```ruby
|
495
|
+
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
496
|
+
```
|
497
|
+
|
498
|
+
|
499
|
+
|
500
|
+
|
501
|
+
|
502
|
+
#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_delete_variants_jobs)
|
503
|
+
|
504
|
+
```ruby
|
505
|
+
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
506
|
+
```
|
507
|
+
|
508
|
+
|
509
|
+
|
510
|
+
|
511
|
+
|
512
|
+
#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_update_categories_job)
|
513
|
+
|
514
|
+
```ruby
|
515
|
+
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
516
|
+
```
|
517
|
+
|
518
|
+
|
519
|
+
|
520
|
+
|
521
|
+
|
522
|
+
#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_update_categories_jobs)
|
523
|
+
|
524
|
+
```ruby
|
525
|
+
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
526
|
+
```
|
527
|
+
|
528
|
+
|
529
|
+
|
530
|
+
|
531
|
+
|
532
|
+
#### [Get Update Items Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_update_items_job)
|
533
|
+
|
534
|
+
```ruby
|
535
|
+
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
536
|
+
```
|
537
|
+
|
538
|
+
|
539
|
+
|
540
|
+
|
541
|
+
|
542
|
+
#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_update_items_jobs)
|
543
|
+
|
544
|
+
```ruby
|
545
|
+
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
546
|
+
```
|
547
|
+
|
548
|
+
|
549
|
+
|
550
|
+
|
551
|
+
|
552
|
+
#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_update_variants_job)
|
553
|
+
|
554
|
+
```ruby
|
555
|
+
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
556
|
+
```
|
557
|
+
|
558
|
+
|
559
|
+
|
560
|
+
|
561
|
+
|
562
|
+
#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_update_variants_jobs)
|
563
|
+
|
564
|
+
```ruby
|
565
|
+
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
566
|
+
```
|
567
|
+
|
568
|
+
|
569
|
+
|
570
|
+
|
571
|
+
|
572
|
+
#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_create_categories_job)
|
573
|
+
|
574
|
+
```ruby
|
575
|
+
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
576
|
+
```
|
577
|
+
|
578
|
+
|
579
|
+
|
580
|
+
|
581
|
+
|
582
|
+
#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_create_items_job)
|
583
|
+
|
584
|
+
```ruby
|
585
|
+
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
586
|
+
```
|
587
|
+
|
588
|
+
|
589
|
+
|
590
|
+
|
591
|
+
|
592
|
+
#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_create_variants_job)
|
593
|
+
|
594
|
+
```ruby
|
595
|
+
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
596
|
+
```
|
597
|
+
|
598
|
+
|
599
|
+
|
600
|
+
|
601
|
+
|
602
|
+
#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_delete_categories_job)
|
603
|
+
|
604
|
+
```ruby
|
605
|
+
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
606
|
+
```
|
607
|
+
|
608
|
+
|
609
|
+
|
610
|
+
|
611
|
+
|
612
|
+
#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_delete_items_job)
|
613
|
+
|
614
|
+
```ruby
|
615
|
+
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
616
|
+
```
|
617
|
+
|
618
|
+
|
619
|
+
|
620
|
+
|
621
|
+
|
622
|
+
#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_delete_variants_job)
|
623
|
+
|
624
|
+
```ruby
|
625
|
+
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
626
|
+
```
|
627
|
+
|
628
|
+
|
629
|
+
|
630
|
+
|
631
|
+
|
632
|
+
#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_update_categories_job)
|
633
|
+
|
634
|
+
```ruby
|
635
|
+
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
636
|
+
```
|
637
|
+
|
638
|
+
|
639
|
+
|
640
|
+
|
641
|
+
|
642
|
+
#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_update_items_job)
|
643
|
+
|
644
|
+
```ruby
|
645
|
+
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
646
|
+
```
|
647
|
+
|
648
|
+
|
649
|
+
|
650
|
+
|
651
|
+
|
652
|
+
#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_update_variants_job)
|
653
|
+
|
654
|
+
```ruby
|
655
|
+
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
656
|
+
```
|
657
|
+
|
658
|
+
|
659
|
+
|
660
|
+
|
661
|
+
|
662
|
+
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2022-10-17/reference/update_catalog_category)
|
663
|
+
|
664
|
+
```ruby
|
665
|
+
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
666
|
+
```
|
667
|
+
|
668
|
+
|
669
|
+
|
670
|
+
|
671
|
+
|
672
|
+
#### [Update Catalog Category Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/update_catalog_category_relationships)
|
673
|
+
|
674
|
+
```ruby
|
675
|
+
KlaviyoAPI::Catalogs.update_catalog_category_relationships(id, related_resource, body)
|
676
|
+
```
|
677
|
+
|
678
|
+
|
679
|
+
|
680
|
+
|
681
|
+
|
682
|
+
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2022-10-17/reference/update_catalog_item)
|
683
|
+
|
684
|
+
```ruby
|
685
|
+
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
686
|
+
```
|
687
|
+
|
688
|
+
|
689
|
+
|
690
|
+
|
691
|
+
|
692
|
+
#### [Update Catalog Item Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/update_catalog_item_relationships)
|
693
|
+
|
694
|
+
```ruby
|
695
|
+
KlaviyoAPI::Catalogs.update_catalog_item_relationships(id, related_resource, body)
|
696
|
+
```
|
697
|
+
|
698
|
+
|
699
|
+
|
700
|
+
|
701
|
+
|
702
|
+
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2022-10-17/reference/update_catalog_variant)
|
703
|
+
|
704
|
+
```ruby
|
705
|
+
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
706
|
+
```
|
707
|
+
|
708
|
+
|
709
|
+
|
710
|
+
|
711
|
+
|
712
|
+
|
713
|
+
## Client
|
714
|
+
|
715
|
+
|
716
|
+
#### [Create Client Event](https://developers.klaviyo.com/en/v2022-10-17/reference/create_client_event)
|
717
|
+
|
718
|
+
```ruby
|
719
|
+
KlaviyoAPI::Client.create_client_event(company_id, body)
|
720
|
+
```
|
721
|
+
|
722
|
+
|
723
|
+
|
724
|
+
|
725
|
+
|
726
|
+
#### [Create Client Profile](https://developers.klaviyo.com/en/v2022-10-17/reference/create_client_profile)
|
727
|
+
|
728
|
+
```ruby
|
729
|
+
KlaviyoAPI::Client.create_client_profile(company_id, body)
|
730
|
+
```
|
731
|
+
|
732
|
+
|
733
|
+
|
734
|
+
|
735
|
+
|
736
|
+
#### [Create Client Subscription](https://developers.klaviyo.com/en/v2022-10-17/reference/create_client_subscription)
|
737
|
+
|
738
|
+
```ruby
|
739
|
+
KlaviyoAPI::Client.create_client_subscription(company_id, body)
|
740
|
+
```
|
741
|
+
|
742
|
+
|
743
|
+
|
744
|
+
|
745
|
+
|
746
|
+
|
747
|
+
## Events
|
748
|
+
|
749
|
+
|
750
|
+
#### [Create Event](https://developers.klaviyo.com/en/v2022-10-17/reference/create_event)
|
751
|
+
|
752
|
+
```ruby
|
753
|
+
KlaviyoAPI::Events.create_event(body)
|
754
|
+
```
|
755
|
+
|
756
|
+
|
757
|
+
|
758
|
+
|
759
|
+
|
760
|
+
#### [Get Event](https://developers.klaviyo.com/en/v2022-10-17/reference/get_event)
|
761
|
+
|
762
|
+
```ruby
|
763
|
+
KlaviyoAPI::Events.get_event(id, opts)
|
764
|
+
```
|
765
|
+
|
766
|
+
|
767
|
+
|
768
|
+
|
769
|
+
|
770
|
+
#### [Get Event Metrics](https://developers.klaviyo.com/en/v2022-10-17/reference/get_event_metrics)
|
771
|
+
|
772
|
+
```ruby
|
773
|
+
KlaviyoAPI::Events.get_event_metrics(id, opts)
|
774
|
+
```
|
775
|
+
|
776
|
+
|
777
|
+
|
778
|
+
|
779
|
+
|
780
|
+
#### [Get Event Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/get_event_profiles)
|
781
|
+
|
782
|
+
```ruby
|
783
|
+
KlaviyoAPI::Events.get_event_profiles(id, opts)
|
784
|
+
```
|
785
|
+
|
786
|
+
|
787
|
+
|
788
|
+
|
789
|
+
|
790
|
+
#### [Get Event Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_event_relationships)
|
791
|
+
|
792
|
+
```ruby
|
793
|
+
KlaviyoAPI::Events.get_event_relationships(id, related_resource)
|
794
|
+
```
|
795
|
+
|
796
|
+
|
797
|
+
|
798
|
+
|
799
|
+
|
800
|
+
#### [Get Events](https://developers.klaviyo.com/en/v2022-10-17/reference/get_events)
|
801
|
+
|
802
|
+
```ruby
|
803
|
+
KlaviyoAPI::Events.get_events(opts)
|
804
|
+
```
|
805
|
+
|
806
|
+
|
807
|
+
|
808
|
+
|
809
|
+
|
810
|
+
|
811
|
+
## Flows
|
812
|
+
|
813
|
+
|
814
|
+
#### [Get Flow](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow)
|
815
|
+
|
816
|
+
```ruby
|
817
|
+
KlaviyoAPI::Flows.get_flow(id, opts)
|
818
|
+
```
|
819
|
+
|
820
|
+
|
821
|
+
|
822
|
+
|
823
|
+
|
824
|
+
#### [Get Flow Action](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_action)
|
825
|
+
|
826
|
+
```ruby
|
827
|
+
KlaviyoAPI::Flows.get_flow_action(id, opts)
|
828
|
+
```
|
829
|
+
|
830
|
+
|
831
|
+
|
832
|
+
|
833
|
+
|
834
|
+
#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_action_flow)
|
835
|
+
|
836
|
+
```ruby
|
837
|
+
KlaviyoAPI::Flows.get_flow_action_flow(action_id, opts)
|
838
|
+
```
|
839
|
+
|
840
|
+
|
841
|
+
|
842
|
+
|
843
|
+
|
844
|
+
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_action_messages)
|
845
|
+
|
846
|
+
```ruby
|
847
|
+
KlaviyoAPI::Flows.get_flow_action_messages(action_id, opts)
|
848
|
+
```
|
849
|
+
|
850
|
+
|
851
|
+
|
852
|
+
|
853
|
+
|
854
|
+
#### [Get Flow Action Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_action_relationships)
|
855
|
+
|
856
|
+
```ruby
|
857
|
+
KlaviyoAPI::Flows.get_flow_action_relationships(id, related_resource, opts)
|
858
|
+
```
|
859
|
+
|
860
|
+
|
861
|
+
|
862
|
+
|
863
|
+
|
864
|
+
#### [Get Flow Actions For Flow](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_flow_actions)
|
865
|
+
|
866
|
+
```ruby
|
867
|
+
KlaviyoAPI::Flows.get_flow_flow_actions(flow_id, opts)
|
868
|
+
```
|
869
|
+
|
870
|
+
|
871
|
+
|
872
|
+
|
873
|
+
|
874
|
+
#### [Get Flow Message](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_message)
|
875
|
+
|
876
|
+
```ruby
|
877
|
+
KlaviyoAPI::Flows.get_flow_message(id, opts)
|
878
|
+
```
|
879
|
+
|
880
|
+
|
881
|
+
|
882
|
+
|
883
|
+
|
884
|
+
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_message_action)
|
885
|
+
|
886
|
+
```ruby
|
887
|
+
KlaviyoAPI::Flows.get_flow_message_action(message_id, opts)
|
888
|
+
```
|
889
|
+
|
890
|
+
|
891
|
+
|
892
|
+
|
893
|
+
|
894
|
+
#### [Get Flow Message Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_message_relationships)
|
895
|
+
|
896
|
+
```ruby
|
897
|
+
KlaviyoAPI::Flows.get_flow_message_relationships(id, related_resource)
|
898
|
+
```
|
899
|
+
|
900
|
+
|
901
|
+
|
902
|
+
|
903
|
+
|
904
|
+
#### [Get Flow Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_relationships)
|
905
|
+
|
906
|
+
```ruby
|
907
|
+
KlaviyoAPI::Flows.get_flow_relationships(id, related_resource, opts)
|
908
|
+
```
|
909
|
+
|
910
|
+
|
911
|
+
|
912
|
+
|
913
|
+
|
914
|
+
#### [Get Flows](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flows)
|
915
|
+
|
916
|
+
```ruby
|
917
|
+
KlaviyoAPI::Flows.get_flows(opts)
|
918
|
+
```
|
919
|
+
|
920
|
+
|
921
|
+
|
922
|
+
|
923
|
+
|
924
|
+
#### [Update Flow Status](https://developers.klaviyo.com/en/v2022-10-17/reference/update_flow)
|
925
|
+
|
926
|
+
```ruby
|
927
|
+
KlaviyoAPI::Flows.update_flow(id, body)
|
928
|
+
```
|
929
|
+
|
930
|
+
|
931
|
+
|
932
|
+
|
933
|
+
|
934
|
+
|
935
|
+
## Lists
|
936
|
+
|
937
|
+
|
938
|
+
#### [Create List](https://developers.klaviyo.com/en/v2022-10-17/reference/create_list)
|
939
|
+
|
940
|
+
```ruby
|
941
|
+
KlaviyoAPI::Lists.create_list(body)
|
942
|
+
```
|
943
|
+
|
944
|
+
|
945
|
+
|
946
|
+
|
947
|
+
|
948
|
+
#### [Add Profile to List](https://developers.klaviyo.com/en/v2022-10-17/reference/create_list_relationships)
|
949
|
+
|
950
|
+
```ruby
|
951
|
+
KlaviyoAPI::Lists.create_list_relationships(id, related_resource, body)
|
952
|
+
```
|
953
|
+
|
954
|
+
|
955
|
+
|
956
|
+
|
957
|
+
|
958
|
+
#### [Delete List](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_list)
|
959
|
+
|
960
|
+
```ruby
|
961
|
+
KlaviyoAPI::Lists.delete_list(id)
|
962
|
+
```
|
963
|
+
|
964
|
+
|
965
|
+
|
966
|
+
|
967
|
+
|
968
|
+
#### [Remove Profile from List](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_list_relationships)
|
969
|
+
|
970
|
+
```ruby
|
971
|
+
KlaviyoAPI::Lists.delete_list_relationships(id, related_resource, body)
|
972
|
+
```
|
973
|
+
|
974
|
+
|
975
|
+
|
976
|
+
|
977
|
+
|
978
|
+
#### [Get List](https://developers.klaviyo.com/en/v2022-10-17/reference/get_list)
|
979
|
+
|
980
|
+
```ruby
|
981
|
+
KlaviyoAPI::Lists.get_list(id, opts)
|
982
|
+
```
|
983
|
+
|
984
|
+
|
985
|
+
|
986
|
+
|
987
|
+
|
988
|
+
#### [Get List Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/get_list_profiles)
|
989
|
+
|
990
|
+
```ruby
|
991
|
+
KlaviyoAPI::Lists.get_list_profiles(list_id, opts)
|
992
|
+
```
|
993
|
+
|
994
|
+
|
995
|
+
|
996
|
+
|
997
|
+
|
998
|
+
#### [Get List Profile Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_list_relationships)
|
999
|
+
|
1000
|
+
```ruby
|
1001
|
+
KlaviyoAPI::Lists.get_list_relationships(id, related_resource, opts)
|
1002
|
+
```
|
1003
|
+
|
1004
|
+
|
1005
|
+
|
1006
|
+
|
1007
|
+
|
1008
|
+
#### [Get Lists](https://developers.klaviyo.com/en/v2022-10-17/reference/get_lists)
|
1009
|
+
|
1010
|
+
```ruby
|
1011
|
+
KlaviyoAPI::Lists.get_lists(opts)
|
1012
|
+
```
|
1013
|
+
|
1014
|
+
|
1015
|
+
|
1016
|
+
|
1017
|
+
|
1018
|
+
#### [Update List](https://developers.klaviyo.com/en/v2022-10-17/reference/update_list)
|
1019
|
+
|
1020
|
+
```ruby
|
1021
|
+
KlaviyoAPI::Lists.update_list(id, body)
|
1022
|
+
```
|
1023
|
+
|
1024
|
+
|
1025
|
+
|
1026
|
+
|
1027
|
+
|
1028
|
+
|
1029
|
+
## Metrics
|
1030
|
+
|
1031
|
+
|
1032
|
+
#### [Get Metric](https://developers.klaviyo.com/en/v2022-10-17/reference/get_metric)
|
1033
|
+
|
1034
|
+
```ruby
|
1035
|
+
KlaviyoAPI::Metrics.get_metric(id, opts)
|
1036
|
+
```
|
1037
|
+
|
1038
|
+
|
1039
|
+
|
1040
|
+
|
1041
|
+
|
1042
|
+
#### [Get Metrics](https://developers.klaviyo.com/en/v2022-10-17/reference/get_metrics)
|
1043
|
+
|
1044
|
+
```ruby
|
1045
|
+
KlaviyoAPI::Metrics.get_metrics(opts)
|
1046
|
+
```
|
1047
|
+
|
1048
|
+
|
1049
|
+
|
1050
|
+
|
1051
|
+
|
1052
|
+
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2022-10-17/reference/query_metric_aggregates)
|
1053
|
+
|
1054
|
+
```ruby
|
1055
|
+
KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
1056
|
+
```
|
1057
|
+
|
1058
|
+
|
1059
|
+
|
1060
|
+
|
1061
|
+
|
1062
|
+
|
1063
|
+
## Profiles
|
1064
|
+
|
1065
|
+
|
1066
|
+
#### [Create Profile](https://developers.klaviyo.com/en/v2022-10-17/reference/create_profile)
|
1067
|
+
|
1068
|
+
```ruby
|
1069
|
+
KlaviyoAPI::Profiles.create_profile(body)
|
1070
|
+
```
|
1071
|
+
|
1072
|
+
|
1073
|
+
|
1074
|
+
|
1075
|
+
|
1076
|
+
#### [Get Profile](https://developers.klaviyo.com/en/v2022-10-17/reference/get_profile)
|
1077
|
+
|
1078
|
+
```ruby
|
1079
|
+
KlaviyoAPI::Profiles.get_profile(id, opts)
|
1080
|
+
```
|
1081
|
+
|
1082
|
+
|
1083
|
+
|
1084
|
+
|
1085
|
+
|
1086
|
+
#### [Get Profile Lists](https://developers.klaviyo.com/en/v2022-10-17/reference/get_profile_lists)
|
1087
|
+
|
1088
|
+
```ruby
|
1089
|
+
KlaviyoAPI::Profiles.get_profile_lists(profile_id, opts)
|
1090
|
+
```
|
1091
|
+
|
1092
|
+
|
1093
|
+
|
1094
|
+
|
1095
|
+
|
1096
|
+
#### [Get Profile Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_profile_relationships)
|
1097
|
+
|
1098
|
+
```ruby
|
1099
|
+
KlaviyoAPI::Profiles.get_profile_relationships(id, related_resource)
|
1100
|
+
```
|
1101
|
+
|
1102
|
+
|
1103
|
+
|
1104
|
+
|
1105
|
+
|
1106
|
+
#### [Get Profile Segments](https://developers.klaviyo.com/en/v2022-10-17/reference/get_profile_segments)
|
1107
|
+
|
1108
|
+
```ruby
|
1109
|
+
KlaviyoAPI::Profiles.get_profile_segments(profile_id, opts)
|
1110
|
+
```
|
1111
|
+
|
1112
|
+
|
1113
|
+
|
1114
|
+
|
1115
|
+
|
1116
|
+
#### [Get Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/get_profiles)
|
1117
|
+
|
1118
|
+
```ruby
|
1119
|
+
KlaviyoAPI::Profiles.get_profiles(opts)
|
1120
|
+
```
|
1121
|
+
|
1122
|
+
|
1123
|
+
|
1124
|
+
|
1125
|
+
|
1126
|
+
#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/subscribe_profiles)
|
1127
|
+
|
1128
|
+
```ruby
|
1129
|
+
KlaviyoAPI::Profiles.subscribe_profiles(body)
|
1130
|
+
```
|
1131
|
+
|
1132
|
+
|
1133
|
+
|
1134
|
+
|
1135
|
+
|
1136
|
+
#### [Suppress Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/suppress_profiles)
|
1137
|
+
|
1138
|
+
```ruby
|
1139
|
+
KlaviyoAPI::Profiles.suppress_profiles(body)
|
1140
|
+
```
|
1141
|
+
|
1142
|
+
|
1143
|
+
|
1144
|
+
|
1145
|
+
|
1146
|
+
#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/unsubscribe_profiles)
|
1147
|
+
|
1148
|
+
```ruby
|
1149
|
+
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
1150
|
+
```
|
1151
|
+
|
1152
|
+
|
1153
|
+
|
1154
|
+
|
1155
|
+
|
1156
|
+
#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/unsuppress_profiles)
|
1157
|
+
|
1158
|
+
```ruby
|
1159
|
+
KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
1160
|
+
```
|
1161
|
+
|
1162
|
+
|
1163
|
+
|
1164
|
+
|
1165
|
+
|
1166
|
+
#### [Update Profile](https://developers.klaviyo.com/en/v2022-10-17/reference/update_profile)
|
1167
|
+
|
1168
|
+
```ruby
|
1169
|
+
KlaviyoAPI::Profiles.update_profile(id, body)
|
1170
|
+
```
|
1171
|
+
|
1172
|
+
|
1173
|
+
|
1174
|
+
|
1175
|
+
|
1176
|
+
|
1177
|
+
## Segments
|
1178
|
+
|
1179
|
+
|
1180
|
+
#### [Get Segment](https://developers.klaviyo.com/en/v2022-10-17/reference/get_segment)
|
1181
|
+
|
1182
|
+
```ruby
|
1183
|
+
KlaviyoAPI::Segments.get_segment(id, opts)
|
1184
|
+
```
|
1185
|
+
|
1186
|
+
|
1187
|
+
|
1188
|
+
|
1189
|
+
|
1190
|
+
#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/get_segment_profiles)
|
1191
|
+
|
1192
|
+
```ruby
|
1193
|
+
KlaviyoAPI::Segments.get_segment_profiles(segment_id, opts)
|
1194
|
+
```
|
1195
|
+
|
1196
|
+
|
1197
|
+
|
1198
|
+
|
1199
|
+
|
1200
|
+
#### [Get Segment Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_segment_relationships)
|
1201
|
+
|
1202
|
+
```ruby
|
1203
|
+
KlaviyoAPI::Segments.get_segment_relationships(id, related_resource, opts)
|
1204
|
+
```
|
1205
|
+
|
1206
|
+
|
1207
|
+
|
1208
|
+
|
1209
|
+
|
1210
|
+
#### [Get Segments](https://developers.klaviyo.com/en/v2022-10-17/reference/get_segments)
|
1211
|
+
|
1212
|
+
```ruby
|
1213
|
+
KlaviyoAPI::Segments.get_segments(opts)
|
1214
|
+
```
|
1215
|
+
|
1216
|
+
|
1217
|
+
|
1218
|
+
|
1219
|
+
|
1220
|
+
#### [Update Segment](https://developers.klaviyo.com/en/v2022-10-17/reference/update_segment)
|
1221
|
+
|
1222
|
+
```ruby
|
1223
|
+
KlaviyoAPI::Segments.update_segment(id, body)
|
1224
|
+
```
|
1225
|
+
|
1226
|
+
|
1227
|
+
|
1228
|
+
|
1229
|
+
|
1230
|
+
|
1231
|
+
## Templates
|
1232
|
+
|
1233
|
+
|
1234
|
+
#### [Create Template](https://developers.klaviyo.com/en/v2022-10-17/reference/create_template)
|
1235
|
+
|
1236
|
+
```ruby
|
1237
|
+
KlaviyoAPI::Templates.create_template(body)
|
1238
|
+
```
|
1239
|
+
|
1240
|
+
|
1241
|
+
|
1242
|
+
|
1243
|
+
|
1244
|
+
#### [Create Template Clone](https://developers.klaviyo.com/en/v2022-10-17/reference/create_template_clone)
|
1245
|
+
|
1246
|
+
```ruby
|
1247
|
+
KlaviyoAPI::Templates.create_template_clone(id, body)
|
1248
|
+
```
|
1249
|
+
|
1250
|
+
|
1251
|
+
|
1252
|
+
|
1253
|
+
|
1254
|
+
#### [Create Template Render](https://developers.klaviyo.com/en/v2022-10-17/reference/create_template_render)
|
1255
|
+
|
1256
|
+
```ruby
|
1257
|
+
KlaviyoAPI::Templates.create_template_render(id, body)
|
1258
|
+
```
|
1259
|
+
|
1260
|
+
|
1261
|
+
|
1262
|
+
|
1263
|
+
|
1264
|
+
#### [Delete Template](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_template)
|
1265
|
+
|
1266
|
+
```ruby
|
1267
|
+
KlaviyoAPI::Templates.delete_template(id)
|
1268
|
+
```
|
1269
|
+
|
1270
|
+
|
1271
|
+
|
1272
|
+
|
1273
|
+
|
1274
|
+
#### [Get Template](https://developers.klaviyo.com/en/v2022-10-17/reference/get_template)
|
1275
|
+
|
1276
|
+
```ruby
|
1277
|
+
KlaviyoAPI::Templates.get_template(id, opts)
|
1278
|
+
```
|
1279
|
+
|
1280
|
+
|
1281
|
+
|
1282
|
+
|
1283
|
+
|
1284
|
+
#### [Get Templates](https://developers.klaviyo.com/en/v2022-10-17/reference/get_templates)
|
1285
|
+
|
1286
|
+
```ruby
|
1287
|
+
KlaviyoAPI::Templates.get_templates(opts)
|
1288
|
+
```
|
1289
|
+
|
1290
|
+
|
1291
|
+
|
1292
|
+
|
1293
|
+
|
1294
|
+
#### [Update Template](https://developers.klaviyo.com/en/v2022-10-17/reference/update_template)
|
1295
|
+
|
1296
|
+
```ruby
|
1297
|
+
KlaviyoAPI::Templates.update_template(id, body)
|
1298
|
+
```
|
1299
|
+
|
1300
|
+
|
1301
|
+
|
1302
|
+
|
1303
|
+
|
1304
|
+
# Appendix
|
1305
|
+
|
1306
|
+
## Per Request API key
|
1307
|
+
```ruby
|
1308
|
+
opts = {
|
1309
|
+
header_params: {
|
1310
|
+
'Authorization': 'Klaviyo-API-Key your-api-key',
|
1311
|
+
},
|
1312
|
+
debug_auth_names: []
|
1313
|
+
}
|
1314
|
+
|
1315
|
+
response = KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
1316
|
+
```
|