klaviyo-api-sdk 1.1.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +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
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2023-
|
6
|
+
The version of the OpenAPI document: 2023-02-22
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -51,7 +51,7 @@ module KlaviyoAPI
|
|
51
51
|
# header parameters
|
52
52
|
header_params = opts[:header_params] || {}
|
53
53
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
54
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
55
55
|
# HTTP header 'Accept' (if needed)
|
56
56
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
57
|
# HTTP header 'Content-Type'
|
@@ -93,10 +93,10 @@ module KlaviyoAPI
|
|
93
93
|
# Get the profile with the given profile ID. Include parameters can be provided to get the following related resource data: `lists` memberships, `segments` memberships\"<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read`
|
94
94
|
# @param id [String]
|
95
95
|
# @param [Hash] opts the optional parameters
|
96
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
97
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-
|
98
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
99
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
96
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
97
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
98
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
99
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
100
100
|
# @return [Hash<String, Object>]
|
101
101
|
def get_profile(id, opts = {})
|
102
102
|
data, _status_code, _headers = get_profile_with_http_info(id, opts)
|
@@ -107,10 +107,10 @@ module KlaviyoAPI
|
|
107
107
|
# Get the profile with the given profile ID. Include parameters can be provided to get the following related resource data: `lists` memberships, `segments` memberships\"<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read`
|
108
108
|
# @param id [String]
|
109
109
|
# @param [Hash] opts the optional parameters
|
110
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
111
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-
|
112
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
113
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
110
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
111
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
112
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
113
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
114
114
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
115
115
|
def get_profile_with_http_info(id, opts = {})
|
116
116
|
if @api_client.config.debugging
|
@@ -149,7 +149,7 @@ module KlaviyoAPI
|
|
149
149
|
# header parameters
|
150
150
|
header_params = opts[:header_params] || {}
|
151
151
|
# klaviyo api revision
|
152
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
152
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
153
153
|
# HTTP header 'Accept' (if needed)
|
154
154
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
155
155
|
|
@@ -186,7 +186,7 @@ module KlaviyoAPI
|
|
186
186
|
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `List Read` `Profiles Read`
|
187
187
|
# @param profile_id [String]
|
188
188
|
# @param [Hash] opts the optional parameters
|
189
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
189
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
190
190
|
# @return [Hash<String, Object>]
|
191
191
|
def get_profile_lists(profile_id, opts = {})
|
192
192
|
data, _status_code, _headers = get_profile_lists_with_http_info(profile_id, opts)
|
@@ -197,7 +197,7 @@ module KlaviyoAPI
|
|
197
197
|
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `List Read` `Profiles Read`
|
198
198
|
# @param profile_id [String]
|
199
199
|
# @param [Hash] opts the optional parameters
|
200
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
200
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
201
201
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
202
202
|
def get_profile_lists_with_http_info(profile_id, opts = {})
|
203
203
|
if @api_client.config.debugging
|
@@ -221,7 +221,7 @@ module KlaviyoAPI
|
|
221
221
|
# header parameters
|
222
222
|
header_params = opts[:header_params] || {}
|
223
223
|
# klaviyo api revision
|
224
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
224
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
225
225
|
# HTTP header 'Accept' (if needed)
|
226
226
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
227
227
|
|
@@ -297,7 +297,7 @@ module KlaviyoAPI
|
|
297
297
|
# header parameters
|
298
298
|
header_params = opts[:header_params] || {}
|
299
299
|
# klaviyo api revision
|
300
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
300
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
301
301
|
# HTTP header 'Accept' (if needed)
|
302
302
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
303
303
|
|
@@ -334,7 +334,7 @@ module KlaviyoAPI
|
|
334
334
|
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read` `Segments Read`
|
335
335
|
# @param profile_id [String]
|
336
336
|
# @param [Hash] opts the optional parameters
|
337
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
337
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
338
338
|
# @return [Hash<String, Object>]
|
339
339
|
def get_profile_segments(profile_id, opts = {})
|
340
340
|
data, _status_code, _headers = get_profile_segments_with_http_info(profile_id, opts)
|
@@ -345,7 +345,7 @@ module KlaviyoAPI
|
|
345
345
|
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read` `Segments Read`
|
346
346
|
# @param profile_id [String]
|
347
347
|
# @param [Hash] opts the optional parameters
|
348
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
348
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
349
349
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
350
350
|
def get_profile_segments_with_http_info(profile_id, opts = {})
|
351
351
|
if @api_client.config.debugging
|
@@ -369,7 +369,7 @@ module KlaviyoAPI
|
|
369
369
|
# header parameters
|
370
370
|
header_params = opts[:header_params] || {}
|
371
371
|
# klaviyo api revision
|
372
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
372
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
373
373
|
# HTTP header 'Accept' (if needed)
|
374
374
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
375
375
|
|
@@ -405,10 +405,10 @@ module KlaviyoAPI
|
|
405
405
|
# Get Profiles
|
406
406
|
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `email` 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: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read`
|
407
407
|
# @param [Hash] opts the optional parameters
|
408
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-
|
409
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
410
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
411
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
408
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
409
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`anonymous_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`
|
410
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
411
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
412
412
|
# @return [Hash<String, Object>]
|
413
413
|
def get_profiles(opts = {})
|
414
414
|
data, _status_code, _headers = get_profiles_with_http_info(opts)
|
@@ -418,10 +418,10 @@ module KlaviyoAPI
|
|
418
418
|
# Get Profiles
|
419
419
|
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `email` 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: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read`
|
420
420
|
# @param [Hash] opts the optional parameters
|
421
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-
|
422
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
423
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
424
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
421
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
422
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`anonymous_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`
|
423
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
424
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
425
425
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
426
426
|
def get_profiles_with_http_info(opts = {})
|
427
427
|
if @api_client.config.debugging
|
@@ -448,7 +448,7 @@ module KlaviyoAPI
|
|
448
448
|
# header parameters
|
449
449
|
header_params = opts[:header_params] || {}
|
450
450
|
# klaviyo api revision
|
451
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
451
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
452
452
|
# HTTP header 'Accept' (if needed)
|
453
453
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
454
454
|
|
@@ -513,7 +513,7 @@ module KlaviyoAPI
|
|
513
513
|
# header parameters
|
514
514
|
header_params = opts[:header_params] || {}
|
515
515
|
# klaviyo api revision
|
516
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
516
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
517
517
|
# HTTP header 'Accept' (if needed)
|
518
518
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
519
519
|
# HTTP header 'Content-Type'
|
@@ -583,7 +583,7 @@ module KlaviyoAPI
|
|
583
583
|
# header parameters
|
584
584
|
header_params = opts[:header_params] || {}
|
585
585
|
# klaviyo api revision
|
586
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
586
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
587
587
|
# HTTP header 'Accept' (if needed)
|
588
588
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
589
589
|
# HTTP header 'Content-Type'
|
@@ -653,7 +653,7 @@ module KlaviyoAPI
|
|
653
653
|
# header parameters
|
654
654
|
header_params = opts[:header_params] || {}
|
655
655
|
# klaviyo api revision
|
656
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
656
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
657
657
|
# HTTP header 'Accept' (if needed)
|
658
658
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
659
659
|
# HTTP header 'Content-Type'
|
@@ -723,7 +723,7 @@ module KlaviyoAPI
|
|
723
723
|
# header parameters
|
724
724
|
header_params = opts[:header_params] || {}
|
725
725
|
# klaviyo api revision
|
726
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
726
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
727
727
|
# HTTP header 'Accept' (if needed)
|
728
728
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
729
729
|
# HTTP header 'Content-Type'
|
@@ -763,7 +763,7 @@ module KlaviyoAPI
|
|
763
763
|
|
764
764
|
# Update Profile
|
765
765
|
# Update the profile with the given profile ID. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Write`
|
766
|
-
# @param id [String]
|
766
|
+
# @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
|
767
767
|
# @param profile_partial_update_query [ProfilePartialUpdateQuery]
|
768
768
|
# @param [Hash] opts the optional parameters
|
769
769
|
# @return [Hash<String, Object>]
|
@@ -774,7 +774,7 @@ module KlaviyoAPI
|
|
774
774
|
|
775
775
|
# Update Profile
|
776
776
|
# Update the profile with the given profile ID. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Write`
|
777
|
-
# @param id [String]
|
777
|
+
# @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
|
778
778
|
# @param profile_partial_update_query [ProfilePartialUpdateQuery]
|
779
779
|
# @param [Hash] opts the optional parameters
|
780
780
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -799,7 +799,7 @@ module KlaviyoAPI
|
|
799
799
|
# header parameters
|
800
800
|
header_params = opts[:header_params] || {}
|
801
801
|
# klaviyo api revision
|
802
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
802
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
803
803
|
# HTTP header 'Accept' (if needed)
|
804
804
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
805
805
|
# HTTP header 'Content-Type'
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2023-
|
6
|
+
The version of the OpenAPI document: 2023-02-22
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -23,7 +23,7 @@ module KlaviyoAPI
|
|
23
23
|
# Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Segments Read`
|
24
24
|
# @param id [String]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
26
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
27
27
|
# @return [Hash<String, Object>]
|
28
28
|
def get_segment(id, opts = {})
|
29
29
|
data, _status_code, _headers = get_segment_with_http_info(id, opts)
|
@@ -34,7 +34,7 @@ module KlaviyoAPI
|
|
34
34
|
# Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Segments Read`
|
35
35
|
# @param id [String]
|
36
36
|
# @param [Hash] opts the optional parameters
|
37
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
37
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
38
38
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
39
39
|
def get_segment_with_http_info(id, opts = {})
|
40
40
|
if @api_client.config.debugging
|
@@ -58,7 +58,7 @@ module KlaviyoAPI
|
|
58
58
|
# header parameters
|
59
59
|
header_params = opts[:header_params] || {}
|
60
60
|
# klaviyo api revision
|
61
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
61
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
62
62
|
# HTTP header 'Accept' (if needed)
|
63
63
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
64
64
|
|
@@ -95,9 +95,9 @@ module KlaviyoAPI
|
|
95
95
|
# Get all profiles within the given segment 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:** `Profiles Read` `Segments Read`
|
96
96
|
# @param segment_id [String]
|
97
97
|
# @param [Hash] opts the optional parameters
|
98
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-
|
99
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
100
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
98
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
99
|
+
# @option opts [String] :filter 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`
|
100
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
101
101
|
# @return [Hash<String, Object>]
|
102
102
|
def get_segment_profiles(segment_id, opts = {})
|
103
103
|
data, _status_code, _headers = get_segment_profiles_with_http_info(segment_id, opts)
|
@@ -108,9 +108,9 @@ module KlaviyoAPI
|
|
108
108
|
# Get all profiles within the given segment 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:** `Profiles Read` `Segments Read`
|
109
109
|
# @param segment_id [String]
|
110
110
|
# @param [Hash] opts the optional parameters
|
111
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-
|
112
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
113
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
111
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
112
|
+
# @option opts [String] :filter 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`
|
113
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
114
114
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
115
115
|
def get_segment_profiles_with_http_info(segment_id, opts = {})
|
116
116
|
if @api_client.config.debugging
|
@@ -136,7 +136,7 @@ module KlaviyoAPI
|
|
136
136
|
# header parameters
|
137
137
|
header_params = opts[:header_params] || {}
|
138
138
|
# klaviyo api revision
|
139
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
139
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
140
140
|
# HTTP header 'Accept' (if needed)
|
141
141
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
142
142
|
|
@@ -174,7 +174,7 @@ module KlaviyoAPI
|
|
174
174
|
# @param id [String]
|
175
175
|
# @param related_resource [String]
|
176
176
|
# @param [Hash] opts the optional parameters
|
177
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
177
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
178
178
|
# @return [Hash<String, Object>]
|
179
179
|
def get_segment_relationships(id, related_resource, opts = {})
|
180
180
|
data, _status_code, _headers = get_segment_relationships_with_http_info(id, related_resource, opts)
|
@@ -186,7 +186,7 @@ module KlaviyoAPI
|
|
186
186
|
# @param id [String]
|
187
187
|
# @param related_resource [String]
|
188
188
|
# @param [Hash] opts the optional parameters
|
189
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
189
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
190
190
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
191
191
|
def get_segment_relationships_with_http_info(id, related_resource, opts = {})
|
192
192
|
if @api_client.config.debugging
|
@@ -215,7 +215,7 @@ module KlaviyoAPI
|
|
215
215
|
# header parameters
|
216
216
|
header_params = opts[:header_params] || {}
|
217
217
|
# klaviyo api revision
|
218
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
218
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
219
219
|
# HTTP header 'Accept' (if needed)
|
220
220
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
221
221
|
|
@@ -252,7 +252,7 @@ module KlaviyoAPI
|
|
252
252
|
# Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Segments Read` `Tags Read`
|
253
253
|
# @param segment_id [String]
|
254
254
|
# @param [Hash] opts the optional parameters
|
255
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
255
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
256
256
|
# @return [Hash<String, Object>]
|
257
257
|
def get_segment_tags(segment_id, opts = {})
|
258
258
|
data, _status_code, _headers = get_segment_tags_with_http_info(segment_id, opts)
|
@@ -263,7 +263,7 @@ module KlaviyoAPI
|
|
263
263
|
# Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Segments Read` `Tags Read`
|
264
264
|
# @param segment_id [String]
|
265
265
|
# @param [Hash] opts the optional parameters
|
266
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
266
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
267
267
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
268
268
|
def get_segment_tags_with_http_info(segment_id, opts = {})
|
269
269
|
if @api_client.config.debugging
|
@@ -287,7 +287,7 @@ module KlaviyoAPI
|
|
287
287
|
# header parameters
|
288
288
|
header_params = opts[:header_params] || {}
|
289
289
|
# klaviyo api revision
|
290
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
290
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
291
291
|
# HTTP header 'Accept' (if needed)
|
292
292
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
293
293
|
|
@@ -323,9 +323,9 @@ module KlaviyoAPI
|
|
323
323
|
# Get Segments
|
324
324
|
# Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `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:** `Segments Read`
|
325
325
|
# @param [Hash] opts the optional parameters
|
326
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
327
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
328
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
326
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
327
|
+
# @option opts [String] :filter 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`
|
328
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
329
329
|
# @return [Hash<String, Object>]
|
330
330
|
def get_segments(opts = {})
|
331
331
|
data, _status_code, _headers = get_segments_with_http_info(opts)
|
@@ -335,9 +335,9 @@ module KlaviyoAPI
|
|
335
335
|
# Get Segments
|
336
336
|
# Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `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:** `Segments Read`
|
337
337
|
# @param [Hash] opts the optional parameters
|
338
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
339
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
340
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
338
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
339
|
+
# @option opts [String] :filter 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`
|
340
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
341
341
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
342
342
|
def get_segments_with_http_info(opts = {})
|
343
343
|
if @api_client.config.debugging
|
@@ -359,7 +359,7 @@ module KlaviyoAPI
|
|
359
359
|
# header parameters
|
360
360
|
header_params = opts[:header_params] || {}
|
361
361
|
# klaviyo api revision
|
362
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
362
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
363
363
|
# HTTP header 'Accept' (if needed)
|
364
364
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
365
365
|
|
@@ -430,7 +430,7 @@ module KlaviyoAPI
|
|
430
430
|
# header parameters
|
431
431
|
header_params = opts[:header_params] || {}
|
432
432
|
# klaviyo api revision
|
433
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
433
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
434
434
|
# HTTP header 'Accept' (if needed)
|
435
435
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
436
436
|
# HTTP header 'Content-Type'
|