klaviyo-api-sdk 2.0.0 → 3.0.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 +65 -0
- data/README.md +487 -230
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +160 -0
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +89 -89
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +357 -357
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +52 -52
- data/lib/klaviyo-api-sdk/api/flows_api.rb +210 -155
- data/lib/klaviyo-api-sdk/api/lists_api.rb +80 -72
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +18 -18
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +86 -92
- data/lib/klaviyo-api-sdk/api/segments_api.rb +68 -60
- data/lib/klaviyo-api-sdk/api/tags_api.rb +107 -107
- data/lib/klaviyo-api-sdk/api/templates_api.rb +32 -32
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +35 -35
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +17 -17
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships.rb → catalog_category_update_query_resource_object_relationships.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items.rb → catalog_category_update_query_resource_object_relationships_items.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_update_query_resource_object_relationships_items_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_resource_object_relationships_categories_data_inner.rb → catalog_item_category_op_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +71 -71
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +43 -43
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +114 -114
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +57 -57
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +30 -30
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object_attributes.rb +16 -16
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response.rb → get_create_variants_jobs5_xx_response.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner.rb → get_create_variants_jobs5_xx_response_errors_inner.rb} +40 -40
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner_source.rb → get_create_variants_jobs5_xx_response_errors_inner_source.rb} +17 -17
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +67 -67
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +39 -39
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/{onsite_profile_create_query_resource_object_attributes.rb → profile_partial_update_query_resource_object_attributes.rb} +48 -48
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription.rb +15 -15
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +23 -23
- data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +17 -17
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +32 -32
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +17 -17
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -16
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +15 -15
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object_attributes.rb +18 -18
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +10 -46
- metadata +16 -558
- data/Gemfile +0 -9
- data/Rakefile +0 -10
- data/docs/AudiencesSubObject.md +0 -20
- data/docs/CampaignCloneQuery.md +0 -18
- data/docs/CampaignCloneQueryResourceObject.md +0 -20
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignCreateQuery.md +0 -18
- data/docs/CampaignCreateQueryResourceObject.md +0 -20
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/CampaignEnum.md +0 -15
- data/docs/CampaignMessageAssignTemplateQuery.md +0 -18
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +0 -20
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignMessageEnum.md +0 -15
- data/docs/CampaignMessagePartialUpdateQuery.md +0 -18
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignPartialUpdateQuery.md +0 -18
- data/docs/CampaignPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +0 -26
- data/docs/CampaignRecipientEstimationEnum.md +0 -15
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +0 -18
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignRecipientEstimationJobEnum.md +0 -15
- data/docs/CampaignSendJobCreateQuery.md +0 -18
- data/docs/CampaignSendJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignSendJobEnum.md +0 -15
- data/docs/CampaignSendJobPartialUpdateQuery.md +0 -18
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignsApi.md +0 -1275
- data/docs/CatalogCategoryBulkCreateJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogCategoryCreateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateQueryResourceObject.md +0 -22
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +0 -24
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryEnum.md +0 -15
- data/docs/CatalogCategoryItemOp.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryUpdateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemBulkCreateJobEnum.md +0 -15
- data/docs/CatalogItemBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogItemBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogItemCategoryOp.md +0 -18
- data/docs/CatalogItemCreateJobCreateQuery.md +0 -18
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemCreateQuery.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObject.md +0 -22
- data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogItemEnum.md +0 -15
- data/docs/CatalogItemUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemUpdateQuery.md +0 -18
- data/docs/CatalogItemUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +0 -34
- data/docs/CatalogJobErrorPayload.md +0 -26
- data/docs/CatalogVariantBulkCreateJobEnum.md +0 -15
- data/docs/CatalogVariantBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogVariantBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogVariantCreateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +0 -46
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItems.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogVariantEnum.md +0 -15
- data/docs/CatalogVariantUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantUpdateQuery.md +0 -18
- data/docs/CatalogVariantUpdateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogsApi.md +0 -4032
- data/docs/ClientApi.md +0 -205
- data/docs/CollectionLinks.md +0 -26
- data/docs/ContentSubObject.md +0 -28
- data/docs/DataPrivacyApi.md +0 -78
- data/docs/DataPrivacyCreateDeletionJobQuery.md +0 -18
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +0 -20
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +0 -22
- data/docs/DataPrivacyDeletionJobEnum.md +0 -15
- data/docs/EmailChannel.md +0 -18
- data/docs/EmailMarketing.md +0 -32
- data/docs/EmailMarketingListSuppression.md +0 -22
- data/docs/EmailMarketingSuppression.md +0 -20
- data/docs/EmailMessageContent.md +0 -24
- data/docs/EmailTrackingOptions.md +0 -24
- data/docs/ErrorSource.md +0 -18
- data/docs/EventCreateQuery.md +0 -18
- data/docs/EventCreateQueryResourceObject.md +0 -20
- data/docs/EventCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/EventEnum.md +0 -15
- data/docs/EventsApi.md +0 -544
- data/docs/FlowActionEnum.md +0 -15
- data/docs/FlowEnum.md +0 -15
- data/docs/FlowMessageEnum.md +0 -15
- data/docs/FlowUpdateQuery.md +0 -18
- data/docs/FlowUpdateQueryResourceObject.md +0 -22
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/FlowsApi.md +0 -1173
- data/docs/GetCampaigns4XXResponse.md +0 -18
- data/docs/GetCampaigns4XXResponseErrorsInner.md +0 -26
- data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +0 -20
- data/docs/ListCreateQuery.md +0 -18
- data/docs/ListCreateQueryResourceObject.md +0 -20
- data/docs/ListCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/ListEnum.md +0 -15
- data/docs/ListMembersAddQuery.md +0 -18
- data/docs/ListMembersAddQueryDataInner.md +0 -20
- data/docs/ListMembersDeleteQuery.md +0 -18
- data/docs/ListPartialUpdateQuery.md +0 -18
- data/docs/ListPartialUpdateQueryResourceObject.md +0 -22
- data/docs/ListsApi.md +0 -832
- data/docs/MetricAggregateEnum.md +0 -15
- data/docs/MetricAggregateQuery.md +0 -18
- data/docs/MetricAggregateQueryResourceObject.md +0 -20
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +0 -36
- data/docs/MetricAggregateRowDTO.md +0 -20
- data/docs/MetricCreateQuery.md +0 -20
- data/docs/MetricEnum.md +0 -15
- data/docs/MetricsApi.md +0 -233
- data/docs/ObjectLinks.md +0 -18
- data/docs/OnsiteProfileCreateQuery.md +0 -18
- data/docs/OnsiteProfileCreateQueryResourceObject.md +0 -22
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +0 -38
- data/docs/OnsiteProfileMeta.md +0 -18
- data/docs/OnsiteProfileMetaIdentifiers.md +0 -28
- data/docs/OnsiteSubscriptionCreateQuery.md +0 -18
- data/docs/OnsiteSubscriptionCreateQueryResourceObject.md +0 -20
- data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md +0 -26
- data/docs/PredictiveAnalytics.md +0 -34
- data/docs/ProfileAggregateEnum.md +0 -15
- data/docs/ProfileCreateQuery.md +0 -18
- data/docs/ProfileCreateQueryResourceObject.md +0 -20
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +0 -36
- data/docs/ProfileEnum.md +0 -15
- data/docs/ProfileLocation.md +0 -34
- data/docs/ProfileLocationLatitude.md +0 -49
- data/docs/ProfileLocationLongitude.md +0 -49
- data/docs/ProfilePartialUpdateQuery.md +0 -18
- data/docs/ProfilePartialUpdateQueryResourceObject.md +0 -22
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileUnsubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileUnsuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfilesApi.md +0 -909
- data/docs/SMSChannel.md +0 -18
- data/docs/SMSMarketing.md +0 -24
- data/docs/SMSMessageContent.md +0 -20
- data/docs/SMSRenderOptions.md +0 -24
- data/docs/SMSTrackingOptions.md +0 -20
- data/docs/STOScheduleOptions.md +0 -18
- data/docs/SegmentEnum.md +0 -15
- data/docs/SegmentPartialUpdateQuery.md +0 -18
- data/docs/SegmentPartialUpdateQueryResourceObject.md +0 -22
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/SegmentsApi.md +0 -543
- data/docs/SendOptions.md +0 -20
- data/docs/SendOptionsSubObject.md +0 -18
- data/docs/SendStrategySubObject.md +0 -24
- data/docs/SendTimeSubObject.md +0 -20
- data/docs/StaticScheduleOptions.md +0 -22
- data/docs/Subscription.md +0 -24
- data/docs/SubscriptionChannels.md +0 -20
- data/docs/SubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/SubscriptionEnum.md +0 -15
- data/docs/Subscriptions.md +0 -20
- data/docs/Suppression.md +0 -18
- data/docs/SuppressionCreateJobCreateQuery.md +0 -18
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagCampaignOp.md +0 -18
- data/docs/TagCampaignOpDataInner.md +0 -20
- data/docs/TagCreateQuery.md +0 -18
- data/docs/TagCreateQueryResourceObject.md +0 -20
- data/docs/TagCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagEnum.md +0 -15
- data/docs/TagFlowOp.md +0 -18
- data/docs/TagFlowOpDataInner.md +0 -20
- data/docs/TagGroupCreateQuery.md +0 -18
- data/docs/TagGroupCreateQueryResourceObject.md +0 -20
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagGroupEnum.md +0 -15
- data/docs/TagGroupUpdateQuery.md +0 -18
- data/docs/TagGroupUpdateQueryResourceObject.md +0 -22
- data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagListOp.md +0 -18
- data/docs/TagListOpDataInner.md +0 -20
- data/docs/TagSegmentOp.md +0 -18
- data/docs/TagSegmentOpDataInner.md +0 -20
- data/docs/TagUpdateQuery.md +0 -18
- data/docs/TagUpdateQueryResourceObject.md +0 -22
- data/docs/TagUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagsApi.md +0 -1923
- data/docs/TemplateCloneQuery.md +0 -18
- data/docs/TemplateCloneQueryResourceObject.md +0 -20
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +0 -22
- data/docs/TemplateCreateQuery.md +0 -18
- data/docs/TemplateCreateQueryResourceObject.md +0 -20
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +0 -32
- data/docs/TemplateEnum.md +0 -15
- data/docs/TemplateRenderQuery.md +0 -18
- data/docs/TemplateRenderQueryResourceObject.md +0 -20
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +0 -22
- data/docs/TemplateUpdateQuery.md +0 -18
- data/docs/TemplateUpdateQueryResourceObject.md +0 -22
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +0 -30
- data/docs/TemplatesApi.md +0 -525
- data/docs/TestApiAnalyticsSampleEnum.md +0 -15
- data/docs/TestListEnum.md +0 -15
- data/docs/ThrottledScheduleOptions.md +0 -20
- data/docs/TrackingOptionsSubObject.md +0 -24
- data/docs/UTMParamsSubObject.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/UnsuppressionCreateJobCreateQuery.md +0 -18
- data/docs/UnsuppressionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/UnsuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/UtmParamInfo.md +0 -20
- data/git_push.sh +0 -57
- data/lib/klaviyo-api-sdk/api/client_api.rb +0 -249
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +0 -284
- data/lib/klaviyo-api-sdk/models/collection_links.rb +0 -260
- data/lib/klaviyo-api-sdk/models/email_channel.rb +0 -219
- data/lib/klaviyo-api-sdk/models/email_marketing.rb +0 -298
- data/lib/klaviyo-api-sdk/models/email_marketing_list_suppression.rb +0 -255
- data/lib/klaviyo-api-sdk/models/email_marketing_suppression.rb +0 -240
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +0 -266
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +0 -268
- data/lib/klaviyo-api-sdk/models/error_source.rb +0 -227
- data/lib/klaviyo-api-sdk/models/flow_action_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +0 -242
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/object_links.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +0 -247
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +0 -269
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object.rb +0 -238
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object_attributes.rb +0 -265
- data/lib/klaviyo-api-sdk/models/predictive_analytics.rb +0 -300
- data/lib/klaviyo-api-sdk/models/profile_aggregate_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/send_options.rb +0 -238
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +0 -240
- data/lib/klaviyo-api-sdk/models/sms_channel.rb +0 -219
- data/lib/klaviyo-api-sdk/models/sms_marketing.rb +0 -270
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +0 -238
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +0 -266
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +0 -240
- data/lib/klaviyo-api-sdk/models/subscription_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/subscriptions.rb +0 -228
- data/lib/klaviyo-api-sdk/models/test_api_analytics_sample_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/test_list_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +0 -238
- data/spec/api/campaigns_api_spec.rb +0 -255
- data/spec/api/catalogs_api_spec.rb +0 -751
- data/spec/api/client_api_spec.rb +0 -74
- data/spec/api/data_privacy_api_spec.rb +0 -47
- data/spec/api/events_api_spec.rb +0 -132
- data/spec/api/flows_api_spec.rb +0 -247
- data/spec/api/lists_api_spec.rb +0 -180
- data/spec/api/metrics_api_spec.rb +0 -74
- data/spec/api/profiles_api_spec.rb +0 -194
- data/spec/api/segments_api_spec.rb +0 -130
- data/spec/api/tags_api_spec.rb +0 -367
- data/spec/api/templates_api_spec.rb +0 -124
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/audiences_sub_object_spec.rb +0 -40
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_clone_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_clone_query_spec.rb +0 -34
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/campaign_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_create_query_spec.rb +0 -34
- data/spec/models/campaign_enum_spec.rb +0 -28
- data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_spec.rb +0 -34
- data/spec/models/campaign_message_enum_spec.rb +0 -28
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_message_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_enum_spec.rb +0 -28
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_send_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_send_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +0 -34
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +0 -56
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_category_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_enum_spec.rb +0 -28
- data/spec/models/catalog_category_item_op_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_category_update_query_spec.rb +0 -34
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_category_op_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_item_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_enum_spec.rb +0 -28
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +0 -82
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_item_update_query_spec.rb +0 -34
- data/spec/models/catalog_job_error_payload_spec.rb +0 -58
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +0 -126
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_data_inner_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_update_query_spec.rb +0 -34
- data/spec/models/collection_links_spec.rb +0 -58
- data/spec/models/content_sub_object_spec.rb +0 -64
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +0 -40
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +0 -34
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +0 -28
- data/spec/models/email_channel_spec.rb +0 -34
- data/spec/models/email_marketing_list_suppression_spec.rb +0 -46
- data/spec/models/email_marketing_spec.rb +0 -76
- data/spec/models/email_marketing_suppression_spec.rb +0 -40
- data/spec/models/email_message_content_spec.rb +0 -52
- data/spec/models/email_tracking_options_spec.rb +0 -52
- data/spec/models/error_source_spec.rb +0 -34
- data/spec/models/event_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/event_create_query_resource_object_spec.rb +0 -40
- data/spec/models/event_create_query_spec.rb +0 -34
- data/spec/models/event_enum_spec.rb +0 -28
- data/spec/models/flow_action_enum_spec.rb +0 -28
- data/spec/models/flow_enum_spec.rb +0 -28
- data/spec/models/flow_message_enum_spec.rb +0 -28
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/flow_update_query_resource_object_spec.rb +0 -46
- data/spec/models/flow_update_query_spec.rb +0 -34
- data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +0 -40
- data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +0 -58
- data/spec/models/get_campaigns4_xx_response_spec.rb +0 -34
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/list_create_query_resource_object_spec.rb +0 -40
- data/spec/models/list_create_query_spec.rb +0 -34
- data/spec/models/list_enum_spec.rb +0 -28
- data/spec/models/list_members_add_query_data_inner_spec.rb +0 -44
- data/spec/models/list_members_add_query_spec.rb +0 -34
- data/spec/models/list_members_delete_query_spec.rb +0 -34
- data/spec/models/list_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/list_partial_update_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_enum_spec.rb +0 -28
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +0 -40
- data/spec/models/metric_aggregate_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_row_dto_spec.rb +0 -40
- data/spec/models/metric_create_query_spec.rb +0 -40
- data/spec/models/metric_enum_spec.rb +0 -28
- data/spec/models/object_links_spec.rb +0 -34
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +0 -94
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +0 -46
- data/spec/models/onsite_profile_create_query_spec.rb +0 -34
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +0 -64
- data/spec/models/onsite_profile_meta_spec.rb +0 -34
- data/spec/models/onsite_subscription_create_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/onsite_subscription_create_query_resource_object_spec.rb +0 -40
- data/spec/models/onsite_subscription_create_query_spec.rb +0 -34
- data/spec/models/predictive_analytics_spec.rb +0 -82
- data/spec/models/profile_aggregate_enum_spec.rb +0 -28
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +0 -88
- data/spec/models/profile_create_query_resource_object_spec.rb +0 -40
- data/spec/models/profile_create_query_spec.rb +0 -34
- data/spec/models/profile_enum_spec.rb +0 -28
- data/spec/models/profile_location_latitude_spec.rb +0 -31
- data/spec/models/profile_location_longitude_spec.rb +0 -31
- data/spec/models/profile_location_spec.rb +0 -82
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/profile_partial_update_query_spec.rb +0 -34
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_unsubscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_unsuppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/segment_enum_spec.rb +0 -28
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/segment_partial_update_query_spec.rb +0 -34
- data/spec/models/send_options_spec.rb +0 -40
- data/spec/models/send_options_sub_object_spec.rb +0 -34
- data/spec/models/send_strategy_sub_object_spec.rb +0 -52
- data/spec/models/send_time_sub_object_spec.rb +0 -40
- data/spec/models/sms_channel_spec.rb +0 -34
- data/spec/models/sms_marketing_spec.rb +0 -52
- data/spec/models/sms_message_content_spec.rb +0 -40
- data/spec/models/sms_render_options_spec.rb +0 -52
- data/spec/models/sms_tracking_options_spec.rb +0 -40
- data/spec/models/static_schedule_options_spec.rb +0 -46
- data/spec/models/sto_schedule_options_spec.rb +0 -34
- data/spec/models/subscription_channels_spec.rb +0 -48
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/subscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/subscription_enum_spec.rb +0 -28
- data/spec/models/subscription_spec.rb +0 -52
- data/spec/models/subscriptions_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/suppression_spec.rb +0 -34
- data/spec/models/tag_campaign_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_campaign_op_spec.rb +0 -34
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_create_query_spec.rb +0 -34
- data/spec/models/tag_enum_spec.rb +0 -28
- data/spec/models/tag_flow_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_flow_op_spec.rb +0 -34
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_group_create_query_spec.rb +0 -34
- data/spec/models/tag_group_enum_spec.rb +0 -28
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_group_update_query_spec.rb +0 -34
- data/spec/models/tag_list_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_list_op_spec.rb +0 -34
- data/spec/models/tag_segment_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_segment_op_spec.rb +0 -34
- data/spec/models/tag_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/tag_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_update_query_spec.rb +0 -34
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_clone_query_resource_object_spec.rb +0 -40
- data/spec/models/template_clone_query_spec.rb +0 -34
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/template_create_query_resource_object_spec.rb +0 -40
- data/spec/models/template_create_query_spec.rb +0 -34
- data/spec/models/template_enum_spec.rb +0 -28
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_render_query_resource_object_spec.rb +0 -40
- data/spec/models/template_render_query_spec.rb +0 -34
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +0 -52
- data/spec/models/template_update_query_resource_object_spec.rb +0 -46
- data/spec/models/template_update_query_spec.rb +0 -34
- data/spec/models/test_api_analytics_sample_enum_spec.rb +0 -28
- data/spec/models/test_list_enum_spec.rb +0 -28
- data/spec/models/throttled_schedule_options_spec.rb +0 -40
- data/spec/models/tracking_options_sub_object_spec.rb +0 -52
- data/spec/models/unsubscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/unsubscription_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/unsubscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/unsuppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/utm_param_info_spec.rb +0 -40
- data/spec/models/utm_params_sub_object_spec.rb +0 -40
- data/spec/spec_helper.rb +0 -111
data/README.md
CHANGED
@@ -1,12 +1,12 @@
|
|
1
1
|
# Klaviyo Ruby SDK
|
2
2
|
|
3
|
-
- SDK version:
|
4
|
-
- API revision: 2023-
|
3
|
+
- SDK version: 3.0.0
|
4
|
+
- API revision: 2023-06-15
|
5
5
|
|
6
6
|
## Helpful Resources
|
7
7
|
|
8
|
-
- [API Reference](https://developers.klaviyo.com/en/v2023-
|
9
|
-
- [API Guides](https://developers.klaviyo.com/en/v2023-
|
8
|
+
- [API Reference](https://developers.klaviyo.com/en/v2023-06-15/reference)
|
9
|
+
- [API Guides](https://developers.klaviyo.com/en/v2023-06-15/docs)
|
10
10
|
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)
|
11
11
|
|
12
12
|
## Design & Approach
|
@@ -19,15 +19,15 @@ This SDK is organized into the following resources:
|
|
19
19
|
|
20
20
|
|
21
21
|
|
22
|
-
-
|
22
|
+
- Accounts
|
23
23
|
|
24
24
|
|
25
25
|
|
26
|
-
-
|
26
|
+
- Campaigns
|
27
27
|
|
28
28
|
|
29
29
|
|
30
|
-
-
|
30
|
+
- Catalogs
|
31
31
|
|
32
32
|
|
33
33
|
|
@@ -68,10 +68,10 @@ This SDK is organized into the following resources:
|
|
68
68
|
|
69
69
|
|
70
70
|
|
71
|
-
|
71
|
+
## Installation
|
72
72
|
|
73
73
|
|
74
|
-
|
74
|
+
### Build
|
75
75
|
|
76
76
|
To build the Ruby code into a gem:
|
77
77
|
|
@@ -82,13 +82,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
82
82
|
Then install the gem locally:
|
83
83
|
|
84
84
|
```shell
|
85
|
-
gem install ./klaviyo-api-sdk-
|
85
|
+
gem install ./klaviyo-api-sdk-3.0.0.gem
|
86
86
|
```
|
87
87
|
|
88
88
|
|
89
89
|
Finally add this to the Gemfile:
|
90
90
|
|
91
|
-
gem 'klaviyo-api-sdk', '~>
|
91
|
+
gem 'klaviyo-api-sdk', '~> 3.0.0'
|
92
92
|
|
93
93
|
To install directly from rubygems:
|
94
94
|
|
@@ -96,7 +96,7 @@ To install directly from rubygems:
|
|
96
96
|
gem install klaviyo-api-sdk
|
97
97
|
```
|
98
98
|
|
99
|
-
|
99
|
+
## Usage Example
|
100
100
|
|
101
101
|
### To load the gem
|
102
102
|
|
@@ -132,7 +132,7 @@ begin
|
|
132
132
|
end
|
133
133
|
```
|
134
134
|
|
135
|
-
|
135
|
+
## Error Handling
|
136
136
|
|
137
137
|
This SDK throws an `ApiException` error when the server returns a non-`2XX` response.
|
138
138
|
```ruby
|
@@ -143,13 +143,6 @@ rescue KlaviyoAPI::ApiError => e
|
|
143
143
|
end
|
144
144
|
```
|
145
145
|
|
146
|
-
# Comprehensive list of Operations & Parameters
|
147
|
-
|
148
|
-
_**NOTE:**_
|
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).
|
150
|
-
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
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.
|
152
|
-
|
153
146
|
## Method signatures
|
154
147
|
- `get` operations can be passed an optional `opts` object (e.g. `get_list_profiles(opts)`).
|
155
148
|
`opts` describes the available options for fetching data (some operations only support a subset of these or none).
|
@@ -185,6 +178,304 @@ body = {
|
|
185
178
|
KlaviyoAPI::Catalogs.create_catalog_item(body)
|
186
179
|
```
|
187
180
|
|
181
|
+
## Optional Parameters and Json Api Features
|
182
|
+
|
183
|
+
Here we will go over
|
184
|
+
|
185
|
+
- Pagination
|
186
|
+
- Page size
|
187
|
+
- Additional Fields
|
188
|
+
- Filtering
|
189
|
+
- Sparse Fields
|
190
|
+
- Sorting
|
191
|
+
- Relationships
|
192
|
+
|
193
|
+
### Quick rule
|
194
|
+
|
195
|
+
As a reminder, the optional parameters are named slightly different from how you would make the call without the SDK docs, query parameter names have variables that make bad Ruby names like
|
196
|
+
`page[cursor]` are transformed to `page_cursor`.
|
197
|
+
|
198
|
+
### Cursor based Pagination
|
199
|
+
|
200
|
+
All the endpoints that return list of results use cursor base pagination.
|
201
|
+
|
202
|
+
Obtain the cursor value from the call you want to get the next page for, then pass it under the `page_cursor` optional parameter. The page cursor looks like `WzE2NDA5OTUyMDAsICIzYzRjeXdGTndadyIsIHRydWVd`.
|
203
|
+
|
204
|
+
If you were using the api directly you would pass the cursor like:
|
205
|
+
|
206
|
+
```
|
207
|
+
https://a.klaviyo.com/api/profiles/?page[cursor]=WzE2NTcyMTM4NjQsICIzc042NjRyeHo0ciIsIHRydWVd
|
208
|
+
```
|
209
|
+
|
210
|
+
The same call in the sdk the call would look like this:
|
211
|
+
|
212
|
+
```ruby
|
213
|
+
opts = {
|
214
|
+
page_cursor: 'WzE2NTcyMTM4NjQsICIzc042NjRyeHo0ciIsIHRydWVd',
|
215
|
+
}
|
216
|
+
|
217
|
+
response = KlaviyoAPI::Profiles.get_profiles(opts)
|
218
|
+
```
|
219
|
+
|
220
|
+
You get the cursor for the next page from `response[:links][:next]` returns the entire url of the next call but the sdk will accept the entire link and use only the relevant cursor.
|
221
|
+
|
222
|
+
Here is an example of getting the second next and passing in the page cursor:
|
223
|
+
|
224
|
+
```ruby
|
225
|
+
opts = {
|
226
|
+
page_cursor: response[:links][:next], # previous response
|
227
|
+
}
|
228
|
+
|
229
|
+
response = KlaviyoAPI::Profiles.get_profiles(opts)
|
230
|
+
```
|
231
|
+
|
232
|
+
There are more page cursors than just next, check the endpoint's docs or the response type but often there is `first`, `last`, `next` and `prev`.
|
233
|
+
|
234
|
+
### Page Size
|
235
|
+
Some endpoint you can get a larger or smaller page size by using the `page_size` parameter.
|
236
|
+
|
237
|
+
if you were hitting the api directly this would look like
|
238
|
+
|
239
|
+
```
|
240
|
+
https://a.klaviyo.com/api/profiles/?page[size]=20
|
241
|
+
```
|
242
|
+
|
243
|
+
In the SDK this looks like:
|
244
|
+
|
245
|
+
```ruby
|
246
|
+
opts = {
|
247
|
+
page_size: 20,
|
248
|
+
}
|
249
|
+
|
250
|
+
response = KlaviyoAPI::Profiles.get_profiles(opts)
|
251
|
+
```
|
252
|
+
|
253
|
+
### Additional Fields
|
254
|
+
|
255
|
+
Additional fields are used to populate part of the response that would be null otherwise.
|
256
|
+
For the `getProfile` endpoint you can pass in a request to get the predictive analytics of the profile. Using the `additional_fields` parameter often will change the rate limit of the endpoint so be sure to keep an eye on your usage.
|
257
|
+
|
258
|
+
The url would look like:
|
259
|
+
```
|
260
|
+
https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/?additional-fields[profile]=predictive_analytics
|
261
|
+
```
|
262
|
+
|
263
|
+
The SDK equivalent is:
|
264
|
+
|
265
|
+
```ruby
|
266
|
+
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
|
267
|
+
opts = {
|
268
|
+
additional_fields_profile: ["predictive_analytics"]
|
269
|
+
}
|
270
|
+
|
271
|
+
response = KlaviyoAPI::Profiles.get_profile(profile_id, opts)
|
272
|
+
|
273
|
+
# If your profile has enough information for predictive analytis it will populate
|
274
|
+
pp(response[:data][:attributes][:predictive_analytics])
|
275
|
+
```
|
276
|
+
|
277
|
+
### Filtering
|
278
|
+
|
279
|
+
Filter by passing the filter as a string as under the optional parameter `filter`.
|
280
|
+
|
281
|
+
Read more about formatting your filter strings in our [developer documentation](https://developers.klaviyo.com/en/v2023-02-22/docs/filtering_)
|
282
|
+
|
283
|
+
Here is an example of a filter string for results between two date times: `less-than(updated,2023-04-26T00:00:00Z),greater-than(updated,2023-04-19T00:00:00Z)`
|
284
|
+
|
285
|
+
Here is a code example filter for profiles with the matching emails:
|
286
|
+
|
287
|
+
```
|
288
|
+
https://a.klaviyo.com/api/profiles/?filter=any(email,["henry.chan@klaviyo-demo.com","amanda.das@klaviyo-demo.com"]
|
289
|
+
```
|
290
|
+
For the sdk:
|
291
|
+
```ruby
|
292
|
+
opts = {
|
293
|
+
filter: 'any(email,["henry.chan@klaviyo-demo.com","amanda.das@klaviyo-demo.com"])'
|
294
|
+
}
|
295
|
+
|
296
|
+
response = KlaviyoAPI::Profiles.get_profiles(opts)
|
297
|
+
```
|
298
|
+
|
299
|
+
### Sparse Fields
|
300
|
+
|
301
|
+
If you only want a specific subset of data from a specific query you can use sparse fields to request only the specific properties.
|
302
|
+
The SDK expands the optional sparse fields into their own option, where you can pass a list of the desired items to include.
|
303
|
+
|
304
|
+
To get a list of event properties the URL your would use is:
|
305
|
+
```
|
306
|
+
https://a.klaviyo.com/api/events/?fields[event]=event_properties
|
307
|
+
```
|
308
|
+
|
309
|
+
In the SDK you would use
|
310
|
+
|
311
|
+
```ruby
|
312
|
+
opts = {
|
313
|
+
fields_event: ["event_properties"]
|
314
|
+
}
|
315
|
+
|
316
|
+
response = KlaviyoAPI::Events.get_events(opts)
|
317
|
+
```
|
318
|
+
|
319
|
+
### Sorting
|
320
|
+
|
321
|
+
Your can request the results of specific endpoints to be ordered by a given parameter. The direction of the sort can swapped by adding a `-` in front of the sort key.
|
322
|
+
For example `datetime` will be ascending while `-datetime` will be descending.
|
323
|
+
|
324
|
+
If you are unsure about the available sort fields you can always check the documentation for the endpoint you are using.
|
325
|
+
For a comprehensive list that links to the documentation for each function check the Endpoints section below.
|
326
|
+
|
327
|
+
Get events sorted by oldest to newest datetime.
|
328
|
+
```
|
329
|
+
https://a.klaviyo.com/api/events/?sort=-datetime
|
330
|
+
```
|
331
|
+
and via the sdk
|
332
|
+
|
333
|
+
```ruby
|
334
|
+
opts = {
|
335
|
+
sort: '-datetime'
|
336
|
+
}
|
337
|
+
|
338
|
+
response = KlaviyoAPI::Events.get_events(opts)
|
339
|
+
```
|
340
|
+
|
341
|
+
### Includes
|
342
|
+
|
343
|
+
How to add additional information to your API response via additional-fields and the `includes` parameter.
|
344
|
+
This allows you to get information about two or more objects from a single api call.
|
345
|
+
Using the `includes` parameter often changes the rate limit of the endpoint so be sure to take note.
|
346
|
+
|
347
|
+
Using the URl to get profile information and the information about the lists the profile is in:
|
348
|
+
|
349
|
+
```
|
350
|
+
https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/?include=lists
|
351
|
+
```
|
352
|
+
|
353
|
+
In the sdk:
|
354
|
+
|
355
|
+
```ruby
|
356
|
+
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
|
357
|
+
opts = {
|
358
|
+
include: ["lists"]
|
359
|
+
}
|
360
|
+
|
361
|
+
response = KlaviyoAPI::Profiles.get_profile(profile_id,opts)
|
362
|
+
|
363
|
+
# Profile information is accessed the same way with
|
364
|
+
pp(response[:data])
|
365
|
+
# Lists related to the profile with be accessible via the included array
|
366
|
+
pp(response[:included])
|
367
|
+
```
|
368
|
+
|
369
|
+
*Note about sparse fields and relationships:* you can request only specific fields of the included object as well.
|
370
|
+
|
371
|
+
```ruby
|
372
|
+
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
|
373
|
+
opts = {
|
374
|
+
fields_list: ["name"],
|
375
|
+
include: ["lists"]
|
376
|
+
}
|
377
|
+
|
378
|
+
response = KlaviyoAPI::Profiles.get_profile(profile_id,opts)
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
# Profile information is accessed the same way with
|
383
|
+
pp(response[:data])
|
384
|
+
# Lists related to the profile with be accessible via the included array
|
385
|
+
pp(response[:included])
|
386
|
+
```
|
387
|
+
|
388
|
+
### Relationships
|
389
|
+
|
390
|
+
The Klaviyo Api has a series of endpoints to expose the relationships between your different Klaviyo Items. You can read more about relationships in [our documentation](https://developers.klaviyo.com/en/v2023-02-22/docs/relationships_).
|
391
|
+
|
392
|
+
Here are some use cases and their examples:
|
393
|
+
|
394
|
+
How to get the list memberships for a profile with the given profile ID.
|
395
|
+
|
396
|
+
Via the URL:
|
397
|
+
|
398
|
+
```
|
399
|
+
https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/relationships/lists/
|
400
|
+
```
|
401
|
+
|
402
|
+
and for the SDK:
|
403
|
+
|
404
|
+
```ruby
|
405
|
+
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
|
406
|
+
|
407
|
+
response = KlaviyoAPI::Profiles.get_profile_relationships_lists(profile_id)
|
408
|
+
```
|
409
|
+
|
410
|
+
For another example:
|
411
|
+
|
412
|
+
Get all campaigns associated with the given `tag_id`.
|
413
|
+
|
414
|
+
the URL:
|
415
|
+
|
416
|
+
```
|
417
|
+
https://a.klaviyo.com/api/tags/9c8db7a0-5ab5-4e3c-9a37-a3224fd14382/relationships/campaigns/
|
418
|
+
```
|
419
|
+
|
420
|
+
Through the SDK:
|
421
|
+
|
422
|
+
```ruby
|
423
|
+
tag_id = '9c8db7a0-5ab5-4e3c-9a37-a3224fd14382'
|
424
|
+
|
425
|
+
response = KlaviyoAPI::Tags.get_tag_relationships_campaigns(tag_id)
|
426
|
+
```
|
427
|
+
### Combining
|
428
|
+
|
429
|
+
You can use any combination of the features outlines above in conjunction with one another.
|
430
|
+
|
431
|
+
#### Get events associated with a specific metric, then return just the event properties sorted by oldest to newest datetime.
|
432
|
+
|
433
|
+
```
|
434
|
+
https://a.klaviyo.com/api/events/?fields[event]=event_properties&filter=equals(metric_id,"URDbLg")&sort=-datetime
|
435
|
+
```
|
436
|
+
or
|
437
|
+
```ruby
|
438
|
+
opts = {
|
439
|
+
filter: 'equals(metric_id,"URDbLg")',
|
440
|
+
fields_event: ["event_properties"]
|
441
|
+
}
|
442
|
+
|
443
|
+
response = KlaviyoAPI::Events.get_events(opts)
|
444
|
+
```
|
445
|
+
|
446
|
+
|
447
|
+
## Comprehensive list of Operations & Parameters
|
448
|
+
|
449
|
+
_**NOTE:**_
|
450
|
+
- 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-06-15/reference/get_events).
|
451
|
+
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
452
|
+
- Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.
|
453
|
+
|
454
|
+
|
455
|
+
|
456
|
+
|
457
|
+
|
458
|
+
|
459
|
+
## Accounts
|
460
|
+
|
461
|
+
|
462
|
+
#### [Get Account](https://developers.klaviyo.com/en/v2023-06-15/reference/get_account)
|
463
|
+
|
464
|
+
```ruby
|
465
|
+
KlaviyoAPI::Accounts.get_account(id, opts)
|
466
|
+
```
|
467
|
+
|
468
|
+
|
469
|
+
|
470
|
+
|
471
|
+
|
472
|
+
#### [Get Accounts](https://developers.klaviyo.com/en/v2023-06-15/reference/get_accounts)
|
473
|
+
|
474
|
+
```ruby
|
475
|
+
KlaviyoAPI::Accounts.get_accounts(opts)
|
476
|
+
```
|
477
|
+
|
478
|
+
|
188
479
|
|
189
480
|
|
190
481
|
|
@@ -192,7 +483,7 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
192
483
|
## Campaigns
|
193
484
|
|
194
485
|
|
195
|
-
#### [Create Campaign](https://developers.klaviyo.com/en/v2023-
|
486
|
+
#### [Create Campaign](https://developers.klaviyo.com/en/v2023-06-15/reference/create_campaign)
|
196
487
|
|
197
488
|
```ruby
|
198
489
|
KlaviyoAPI::Campaigns.create_campaign(body)
|
@@ -202,7 +493,7 @@ KlaviyoAPI::Campaigns.create_campaign(body)
|
|
202
493
|
|
203
494
|
|
204
495
|
|
205
|
-
#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2023-
|
496
|
+
#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2023-06-15/reference/create_campaign_clone)
|
206
497
|
|
207
498
|
```ruby
|
208
499
|
KlaviyoAPI::Campaigns.create_campaign_clone(body)
|
@@ -212,7 +503,7 @@ KlaviyoAPI::Campaigns.create_campaign_clone(body)
|
|
212
503
|
|
213
504
|
|
214
505
|
|
215
|
-
#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2023-
|
506
|
+
#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2023-06-15/reference/create_campaign_message_assign_template)
|
216
507
|
|
217
508
|
```ruby
|
218
509
|
KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
|
@@ -222,7 +513,7 @@ KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
|
|
222
513
|
|
223
514
|
|
224
515
|
|
225
|
-
#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-
|
516
|
+
#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-06-15/reference/create_campaign_recipient_estimation_job)
|
226
517
|
|
227
518
|
```ruby
|
228
519
|
KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
|
@@ -232,7 +523,7 @@ KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
|
|
232
523
|
|
233
524
|
|
234
525
|
|
235
|
-
#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2023-
|
526
|
+
#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2023-06-15/reference/create_campaign_send_job)
|
236
527
|
|
237
528
|
```ruby
|
238
529
|
KlaviyoAPI::Campaigns.create_campaign_send_job(body)
|
@@ -242,7 +533,7 @@ KlaviyoAPI::Campaigns.create_campaign_send_job(body)
|
|
242
533
|
|
243
534
|
|
244
535
|
|
245
|
-
#### [Delete Campaign](https://developers.klaviyo.com/en/v2023-
|
536
|
+
#### [Delete Campaign](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_campaign)
|
246
537
|
|
247
538
|
```ruby
|
248
539
|
KlaviyoAPI::Campaigns.delete_campaign(id)
|
@@ -252,7 +543,7 @@ KlaviyoAPI::Campaigns.delete_campaign(id)
|
|
252
543
|
|
253
544
|
|
254
545
|
|
255
|
-
#### [Get Campaign](https://developers.klaviyo.com/en/v2023-
|
546
|
+
#### [Get Campaign](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign)
|
256
547
|
|
257
548
|
```ruby
|
258
549
|
KlaviyoAPI::Campaigns.get_campaign(id, opts)
|
@@ -262,7 +553,7 @@ KlaviyoAPI::Campaigns.get_campaign(id, opts)
|
|
262
553
|
|
263
554
|
|
264
555
|
|
265
|
-
#### [Get Campaign Message](https://developers.klaviyo.com/en/v2023-
|
556
|
+
#### [Get Campaign Message](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign_message)
|
266
557
|
|
267
558
|
```ruby
|
268
559
|
KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
|
@@ -272,7 +563,7 @@ KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
|
|
272
563
|
|
273
564
|
|
274
565
|
|
275
|
-
#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2023-
|
566
|
+
#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign_recipient_estimation)
|
276
567
|
|
277
568
|
```ruby
|
278
569
|
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
|
@@ -282,7 +573,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
|
|
282
573
|
|
283
574
|
|
284
575
|
|
285
|
-
#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-
|
576
|
+
#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign_recipient_estimation_job)
|
286
577
|
|
287
578
|
```ruby
|
288
579
|
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
|
@@ -292,7 +583,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
|
|
292
583
|
|
293
584
|
|
294
585
|
|
295
|
-
#### [Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2023-
|
586
|
+
#### [Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign_relationships_tags)
|
296
587
|
|
297
588
|
```ruby
|
298
589
|
KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
|
@@ -302,7 +593,7 @@ KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
|
|
302
593
|
|
303
594
|
|
304
595
|
|
305
|
-
#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2023-
|
596
|
+
#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign_send_job)
|
306
597
|
|
307
598
|
```ruby
|
308
599
|
KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
@@ -312,17 +603,17 @@ KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
|
312
603
|
|
313
604
|
|
314
605
|
|
315
|
-
#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2023-
|
606
|
+
#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaign_tags)
|
316
607
|
|
317
608
|
```ruby
|
318
|
-
KlaviyoAPI::Campaigns.get_campaign_tags(
|
609
|
+
KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
|
319
610
|
```
|
320
611
|
|
321
612
|
|
322
613
|
|
323
614
|
|
324
615
|
|
325
|
-
#### [Get Campaigns](https://developers.klaviyo.com/en/v2023-
|
616
|
+
#### [Get Campaigns](https://developers.klaviyo.com/en/v2023-06-15/reference/get_campaigns)
|
326
617
|
|
327
618
|
```ruby
|
328
619
|
KlaviyoAPI::Campaigns.get_campaigns(opts)
|
@@ -332,7 +623,7 @@ KlaviyoAPI::Campaigns.get_campaigns(opts)
|
|
332
623
|
|
333
624
|
|
334
625
|
|
335
|
-
#### [Update Campaign](https://developers.klaviyo.com/en/v2023-
|
626
|
+
#### [Update Campaign](https://developers.klaviyo.com/en/v2023-06-15/reference/update_campaign)
|
336
627
|
|
337
628
|
```ruby
|
338
629
|
KlaviyoAPI::Campaigns.update_campaign(id, body)
|
@@ -342,7 +633,7 @@ KlaviyoAPI::Campaigns.update_campaign(id, body)
|
|
342
633
|
|
343
634
|
|
344
635
|
|
345
|
-
#### [Update Campaign Message](https://developers.klaviyo.com/en/v2023-
|
636
|
+
#### [Update Campaign Message](https://developers.klaviyo.com/en/v2023-06-15/reference/update_campaign_message)
|
346
637
|
|
347
638
|
```ruby
|
348
639
|
KlaviyoAPI::Campaigns.update_campaign_message(id, body)
|
@@ -352,7 +643,7 @@ KlaviyoAPI::Campaigns.update_campaign_message(id, body)
|
|
352
643
|
|
353
644
|
|
354
645
|
|
355
|
-
#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2023-
|
646
|
+
#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2023-06-15/reference/update_campaign_send_job)
|
356
647
|
|
357
648
|
```ruby
|
358
649
|
KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
|
@@ -366,7 +657,7 @@ KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
|
|
366
657
|
## Catalogs
|
367
658
|
|
368
659
|
|
369
|
-
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2023-
|
660
|
+
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2023-06-15/reference/create_catalog_category)
|
370
661
|
|
371
662
|
```ruby
|
372
663
|
KlaviyoAPI::Catalogs.create_catalog_category(body)
|
@@ -376,7 +667,7 @@ KlaviyoAPI::Catalogs.create_catalog_category(body)
|
|
376
667
|
|
377
668
|
|
378
669
|
|
379
|
-
#### [Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-
|
670
|
+
#### [Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-06-15/reference/create_catalog_category_relationships_items)
|
380
671
|
|
381
672
|
```ruby
|
382
673
|
KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
|
@@ -386,7 +677,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
|
|
386
677
|
|
387
678
|
|
388
679
|
|
389
|
-
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2023-
|
680
|
+
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2023-06-15/reference/create_catalog_item)
|
390
681
|
|
391
682
|
```ruby
|
392
683
|
KlaviyoAPI::Catalogs.create_catalog_item(body)
|
@@ -396,7 +687,7 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
396
687
|
|
397
688
|
|
398
689
|
|
399
|
-
#### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-
|
690
|
+
#### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-06-15/reference/create_catalog_item_relationships_categories)
|
400
691
|
|
401
692
|
```ruby
|
402
693
|
KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
|
@@ -406,7 +697,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
|
|
406
697
|
|
407
698
|
|
408
699
|
|
409
|
-
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2023-
|
700
|
+
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2023-06-15/reference/create_catalog_variant)
|
410
701
|
|
411
702
|
```ruby
|
412
703
|
KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
@@ -416,7 +707,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
|
416
707
|
|
417
708
|
|
418
709
|
|
419
|
-
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2023-
|
710
|
+
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_catalog_category)
|
420
711
|
|
421
712
|
```ruby
|
422
713
|
KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
@@ -426,7 +717,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
|
426
717
|
|
427
718
|
|
428
719
|
|
429
|
-
#### [Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-
|
720
|
+
#### [Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_catalog_category_relationships_items)
|
430
721
|
|
431
722
|
```ruby
|
432
723
|
KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
|
@@ -436,7 +727,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
|
|
436
727
|
|
437
728
|
|
438
729
|
|
439
|
-
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2023-
|
730
|
+
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_catalog_item)
|
440
731
|
|
441
732
|
```ruby
|
442
733
|
KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
@@ -446,7 +737,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
|
446
737
|
|
447
738
|
|
448
739
|
|
449
|
-
#### [Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-
|
740
|
+
#### [Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_catalog_item_relationships_categories)
|
450
741
|
|
451
742
|
```ruby
|
452
743
|
KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
|
@@ -456,7 +747,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
|
|
456
747
|
|
457
748
|
|
458
749
|
|
459
|
-
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-
|
750
|
+
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_catalog_variant)
|
460
751
|
|
461
752
|
```ruby
|
462
753
|
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
@@ -466,7 +757,7 @@ KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
|
466
757
|
|
467
758
|
|
468
759
|
|
469
|
-
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2023-
|
760
|
+
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_categories)
|
470
761
|
|
471
762
|
```ruby
|
472
763
|
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
@@ -476,7 +767,7 @@ KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
|
476
767
|
|
477
768
|
|
478
769
|
|
479
|
-
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2023-
|
770
|
+
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_category)
|
480
771
|
|
481
772
|
```ruby
|
482
773
|
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
@@ -486,17 +777,17 @@ KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
|
486
777
|
|
487
778
|
|
488
779
|
|
489
|
-
#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-
|
780
|
+
#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_category_items)
|
490
781
|
|
491
782
|
```ruby
|
492
|
-
KlaviyoAPI::Catalogs.get_catalog_category_items(
|
783
|
+
KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts)
|
493
784
|
```
|
494
785
|
|
495
786
|
|
496
787
|
|
497
788
|
|
498
789
|
|
499
|
-
#### [Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-
|
790
|
+
#### [Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_category_relationships_items)
|
500
791
|
|
501
792
|
```ruby
|
502
793
|
KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
|
@@ -506,7 +797,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
|
|
506
797
|
|
507
798
|
|
508
799
|
|
509
|
-
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2023-
|
800
|
+
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_item)
|
510
801
|
|
511
802
|
```ruby
|
512
803
|
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
@@ -516,17 +807,17 @@ KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
|
516
807
|
|
517
808
|
|
518
809
|
|
519
|
-
#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-
|
810
|
+
#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_item_categories)
|
520
811
|
|
521
812
|
```ruby
|
522
|
-
KlaviyoAPI::Catalogs.get_catalog_item_categories(
|
813
|
+
KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts)
|
523
814
|
```
|
524
815
|
|
525
816
|
|
526
817
|
|
527
818
|
|
528
819
|
|
529
|
-
#### [Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-
|
820
|
+
#### [Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_item_relationships_categories)
|
530
821
|
|
531
822
|
```ruby
|
532
823
|
KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
|
@@ -536,17 +827,17 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
|
|
536
827
|
|
537
828
|
|
538
829
|
|
539
|
-
#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-
|
830
|
+
#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_item_variants)
|
540
831
|
|
541
832
|
```ruby
|
542
|
-
KlaviyoAPI::Catalogs.get_catalog_item_variants(
|
833
|
+
KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts)
|
543
834
|
```
|
544
835
|
|
545
836
|
|
546
837
|
|
547
838
|
|
548
839
|
|
549
|
-
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2023-
|
840
|
+
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_items)
|
550
841
|
|
551
842
|
```ruby
|
552
843
|
KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
@@ -556,7 +847,7 @@ KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
|
556
847
|
|
557
848
|
|
558
849
|
|
559
|
-
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2023-
|
850
|
+
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_variant)
|
560
851
|
|
561
852
|
```ruby
|
562
853
|
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
@@ -566,7 +857,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
|
566
857
|
|
567
858
|
|
568
859
|
|
569
|
-
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2023-
|
860
|
+
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2023-06-15/reference/get_catalog_variants)
|
570
861
|
|
571
862
|
```ruby
|
572
863
|
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
@@ -576,7 +867,7 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
|
576
867
|
|
577
868
|
|
578
869
|
|
579
|
-
#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2023-
|
870
|
+
#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_create_categories_job)
|
580
871
|
|
581
872
|
```ruby
|
582
873
|
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
@@ -586,7 +877,7 @@ KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
|
586
877
|
|
587
878
|
|
588
879
|
|
589
|
-
#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-
|
880
|
+
#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_create_categories_jobs)
|
590
881
|
|
591
882
|
```ruby
|
592
883
|
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
@@ -596,7 +887,7 @@ KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
|
596
887
|
|
597
888
|
|
598
889
|
|
599
|
-
#### [Get Create Items Job](https://developers.klaviyo.com/en/v2023-
|
890
|
+
#### [Get Create Items Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_create_items_job)
|
600
891
|
|
601
892
|
```ruby
|
602
893
|
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
@@ -606,7 +897,7 @@ KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
|
606
897
|
|
607
898
|
|
608
899
|
|
609
|
-
#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-
|
900
|
+
#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_create_items_jobs)
|
610
901
|
|
611
902
|
```ruby
|
612
903
|
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
@@ -616,7 +907,7 @@ KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
|
616
907
|
|
617
908
|
|
618
909
|
|
619
|
-
#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2023-
|
910
|
+
#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_create_variants_job)
|
620
911
|
|
621
912
|
```ruby
|
622
913
|
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
@@ -626,7 +917,7 @@ KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
|
626
917
|
|
627
918
|
|
628
919
|
|
629
|
-
#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-
|
920
|
+
#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_create_variants_jobs)
|
630
921
|
|
631
922
|
```ruby
|
632
923
|
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
@@ -636,7 +927,7 @@ KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
|
636
927
|
|
637
928
|
|
638
929
|
|
639
|
-
#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-
|
930
|
+
#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_delete_categories_job)
|
640
931
|
|
641
932
|
```ruby
|
642
933
|
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
@@ -646,7 +937,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
|
646
937
|
|
647
938
|
|
648
939
|
|
649
|
-
#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-
|
940
|
+
#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_delete_categories_jobs)
|
650
941
|
|
651
942
|
```ruby
|
652
943
|
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
@@ -656,7 +947,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
|
656
947
|
|
657
948
|
|
658
949
|
|
659
|
-
#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2023-
|
950
|
+
#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_delete_items_job)
|
660
951
|
|
661
952
|
```ruby
|
662
953
|
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
@@ -666,7 +957,7 @@ KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
|
666
957
|
|
667
958
|
|
668
959
|
|
669
|
-
#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-
|
960
|
+
#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_delete_items_jobs)
|
670
961
|
|
671
962
|
```ruby
|
672
963
|
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
@@ -676,7 +967,7 @@ KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
|
676
967
|
|
677
968
|
|
678
969
|
|
679
|
-
#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-
|
970
|
+
#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_delete_variants_job)
|
680
971
|
|
681
972
|
```ruby
|
682
973
|
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
@@ -686,7 +977,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
|
686
977
|
|
687
978
|
|
688
979
|
|
689
|
-
#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-
|
980
|
+
#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_delete_variants_jobs)
|
690
981
|
|
691
982
|
```ruby
|
692
983
|
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
@@ -696,7 +987,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
|
696
987
|
|
697
988
|
|
698
989
|
|
699
|
-
#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2023-
|
990
|
+
#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_update_categories_job)
|
700
991
|
|
701
992
|
```ruby
|
702
993
|
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
@@ -706,7 +997,7 @@ KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
|
706
997
|
|
707
998
|
|
708
999
|
|
709
|
-
#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-
|
1000
|
+
#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_update_categories_jobs)
|
710
1001
|
|
711
1002
|
```ruby
|
712
1003
|
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
@@ -716,7 +1007,7 @@ KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
|
716
1007
|
|
717
1008
|
|
718
1009
|
|
719
|
-
#### [Get Update Items Job](https://developers.klaviyo.com/en/v2023-
|
1010
|
+
#### [Get Update Items Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_update_items_job)
|
720
1011
|
|
721
1012
|
```ruby
|
722
1013
|
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
@@ -726,7 +1017,7 @@ KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
|
726
1017
|
|
727
1018
|
|
728
1019
|
|
729
|
-
#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-
|
1020
|
+
#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_update_items_jobs)
|
730
1021
|
|
731
1022
|
```ruby
|
732
1023
|
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
@@ -736,7 +1027,7 @@ KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
|
736
1027
|
|
737
1028
|
|
738
1029
|
|
739
|
-
#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2023-
|
1030
|
+
#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2023-06-15/reference/get_update_variants_job)
|
740
1031
|
|
741
1032
|
```ruby
|
742
1033
|
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
@@ -746,7 +1037,7 @@ KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
|
746
1037
|
|
747
1038
|
|
748
1039
|
|
749
|
-
#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-
|
1040
|
+
#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-06-15/reference/get_update_variants_jobs)
|
750
1041
|
|
751
1042
|
```ruby
|
752
1043
|
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
@@ -756,7 +1047,7 @@ KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
|
756
1047
|
|
757
1048
|
|
758
1049
|
|
759
|
-
#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-
|
1050
|
+
#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_create_categories_job)
|
760
1051
|
|
761
1052
|
```ruby
|
762
1053
|
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
@@ -766,7 +1057,7 @@ KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
|
766
1057
|
|
767
1058
|
|
768
1059
|
|
769
|
-
#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-
|
1060
|
+
#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_create_items_job)
|
770
1061
|
|
771
1062
|
```ruby
|
772
1063
|
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
@@ -776,7 +1067,7 @@ KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
|
776
1067
|
|
777
1068
|
|
778
1069
|
|
779
|
-
#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-
|
1070
|
+
#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_create_variants_job)
|
780
1071
|
|
781
1072
|
```ruby
|
782
1073
|
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
@@ -786,7 +1077,7 @@ KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
|
786
1077
|
|
787
1078
|
|
788
1079
|
|
789
|
-
#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-
|
1080
|
+
#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_delete_categories_job)
|
790
1081
|
|
791
1082
|
```ruby
|
792
1083
|
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
@@ -796,7 +1087,7 @@ KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
|
796
1087
|
|
797
1088
|
|
798
1089
|
|
799
|
-
#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-
|
1090
|
+
#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_delete_items_job)
|
800
1091
|
|
801
1092
|
```ruby
|
802
1093
|
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
@@ -806,7 +1097,7 @@ KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
|
806
1097
|
|
807
1098
|
|
808
1099
|
|
809
|
-
#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-
|
1100
|
+
#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_delete_variants_job)
|
810
1101
|
|
811
1102
|
```ruby
|
812
1103
|
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
@@ -816,7 +1107,7 @@ KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
|
816
1107
|
|
817
1108
|
|
818
1109
|
|
819
|
-
#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-
|
1110
|
+
#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_update_categories_job)
|
820
1111
|
|
821
1112
|
```ruby
|
822
1113
|
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
@@ -826,7 +1117,7 @@ KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
|
826
1117
|
|
827
1118
|
|
828
1119
|
|
829
|
-
#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-
|
1120
|
+
#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_update_items_job)
|
830
1121
|
|
831
1122
|
```ruby
|
832
1123
|
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
@@ -836,7 +1127,7 @@ KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
|
836
1127
|
|
837
1128
|
|
838
1129
|
|
839
|
-
#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-
|
1130
|
+
#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-06-15/reference/spawn_update_variants_job)
|
840
1131
|
|
841
1132
|
```ruby
|
842
1133
|
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
@@ -846,7 +1137,7 @@ KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
|
846
1137
|
|
847
1138
|
|
848
1139
|
|
849
|
-
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2023-
|
1140
|
+
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2023-06-15/reference/update_catalog_category)
|
850
1141
|
|
851
1142
|
```ruby
|
852
1143
|
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
@@ -856,7 +1147,7 @@ KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
|
856
1147
|
|
857
1148
|
|
858
1149
|
|
859
|
-
#### [Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-
|
1150
|
+
#### [Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-06-15/reference/update_catalog_category_relationships_items)
|
860
1151
|
|
861
1152
|
```ruby
|
862
1153
|
KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
|
@@ -866,7 +1157,7 @@ KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
|
|
866
1157
|
|
867
1158
|
|
868
1159
|
|
869
|
-
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2023-
|
1160
|
+
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2023-06-15/reference/update_catalog_item)
|
870
1161
|
|
871
1162
|
```ruby
|
872
1163
|
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
@@ -876,7 +1167,7 @@ KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
|
876
1167
|
|
877
1168
|
|
878
1169
|
|
879
|
-
#### [Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-
|
1170
|
+
#### [Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-06-15/reference/update_catalog_item_relationships_categories)
|
880
1171
|
|
881
1172
|
```ruby
|
882
1173
|
KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
|
@@ -886,7 +1177,7 @@ KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
|
|
886
1177
|
|
887
1178
|
|
888
1179
|
|
889
|
-
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2023-
|
1180
|
+
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2023-06-15/reference/update_catalog_variant)
|
890
1181
|
|
891
1182
|
```ruby
|
892
1183
|
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
@@ -897,44 +1188,10 @@ KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
|
897
1188
|
|
898
1189
|
|
899
1190
|
|
900
|
-
## Client
|
901
|
-
|
902
|
-
|
903
|
-
#### [Create Client Event](https://developers.klaviyo.com/en/v2023-02-22/reference/create_client_event)
|
904
|
-
|
905
|
-
```ruby
|
906
|
-
KlaviyoAPI::Client.create_client_event(company_id, body)
|
907
|
-
```
|
908
|
-
|
909
|
-
|
910
|
-
|
911
|
-
|
912
|
-
|
913
|
-
#### [Create or Update Client Profile](https://developers.klaviyo.com/en/v2023-02-22/reference/create_client_profile)
|
914
|
-
|
915
|
-
```ruby
|
916
|
-
KlaviyoAPI::Client.create_client_profile(company_id, body)
|
917
|
-
```
|
918
|
-
|
919
|
-
|
920
|
-
|
921
|
-
|
922
|
-
|
923
|
-
#### [Create Client Subscription](https://developers.klaviyo.com/en/v2023-02-22/reference/create_client_subscription)
|
924
|
-
|
925
|
-
```ruby
|
926
|
-
KlaviyoAPI::Client.create_client_subscription(company_id, body)
|
927
|
-
```
|
928
|
-
|
929
|
-
|
930
|
-
|
931
|
-
|
932
|
-
|
933
|
-
|
934
1191
|
## Data Privacy
|
935
1192
|
|
936
1193
|
|
937
|
-
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2023-
|
1194
|
+
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2023-06-15/reference/request_profile_deletion)
|
938
1195
|
|
939
1196
|
```ruby
|
940
1197
|
KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
|
@@ -948,7 +1205,7 @@ KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
|
|
948
1205
|
## Events
|
949
1206
|
|
950
1207
|
|
951
|
-
#### [Create Event](https://developers.klaviyo.com/en/v2023-
|
1208
|
+
#### [Create Event](https://developers.klaviyo.com/en/v2023-06-15/reference/create_event)
|
952
1209
|
|
953
1210
|
```ruby
|
954
1211
|
KlaviyoAPI::Events.create_event(body)
|
@@ -958,7 +1215,7 @@ KlaviyoAPI::Events.create_event(body)
|
|
958
1215
|
|
959
1216
|
|
960
1217
|
|
961
|
-
#### [Get Event](https://developers.klaviyo.com/en/v2023-
|
1218
|
+
#### [Get Event](https://developers.klaviyo.com/en/v2023-06-15/reference/get_event)
|
962
1219
|
|
963
1220
|
```ruby
|
964
1221
|
KlaviyoAPI::Events.get_event(id, opts)
|
@@ -968,7 +1225,7 @@ KlaviyoAPI::Events.get_event(id, opts)
|
|
968
1225
|
|
969
1226
|
|
970
1227
|
|
971
|
-
#### [Get Event Metrics](https://developers.klaviyo.com/en/v2023-
|
1228
|
+
#### [Get Event Metrics](https://developers.klaviyo.com/en/v2023-06-15/reference/get_event_metrics)
|
972
1229
|
|
973
1230
|
```ruby
|
974
1231
|
KlaviyoAPI::Events.get_event_metrics(id, opts)
|
@@ -978,7 +1235,7 @@ KlaviyoAPI::Events.get_event_metrics(id, opts)
|
|
978
1235
|
|
979
1236
|
|
980
1237
|
|
981
|
-
#### [Get Event Profiles](https://developers.klaviyo.com/en/v2023-
|
1238
|
+
#### [Get Event Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_event_profiles)
|
982
1239
|
|
983
1240
|
```ruby
|
984
1241
|
KlaviyoAPI::Events.get_event_profiles(id, opts)
|
@@ -988,7 +1245,7 @@ KlaviyoAPI::Events.get_event_profiles(id, opts)
|
|
988
1245
|
|
989
1246
|
|
990
1247
|
|
991
|
-
#### [Get Event Relationships Metrics](https://developers.klaviyo.com/en/v2023-
|
1248
|
+
#### [Get Event Relationships Metrics](https://developers.klaviyo.com/en/v2023-06-15/reference/get_event_relationships_metrics)
|
992
1249
|
|
993
1250
|
```ruby
|
994
1251
|
KlaviyoAPI::Events.get_event_relationships_metrics(id)
|
@@ -998,7 +1255,7 @@ KlaviyoAPI::Events.get_event_relationships_metrics(id)
|
|
998
1255
|
|
999
1256
|
|
1000
1257
|
|
1001
|
-
#### [Get Event Relationships Profiles](https://developers.klaviyo.com/en/v2023-
|
1258
|
+
#### [Get Event Relationships Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_event_relationships_profiles)
|
1002
1259
|
|
1003
1260
|
```ruby
|
1004
1261
|
KlaviyoAPI::Events.get_event_relationships_profiles(id)
|
@@ -1008,7 +1265,7 @@ KlaviyoAPI::Events.get_event_relationships_profiles(id)
|
|
1008
1265
|
|
1009
1266
|
|
1010
1267
|
|
1011
|
-
#### [Get Events](https://developers.klaviyo.com/en/v2023-
|
1268
|
+
#### [Get Events](https://developers.klaviyo.com/en/v2023-06-15/reference/get_events)
|
1012
1269
|
|
1013
1270
|
```ruby
|
1014
1271
|
KlaviyoAPI::Events.get_events(opts)
|
@@ -1022,7 +1279,7 @@ KlaviyoAPI::Events.get_events(opts)
|
|
1022
1279
|
## Flows
|
1023
1280
|
|
1024
1281
|
|
1025
|
-
#### [Get Flow](https://developers.klaviyo.com/en/v2023-
|
1282
|
+
#### [Get Flow](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow)
|
1026
1283
|
|
1027
1284
|
```ruby
|
1028
1285
|
KlaviyoAPI::Flows.get_flow(id, opts)
|
@@ -1032,7 +1289,7 @@ KlaviyoAPI::Flows.get_flow(id, opts)
|
|
1032
1289
|
|
1033
1290
|
|
1034
1291
|
|
1035
|
-
#### [Get Flow Action](https://developers.klaviyo.com/en/v2023-
|
1292
|
+
#### [Get Flow Action](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_action)
|
1036
1293
|
|
1037
1294
|
```ruby
|
1038
1295
|
KlaviyoAPI::Flows.get_flow_action(id, opts)
|
@@ -1042,27 +1299,27 @@ KlaviyoAPI::Flows.get_flow_action(id, opts)
|
|
1042
1299
|
|
1043
1300
|
|
1044
1301
|
|
1045
|
-
#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-
|
1302
|
+
#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_action_flow)
|
1046
1303
|
|
1047
1304
|
```ruby
|
1048
|
-
KlaviyoAPI::Flows.get_flow_action_flow(
|
1305
|
+
KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
|
1049
1306
|
```
|
1050
1307
|
|
1051
1308
|
|
1052
1309
|
|
1053
1310
|
|
1054
1311
|
|
1055
|
-
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2023-
|
1312
|
+
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_action_messages)
|
1056
1313
|
|
1057
1314
|
```ruby
|
1058
|
-
KlaviyoAPI::Flows.get_flow_action_messages(
|
1315
|
+
KlaviyoAPI::Flows.get_flow_action_messages(id, opts)
|
1059
1316
|
```
|
1060
1317
|
|
1061
1318
|
|
1062
1319
|
|
1063
1320
|
|
1064
1321
|
|
1065
|
-
#### [Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2023-
|
1322
|
+
#### [Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_action_relationships_flow)
|
1066
1323
|
|
1067
1324
|
```ruby
|
1068
1325
|
KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
|
@@ -1072,7 +1329,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
|
|
1072
1329
|
|
1073
1330
|
|
1074
1331
|
|
1075
|
-
#### [Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2023-
|
1332
|
+
#### [Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_action_relationships_messages)
|
1076
1333
|
|
1077
1334
|
```ruby
|
1078
1335
|
KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
|
@@ -1082,17 +1339,17 @@ KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
|
|
1082
1339
|
|
1083
1340
|
|
1084
1341
|
|
1085
|
-
#### [Get Flow Actions For Flow](https://developers.klaviyo.com/en/v2023-
|
1342
|
+
#### [Get Flow Actions For Flow](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_flow_actions)
|
1086
1343
|
|
1087
1344
|
```ruby
|
1088
|
-
KlaviyoAPI::Flows.get_flow_flow_actions(
|
1345
|
+
KlaviyoAPI::Flows.get_flow_flow_actions(id, opts)
|
1089
1346
|
```
|
1090
1347
|
|
1091
1348
|
|
1092
1349
|
|
1093
1350
|
|
1094
1351
|
|
1095
|
-
#### [Get Flow Message](https://developers.klaviyo.com/en/v2023-
|
1352
|
+
#### [Get Flow Message](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_message)
|
1096
1353
|
|
1097
1354
|
```ruby
|
1098
1355
|
KlaviyoAPI::Flows.get_flow_message(id, opts)
|
@@ -1102,17 +1359,17 @@ KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
1102
1359
|
|
1103
1360
|
|
1104
1361
|
|
1105
|
-
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-
|
1362
|
+
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_message_action)
|
1106
1363
|
|
1107
1364
|
```ruby
|
1108
|
-
KlaviyoAPI::Flows.get_flow_message_action(
|
1365
|
+
KlaviyoAPI::Flows.get_flow_message_action(id, opts)
|
1109
1366
|
```
|
1110
1367
|
|
1111
1368
|
|
1112
1369
|
|
1113
1370
|
|
1114
1371
|
|
1115
|
-
#### [Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2023-
|
1372
|
+
#### [Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_message_relationships_action)
|
1116
1373
|
|
1117
1374
|
```ruby
|
1118
1375
|
KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
|
@@ -1122,7 +1379,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
|
|
1122
1379
|
|
1123
1380
|
|
1124
1381
|
|
1125
|
-
#### [Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2023-
|
1382
|
+
#### [Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_relationships_flow_actions)
|
1126
1383
|
|
1127
1384
|
```ruby
|
1128
1385
|
KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts)
|
@@ -1132,7 +1389,7 @@ KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts)
|
|
1132
1389
|
|
1133
1390
|
|
1134
1391
|
|
1135
|
-
#### [Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2023-
|
1392
|
+
#### [Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_relationships_tags)
|
1136
1393
|
|
1137
1394
|
```ruby
|
1138
1395
|
KlaviyoAPI::Flows.get_flow_relationships_tags(id)
|
@@ -1142,17 +1399,17 @@ KlaviyoAPI::Flows.get_flow_relationships_tags(id)
|
|
1142
1399
|
|
1143
1400
|
|
1144
1401
|
|
1145
|
-
#### [Get Flow Tags](https://developers.klaviyo.com/en/v2023-
|
1402
|
+
#### [Get Flow Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flow_tags)
|
1146
1403
|
|
1147
1404
|
```ruby
|
1148
|
-
KlaviyoAPI::Flows.get_flow_tags(
|
1405
|
+
KlaviyoAPI::Flows.get_flow_tags(id, opts)
|
1149
1406
|
```
|
1150
1407
|
|
1151
1408
|
|
1152
1409
|
|
1153
1410
|
|
1154
1411
|
|
1155
|
-
#### [Get Flows](https://developers.klaviyo.com/en/v2023-
|
1412
|
+
#### [Get Flows](https://developers.klaviyo.com/en/v2023-06-15/reference/get_flows)
|
1156
1413
|
|
1157
1414
|
```ruby
|
1158
1415
|
KlaviyoAPI::Flows.get_flows(opts)
|
@@ -1162,7 +1419,7 @@ KlaviyoAPI::Flows.get_flows(opts)
|
|
1162
1419
|
|
1163
1420
|
|
1164
1421
|
|
1165
|
-
#### [Update Flow Status](https://developers.klaviyo.com/en/v2023-
|
1422
|
+
#### [Update Flow Status](https://developers.klaviyo.com/en/v2023-06-15/reference/update_flow)
|
1166
1423
|
|
1167
1424
|
```ruby
|
1168
1425
|
KlaviyoAPI::Flows.update_flow(id, body)
|
@@ -1176,7 +1433,7 @@ KlaviyoAPI::Flows.update_flow(id, body)
|
|
1176
1433
|
## Lists
|
1177
1434
|
|
1178
1435
|
|
1179
|
-
#### [Create List](https://developers.klaviyo.com/en/v2023-
|
1436
|
+
#### [Create List](https://developers.klaviyo.com/en/v2023-06-15/reference/create_list)
|
1180
1437
|
|
1181
1438
|
```ruby
|
1182
1439
|
KlaviyoAPI::Lists.create_list(body)
|
@@ -1186,7 +1443,7 @@ KlaviyoAPI::Lists.create_list(body)
|
|
1186
1443
|
|
1187
1444
|
|
1188
1445
|
|
1189
|
-
#### [Add Profile To List](https://developers.klaviyo.com/en/v2023-
|
1446
|
+
#### [Add Profile To List](https://developers.klaviyo.com/en/v2023-06-15/reference/create_list_relationships)
|
1190
1447
|
|
1191
1448
|
```ruby
|
1192
1449
|
KlaviyoAPI::Lists.create_list_relationships(id, body)
|
@@ -1196,7 +1453,7 @@ KlaviyoAPI::Lists.create_list_relationships(id, body)
|
|
1196
1453
|
|
1197
1454
|
|
1198
1455
|
|
1199
|
-
#### [Delete List](https://developers.klaviyo.com/en/v2023-
|
1456
|
+
#### [Delete List](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_list)
|
1200
1457
|
|
1201
1458
|
```ruby
|
1202
1459
|
KlaviyoAPI::Lists.delete_list(id)
|
@@ -1206,7 +1463,7 @@ KlaviyoAPI::Lists.delete_list(id)
|
|
1206
1463
|
|
1207
1464
|
|
1208
1465
|
|
1209
|
-
#### [Remove Profile From List](https://developers.klaviyo.com/en/v2023-
|
1466
|
+
#### [Remove Profile From List](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_list_relationships)
|
1210
1467
|
|
1211
1468
|
```ruby
|
1212
1469
|
KlaviyoAPI::Lists.delete_list_relationships(id, body)
|
@@ -1216,7 +1473,7 @@ KlaviyoAPI::Lists.delete_list_relationships(id, body)
|
|
1216
1473
|
|
1217
1474
|
|
1218
1475
|
|
1219
|
-
#### [Get List](https://developers.klaviyo.com/en/v2023-
|
1476
|
+
#### [Get List](https://developers.klaviyo.com/en/v2023-06-15/reference/get_list)
|
1220
1477
|
|
1221
1478
|
```ruby
|
1222
1479
|
KlaviyoAPI::Lists.get_list(id, opts)
|
@@ -1226,17 +1483,17 @@ KlaviyoAPI::Lists.get_list(id, opts)
|
|
1226
1483
|
|
1227
1484
|
|
1228
1485
|
|
1229
|
-
#### [Get List Profiles](https://developers.klaviyo.com/en/v2023-
|
1486
|
+
#### [Get List Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_list_profiles)
|
1230
1487
|
|
1231
1488
|
```ruby
|
1232
|
-
KlaviyoAPI::Lists.get_list_profiles(
|
1489
|
+
KlaviyoAPI::Lists.get_list_profiles(id, opts)
|
1233
1490
|
```
|
1234
1491
|
|
1235
1492
|
|
1236
1493
|
|
1237
1494
|
|
1238
1495
|
|
1239
|
-
#### [Get List Relationships Profiles](https://developers.klaviyo.com/en/v2023-
|
1496
|
+
#### [Get List Relationships Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_list_relationships_profiles)
|
1240
1497
|
|
1241
1498
|
```ruby
|
1242
1499
|
KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
|
@@ -1246,7 +1503,7 @@ KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
|
|
1246
1503
|
|
1247
1504
|
|
1248
1505
|
|
1249
|
-
#### [Get List Relationships Tags](https://developers.klaviyo.com/en/v2023-
|
1506
|
+
#### [Get List Relationships Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_list_relationships_tags)
|
1250
1507
|
|
1251
1508
|
```ruby
|
1252
1509
|
KlaviyoAPI::Lists.get_list_relationships_tags(id)
|
@@ -1256,17 +1513,17 @@ KlaviyoAPI::Lists.get_list_relationships_tags(id)
|
|
1256
1513
|
|
1257
1514
|
|
1258
1515
|
|
1259
|
-
#### [Get List Tags](https://developers.klaviyo.com/en/v2023-
|
1516
|
+
#### [Get List Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_list_tags)
|
1260
1517
|
|
1261
1518
|
```ruby
|
1262
|
-
KlaviyoAPI::Lists.get_list_tags(
|
1519
|
+
KlaviyoAPI::Lists.get_list_tags(id, opts)
|
1263
1520
|
```
|
1264
1521
|
|
1265
1522
|
|
1266
1523
|
|
1267
1524
|
|
1268
1525
|
|
1269
|
-
#### [Get Lists](https://developers.klaviyo.com/en/v2023-
|
1526
|
+
#### [Get Lists](https://developers.klaviyo.com/en/v2023-06-15/reference/get_lists)
|
1270
1527
|
|
1271
1528
|
```ruby
|
1272
1529
|
KlaviyoAPI::Lists.get_lists(opts)
|
@@ -1276,7 +1533,7 @@ KlaviyoAPI::Lists.get_lists(opts)
|
|
1276
1533
|
|
1277
1534
|
|
1278
1535
|
|
1279
|
-
#### [Update List](https://developers.klaviyo.com/en/v2023-
|
1536
|
+
#### [Update List](https://developers.klaviyo.com/en/v2023-06-15/reference/update_list)
|
1280
1537
|
|
1281
1538
|
```ruby
|
1282
1539
|
KlaviyoAPI::Lists.update_list(id, body)
|
@@ -1290,7 +1547,7 @@ KlaviyoAPI::Lists.update_list(id, body)
|
|
1290
1547
|
## Metrics
|
1291
1548
|
|
1292
1549
|
|
1293
|
-
#### [Get Metric](https://developers.klaviyo.com/en/v2023-
|
1550
|
+
#### [Get Metric](https://developers.klaviyo.com/en/v2023-06-15/reference/get_metric)
|
1294
1551
|
|
1295
1552
|
```ruby
|
1296
1553
|
KlaviyoAPI::Metrics.get_metric(id, opts)
|
@@ -1300,7 +1557,7 @@ KlaviyoAPI::Metrics.get_metric(id, opts)
|
|
1300
1557
|
|
1301
1558
|
|
1302
1559
|
|
1303
|
-
#### [Get Metrics](https://developers.klaviyo.com/en/v2023-
|
1560
|
+
#### [Get Metrics](https://developers.klaviyo.com/en/v2023-06-15/reference/get_metrics)
|
1304
1561
|
|
1305
1562
|
```ruby
|
1306
1563
|
KlaviyoAPI::Metrics.get_metrics(opts)
|
@@ -1310,7 +1567,7 @@ KlaviyoAPI::Metrics.get_metrics(opts)
|
|
1310
1567
|
|
1311
1568
|
|
1312
1569
|
|
1313
|
-
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-
|
1570
|
+
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-06-15/reference/query_metric_aggregates)
|
1314
1571
|
|
1315
1572
|
```ruby
|
1316
1573
|
KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
@@ -1324,17 +1581,17 @@ KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
|
1324
1581
|
## Profiles
|
1325
1582
|
|
1326
1583
|
|
1327
|
-
#### [Create Profile](https://developers.klaviyo.com/en/v2023-
|
1584
|
+
#### [Create Profile](https://developers.klaviyo.com/en/v2023-06-15/reference/create_profile)
|
1328
1585
|
|
1329
1586
|
```ruby
|
1330
|
-
KlaviyoAPI::Profiles.create_profile(body
|
1587
|
+
KlaviyoAPI::Profiles.create_profile(body)
|
1331
1588
|
```
|
1332
1589
|
|
1333
1590
|
|
1334
1591
|
|
1335
1592
|
|
1336
1593
|
|
1337
|
-
#### [Get Profile](https://developers.klaviyo.com/en/v2023-
|
1594
|
+
#### [Get Profile](https://developers.klaviyo.com/en/v2023-06-15/reference/get_profile)
|
1338
1595
|
|
1339
1596
|
```ruby
|
1340
1597
|
KlaviyoAPI::Profiles.get_profile(id, opts)
|
@@ -1344,17 +1601,17 @@ KlaviyoAPI::Profiles.get_profile(id, opts)
|
|
1344
1601
|
|
1345
1602
|
|
1346
1603
|
|
1347
|
-
#### [Get Profile Lists](https://developers.klaviyo.com/en/v2023-
|
1604
|
+
#### [Get Profile Lists](https://developers.klaviyo.com/en/v2023-06-15/reference/get_profile_lists)
|
1348
1605
|
|
1349
1606
|
```ruby
|
1350
|
-
KlaviyoAPI::Profiles.get_profile_lists(
|
1607
|
+
KlaviyoAPI::Profiles.get_profile_lists(id, opts)
|
1351
1608
|
```
|
1352
1609
|
|
1353
1610
|
|
1354
1611
|
|
1355
1612
|
|
1356
1613
|
|
1357
|
-
#### [Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2023-
|
1614
|
+
#### [Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2023-06-15/reference/get_profile_relationships_lists)
|
1358
1615
|
|
1359
1616
|
```ruby
|
1360
1617
|
KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
|
@@ -1364,7 +1621,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
|
|
1364
1621
|
|
1365
1622
|
|
1366
1623
|
|
1367
|
-
#### [Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2023-
|
1624
|
+
#### [Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2023-06-15/reference/get_profile_relationships_segments)
|
1368
1625
|
|
1369
1626
|
```ruby
|
1370
1627
|
KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
|
@@ -1374,17 +1631,17 @@ KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
|
|
1374
1631
|
|
1375
1632
|
|
1376
1633
|
|
1377
|
-
#### [Get Profile Segments](https://developers.klaviyo.com/en/v2023-
|
1634
|
+
#### [Get Profile Segments](https://developers.klaviyo.com/en/v2023-06-15/reference/get_profile_segments)
|
1378
1635
|
|
1379
1636
|
```ruby
|
1380
|
-
KlaviyoAPI::Profiles.get_profile_segments(
|
1637
|
+
KlaviyoAPI::Profiles.get_profile_segments(id, opts)
|
1381
1638
|
```
|
1382
1639
|
|
1383
1640
|
|
1384
1641
|
|
1385
1642
|
|
1386
1643
|
|
1387
|
-
#### [Get Profiles](https://developers.klaviyo.com/en/v2023-
|
1644
|
+
#### [Get Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_profiles)
|
1388
1645
|
|
1389
1646
|
```ruby
|
1390
1647
|
KlaviyoAPI::Profiles.get_profiles(opts)
|
@@ -1394,7 +1651,7 @@ KlaviyoAPI::Profiles.get_profiles(opts)
|
|
1394
1651
|
|
1395
1652
|
|
1396
1653
|
|
1397
|
-
#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2023-
|
1654
|
+
#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/subscribe_profiles)
|
1398
1655
|
|
1399
1656
|
```ruby
|
1400
1657
|
KlaviyoAPI::Profiles.subscribe_profiles(body)
|
@@ -1404,7 +1661,7 @@ KlaviyoAPI::Profiles.subscribe_profiles(body)
|
|
1404
1661
|
|
1405
1662
|
|
1406
1663
|
|
1407
|
-
#### [Suppress Profiles](https://developers.klaviyo.com/en/v2023-
|
1664
|
+
#### [Suppress Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/suppress_profiles)
|
1408
1665
|
|
1409
1666
|
```ruby
|
1410
1667
|
KlaviyoAPI::Profiles.suppress_profiles(body)
|
@@ -1414,7 +1671,7 @@ KlaviyoAPI::Profiles.suppress_profiles(body)
|
|
1414
1671
|
|
1415
1672
|
|
1416
1673
|
|
1417
|
-
#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-
|
1674
|
+
#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/unsubscribe_profiles)
|
1418
1675
|
|
1419
1676
|
```ruby
|
1420
1677
|
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
@@ -1424,7 +1681,7 @@ KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
|
1424
1681
|
|
1425
1682
|
|
1426
1683
|
|
1427
|
-
#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-
|
1684
|
+
#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/unsuppress_profiles)
|
1428
1685
|
|
1429
1686
|
```ruby
|
1430
1687
|
KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
@@ -1434,10 +1691,10 @@ KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
|
1434
1691
|
|
1435
1692
|
|
1436
1693
|
|
1437
|
-
#### [Update Profile](https://developers.klaviyo.com/en/v2023-
|
1694
|
+
#### [Update Profile](https://developers.klaviyo.com/en/v2023-06-15/reference/update_profile)
|
1438
1695
|
|
1439
1696
|
```ruby
|
1440
|
-
KlaviyoAPI::Profiles.update_profile(id, body
|
1697
|
+
KlaviyoAPI::Profiles.update_profile(id, body)
|
1441
1698
|
```
|
1442
1699
|
|
1443
1700
|
|
@@ -1448,7 +1705,7 @@ KlaviyoAPI::Profiles.update_profile(id, body, opts)
|
|
1448
1705
|
## Segments
|
1449
1706
|
|
1450
1707
|
|
1451
|
-
#### [Get Segment](https://developers.klaviyo.com/en/v2023-
|
1708
|
+
#### [Get Segment](https://developers.klaviyo.com/en/v2023-06-15/reference/get_segment)
|
1452
1709
|
|
1453
1710
|
```ruby
|
1454
1711
|
KlaviyoAPI::Segments.get_segment(id, opts)
|
@@ -1458,17 +1715,17 @@ KlaviyoAPI::Segments.get_segment(id, opts)
|
|
1458
1715
|
|
1459
1716
|
|
1460
1717
|
|
1461
|
-
#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2023-
|
1718
|
+
#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_segment_profiles)
|
1462
1719
|
|
1463
1720
|
```ruby
|
1464
|
-
KlaviyoAPI::Segments.get_segment_profiles(
|
1721
|
+
KlaviyoAPI::Segments.get_segment_profiles(id, opts)
|
1465
1722
|
```
|
1466
1723
|
|
1467
1724
|
|
1468
1725
|
|
1469
1726
|
|
1470
1727
|
|
1471
|
-
#### [Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2023-
|
1728
|
+
#### [Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2023-06-15/reference/get_segment_relationships_profiles)
|
1472
1729
|
|
1473
1730
|
```ruby
|
1474
1731
|
KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
|
@@ -1478,7 +1735,7 @@ KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
|
|
1478
1735
|
|
1479
1736
|
|
1480
1737
|
|
1481
|
-
#### [Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2023-
|
1738
|
+
#### [Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_segment_relationships_tags)
|
1482
1739
|
|
1483
1740
|
```ruby
|
1484
1741
|
KlaviyoAPI::Segments.get_segment_relationships_tags(id)
|
@@ -1488,17 +1745,17 @@ KlaviyoAPI::Segments.get_segment_relationships_tags(id)
|
|
1488
1745
|
|
1489
1746
|
|
1490
1747
|
|
1491
|
-
#### [Get Segment Tags](https://developers.klaviyo.com/en/v2023-
|
1748
|
+
#### [Get Segment Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_segment_tags)
|
1492
1749
|
|
1493
1750
|
```ruby
|
1494
|
-
KlaviyoAPI::Segments.get_segment_tags(
|
1751
|
+
KlaviyoAPI::Segments.get_segment_tags(id, opts)
|
1495
1752
|
```
|
1496
1753
|
|
1497
1754
|
|
1498
1755
|
|
1499
1756
|
|
1500
1757
|
|
1501
|
-
#### [Get Segments](https://developers.klaviyo.com/en/v2023-
|
1758
|
+
#### [Get Segments](https://developers.klaviyo.com/en/v2023-06-15/reference/get_segments)
|
1502
1759
|
|
1503
1760
|
```ruby
|
1504
1761
|
KlaviyoAPI::Segments.get_segments(opts)
|
@@ -1508,7 +1765,7 @@ KlaviyoAPI::Segments.get_segments(opts)
|
|
1508
1765
|
|
1509
1766
|
|
1510
1767
|
|
1511
|
-
#### [Update Segment](https://developers.klaviyo.com/en/v2023-
|
1768
|
+
#### [Update Segment](https://developers.klaviyo.com/en/v2023-06-15/reference/update_segment)
|
1512
1769
|
|
1513
1770
|
```ruby
|
1514
1771
|
KlaviyoAPI::Segments.update_segment(id, body)
|
@@ -1522,7 +1779,7 @@ KlaviyoAPI::Segments.update_segment(id, body)
|
|
1522
1779
|
## Tags
|
1523
1780
|
|
1524
1781
|
|
1525
|
-
#### [Create Tag](https://developers.klaviyo.com/en/v2023-
|
1782
|
+
#### [Create Tag](https://developers.klaviyo.com/en/v2023-06-15/reference/create_tag)
|
1526
1783
|
|
1527
1784
|
```ruby
|
1528
1785
|
KlaviyoAPI::Tags.create_tag(body)
|
@@ -1532,7 +1789,7 @@ KlaviyoAPI::Tags.create_tag(body)
|
|
1532
1789
|
|
1533
1790
|
|
1534
1791
|
|
1535
|
-
#### [Create Tag Group](https://developers.klaviyo.com/en/v2023-
|
1792
|
+
#### [Create Tag Group](https://developers.klaviyo.com/en/v2023-06-15/reference/create_tag_group)
|
1536
1793
|
|
1537
1794
|
```ruby
|
1538
1795
|
KlaviyoAPI::Tags.create_tag_group(body)
|
@@ -1542,7 +1799,7 @@ KlaviyoAPI::Tags.create_tag_group(body)
|
|
1542
1799
|
|
1543
1800
|
|
1544
1801
|
|
1545
|
-
#### [Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-
|
1802
|
+
#### [Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-06-15/reference/create_tag_relationships_campaigns)
|
1546
1803
|
|
1547
1804
|
```ruby
|
1548
1805
|
KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
|
@@ -1552,7 +1809,7 @@ KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
|
|
1552
1809
|
|
1553
1810
|
|
1554
1811
|
|
1555
|
-
#### [Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-
|
1812
|
+
#### [Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-06-15/reference/create_tag_relationships_flows)
|
1556
1813
|
|
1557
1814
|
```ruby
|
1558
1815
|
KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
|
@@ -1562,7 +1819,7 @@ KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
|
|
1562
1819
|
|
1563
1820
|
|
1564
1821
|
|
1565
|
-
#### [Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-
|
1822
|
+
#### [Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-06-15/reference/create_tag_relationships_lists)
|
1566
1823
|
|
1567
1824
|
```ruby
|
1568
1825
|
KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
|
@@ -1572,7 +1829,7 @@ KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
|
|
1572
1829
|
|
1573
1830
|
|
1574
1831
|
|
1575
|
-
#### [Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-
|
1832
|
+
#### [Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-06-15/reference/create_tag_relationships_segments)
|
1576
1833
|
|
1577
1834
|
```ruby
|
1578
1835
|
KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
|
@@ -1582,7 +1839,7 @@ KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
|
|
1582
1839
|
|
1583
1840
|
|
1584
1841
|
|
1585
|
-
#### [Delete Tag](https://developers.klaviyo.com/en/v2023-
|
1842
|
+
#### [Delete Tag](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_tag)
|
1586
1843
|
|
1587
1844
|
```ruby
|
1588
1845
|
KlaviyoAPI::Tags.delete_tag(id)
|
@@ -1592,7 +1849,7 @@ KlaviyoAPI::Tags.delete_tag(id)
|
|
1592
1849
|
|
1593
1850
|
|
1594
1851
|
|
1595
|
-
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2023-
|
1852
|
+
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_tag_group)
|
1596
1853
|
|
1597
1854
|
```ruby
|
1598
1855
|
KlaviyoAPI::Tags.delete_tag_group(id)
|
@@ -1602,7 +1859,7 @@ KlaviyoAPI::Tags.delete_tag_group(id)
|
|
1602
1859
|
|
1603
1860
|
|
1604
1861
|
|
1605
|
-
#### [Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-
|
1862
|
+
#### [Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_tag_relationships_campaigns)
|
1606
1863
|
|
1607
1864
|
```ruby
|
1608
1865
|
KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
|
@@ -1612,7 +1869,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
|
|
1612
1869
|
|
1613
1870
|
|
1614
1871
|
|
1615
|
-
#### [Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-
|
1872
|
+
#### [Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_tag_relationships_flows)
|
1616
1873
|
|
1617
1874
|
```ruby
|
1618
1875
|
KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
|
@@ -1622,7 +1879,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
|
|
1622
1879
|
|
1623
1880
|
|
1624
1881
|
|
1625
|
-
#### [Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-
|
1882
|
+
#### [Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_tag_relationships_lists)
|
1626
1883
|
|
1627
1884
|
```ruby
|
1628
1885
|
KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
|
@@ -1632,7 +1889,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
|
|
1632
1889
|
|
1633
1890
|
|
1634
1891
|
|
1635
|
-
#### [Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-
|
1892
|
+
#### [Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_tag_relationships_segments)
|
1636
1893
|
|
1637
1894
|
```ruby
|
1638
1895
|
KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
|
@@ -1642,7 +1899,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
|
|
1642
1899
|
|
1643
1900
|
|
1644
1901
|
|
1645
|
-
#### [Get Tag](https://developers.klaviyo.com/en/v2023-
|
1902
|
+
#### [Get Tag](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag)
|
1646
1903
|
|
1647
1904
|
```ruby
|
1648
1905
|
KlaviyoAPI::Tags.get_tag(id, opts)
|
@@ -1652,7 +1909,7 @@ KlaviyoAPI::Tags.get_tag(id, opts)
|
|
1652
1909
|
|
1653
1910
|
|
1654
1911
|
|
1655
|
-
#### [Get Tag Group](https://developers.klaviyo.com/en/v2023-
|
1912
|
+
#### [Get Tag Group](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_group)
|
1656
1913
|
|
1657
1914
|
```ruby
|
1658
1915
|
KlaviyoAPI::Tags.get_tag_group(id, opts)
|
@@ -1662,7 +1919,7 @@ KlaviyoAPI::Tags.get_tag_group(id, opts)
|
|
1662
1919
|
|
1663
1920
|
|
1664
1921
|
|
1665
|
-
#### [Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2023-
|
1922
|
+
#### [Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_group_relationships_tags)
|
1666
1923
|
|
1667
1924
|
```ruby
|
1668
1925
|
KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
|
@@ -1672,7 +1929,7 @@ KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
|
|
1672
1929
|
|
1673
1930
|
|
1674
1931
|
|
1675
|
-
#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-
|
1932
|
+
#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_group_tags)
|
1676
1933
|
|
1677
1934
|
```ruby
|
1678
1935
|
KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
|
@@ -1682,7 +1939,7 @@ KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
|
|
1682
1939
|
|
1683
1940
|
|
1684
1941
|
|
1685
|
-
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2023-
|
1942
|
+
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_groups)
|
1686
1943
|
|
1687
1944
|
```ruby
|
1688
1945
|
KlaviyoAPI::Tags.get_tag_groups(opts)
|
@@ -1692,7 +1949,7 @@ KlaviyoAPI::Tags.get_tag_groups(opts)
|
|
1692
1949
|
|
1693
1950
|
|
1694
1951
|
|
1695
|
-
#### [Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-
|
1952
|
+
#### [Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_relationships_campaigns)
|
1696
1953
|
|
1697
1954
|
```ruby
|
1698
1955
|
KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
|
@@ -1702,7 +1959,7 @@ KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
|
|
1702
1959
|
|
1703
1960
|
|
1704
1961
|
|
1705
|
-
#### [Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-
|
1962
|
+
#### [Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_relationships_flows)
|
1706
1963
|
|
1707
1964
|
```ruby
|
1708
1965
|
KlaviyoAPI::Tags.get_tag_relationships_flows(id)
|
@@ -1712,7 +1969,7 @@ KlaviyoAPI::Tags.get_tag_relationships_flows(id)
|
|
1712
1969
|
|
1713
1970
|
|
1714
1971
|
|
1715
|
-
#### [Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-
|
1972
|
+
#### [Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_relationships_lists)
|
1716
1973
|
|
1717
1974
|
```ruby
|
1718
1975
|
KlaviyoAPI::Tags.get_tag_relationships_lists(id)
|
@@ -1722,7 +1979,7 @@ KlaviyoAPI::Tags.get_tag_relationships_lists(id)
|
|
1722
1979
|
|
1723
1980
|
|
1724
1981
|
|
1725
|
-
#### [Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-
|
1982
|
+
#### [Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_relationships_segments)
|
1726
1983
|
|
1727
1984
|
```ruby
|
1728
1985
|
KlaviyoAPI::Tags.get_tag_relationships_segments(id)
|
@@ -1732,7 +1989,7 @@ KlaviyoAPI::Tags.get_tag_relationships_segments(id)
|
|
1732
1989
|
|
1733
1990
|
|
1734
1991
|
|
1735
|
-
#### [Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2023-
|
1992
|
+
#### [Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_relationships_tag_group)
|
1736
1993
|
|
1737
1994
|
```ruby
|
1738
1995
|
KlaviyoAPI::Tags.get_tag_relationships_tag_group(id)
|
@@ -1742,7 +1999,7 @@ KlaviyoAPI::Tags.get_tag_relationships_tag_group(id)
|
|
1742
1999
|
|
1743
2000
|
|
1744
2001
|
|
1745
|
-
#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-
|
2002
|
+
#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tag_tag_group)
|
1746
2003
|
|
1747
2004
|
```ruby
|
1748
2005
|
KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
|
@@ -1752,7 +2009,7 @@ KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
|
|
1752
2009
|
|
1753
2010
|
|
1754
2011
|
|
1755
|
-
#### [Get Tags](https://developers.klaviyo.com/en/v2023-
|
2012
|
+
#### [Get Tags](https://developers.klaviyo.com/en/v2023-06-15/reference/get_tags)
|
1756
2013
|
|
1757
2014
|
```ruby
|
1758
2015
|
KlaviyoAPI::Tags.get_tags(opts)
|
@@ -1762,7 +2019,7 @@ KlaviyoAPI::Tags.get_tags(opts)
|
|
1762
2019
|
|
1763
2020
|
|
1764
2021
|
|
1765
|
-
#### [Update Tag](https://developers.klaviyo.com/en/v2023-
|
2022
|
+
#### [Update Tag](https://developers.klaviyo.com/en/v2023-06-15/reference/update_tag)
|
1766
2023
|
|
1767
2024
|
```ruby
|
1768
2025
|
KlaviyoAPI::Tags.update_tag(id, body)
|
@@ -1772,7 +2029,7 @@ KlaviyoAPI::Tags.update_tag(id, body)
|
|
1772
2029
|
|
1773
2030
|
|
1774
2031
|
|
1775
|
-
#### [Update Tag Group](https://developers.klaviyo.com/en/v2023-
|
2032
|
+
#### [Update Tag Group](https://developers.klaviyo.com/en/v2023-06-15/reference/update_tag_group)
|
1776
2033
|
|
1777
2034
|
```ruby
|
1778
2035
|
KlaviyoAPI::Tags.update_tag_group(id, body)
|
@@ -1786,7 +2043,7 @@ KlaviyoAPI::Tags.update_tag_group(id, body)
|
|
1786
2043
|
## Templates
|
1787
2044
|
|
1788
2045
|
|
1789
|
-
#### [Create Template](https://developers.klaviyo.com/en/v2023-
|
2046
|
+
#### [Create Template](https://developers.klaviyo.com/en/v2023-06-15/reference/create_template)
|
1790
2047
|
|
1791
2048
|
```ruby
|
1792
2049
|
KlaviyoAPI::Templates.create_template(body)
|
@@ -1796,7 +2053,7 @@ KlaviyoAPI::Templates.create_template(body)
|
|
1796
2053
|
|
1797
2054
|
|
1798
2055
|
|
1799
|
-
#### [Create Template Clone](https://developers.klaviyo.com/en/v2023-
|
2056
|
+
#### [Create Template Clone](https://developers.klaviyo.com/en/v2023-06-15/reference/create_template_clone)
|
1800
2057
|
|
1801
2058
|
```ruby
|
1802
2059
|
KlaviyoAPI::Templates.create_template_clone(body)
|
@@ -1806,7 +2063,7 @@ KlaviyoAPI::Templates.create_template_clone(body)
|
|
1806
2063
|
|
1807
2064
|
|
1808
2065
|
|
1809
|
-
#### [Create Template Render](https://developers.klaviyo.com/en/v2023-
|
2066
|
+
#### [Create Template Render](https://developers.klaviyo.com/en/v2023-06-15/reference/create_template_render)
|
1810
2067
|
|
1811
2068
|
```ruby
|
1812
2069
|
KlaviyoAPI::Templates.create_template_render(body)
|
@@ -1816,7 +2073,7 @@ KlaviyoAPI::Templates.create_template_render(body)
|
|
1816
2073
|
|
1817
2074
|
|
1818
2075
|
|
1819
|
-
#### [Delete Template](https://developers.klaviyo.com/en/v2023-
|
2076
|
+
#### [Delete Template](https://developers.klaviyo.com/en/v2023-06-15/reference/delete_template)
|
1820
2077
|
|
1821
2078
|
```ruby
|
1822
2079
|
KlaviyoAPI::Templates.delete_template(id)
|
@@ -1826,7 +2083,7 @@ KlaviyoAPI::Templates.delete_template(id)
|
|
1826
2083
|
|
1827
2084
|
|
1828
2085
|
|
1829
|
-
#### [Get Template](https://developers.klaviyo.com/en/v2023-
|
2086
|
+
#### [Get Template](https://developers.klaviyo.com/en/v2023-06-15/reference/get_template)
|
1830
2087
|
|
1831
2088
|
```ruby
|
1832
2089
|
KlaviyoAPI::Templates.get_template(id, opts)
|
@@ -1836,7 +2093,7 @@ KlaviyoAPI::Templates.get_template(id, opts)
|
|
1836
2093
|
|
1837
2094
|
|
1838
2095
|
|
1839
|
-
#### [Get Templates](https://developers.klaviyo.com/en/v2023-
|
2096
|
+
#### [Get Templates](https://developers.klaviyo.com/en/v2023-06-15/reference/get_templates)
|
1840
2097
|
|
1841
2098
|
```ruby
|
1842
2099
|
KlaviyoAPI::Templates.get_templates(opts)
|
@@ -1846,7 +2103,7 @@ KlaviyoAPI::Templates.get_templates(opts)
|
|
1846
2103
|
|
1847
2104
|
|
1848
2105
|
|
1849
|
-
#### [Update Template](https://developers.klaviyo.com/en/v2023-
|
2106
|
+
#### [Update Template](https://developers.klaviyo.com/en/v2023-06-15/reference/update_template)
|
1850
2107
|
|
1851
2108
|
```ruby
|
1852
2109
|
KlaviyoAPI::Templates.update_template(id, body)
|