klaviyo-api-sdk 1.0.1 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +19 -0
- data/README.md +513 -119
- data/docs/AudiencesSubObject.md +20 -0
- data/docs/CampaignCloneQuery.md +18 -0
- data/docs/CampaignCloneQueryAsSubResource.md +20 -0
- data/docs/CampaignCloneQueryAsSubResourceAttributes.md +20 -0
- data/docs/CampaignCreateQuery.md +18 -0
- data/docs/CampaignCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignCreateQueryAsSubResourceAttributes.md +28 -0
- data/docs/CampaignMessageAssignTemplateQuery.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +20 -0
- data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +20 -0
- data/docs/CampaignMessagePartialUpdateQuery.md +18 -0
- data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +22 -0
- data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +20 -0
- data/docs/CampaignPartialUpdateQuery.md +18 -0
- data/docs/CampaignPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +26 -0
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CampaignSendJobCreateQuery.md +18 -0
- data/docs/CampaignSendJobCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CampaignSendJobPartialUpdateQuery.md +18 -0
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CampaignTagOp.md +18 -0
- data/docs/{ListDeleteQueryAsSubResource.md → CampaignTagOpDataInner.md} +2 -2
- data/docs/CampaignsApi.md +1277 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +7 -7
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +2 -2
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +2 -2
- data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +2 -2
- data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +23 -21
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogItemDeleteQueryAsSubResource.md +2 -2
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogItemUpdateQueryAsSubResource.md +2 -2
- data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +18 -16
- data/docs/CatalogJobErrorPayload.md +8 -8
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +29 -29
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +2 -2
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +2 -2
- data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +22 -22
- data/docs/CatalogsApi.md +256 -256
- data/docs/ClientApi.md +11 -11
- data/docs/ContentSubObject.md +28 -0
- data/docs/DataPrivacyApi.md +78 -0
- data/docs/DataPrivacyCreateDeletionJobQuery.md +18 -0
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +20 -0
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +22 -0
- data/docs/ErrorSource.md +2 -2
- data/docs/EventCreateQueryAsSubResourceAttributes.md +8 -8
- data/docs/EventsApi.md +36 -36
- data/docs/FlowsApi.md +147 -69
- data/docs/GetCampaigns4XXResponse.md +18 -0
- data/docs/GetCampaigns4XXResponseErrorsInner.md +26 -0
- data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +20 -0
- data/docs/IncludedCategories.md +2 -2
- data/docs/IncludedCategoriesAttributes.md +5 -5
- data/docs/IncludedItems.md +2 -2
- data/docs/IncludedItemsAttributes.md +22 -20
- data/docs/IncludedLists.md +2 -2
- data/docs/IncludedListsAttributes.md +4 -4
- data/docs/IncludedMetrics.md +1 -1
- data/docs/IncludedMetricsAttributes.md +4 -4
- data/docs/IncludedProfiles.md +2 -2
- data/docs/IncludedProfilesAttributes.md +21 -21
- data/docs/IncludedSegments.md +1 -1
- data/docs/IncludedSegmentsAttributes.md +22 -0
- data/docs/{IncludedProfile.md → IncludedTags.md} +5 -5
- data/docs/IncludedVariants.md +2 -2
- data/docs/IncludedVariantsAttributes.md +28 -28
- data/docs/ListCreateQueryAsSubResourceAttributes.md +2 -2
- data/docs/ListPartialUpdateQueryAsSubResource.md +2 -2
- data/docs/ListsApi.md +111 -35
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +19 -19
- data/docs/MetricAggregateRowDTO.md +2 -2
- data/docs/MetricCreateQuery.md +3 -3
- data/docs/MetricsApi.md +14 -14
- data/docs/OnsiteProfileMetaIdentifiers.md +10 -10
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +10 -10
- data/docs/ProfileCreateQueryAsSubResourceAttributes.md +18 -18
- data/docs/ProfileLocation.md +15 -15
- data/docs/ProfileLocationLongitude.md +49 -0
- data/docs/ProfilePartialUpdateQueryAsSubResource.md +2 -2
- data/docs/ProfilesApi.md +36 -36
- data/docs/STOScheduleOptions.md +18 -0
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +1 -1
- data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/SegmentsApi.md +103 -24
- data/docs/SendOptionsSubObject.md +18 -0
- data/docs/SendStrategySubObject.md +24 -0
- data/docs/SendTimeSubObject.md +20 -0
- data/docs/StaticScheduleOptions.md +22 -0
- data/docs/Subscription.md +8 -4
- data/docs/SubscriptionChannels.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +5 -5
- data/docs/Suppression.md +2 -2
- data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/TagCreateQuery.md +18 -0
- data/docs/TagCreateQueryAsSubResource.md +20 -0
- data/docs/TagCreateQueryAsSubResourceAttributes.md +20 -0
- data/docs/TagGroupCreateQuery.md +18 -0
- data/docs/TagGroupCreateQueryAsSubResource.md +20 -0
- data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +20 -0
- data/docs/TagGroupUpdateQuery.md +18 -0
- data/docs/TagGroupUpdateQueryAsSubResource.md +22 -0
- data/docs/{V2TemplateRenderQueryAsSubResourceAttributes.md → TagGroupUpdateQueryAsSubResourceAttributes.md} +4 -4
- data/docs/TagSegmentOp.md +18 -0
- data/docs/{TemplateDeleteQueryAsSubResource.md → TagSegmentOpDataInner.md} +2 -2
- data/docs/TagUpdateQuery.md +18 -0
- data/docs/TagUpdateQueryAsSubResource.md +22 -0
- data/docs/TagUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/TagsApi.md +1205 -0
- data/docs/TemplateCloneQueryAsSubResourceAttributes.md +5 -3
- data/docs/TemplateCreateQueryAsSubResourceAttributes.md +14 -8
- data/docs/TemplateRenderQuery.md +18 -0
- data/docs/TemplateRenderQueryAsSubResource.md +20 -0
- data/docs/TemplateRenderQueryAsSubResourceAttributes.md +22 -0
- data/docs/TemplateUpdateQueryAsSubResource.md +1 -1
- data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +13 -7
- data/docs/TemplatesApi.md +40 -44
- data/docs/ThrottledScheduleOptions.md +20 -0
- data/docs/TrackingOptionsSubObject.md +24 -0
- data/docs/UTMParamsSubObject.md +20 -0
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +6 -6
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +1 -1
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/V2TemplateRenderQueryAsSubResource.md +2 -4
- data/klaviyo-api-sdk.gemspec +3 -3
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +1275 -0
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +338 -338
- data/lib/klaviyo-api-sdk/api/client_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +92 -0
- data/lib/klaviyo-api-sdk/api/events_api.rb +46 -46
- data/lib/klaviyo-api-sdk/api/flows_api.rb +167 -93
- data/lib/klaviyo-api-sdk/api/lists_api.rb +122 -50
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +21 -21
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +53 -53
- data/lib/klaviyo-api-sdk/api/segments_api.rb +112 -33
- data/lib/klaviyo-api-sdk/api/tags_api.rb +1216 -0
- data/lib/klaviyo-api-sdk/api/templates_api.rb +57 -69
- data/lib/klaviyo-api-sdk/api_client.rb +3 -3
- data/lib/klaviyo-api-sdk/api_error.rb +2 -2
- data/lib/klaviyo-api-sdk/configuration.rb +2 -2
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +234 -0
- data/lib/klaviyo-api-sdk/models/{v2_template_render_query.rb → campaign_clone_query.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +291 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +256 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_tag_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/{list_delete_query_as_sub_resource.rb → campaign_tag_op_data_inner.rb} +7 -7
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +8 -3
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +28 -4
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +21 -3
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +6 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +21 -9
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +13 -3
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +270 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +2 -2
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/error_source.rb +5 -2
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +7 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response.rb +226 -0
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner.rb +275 -0
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner_source.rb +228 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +2 -2
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_categories.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +5 -2
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flows.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_items.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +24 -3
- data/lib/klaviyo-api-sdk/models/included_lists.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +5 -2
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +14 -2
- data/lib/klaviyo-api-sdk/models/included_segments.rb +3 -3
- data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/{included_profile.rb → included_tags.rb} +9 -8
- data/lib/klaviyo-api-sdk/models/included_variants.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +17 -3
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +29 -21
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +4 -2
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +4 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +17 -12
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +7 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +11 -2
- data/lib/klaviyo-api-sdk/models/profile_location.rb +10 -3
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +3 -2
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +3 -3
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/send_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +220 -0
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +240 -0
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +2 -2
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +245 -0
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +225 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +27 -6
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +5 -2
- data/lib/klaviyo-api-sdk/models/suppression.rb +3 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +234 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/{v2_template_render_query_as_sub_resource_attributes.rb → tag_group_update_query_as_sub_resource_attributes.rb} +16 -15
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/{template_delete_query_as_sub_resource.rb → tag_segment_op_data_inner.rb} +7 -7
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +20 -3
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +7 -2
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +240 -0
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +5 -7
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +3 -3
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +2 -2
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +240 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +11 -62
- data/lib/klaviyo-api-sdk/version.rb +2 -2
- data/lib/klaviyo-api-sdk.rb +68 -11
- data/spec/api/campaigns_api_spec.rb +284 -0
- data/spec/api/catalogs_api_spec.rb +94 -94
- data/spec/api/client_api_spec.rb +5 -5
- data/spec/api/data_privacy_api_spec.rb +47 -0
- data/spec/api/events_api_spec.rb +19 -19
- data/spec/api/flows_api_spec.rb +44 -33
- data/spec/api/lists_api_spec.rb +28 -15
- data/spec/api/metrics_api_spec.rb +8 -8
- data/spec/api/profiles_api_spec.rb +21 -21
- data/spec/api/segments_api_spec.rb +24 -10
- data/spec/api/tags_api_spec.rb +245 -0
- data/spec/api/templates_api_spec.rb +18 -18
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/audiences_sub_object_spec.rb +40 -0
- data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/{v2_template_render_query_spec.rb → campaign_clone_query_spec.rb} +8 -8
- data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +64 -0
- data/spec/models/campaign_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_create_query_spec.rb +34 -0
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_message_assign_template_query_spec.rb +34 -0
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/campaign_message_partial_update_query_spec.rb +34 -0
- data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +58 -0
- data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/campaign_partial_update_query_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_send_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +34 -0
- data/spec/models/{list_delete_query_as_sub_resource_spec.rb → campaign_tag_op_data_inner_spec.rb} +9 -9
- data/spec/models/campaign_tag_op_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_create_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_item_op_spec.rb +2 -2
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_update_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_update_query_spec.rb +2 -2
- data/spec/models/catalog_item_category_op_spec.rb +2 -2
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_create_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_update_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_update_query_spec.rb +2 -2
- data/spec/models/catalog_job_error_payload_spec.rb +2 -2
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_update_query_spec.rb +2 -2
- data/spec/models/content_sub_object_spec.rb +64 -0
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +34 -0
- data/spec/models/email_message_content_spec.rb +2 -2
- data/spec/models/email_tracking_options_spec.rb +2 -2
- data/spec/models/error_source_spec.rb +2 -2
- data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/event_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/event_create_query_spec.rb +2 -2
- data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/flow_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/flow_update_query_spec.rb +2 -2
- data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +40 -0
- data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +58 -0
- data/spec/models/get_campaigns4_xx_response_spec.rb +34 -0
- data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +2 -2
- data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +2 -2
- data/spec/models/get_catalog_items4_xx_response_spec.rb +2 -2
- data/spec/models/included_categories_attributes_spec.rb +2 -2
- data/spec/models/included_categories_spec.rb +2 -2
- data/spec/models/included_flow_action_spec.rb +2 -2
- data/spec/models/included_flow_actions_attributes_spec.rb +2 -2
- data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +2 -2
- data/spec/models/included_flow_actions_spec.rb +2 -2
- data/spec/models/included_flow_messages_attributes_content_spec.rb +2 -2
- data/spec/models/included_flow_messages_attributes_spec.rb +2 -2
- data/spec/models/included_flow_messages_spec.rb +2 -2
- data/spec/models/included_flows_attributes_spec.rb +2 -2
- data/spec/models/included_flows_spec.rb +2 -2
- data/spec/models/included_items_attributes_spec.rb +2 -2
- data/spec/models/included_items_spec.rb +2 -2
- data/spec/models/included_lists_attributes_spec.rb +2 -2
- data/spec/models/included_lists_spec.rb +2 -2
- data/spec/models/included_metrics_attributes_spec.rb +2 -2
- data/spec/models/included_metrics_spec.rb +2 -2
- data/spec/models/included_profiles_attributes_spec.rb +2 -2
- data/spec/models/included_profiles_spec.rb +2 -2
- data/spec/models/included_segments_attributes_spec.rb +46 -0
- data/spec/models/included_segments_spec.rb +2 -2
- data/spec/models/{included_profile_spec.rb → included_tags_spec.rb} +9 -9
- data/spec/models/included_variants_attributes_spec.rb +2 -2
- data/spec/models/included_variants_links_spec.rb +2 -2
- data/spec/models/included_variants_spec.rb +2 -2
- data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/list_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/list_create_query_spec.rb +2 -2
- data/spec/models/list_members_add_query_data_inner_spec.rb +2 -2
- data/spec/models/list_members_add_query_spec.rb +2 -2
- data/spec/models/list_members_delete_query_spec.rb +2 -2
- data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/list_partial_update_query_spec.rb +2 -2
- data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/metric_aggregate_query_spec.rb +2 -2
- data/spec/models/metric_aggregate_row_dto_spec.rb +2 -2
- data/spec/models/metric_create_query_spec.rb +2 -2
- data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/onsite_profile_create_query_spec.rb +2 -2
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +2 -2
- data/spec/models/onsite_profile_meta_spec.rb +2 -2
- data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/onsite_subscription_create_query_spec.rb +2 -2
- data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/profile_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/profile_create_query_spec.rb +2 -2
- data/spec/models/profile_location_latitude_spec.rb +2 -2
- data/spec/models/profile_location_longitude_spec.rb +31 -0
- data/spec/models/profile_location_spec.rb +2 -2
- data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/profile_partial_update_query_spec.rb +2 -2
- data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/segment_partial_update_query_spec.rb +2 -2
- data/spec/models/send_options_spec.rb +2 -2
- data/spec/models/send_options_sub_object_spec.rb +40 -0
- data/spec/models/send_strategy_sub_object_spec.rb +46 -0
- data/spec/models/send_time_sub_object_spec.rb +40 -0
- data/spec/models/sms_message_content_spec.rb +2 -2
- data/spec/models/sms_render_options_spec.rb +2 -2
- data/spec/models/sms_tracking_options_spec.rb +2 -2
- data/spec/models/static_schedule_options_spec.rb +46 -0
- data/spec/models/sto_schedule_options_spec.rb +34 -0
- data/spec/models/subscription_channels_spec.rb +48 -0
- data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/subscription_create_job_create_query_spec.rb +2 -2
- data/spec/models/subscription_spec.rb +2 -2
- data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/suppression_create_job_create_query_spec.rb +2 -2
- data/spec/models/suppression_spec.rb +2 -2
- data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/tag_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/tag_create_query_spec.rb +34 -0
- data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/tag_group_create_query_spec.rb +34 -0
- data/spec/models/{v2_template_render_query_as_sub_resource_attributes_spec.rb → tag_group_update_query_as_sub_resource_attributes_spec.rb} +9 -9
- data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/tag_group_update_query_spec.rb +34 -0
- data/spec/models/tag_segment_op_data_inner_spec.rb +44 -0
- data/spec/models/tag_segment_op_spec.rb +34 -0
- data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/tag_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/tag_update_query_spec.rb +34 -0
- data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +8 -2
- data/spec/models/template_clone_query_as_sub_resource_spec.rb +8 -2
- data/spec/models/template_clone_query_spec.rb +2 -2
- data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/template_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/template_create_query_spec.rb +2 -2
- data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/{template_delete_query_as_sub_resource_spec.rb → template_render_query_as_sub_resource_spec.rb} +9 -9
- data/spec/models/template_render_query_spec.rb +34 -0
- data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/template_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/template_update_query_spec.rb +2 -2
- data/spec/models/throttled_schedule_options_spec.rb +40 -0
- data/spec/models/tracking_options_sub_object_spec.rb +52 -0
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/unsubscription_create_job_create_query_spec.rb +2 -2
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/unsuppression_create_job_create_query_spec.rb +2 -2
- data/spec/models/utm_param_info_spec.rb +2 -2
- data/spec/models/utm_params_sub_object_spec.rb +40 -0
- data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +3 -13
- data/spec/spec_helper.rb +2 -2
- metadata +207 -19
- data/docs/V2TemplateRenderQuery.md +0 -18
- data/test.rb +0 -50
data/docs/ListsApi.md
CHANGED
@@ -10,7 +10,8 @@ All URIs are relative to *https://a.klaviyo.com*
|
|
10
10
|
| [**delete_list_relationships**](ListsApi.md#delete_list_relationships) | **DELETE** /api/lists/{id}/relationships/{related_resource}/ | Remove Profile from List |
|
11
11
|
| [**get_list**](ListsApi.md#get_list) | **GET** /api/lists/{id}/ | Get List |
|
12
12
|
| [**get_list_profiles**](ListsApi.md#get_list_profiles) | **GET** /api/lists/{list_id}/profiles/ | Get List Profiles |
|
13
|
-
| [**get_list_relationships**](ListsApi.md#get_list_relationships) | **GET** /api/lists/{id}/relationships/{related_resource}/ | Get List
|
13
|
+
| [**get_list_relationships**](ListsApi.md#get_list_relationships) | **GET** /api/lists/{id}/relationships/{related_resource}/ | Get List Relationships |
|
14
|
+
| [**get_list_tags**](ListsApi.md#get_list_tags) | **GET** /api/lists/{list_id}/tags/ | Get List Tags |
|
14
15
|
| [**get_lists**](ListsApi.md#get_lists) | **GET** /api/lists/ | Get Lists |
|
15
16
|
| [**update_list**](ListsApi.md#update_list) | **PATCH** /api/lists/{id}/ | Update List |
|
16
17
|
|
@@ -37,7 +38,7 @@ KlaviyoAPI.configure do |config|
|
|
37
38
|
end
|
38
39
|
|
39
40
|
api_instance = KlaviyoAPI::ListsApi.new
|
40
|
-
list_create_query = KlaviyoAPI::ListCreateQuery.new({data: KlaviyoAPI::ListCreateQueryAsSubResource.new({type: 'list', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: '
|
41
|
+
list_create_query = KlaviyoAPI::ListCreateQuery.new({data: KlaviyoAPI::ListCreateQueryAsSubResource.new({type: 'list', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: 'Newsletter'})})}) # ListCreateQuery |
|
41
42
|
|
42
43
|
begin
|
43
44
|
# Create List
|
@@ -92,7 +93,7 @@ end
|
|
92
93
|
|
93
94
|
Add Profile to List
|
94
95
|
|
95
|
-
Add a profile to a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
|
96
|
+
Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
|
96
97
|
|
97
98
|
### Examples
|
98
99
|
|
@@ -182,7 +183,7 @@ KlaviyoAPI.configure do |config|
|
|
182
183
|
end
|
183
184
|
|
184
185
|
api_instance = KlaviyoAPI::ListsApi.new
|
185
|
-
id = '
|
186
|
+
id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
186
187
|
|
187
188
|
begin
|
188
189
|
# Delete List
|
@@ -214,7 +215,7 @@ end
|
|
214
215
|
|
215
216
|
| Name | Type | Description | Notes |
|
216
217
|
| ---- | ---- | ----------- | ----- |
|
217
|
-
| **id** | **String** |
|
218
|
+
| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
218
219
|
|
219
220
|
### Return type
|
220
221
|
|
@@ -236,7 +237,7 @@ nil (empty response body)
|
|
236
237
|
|
237
238
|
Remove Profile from List
|
238
239
|
|
239
|
-
Remove a profile from a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
|
240
|
+
Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
|
240
241
|
|
241
242
|
### Examples
|
242
243
|
|
@@ -326,9 +327,9 @@ KlaviyoAPI.configure do |config|
|
|
326
327
|
end
|
327
328
|
|
328
329
|
api_instance = KlaviyoAPI::ListsApi.new
|
329
|
-
id = '
|
330
|
+
id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
330
331
|
opts = {
|
331
|
-
fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
332
|
+
fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
332
333
|
}
|
333
334
|
|
334
335
|
begin
|
@@ -362,8 +363,8 @@ end
|
|
362
363
|
|
363
364
|
| Name | Type | Description | Notes |
|
364
365
|
| ---- | ---- | ----------- | ----- |
|
365
|
-
| **id** | **String** |
|
366
|
-
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
366
|
+
| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
367
|
+
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
367
368
|
|
368
369
|
### Return type
|
369
370
|
|
@@ -385,7 +386,7 @@ end
|
|
385
386
|
|
386
387
|
Get List Profiles
|
387
388
|
|
388
|
-
Get all profiles within a list with the given list ID.
|
389
|
+
Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields. You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read` `Profiles Read`
|
389
390
|
|
390
391
|
### Examples
|
391
392
|
|
@@ -401,11 +402,11 @@ KlaviyoAPI.configure do |config|
|
|
401
402
|
end
|
402
403
|
|
403
404
|
api_instance = KlaviyoAPI::ListsApi.new
|
404
|
-
list_id = '
|
405
|
+
list_id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
405
406
|
opts = {
|
406
|
-
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
407
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
408
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
407
|
+
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
408
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
|
409
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
409
410
|
}
|
410
411
|
|
411
412
|
begin
|
@@ -439,10 +440,10 @@ end
|
|
439
440
|
|
440
441
|
| Name | Type | Description | Notes |
|
441
442
|
| ---- | ---- | ----------- | ----- |
|
442
|
-
| **list_id** | **String** |
|
443
|
-
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
444
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
445
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
443
|
+
| **list_id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
444
|
+
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
445
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals` | [optional] |
|
446
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
446
447
|
|
447
448
|
### Return type
|
448
449
|
|
@@ -462,9 +463,9 @@ end
|
|
462
463
|
|
463
464
|
> Hash<String, Object> get_list_relationships(id, related_resource, opts)
|
464
465
|
|
465
|
-
Get List
|
466
|
+
Get List Relationships
|
466
467
|
|
467
|
-
Get profile membership [relationships](https://developers.klaviyo.com/en/
|
468
|
+
Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID. You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read` `Profiles Read`
|
468
469
|
|
469
470
|
### Examples
|
470
471
|
|
@@ -483,11 +484,11 @@ api_instance = KlaviyoAPI::ListsApi.new
|
|
483
484
|
id = 'id_example' # String |
|
484
485
|
related_resource = 'profiles' # String |
|
485
486
|
opts = {
|
486
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
487
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
487
488
|
}
|
488
489
|
|
489
490
|
begin
|
490
|
-
# Get List
|
491
|
+
# Get List Relationships
|
491
492
|
result = api_instance.get_list_relationships(id, related_resource, opts)
|
492
493
|
p result
|
493
494
|
rescue KlaviyoAPI::ApiError => e
|
@@ -503,7 +504,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
503
504
|
|
504
505
|
```ruby
|
505
506
|
begin
|
506
|
-
# Get List
|
507
|
+
# Get List Relationships
|
507
508
|
data, status_code, headers = api_instance.get_list_relationships_with_http_info(id, related_resource, opts)
|
508
509
|
p status_code # => 2xx
|
509
510
|
p headers # => { ... }
|
@@ -519,7 +520,82 @@ end
|
|
519
520
|
| ---- | ---- | ----------- | ----- |
|
520
521
|
| **id** | **String** | | |
|
521
522
|
| **related_resource** | **String** | | |
|
522
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
523
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
524
|
+
|
525
|
+
### Return type
|
526
|
+
|
527
|
+
**Hash<String, Object>**
|
528
|
+
|
529
|
+
### Authorization
|
530
|
+
|
531
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
532
|
+
|
533
|
+
### HTTP request headers
|
534
|
+
|
535
|
+
- **Content-Type**: Not defined
|
536
|
+
- **Accept**: application/json
|
537
|
+
|
538
|
+
|
539
|
+
## get_list_tags
|
540
|
+
|
541
|
+
> Hash<String, Object> get_list_tags(list_id, opts)
|
542
|
+
|
543
|
+
Get List Tags
|
544
|
+
|
545
|
+
Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `List Read` `Tags Read`
|
546
|
+
|
547
|
+
### Examples
|
548
|
+
|
549
|
+
```ruby
|
550
|
+
require 'time'
|
551
|
+
require 'klaviyo-api-sdk'
|
552
|
+
# setup authorization
|
553
|
+
KlaviyoAPI.configure do |config|
|
554
|
+
# Configure API key authorization: Klaviyo-API-Key
|
555
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
556
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
557
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
558
|
+
end
|
559
|
+
|
560
|
+
api_instance = KlaviyoAPI::ListsApi.new
|
561
|
+
list_id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
562
|
+
opts = {
|
563
|
+
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
564
|
+
}
|
565
|
+
|
566
|
+
begin
|
567
|
+
# Get List Tags
|
568
|
+
result = api_instance.get_list_tags(list_id, opts)
|
569
|
+
p result
|
570
|
+
rescue KlaviyoAPI::ApiError => e
|
571
|
+
puts "Error when calling ListsApi->get_list_tags: #{e}"
|
572
|
+
end
|
573
|
+
```
|
574
|
+
|
575
|
+
#### Using the get_list_tags_with_http_info variant
|
576
|
+
|
577
|
+
This returns an Array which contains the response data, status code and headers.
|
578
|
+
|
579
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_list_tags_with_http_info(list_id, opts)
|
580
|
+
|
581
|
+
```ruby
|
582
|
+
begin
|
583
|
+
# Get List Tags
|
584
|
+
data, status_code, headers = api_instance.get_list_tags_with_http_info(list_id, opts)
|
585
|
+
p status_code # => 2xx
|
586
|
+
p headers # => { ... }
|
587
|
+
p data # => Hash<String, Object>
|
588
|
+
rescue KlaviyoAPI::ApiError => e
|
589
|
+
puts "Error when calling ListsApi->get_list_tags_with_http_info: #{e}"
|
590
|
+
end
|
591
|
+
```
|
592
|
+
|
593
|
+
### Parameters
|
594
|
+
|
595
|
+
| Name | Type | Description | Notes |
|
596
|
+
| ---- | ---- | ----------- | ----- |
|
597
|
+
| **list_id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
598
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
523
599
|
|
524
600
|
### Return type
|
525
601
|
|
@@ -541,7 +617,7 @@ end
|
|
541
617
|
|
542
618
|
Get Lists
|
543
619
|
|
544
|
-
Get all lists in an account.
|
620
|
+
Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read`
|
545
621
|
|
546
622
|
### Examples
|
547
623
|
|
@@ -558,9 +634,9 @@ end
|
|
558
634
|
|
559
635
|
api_instance = KlaviyoAPI::ListsApi.new
|
560
636
|
opts = {
|
561
|
-
fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
562
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
563
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
637
|
+
fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
638
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
|
639
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
564
640
|
}
|
565
641
|
|
566
642
|
begin
|
@@ -594,9 +670,9 @@ end
|
|
594
670
|
|
595
671
|
| Name | Type | Description | Notes |
|
596
672
|
| ---- | ---- | ----------- | ----- |
|
597
|
-
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
598
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
599
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
673
|
+
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
674
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` | [optional] |
|
675
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
600
676
|
|
601
677
|
### Return type
|
602
678
|
|
@@ -634,8 +710,8 @@ KlaviyoAPI.configure do |config|
|
|
634
710
|
end
|
635
711
|
|
636
712
|
api_instance = KlaviyoAPI::ListsApi.new
|
637
|
-
id = '
|
638
|
-
list_partial_update_query = KlaviyoAPI::ListPartialUpdateQuery.new({data: KlaviyoAPI::ListPartialUpdateQueryAsSubResource.new({type: 'list', id: '
|
713
|
+
id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
714
|
+
list_partial_update_query = KlaviyoAPI::ListPartialUpdateQuery.new({data: KlaviyoAPI::ListPartialUpdateQueryAsSubResource.new({type: 'list', id: 'Y6nRLr', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: 'Newsletter'})})}) # ListPartialUpdateQuery |
|
639
715
|
|
640
716
|
begin
|
641
717
|
# Update List
|
@@ -668,7 +744,7 @@ end
|
|
668
744
|
|
669
745
|
| Name | Type | Description | Notes |
|
670
746
|
| ---- | ---- | ----------- | ----- |
|
671
|
-
| **id** | **String** |
|
747
|
+
| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
672
748
|
| **list_partial_update_query** | [**ListPartialUpdateQuery**](ListPartialUpdateQuery.md) | | |
|
673
749
|
|
674
750
|
### Return type
|
@@ -4,16 +4,16 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **metric_id** | **String** |
|
8
|
-
| **
|
9
|
-
| **
|
10
|
-
| **
|
11
|
-
| **
|
12
|
-
| **
|
13
|
-
| **
|
14
|
-
| **
|
15
|
-
| **
|
16
|
-
| **
|
7
|
+
| **metric_id** | **String** | The metric ID used in the aggregation. | |
|
8
|
+
| **page_cursor** | **String** | Optional pagination cursor to iterate over large result sets | [optional] |
|
9
|
+
| **measurements** | **Array<String>** | Measurement key, e.g. `unique`, `sum_value`, `count` | |
|
10
|
+
| **interval** | **String** | Aggregation interval, e.g. \"hour\", \"day\", \"week\", \"month\" | |
|
11
|
+
| **page_size** | **Integer** | Alter the maximum number of returned rows in a single page of aggregation results | [optional][default to 500] |
|
12
|
+
| **by** | **Array<String>** | Optional attribute(s) used for partitioning by the aggregation function | [optional] |
|
13
|
+
| **return_fields** | **Array<String>** | Provide fields to limit the returned data | [optional] |
|
14
|
+
| **filter** | **Array<String>** | List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). These filters follow a similar format to those in `GET` requests, the primary difference is that this endpoint asks for a list. The time range can be filtered by providing a `greater-or-equal` and a `less-than` filter on the `datetime` field. | |
|
15
|
+
| **timezone** | **String** | The timezone used for processing the query, e.g. `'America/New_York'`. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones). While most are supported, a few notable exceptions are `Factory`, `Europe/Kyiv` and `Pacific/Kanton`. This field is case-sensitive. | [optional][default to 'UTC'] |
|
16
|
+
| **sort** | **String** | Provide a sort key (e.g. -$message) | [optional] |
|
17
17
|
|
18
18
|
## Example
|
19
19
|
|
@@ -21,16 +21,16 @@
|
|
21
21
|
require 'klaviyo-api-sdk'
|
22
22
|
|
23
23
|
instance = KlaviyoAPI::MetricAggregateQueryAsSubResourceAttributes.new(
|
24
|
-
metric_id:
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
24
|
+
metric_id: 0rG4eQ,
|
25
|
+
page_cursor: null,
|
26
|
+
measurements: count,
|
27
|
+
interval: day,
|
28
|
+
page_size: 500,
|
29
|
+
by: $message,
|
29
30
|
return_fields: null,
|
30
|
-
filter:
|
31
|
-
timezone:
|
32
|
-
sort: null
|
33
|
-
page_cursor: null
|
31
|
+
filter: ["greater-or-equal(datetime,2022-12-01T00:00:00)","less-than(datetime,2022-12-08T00:00:00"],
|
32
|
+
timezone: America/New_York,
|
33
|
+
sort: null
|
34
34
|
)
|
35
35
|
```
|
36
36
|
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **dimensions** | **Array<String>** |
|
8
|
-
| **measurements** | **Object** |
|
7
|
+
| **dimensions** | **Array<String>** | List of dimensions associated with this set of measurements | |
|
8
|
+
| **measurements** | **Object** | Dictionary of measurement_key, values | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/MetricCreateQuery.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **name** | **String** |
|
8
|
-
| **service** | **String** |
|
7
|
+
| **name** | **String** | Name of the event. Must be less than 128 characters. | |
|
8
|
+
| **service** | **String** | This is for advanced usage. For api requests, this should use the default, which is set to api. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -13,7 +13,7 @@
|
|
13
13
|
require 'klaviyo-api-sdk'
|
14
14
|
|
15
15
|
instance = KlaviyoAPI::MetricCreateQuery.new(
|
16
|
-
name:
|
16
|
+
name: Viewed Product,
|
17
17
|
service: null
|
18
18
|
)
|
19
19
|
```
|
data/docs/MetricsApi.md
CHANGED
@@ -15,7 +15,7 @@ All URIs are relative to *https://a.klaviyo.com*
|
|
15
15
|
|
16
16
|
Get Metric
|
17
17
|
|
18
|
-
Get a metric with the given metric ID
|
18
|
+
Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Metrics Read`
|
19
19
|
|
20
20
|
### Examples
|
21
21
|
|
@@ -31,9 +31,9 @@ KlaviyoAPI.configure do |config|
|
|
31
31
|
end
|
32
32
|
|
33
33
|
api_instance = KlaviyoAPI::MetricsApi.new
|
34
|
-
id = 'id_example' # String |
|
34
|
+
id = 'id_example' # String | Metric ID
|
35
35
|
opts = {
|
36
|
-
fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
36
|
+
fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
37
37
|
}
|
38
38
|
|
39
39
|
begin
|
@@ -67,8 +67,8 @@ end
|
|
67
67
|
|
68
68
|
| Name | Type | Description | Notes |
|
69
69
|
| ---- | ---- | ----------- | ----- |
|
70
|
-
| **id** | **String** |
|
71
|
-
| **fields_metric** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
70
|
+
| **id** | **String** | Metric ID | |
|
71
|
+
| **fields_metric** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
72
72
|
|
73
73
|
### Return type
|
74
74
|
|
@@ -90,7 +90,7 @@ end
|
|
90
90
|
|
91
91
|
Get Metrics
|
92
92
|
|
93
|
-
Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category`
|
93
|
+
Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Metrics Read`
|
94
94
|
|
95
95
|
### Examples
|
96
96
|
|
@@ -107,9 +107,9 @@ end
|
|
107
107
|
|
108
108
|
api_instance = KlaviyoAPI::MetricsApi.new
|
109
109
|
opts = {
|
110
|
-
fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
111
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
112
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
110
|
+
fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
111
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`
|
112
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
113
113
|
}
|
114
114
|
|
115
115
|
begin
|
@@ -143,9 +143,9 @@ end
|
|
143
143
|
|
144
144
|
| Name | Type | Description | Notes |
|
145
145
|
| ---- | ---- | ----------- | ----- |
|
146
|
-
| **fields_metric** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
147
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
148
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
146
|
+
| **fields_metric** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
147
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals` | [optional] |
|
148
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
149
149
|
|
150
150
|
### Return type
|
151
151
|
|
@@ -167,7 +167,7 @@ end
|
|
167
167
|
|
168
168
|
Query Metric Aggregates
|
169
169
|
|
170
|
-
Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request. Results can be filtered and grouped by time, event, or profile dimensions. **Request body parameters** (nested under `attributes`): * `return_fields`: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/
|
170
|
+
Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request. Results can be filtered and grouped by time, event, or profile dimensions. **Request body parameters** (nested under `attributes`): * `return_fields`: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets) * `sort`: sort results by a specified field, such as `\"-timestamp\"` * `page_cursor`: results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/reference/api_overview#pagination) * `page_size`: limit the number of returned results per page * `by`: optional attributes used to group by the aggregation function * When using `by` attributes, an empty `dimensions` response is expected when the counts for the events do not have the associated dimension requested by the set `by` attribute. For example, a query including `\"by\": [\"$flow\"]` will return an empty dimensions response for counts of metrics not associated with a `$flow` * `measurement`: the measurement key supports the following values: * `\"sum_value\"`: perform a summation of the `_Event Value_`, optionally partitioned over any dimension provided in the `by` field * `\"count\"`: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the `by` field * `\"unique\"` counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the `by` field * `interval`: aggregation interval, such as `\"hour\"`,`\"day\"`,`\"week\"`, and `\"month\"` * `metric_id`: the metric ID used in the aggregation * `filter`: list of filters for specific fields, must include time range using ISO 8601 format (`\"YYYY-MM-DDTHH:MM:SS.mmmmmm\"`) * The time range can be filtered by providing a `greater-or-equal` filter on the datetime field, such as `\"greater-or-equal(datetime,2021-07-01T00:00:00)\"` and a `less-than` filter on the same datetime field, such as `\"less-than(datetime,2022-07-01T00:00:00)\"` * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date * Filter the list of supported aggregate dimensions using the common filter syntax, such as `\"equals(URL,\\\"https://www.klaviyo.com/\\\")\"` * `timezone`: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones) * While the payload accepts a timezone, the response datetimes returned will be in UTC. For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Metrics Read`
|
171
171
|
|
172
172
|
### Examples
|
173
173
|
|
@@ -183,7 +183,7 @@ KlaviyoAPI.configure do |config|
|
|
183
183
|
end
|
184
184
|
|
185
185
|
api_instance = KlaviyoAPI::MetricsApi.new
|
186
|
-
metric_aggregate_query = KlaviyoAPI::MetricAggregateQuery.new({data: KlaviyoAPI::MetricAggregateQueryAsSubResource.new({type: 'metric-aggregate', attributes: KlaviyoAPI::MetricAggregateQueryAsSubResourceAttributes.new({metric_id: '
|
186
|
+
metric_aggregate_query = KlaviyoAPI::MetricAggregateQuery.new({data: KlaviyoAPI::MetricAggregateQueryAsSubResource.new({type: 'metric-aggregate', attributes: KlaviyoAPI::MetricAggregateQueryAsSubResourceAttributes.new({metric_id: '0rG4eQ', measurements: count, interval: 'day', filter: ["greater-or-equal(datetime, 2022-12-01T00: 00: 00)", "less-than(datetime, 2022-12-08T00: 00: 00"]})})}) # MetricAggregateQuery | Retrieve Metric Aggregations
|
187
187
|
|
188
188
|
begin
|
189
189
|
# Query Metric Aggregates
|
@@ -4,12 +4,12 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** |
|
8
|
-
| **
|
9
|
-
| **
|
10
|
-
| **
|
7
|
+
| **id** | **String** | Primary key that uniquely identifies this profile. Generated by Klaviyo. | [optional] |
|
8
|
+
| **email** | **String** | Individual's email address | [optional] |
|
9
|
+
| **phone_number** | **String** | Individual's phone number in E.164 format | [optional] |
|
10
|
+
| **external_id** | **String** | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system. | [optional] |
|
11
11
|
| **anonymous_id** | **String** | | [optional] |
|
12
|
-
| **_kx** | **String** | | [optional] |
|
12
|
+
| **_kx** | **String** | Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo's web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint. | [optional] |
|
13
13
|
|
14
14
|
## Example
|
15
15
|
|
@@ -17,12 +17,12 @@
|
|
17
17
|
require 'klaviyo-api-sdk'
|
18
18
|
|
19
19
|
instance = KlaviyoAPI::OnsiteProfileMetaIdentifiers.new(
|
20
|
-
id:
|
21
|
-
|
22
|
-
|
23
|
-
|
20
|
+
id: 01GDDKASAP8TKDDA2GRZDSVP4H,
|
21
|
+
email: sarah.mason@klaviyo-demo.com,
|
22
|
+
phone_number: +15005550006,
|
23
|
+
external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
|
24
24
|
anonymous_id: null,
|
25
|
-
_kx:
|
25
|
+
_kx: J8fjcn003Wy6b-3ILNlOyZXabW6dcFwTyeuxrowMers%3D.McN66
|
26
26
|
)
|
27
27
|
```
|
28
28
|
|
@@ -4,11 +4,11 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **list_id** | **String** |
|
8
|
-
| **custom_source** | **String** |
|
9
|
-
| **email** | **String** |
|
10
|
-
| **phone_number** | **String** |
|
11
|
-
| **properties** | **Object** |
|
7
|
+
| **list_id** | **String** | The list ID to add the newly subscribed profile to. | |
|
8
|
+
| **custom_source** | **String** | A custom method detail or source to store on the consent records for this subscription. | [optional] |
|
9
|
+
| **email** | **String** | Email address to create subscription and email consent record for. | [optional] |
|
10
|
+
| **phone_number** | **String** | Phone number to create subscription and SMS consent record for, in E.164 format. | [optional] |
|
11
|
+
| **properties** | **Object** | Profile properties to set on the newly subscribed profile. | [optional] |
|
12
12
|
|
13
13
|
## Example
|
14
14
|
|
@@ -16,11 +16,11 @@
|
|
16
16
|
require 'klaviyo-api-sdk'
|
17
17
|
|
18
18
|
instance = KlaviyoAPI::OnsiteSubscriptionCreateQueryAsSubResourceAttributes.new(
|
19
|
-
list_id:
|
20
|
-
custom_source:
|
21
|
-
email:
|
22
|
-
phone_number:
|
23
|
-
properties:
|
19
|
+
list_id: Y6nRLr,
|
20
|
+
custom_source: Homepage footer signup form,
|
21
|
+
email: matt.kemp@klaviyo-demo.com,
|
22
|
+
phone_number: +15005550006,
|
23
|
+
properties: {"first_name":"Matt","last_name":"Kemp","favorite_color":"Blue"}
|
24
24
|
)
|
25
25
|
```
|
26
26
|
|
@@ -4,17 +4,17 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **email** | **String** |
|
8
|
-
| **phone_number** | **String** |
|
9
|
-
| **external_id** | **String** |
|
7
|
+
| **email** | **String** | Individual's email address | [optional] |
|
8
|
+
| **phone_number** | **String** | Individual's phone number in E.164 format | [optional] |
|
9
|
+
| **external_id** | **String** | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system. | [optional] |
|
10
10
|
| **anonymous_id** | **String** | | [optional] |
|
11
|
-
| **first_name** | **String** |
|
12
|
-
| **last_name** | **String** |
|
13
|
-
| **organization** | **String** |
|
14
|
-
| **title** | **String** |
|
15
|
-
| **image** | **String** |
|
11
|
+
| **first_name** | **String** | Individual's first name | [optional] |
|
12
|
+
| **last_name** | **String** | Individual's last name | [optional] |
|
13
|
+
| **organization** | **String** | Name of the company or organization within the company for whom the individual works | [optional] |
|
14
|
+
| **title** | **String** | Individual's job title | [optional] |
|
15
|
+
| **image** | **String** | URL pointing to the location of a profile image | [optional] |
|
16
16
|
| **location** | [**ProfileLocation**](ProfileLocation.md) | | [optional] |
|
17
|
-
| **properties** | **Object** |
|
17
|
+
| **properties** | **Object** | An object containing key/value pairs for any custom properties assigned to this profile | [optional] |
|
18
18
|
|
19
19
|
## Example
|
20
20
|
|
@@ -22,17 +22,17 @@
|
|
22
22
|
require 'klaviyo-api-sdk'
|
23
23
|
|
24
24
|
instance = KlaviyoAPI::ProfileCreateQueryAsSubResourceAttributes.new(
|
25
|
-
email:
|
26
|
-
phone_number:
|
27
|
-
external_id:
|
25
|
+
email: sarah.mason@klaviyo-demo.com,
|
26
|
+
phone_number: +15005550006,
|
27
|
+
external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
|
28
28
|
anonymous_id: null,
|
29
|
-
first_name:
|
30
|
-
last_name:
|
31
|
-
organization:
|
32
|
-
title:
|
33
|
-
image:
|
29
|
+
first_name: Sarah,
|
30
|
+
last_name: Mason,
|
31
|
+
organization: Klaviyo,
|
32
|
+
title: Engineer,
|
33
|
+
image: https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg,
|
34
34
|
location: null,
|
35
|
-
properties:
|
35
|
+
properties: {"pseudonym":"Dr. Octopus"}
|
36
36
|
)
|
37
37
|
```
|
38
38
|
|