klaviyo-api-sdk 1.1.0 → 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 +10 -0
- data/README.md +314 -136
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CampaignTagOp.md +18 -0
- data/docs/CampaignTagOpDataInner.md +20 -0
- data/docs/CampaignsApi.md +1277 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +6 -6
- 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 +21 -19
- 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 +27 -27
- 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 +238 -238
- data/docs/ErrorSource.md +1 -1
- data/docs/EventsApi.md +26 -26
- data/docs/FlowsApi.md +64 -56
- 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/IncludedProfiles.md +2 -2
- data/docs/IncludedProfilesAttributes.md +21 -21
- data/docs/IncludedSegments.md +1 -1
- data/docs/IncludedSegmentsAttributes.md +22 -0
- data/docs/IncludedTags.md +24 -0
- 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 +30 -30
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +5 -5
- data/docs/MetricsApi.md +9 -9
- data/docs/OnsiteProfileMetaIdentifiers.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 +26 -26
- data/docs/STOScheduleOptions.md +18 -0
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +1 -1
- data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/SegmentsApi.md +19 -19
- data/docs/SendOptionsSubObject.md +1 -3
- data/docs/SendStrategySubObject.md +4 -2
- data/docs/Subscription.md +8 -4
- data/docs/SubscriptionChannels.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +2 -2
- data/docs/Suppression.md +1 -1
- data/docs/TagsApi.md +24 -24
- data/docs/TemplateCloneQueryAsSubResource.md +0 -2
- data/docs/TemplatesApi.md +11 -11
- data/docs/ThrottledScheduleOptions.md +1 -1
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +1275 -0
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +299 -299
- data/lib/klaviyo-api-sdk/api/client_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/events_api.rb +33 -33
- data/lib/klaviyo-api-sdk/api/flows_api.rb +86 -74
- data/lib/klaviyo-api-sdk/api/lists_api.rb +39 -39
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +34 -34
- data/lib/klaviyo-api-sdk/api/segments_api.rb +25 -25
- data/lib/klaviyo-api-sdk/api/tags_api.rb +41 -41
- data/lib/klaviyo-api-sdk/api/templates_api.rb +18 -18
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_tag_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/campaign_tag_op_data_inner.rb +272 -0
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +5 -2
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +23 -3
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +1 -1
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +2 -2
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +20 -2
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +5 -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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +16 -8
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +1 -1
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +2 -2
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +12 -2
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +1 -1
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/error_source.rb +2 -1
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +1 -1
- 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/included_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +4 -1
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flows.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_items.rb +2 -1
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +23 -2
- data/lib/klaviyo-api-sdk/models/included_lists.rb +2 -1
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +4 -1
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +2 -1
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +13 -1
- data/lib/klaviyo-api-sdk/models/included_segments.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/included_tags.rb +301 -0
- data/lib/klaviyo-api-sdk/models/included_variants.rb +2 -1
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +16 -2
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +2 -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_as_sub_resource.rb +2 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +17 -15
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +16 -11
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +10 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +9 -2
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +2 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +2 -2
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +5 -15
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +15 -6
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +225 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +26 -5
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource_attributes.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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_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_as_sub_resource.rb +2 -13
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +1 -1
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/utm_param_info.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 +14 -5
- data/spec/api/campaigns_api_spec.rb +284 -0
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- 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_tag_op_data_inner_spec.rb +44 -0
- data/spec/models/campaign_tag_op_spec.rb +34 -0
- 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/included_segments_attributes_spec.rb +46 -0
- data/spec/models/included_tags_spec.rb +56 -0
- data/spec/models/profile_location_longitude_spec.rb +31 -0
- data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/sto_schedule_options_spec.rb +34 -0
- data/spec/models/subscription_channels_spec.rb +48 -0
- data/spec/spec_helper.rb +1 -1
- metadata +51 -6
@@ -4,17 +4,18 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **external_id** | **String** |
|
8
|
-
| **title** | **String** |
|
9
|
-
| **description** | **String** |
|
10
|
-
| **
|
11
|
-
| **
|
12
|
-
| **
|
13
|
-
| **
|
14
|
-
| **
|
15
|
-
| **
|
16
|
-
| **
|
17
|
-
| **
|
7
|
+
| **external_id** | **String** | The ID of the catalog item in an external system. | [optional] |
|
8
|
+
| **title** | **String** | The title of the catalog item. | [optional] |
|
9
|
+
| **description** | **String** | A description of the catalog item. | [optional] |
|
10
|
+
| **price** | **Float** | This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant). | [optional] |
|
11
|
+
| **url** | **String** | URL pointing to the location of the catalog item on your website. | [optional] |
|
12
|
+
| **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item. | [optional] |
|
13
|
+
| **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item | [optional] |
|
14
|
+
| **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item. | [optional] |
|
15
|
+
| **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb. | [optional] |
|
16
|
+
| **published** | **Boolean** | Boolean value indicating whether the catalog item is published. | [optional] |
|
17
|
+
| **created** | **Time** | Date and time when the catalog item was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
|
18
|
+
| **updated** | **Time** | Date and time when the catalog item was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
|
18
19
|
|
19
20
|
## Example
|
20
21
|
|
@@ -22,15 +23,16 @@
|
|
22
23
|
require 'klaviyo-api-sdk'
|
23
24
|
|
24
25
|
instance = KlaviyoAPI::IncludedItemsAttributes.new(
|
25
|
-
external_id:
|
26
|
-
title:
|
27
|
-
description:
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
26
|
+
external_id: SAMPLE-DATA-ITEM-1,
|
27
|
+
title: Ocean Blue Shirt (Sample),
|
28
|
+
description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
|
29
|
+
price: null,
|
30
|
+
url: https://via.placeholder.com/150,
|
31
|
+
image_full_url: https://via.placeholder.com/300,
|
32
|
+
image_thumbnail_url: https://via.placeholder.com/150,
|
33
|
+
images: ["https://via.placeholder.com/150"],
|
34
|
+
custom_metadata: {"Top Pick":true},
|
35
|
+
published: true,
|
34
36
|
created: null,
|
35
37
|
updated: null
|
36
38
|
)
|
data/docs/IncludedLists.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | **String** | | |
|
8
|
-
| **id** | **String** |
|
8
|
+
| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
9
9
|
| **attributes** | [**IncludedListsAttributes**](IncludedListsAttributes.md) | | |
|
10
10
|
| **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) | | |
|
11
11
|
|
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
|
|
16
16
|
|
17
17
|
instance = KlaviyoAPI::IncludedLists.new(
|
18
18
|
type: null,
|
19
|
-
id:
|
19
|
+
id: Y6nRLr,
|
20
20
|
attributes: null,
|
21
21
|
links: null
|
22
22
|
)
|
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **name** | **String** |
|
8
|
-
| **created** | **Time** |
|
9
|
-
| **updated** | **Time** |
|
7
|
+
| **name** | **String** | A helpful name to label the list | [optional] |
|
8
|
+
| **created** | **Time** | Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
|
9
|
+
| **updated** | **Time** | Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
@@ -14,7 +14,7 @@
|
|
14
14
|
require 'klaviyo-api-sdk'
|
15
15
|
|
16
16
|
instance = KlaviyoAPI::IncludedListsAttributes.new(
|
17
|
-
name:
|
17
|
+
name: Newsletter,
|
18
18
|
created: null,
|
19
19
|
updated: null
|
20
20
|
)
|
data/docs/IncludedProfiles.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | **String** | | |
|
8
|
-
| **id** | **String** |
|
8
|
+
| **id** | **String** | Primary key that uniquely identifies this profile. Generated by Klaviyo. | |
|
9
9
|
| **attributes** | [**IncludedProfilesAttributes**](IncludedProfilesAttributes.md) | | |
|
10
10
|
| **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) | | |
|
11
11
|
|
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
|
|
16
16
|
|
17
17
|
instance = KlaviyoAPI::IncludedProfiles.new(
|
18
18
|
type: null,
|
19
|
-
id:
|
19
|
+
id: 01GDDKASAP8TKDDA2GRZDSVP4H,
|
20
20
|
attributes: null,
|
21
21
|
links: null
|
22
22
|
)
|
@@ -4,20 +4,20 @@
|
|
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** |
|
16
|
-
| **created** | **Time** |
|
17
|
-
| **updated** | **Time** |
|
18
|
-
| **last_event_date** | **Time** |
|
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
|
+
| **created** | **Time** | Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
|
17
|
+
| **updated** | **Time** | Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
|
18
|
+
| **last_event_date** | **Time** | Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
|
19
19
|
| **location** | [**ProfileLocation**](ProfileLocation.md) | | [optional] |
|
20
|
-
| **properties** | **Object** |
|
20
|
+
| **properties** | **Object** | An object containing key/value pairs for any custom properties assigned to this profile | [optional] |
|
21
21
|
|
22
22
|
## Example
|
23
23
|
|
@@ -25,20 +25,20 @@
|
|
25
25
|
require 'klaviyo-api-sdk'
|
26
26
|
|
27
27
|
instance = KlaviyoAPI::IncludedProfilesAttributes.new(
|
28
|
-
email:
|
29
|
-
phone_number:
|
30
|
-
external_id:
|
28
|
+
email: sarah.mason@klaviyo-demo.com,
|
29
|
+
phone_number: +15005550006,
|
30
|
+
external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
|
31
31
|
anonymous_id: null,
|
32
|
-
first_name:
|
33
|
-
last_name:
|
34
|
-
organization:
|
35
|
-
title:
|
36
|
-
image:
|
32
|
+
first_name: Sarah,
|
33
|
+
last_name: Mason,
|
34
|
+
organization: Klaviyo,
|
35
|
+
title: Engineer,
|
36
|
+
image: https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg,
|
37
37
|
created: null,
|
38
38
|
updated: null,
|
39
39
|
last_event_date: null,
|
40
40
|
location: null,
|
41
|
-
properties:
|
41
|
+
properties: {"pseudonym":"Dr. Octopus"}
|
42
42
|
)
|
43
43
|
```
|
44
44
|
|
data/docs/IncludedSegments.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | **String** | | |
|
8
8
|
| **id** | **String** | | |
|
9
|
-
| **attributes** | [**
|
9
|
+
| **attributes** | [**IncludedSegmentsAttributes**](IncludedSegmentsAttributes.md) | | |
|
10
10
|
| **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) | | |
|
11
11
|
|
12
12
|
## Example
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# KlaviyoAPI::IncludedSegmentsAttributes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | A helpful name to label the segment | [optional] |
|
8
|
+
| **created** | **Time** | Date and time when the segment was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
|
9
|
+
| **updated** | **Time** | Date and time when the segment was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'klaviyo-api-sdk'
|
15
|
+
|
16
|
+
instance = KlaviyoAPI::IncludedSegmentsAttributes.new(
|
17
|
+
name: Repeat Purchasers,
|
18
|
+
created: null,
|
19
|
+
updated: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# KlaviyoAPI::IncludedTags
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | | |
|
8
|
+
| **id** | **String** | The Tag ID | |
|
9
|
+
| **attributes** | [**TagUpdateQueryAsSubResourceAttributes**](TagUpdateQueryAsSubResourceAttributes.md) | | |
|
10
|
+
| **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) | | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'klaviyo-api-sdk'
|
16
|
+
|
17
|
+
instance = KlaviyoAPI::IncludedTags.new(
|
18
|
+
type: null,
|
19
|
+
id: abcd1234-ef56-gh78-ij90-abcdef123456,
|
20
|
+
attributes: null,
|
21
|
+
links: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/IncludedVariants.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | **String** | | |
|
8
|
-
| **id** | **String** |
|
8
|
+
| **id** | **String** | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
9
9
|
| **attributes** | [**IncludedVariantsAttributes**](IncludedVariantsAttributes.md) | | |
|
10
10
|
| **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) | | |
|
11
11
|
|
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
|
|
16
16
|
|
17
17
|
instance = KlaviyoAPI::IncludedVariants.new(
|
18
18
|
type: null,
|
19
|
-
id:
|
19
|
+
id: $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
|
20
20
|
attributes: null,
|
21
21
|
links: null
|
22
22
|
)
|
@@ -4,21 +4,21 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **external_id** | **String** |
|
8
|
-
| **title** | **String** |
|
9
|
-
| **description** | **String** |
|
10
|
-
| **sku** | **String** |
|
11
|
-
| **inventory_policy** | **Integer** |
|
12
|
-
| **inventory_quantity** | **Float** |
|
13
|
-
| **price** | **Float** |
|
14
|
-
| **url** | **String** |
|
15
|
-
| **image_full_url** | **String** |
|
16
|
-
| **image_thumbnail_url** | **String** |
|
17
|
-
| **images** | **Array<String>** |
|
18
|
-
| **custom_metadata** | **Object** |
|
19
|
-
| **published** | **Boolean** |
|
20
|
-
| **created** | **Time** | | [optional] |
|
21
|
-
| **updated** | **Time** |
|
7
|
+
| **external_id** | **String** | The ID of the catalog item variant in an external system. | [optional] |
|
8
|
+
| **title** | **String** | The title of the catalog item variant. | [optional] |
|
9
|
+
| **description** | **String** | A description of the catalog item variant. | [optional] |
|
10
|
+
| **sku** | **String** | The SKU of the catalog item variant. | [optional] |
|
11
|
+
| **inventory_policy** | **Integer** | This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity. | [optional] |
|
12
|
+
| **inventory_quantity** | **Float** | The quantity of the catalog item variant currently in stock. | [optional] |
|
13
|
+
| **price** | **Float** | This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item). | [optional] |
|
14
|
+
| **url** | **String** | URL pointing to the location of the catalog item variant on your website. | [optional] |
|
15
|
+
| **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item variant. | [optional] |
|
16
|
+
| **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item variant. | [optional] |
|
17
|
+
| **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item variant. | [optional] |
|
18
|
+
| **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb. | [optional] |
|
19
|
+
| **published** | **Boolean** | Boolean value indicating whether the catalog item variant is published. | [optional] |
|
20
|
+
| **created** | **Time** | Date and time when the catalog item variant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
|
21
|
+
| **updated** | **Time** | Date and time when the catalog item variant was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
|
22
22
|
|
23
23
|
## Example
|
24
24
|
|
@@ -26,19 +26,19 @@
|
|
26
26
|
require 'klaviyo-api-sdk'
|
27
27
|
|
28
28
|
instance = KlaviyoAPI::IncludedVariantsAttributes.new(
|
29
|
-
external_id:
|
30
|
-
title:
|
31
|
-
description:
|
32
|
-
sku:
|
33
|
-
inventory_policy:
|
34
|
-
inventory_quantity:
|
35
|
-
price:
|
36
|
-
url:
|
37
|
-
image_full_url:
|
38
|
-
image_thumbnail_url:
|
39
|
-
images:
|
40
|
-
custom_metadata:
|
41
|
-
published:
|
29
|
+
external_id: SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
|
30
|
+
title: Ocean Blue Shirt (Sample) Variant Medium,
|
31
|
+
description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
|
32
|
+
sku: OBS-MD,
|
33
|
+
inventory_policy: 2,
|
34
|
+
inventory_quantity: 25,
|
35
|
+
price: 42,
|
36
|
+
url: https://via.placeholder.com/150,
|
37
|
+
image_full_url: https://via.placeholder.com/300,
|
38
|
+
image_thumbnail_url: https://via.placeholder.com/150,
|
39
|
+
images: ["https://via.placeholder.com/150"],
|
40
|
+
custom_metadata: {"Top Pick":true},
|
41
|
+
published: true,
|
42
42
|
created: null,
|
43
43
|
updated: null
|
44
44
|
)
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **name** | **String** |
|
7
|
+
| **name** | **String** | A helpful name to label the list | |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -12,7 +12,7 @@
|
|
12
12
|
require 'klaviyo-api-sdk'
|
13
13
|
|
14
14
|
instance = KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new(
|
15
|
-
name:
|
15
|
+
name: Newsletter
|
16
16
|
)
|
17
17
|
```
|
18
18
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | **String** | | |
|
8
|
-
| **id** | **String** |
|
8
|
+
| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
9
9
|
| **attributes** | [**ListCreateQueryAsSubResourceAttributes**](ListCreateQueryAsSubResourceAttributes.md) | | |
|
10
10
|
|
11
11
|
## Example
|
@@ -15,7 +15,7 @@ require 'klaviyo-api-sdk'
|
|
15
15
|
|
16
16
|
instance = KlaviyoAPI::ListPartialUpdateQueryAsSubResource.new(
|
17
17
|
type: null,
|
18
|
-
id:
|
18
|
+
id: Y6nRLr,
|
19
19
|
attributes: null
|
20
20
|
)
|
21
21
|
```
|
data/docs/ListsApi.md
CHANGED
@@ -38,7 +38,7 @@ KlaviyoAPI.configure do |config|
|
|
38
38
|
end
|
39
39
|
|
40
40
|
api_instance = KlaviyoAPI::ListsApi.new
|
41
|
-
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 |
|
42
42
|
|
43
43
|
begin
|
44
44
|
# Create List
|
@@ -183,7 +183,7 @@ KlaviyoAPI.configure do |config|
|
|
183
183
|
end
|
184
184
|
|
185
185
|
api_instance = KlaviyoAPI::ListsApi.new
|
186
|
-
id = '
|
186
|
+
id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
187
187
|
|
188
188
|
begin
|
189
189
|
# Delete List
|
@@ -215,7 +215,7 @@ end
|
|
215
215
|
|
216
216
|
| Name | Type | Description | Notes |
|
217
217
|
| ---- | ---- | ----------- | ----- |
|
218
|
-
| **id** | **String** |
|
218
|
+
| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
219
219
|
|
220
220
|
### Return type
|
221
221
|
|
@@ -327,9 +327,9 @@ KlaviyoAPI.configure do |config|
|
|
327
327
|
end
|
328
328
|
|
329
329
|
api_instance = KlaviyoAPI::ListsApi.new
|
330
|
-
id = '
|
330
|
+
id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
331
331
|
opts = {
|
332
|
-
fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
332
|
+
fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
333
333
|
}
|
334
334
|
|
335
335
|
begin
|
@@ -363,8 +363,8 @@ end
|
|
363
363
|
|
364
364
|
| Name | Type | Description | Notes |
|
365
365
|
| ---- | ---- | ----------- | ----- |
|
366
|
-
| **id** | **String** |
|
367
|
-
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
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] |
|
368
368
|
|
369
369
|
### Return type
|
370
370
|
|
@@ -402,11 +402,11 @@ KlaviyoAPI.configure do |config|
|
|
402
402
|
end
|
403
403
|
|
404
404
|
api_instance = KlaviyoAPI::ListsApi.new
|
405
|
-
list_id = '
|
405
|
+
list_id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
406
406
|
opts = {
|
407
|
-
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
408
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
409
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
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
|
410
410
|
}
|
411
411
|
|
412
412
|
begin
|
@@ -440,10 +440,10 @@ end
|
|
440
440
|
|
441
441
|
| Name | Type | Description | Notes |
|
442
442
|
| ---- | ---- | ----------- | ----- |
|
443
|
-
| **list_id** | **String** |
|
444
|
-
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
445
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
446
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
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] |
|
447
447
|
|
448
448
|
### Return type
|
449
449
|
|
@@ -484,7 +484,7 @@ api_instance = KlaviyoAPI::ListsApi.new
|
|
484
484
|
id = 'id_example' # String |
|
485
485
|
related_resource = 'profiles' # String |
|
486
486
|
opts = {
|
487
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
487
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
488
488
|
}
|
489
489
|
|
490
490
|
begin
|
@@ -520,7 +520,7 @@ end
|
|
520
520
|
| ---- | ---- | ----------- | ----- |
|
521
521
|
| **id** | **String** | | |
|
522
522
|
| **related_resource** | **String** | | |
|
523
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
523
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
524
524
|
|
525
525
|
### Return type
|
526
526
|
|
@@ -558,9 +558,9 @@ KlaviyoAPI.configure do |config|
|
|
558
558
|
end
|
559
559
|
|
560
560
|
api_instance = KlaviyoAPI::ListsApi.new
|
561
|
-
list_id = '
|
561
|
+
list_id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
562
562
|
opts = {
|
563
|
-
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
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
564
|
}
|
565
565
|
|
566
566
|
begin
|
@@ -594,8 +594,8 @@ end
|
|
594
594
|
|
595
595
|
| Name | Type | Description | Notes |
|
596
596
|
| ---- | ---- | ----------- | ----- |
|
597
|
-
| **list_id** | **String** |
|
598
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
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] |
|
599
599
|
|
600
600
|
### Return type
|
601
601
|
|
@@ -634,9 +634,9 @@ end
|
|
634
634
|
|
635
635
|
api_instance = KlaviyoAPI::ListsApi.new
|
636
636
|
opts = {
|
637
|
-
fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
638
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
639
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
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
|
640
640
|
}
|
641
641
|
|
642
642
|
begin
|
@@ -670,9 +670,9 @@ end
|
|
670
670
|
|
671
671
|
| Name | Type | Description | Notes |
|
672
672
|
| ---- | ---- | ----------- | ----- |
|
673
|
-
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
674
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
675
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
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] |
|
676
676
|
|
677
677
|
### Return type
|
678
678
|
|
@@ -710,8 +710,8 @@ KlaviyoAPI.configure do |config|
|
|
710
710
|
end
|
711
711
|
|
712
712
|
api_instance = KlaviyoAPI::ListsApi.new
|
713
|
-
id = '
|
714
|
-
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 |
|
715
715
|
|
716
716
|
begin
|
717
717
|
# Update List
|
@@ -744,7 +744,7 @@ end
|
|
744
744
|
|
745
745
|
| Name | Type | Description | Notes |
|
746
746
|
| ---- | ---- | ----------- | ----- |
|
747
|
-
| **id** | **String** |
|
747
|
+
| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
748
748
|
| **list_partial_update_query** | [**ListPartialUpdateQuery**](ListPartialUpdateQuery.md) | | |
|
749
749
|
|
750
750
|
### Return type
|
@@ -5,15 +5,15 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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] |
|
8
9
|
| **measurements** | **Array<String>** | Measurement key, e.g. `unique`, `sum_value`, `count` | |
|
9
10
|
| **interval** | **String** | Aggregation interval, e.g. \"hour\", \"day\", \"week\", \"month\" | |
|
10
11
|
| **page_size** | **Integer** | Alter the maximum number of returned rows in a single page of aggregation results | [optional][default to 500] |
|
11
12
|
| **by** | **Array<String>** | Optional attribute(s) used for partitioning by the aggregation function | [optional] |
|
12
13
|
| **return_fields** | **Array<String>** | Provide fields to limit the returned data | [optional] |
|
13
|
-
| **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 `
|
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. | |
|
14
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'] |
|
15
|
-
| **sort** | **String** |
|
16
|
-
| **page_cursor** | **String** | | [optional] |
|
16
|
+
| **sort** | **String** | Provide a sort key (e.g. -$message) | [optional] |
|
17
17
|
|
18
18
|
## Example
|
19
19
|
|
@@ -22,6 +22,7 @@ require 'klaviyo-api-sdk'
|
|
22
22
|
|
23
23
|
instance = KlaviyoAPI::MetricAggregateQueryAsSubResourceAttributes.new(
|
24
24
|
metric_id: 0rG4eQ,
|
25
|
+
page_cursor: null,
|
25
26
|
measurements: count,
|
26
27
|
interval: day,
|
27
28
|
page_size: 500,
|
@@ -29,8 +30,7 @@ instance = KlaviyoAPI::MetricAggregateQueryAsSubResourceAttributes.new(
|
|
29
30
|
return_fields: null,
|
30
31
|
filter: ["greater-or-equal(datetime,2022-12-01T00:00:00)","less-than(datetime,2022-12-08T00:00:00"],
|
31
32
|
timezone: America/New_York,
|
32
|
-
sort: null
|
33
|
-
page_cursor: null
|
33
|
+
sort: null
|
34
34
|
)
|
35
35
|
```
|
36
36
|
|