klaviyo-api-sdk 1.0.0 → 1.1.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 +14 -0
- data/README.md +335 -119
- data/docs/AudiencesSubObject.md +20 -0
- data/docs/CampaignCloneQuery.md +18 -0
- data/docs/CampaignCloneQueryAsSubResource.md +20 -0
- data/docs/CampaignCloneQueryAsSubResourceAttributes.md +20 -0
- data/docs/CampaignCreateQuery.md +18 -0
- data/docs/CampaignCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignCreateQueryAsSubResourceAttributes.md +28 -0
- data/docs/CampaignMessageAssignTemplateQuery.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +20 -0
- data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +20 -0
- data/docs/CampaignMessagePartialUpdateQuery.md +18 -0
- data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +22 -0
- data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +20 -0
- data/docs/CampaignPartialUpdateQuery.md +18 -0
- data/docs/CampaignPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +26 -0
- data/docs/CampaignSendJobCreateQuery.md +18 -0
- data/docs/CampaignSendJobCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CampaignSendJobPartialUpdateQuery.md +18 -0
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +2 -2
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +1 -1
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +1 -1
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +4 -4
- data/docs/CatalogItemDeleteQueryAsSubResource.md +1 -1
- data/docs/CatalogItemUpdateQueryAsSubResource.md +1 -1
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +4 -4
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +1 -1
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +1 -1
- data/docs/CatalogsApi.md +202 -202
- data/docs/ClientApi.md +11 -11
- data/docs/ContentSubObject.md +28 -0
- data/docs/DataPrivacyApi.md +78 -0
- data/docs/DataPrivacyCreateDeletionJobQuery.md +18 -0
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +20 -0
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +22 -0
- data/docs/ErrorSource.md +2 -2
- data/docs/EventCreateQueryAsSubResourceAttributes.md +8 -8
- data/docs/EventsApi.md +36 -36
- data/docs/FlowsApi.md +139 -69
- data/docs/IncludedCategories.md +1 -1
- data/docs/IncludedMetrics.md +1 -1
- data/docs/IncludedMetricsAttributes.md +4 -4
- data/docs/ListsApi.md +101 -25
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +15 -15
- data/docs/MetricAggregateRowDTO.md +2 -2
- data/docs/MetricCreateQuery.md +3 -3
- data/docs/MetricsApi.md +14 -14
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +10 -10
- data/docs/ProfilesApi.md +31 -31
- data/docs/SegmentsApi.md +102 -23
- data/docs/SendOptionsSubObject.md +20 -0
- data/docs/SendStrategySubObject.md +22 -0
- data/docs/SendTimeSubObject.md +20 -0
- data/docs/StaticScheduleOptions.md +22 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
- data/docs/Suppression.md +1 -1
- data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/TagCreateQuery.md +18 -0
- data/docs/TagCreateQueryAsSubResource.md +20 -0
- data/docs/TagCreateQueryAsSubResourceAttributes.md +20 -0
- data/docs/TagGroupCreateQuery.md +18 -0
- data/docs/TagGroupCreateQueryAsSubResource.md +20 -0
- data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +20 -0
- data/docs/TagGroupUpdateQuery.md +18 -0
- data/docs/TagGroupUpdateQueryAsSubResource.md +22 -0
- data/docs/{V2TemplateRenderQueryAsSubResourceAttributes.md → TagGroupUpdateQueryAsSubResourceAttributes.md} +4 -4
- data/docs/TagSegmentOp.md +18 -0
- data/docs/{ListDeleteQueryAsSubResource.md → TagSegmentOpDataInner.md} +2 -2
- data/docs/TagUpdateQuery.md +18 -0
- data/docs/TagUpdateQueryAsSubResource.md +22 -0
- data/docs/TagUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/TagsApi.md +1205 -0
- data/docs/TemplateCloneQueryAsSubResource.md +2 -0
- data/docs/TemplateCloneQueryAsSubResourceAttributes.md +5 -3
- data/docs/TemplateCreateQueryAsSubResourceAttributes.md +14 -8
- data/docs/TemplateRenderQuery.md +18 -0
- data/docs/TemplateRenderQueryAsSubResource.md +20 -0
- data/docs/TemplateRenderQueryAsSubResourceAttributes.md +22 -0
- data/docs/TemplateUpdateQueryAsSubResource.md +1 -1
- data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +13 -7
- data/docs/TemplatesApi.md +40 -44
- data/docs/ThrottledScheduleOptions.md +20 -0
- data/docs/TrackingOptionsSubObject.md +24 -0
- data/docs/UTMParamsSubObject.md +20 -0
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +1 -1
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/V2TemplateRenderQueryAsSubResource.md +2 -4
- data/klaviyo-api-sdk.gemspec +3 -3
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +277 -277
- data/lib/klaviyo-api-sdk/api/client_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +92 -0
- data/lib/klaviyo-api-sdk/api/events_api.rb +46 -46
- data/lib/klaviyo-api-sdk/api/flows_api.rb +155 -93
- data/lib/klaviyo-api-sdk/api/lists_api.rb +114 -42
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +21 -21
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +51 -51
- data/lib/klaviyo-api-sdk/api/segments_api.rb +112 -33
- data/lib/klaviyo-api-sdk/api/tags_api.rb +1216 -0
- data/lib/klaviyo-api-sdk/api/templates_api.rb +57 -69
- data/lib/klaviyo-api-sdk/api_client.rb +24 -3
- data/lib/klaviyo-api-sdk/api_error.rb +2 -2
- data/lib/klaviyo-api-sdk/configuration.rb +2 -2
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +234 -0
- data/lib/klaviyo-api-sdk/models/{v2_template_render_query.rb → campaign_clone_query.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +291 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/{included_profile.rb → campaign_message_partial_update_query_as_sub_resource.rb} +12 -25
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +256 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +4 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +270 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +2 -2
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/error_source.rb +4 -2
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +7 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +2 -2
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_categories.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flows.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_items.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_lists.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +3 -2
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_segments.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_variants.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +14 -8
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +4 -2
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +4 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +7 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_location.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/send_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +230 -0
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +243 -0
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +240 -0
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +2 -2
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +2 -2
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +245 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +5 -2
- data/lib/klaviyo-api-sdk/models/suppression.rb +3 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +3 -2
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +234 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/{v2_template_render_query_as_sub_resource_attributes.rb → tag_group_update_query_as_sub_resource_attributes.rb} +16 -15
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/{list_delete_query_as_sub_resource.rb → tag_segment_op_data_inner.rb} +7 -7
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +287 -0
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +14 -3
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +20 -3
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +7 -2
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/{template_delete_query_as_sub_resource.rb → template_render_query_as_sub_resource.rb} +15 -15
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +3 -2
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +6 -2
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +240 -0
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +5 -7
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +3 -3
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +2 -2
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +240 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +11 -62
- data/lib/klaviyo-api-sdk/version.rb +2 -2
- data/lib/klaviyo-api-sdk.rb +55 -7
- data/spec/api/catalogs_api_spec.rb +94 -94
- data/spec/api/client_api_spec.rb +5 -5
- data/spec/api/data_privacy_api_spec.rb +47 -0
- data/spec/api/events_api_spec.rb +19 -19
- data/spec/api/flows_api_spec.rb +44 -33
- data/spec/api/lists_api_spec.rb +28 -15
- data/spec/api/metrics_api_spec.rb +8 -8
- data/spec/api/profiles_api_spec.rb +21 -21
- data/spec/api/segments_api_spec.rb +24 -10
- data/spec/api/tags_api_spec.rb +245 -0
- data/spec/api/templates_api_spec.rb +18 -18
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/audiences_sub_object_spec.rb +40 -0
- data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/{v2_template_render_query_spec.rb → campaign_clone_query_spec.rb} +8 -8
- data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +64 -0
- data/spec/models/campaign_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_create_query_spec.rb +34 -0
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_message_assign_template_query_spec.rb +34 -0
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/campaign_message_partial_update_query_spec.rb +34 -0
- data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +58 -0
- data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/campaign_partial_update_query_spec.rb +34 -0
- data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_send_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_create_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_item_op_spec.rb +2 -2
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_update_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_category_update_query_spec.rb +2 -2
- data/spec/models/catalog_item_category_op_spec.rb +2 -2
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_create_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_update_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_item_update_query_spec.rb +2 -2
- data/spec/models/catalog_job_error_payload_spec.rb +2 -2
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +2 -2
- data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/catalog_variant_update_query_spec.rb +2 -2
- data/spec/models/content_sub_object_spec.rb +64 -0
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +34 -0
- data/spec/models/email_message_content_spec.rb +2 -2
- data/spec/models/email_tracking_options_spec.rb +2 -2
- data/spec/models/error_source_spec.rb +2 -2
- data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/event_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/event_create_query_spec.rb +2 -2
- data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/flow_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/flow_update_query_spec.rb +2 -2
- data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +2 -2
- data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +2 -2
- data/spec/models/get_catalog_items4_xx_response_spec.rb +2 -2
- data/spec/models/included_categories_attributes_spec.rb +2 -2
- data/spec/models/included_categories_spec.rb +2 -2
- data/spec/models/included_flow_action_spec.rb +2 -2
- data/spec/models/included_flow_actions_attributes_spec.rb +2 -2
- data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +2 -2
- data/spec/models/included_flow_actions_spec.rb +2 -2
- data/spec/models/included_flow_messages_attributes_content_spec.rb +2 -2
- data/spec/models/included_flow_messages_attributes_spec.rb +2 -2
- data/spec/models/included_flow_messages_spec.rb +2 -2
- data/spec/models/included_flows_attributes_spec.rb +2 -2
- data/spec/models/included_flows_spec.rb +2 -2
- data/spec/models/included_items_attributes_spec.rb +2 -2
- data/spec/models/included_items_spec.rb +2 -2
- data/spec/models/included_lists_attributes_spec.rb +2 -2
- data/spec/models/included_lists_spec.rb +2 -2
- data/spec/models/included_metrics_attributes_spec.rb +2 -2
- data/spec/models/included_metrics_spec.rb +2 -2
- data/spec/models/included_profiles_attributes_spec.rb +2 -2
- data/spec/models/included_profiles_spec.rb +2 -2
- data/spec/models/included_segments_spec.rb +2 -2
- data/spec/models/included_variants_attributes_spec.rb +2 -2
- data/spec/models/included_variants_links_spec.rb +2 -2
- data/spec/models/included_variants_spec.rb +2 -2
- data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/list_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/list_create_query_spec.rb +2 -2
- data/spec/models/list_members_add_query_data_inner_spec.rb +2 -2
- data/spec/models/list_members_add_query_spec.rb +2 -2
- data/spec/models/list_members_delete_query_spec.rb +2 -2
- data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/list_partial_update_query_spec.rb +2 -2
- data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/metric_aggregate_query_spec.rb +2 -2
- data/spec/models/metric_aggregate_row_dto_spec.rb +2 -2
- data/spec/models/metric_create_query_spec.rb +2 -2
- data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/onsite_profile_create_query_spec.rb +2 -2
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +2 -2
- data/spec/models/onsite_profile_meta_spec.rb +2 -2
- data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/onsite_subscription_create_query_spec.rb +2 -2
- data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/profile_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/profile_create_query_spec.rb +2 -2
- data/spec/models/profile_location_latitude_spec.rb +2 -2
- data/spec/models/profile_location_spec.rb +2 -2
- data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/profile_partial_update_query_spec.rb +2 -2
- data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/segment_partial_update_query_spec.rb +2 -2
- data/spec/models/send_options_spec.rb +2 -2
- data/spec/models/send_options_sub_object_spec.rb +40 -0
- data/spec/models/send_strategy_sub_object_spec.rb +46 -0
- data/spec/models/send_time_sub_object_spec.rb +40 -0
- data/spec/models/sms_message_content_spec.rb +2 -2
- data/spec/models/sms_render_options_spec.rb +2 -2
- data/spec/models/sms_tracking_options_spec.rb +2 -2
- data/spec/models/static_schedule_options_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/subscription_create_job_create_query_spec.rb +2 -2
- data/spec/models/subscription_spec.rb +2 -2
- data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/suppression_create_job_create_query_spec.rb +2 -2
- data/spec/models/suppression_spec.rb +2 -2
- data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/tag_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/tag_create_query_spec.rb +34 -0
- data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/tag_group_create_query_spec.rb +34 -0
- data/spec/models/{v2_template_render_query_as_sub_resource_attributes_spec.rb → tag_group_update_query_as_sub_resource_attributes_spec.rb} +9 -9
- data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/tag_group_update_query_spec.rb +34 -0
- data/spec/models/{list_delete_query_as_sub_resource_spec.rb → tag_segment_op_data_inner_spec.rb} +9 -9
- data/spec/models/tag_segment_op_spec.rb +34 -0
- data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/{included_profile_spec.rb → tag_update_query_as_sub_resource_spec.rb} +9 -15
- data/spec/models/tag_update_query_spec.rb +34 -0
- data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +8 -2
- data/spec/models/template_clone_query_as_sub_resource_spec.rb +8 -2
- data/spec/models/template_clone_query_spec.rb +2 -2
- data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/template_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/template_create_query_spec.rb +2 -2
- data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/{template_delete_query_as_sub_resource_spec.rb → template_render_query_as_sub_resource_spec.rb} +9 -9
- data/spec/models/template_render_query_spec.rb +34 -0
- data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/template_update_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/template_update_query_spec.rb +2 -2
- data/spec/models/throttled_schedule_options_spec.rb +40 -0
- data/spec/models/tracking_options_sub_object_spec.rb +52 -0
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/unsubscription_create_job_create_query_spec.rb +2 -2
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
- data/spec/models/unsuppression_create_job_create_query_spec.rb +2 -2
- data/spec/models/utm_param_info_spec.rb +2 -2
- data/spec/models/utm_params_sub_object_spec.rb +40 -0
- data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +3 -13
- data/spec/spec_helper.rb +2 -2
- metadata +165 -21
- data/docs/IncludedProfile.md +0 -24
- data/docs/TemplateDeleteQueryAsSubResource.md +0 -20
- data/docs/V2TemplateRenderQuery.md +0 -18
data/docs/CatalogsApi.md
CHANGED
|
@@ -442,7 +442,7 @@ KlaviyoAPI.configure do |config|
|
|
|
442
442
|
end
|
|
443
443
|
|
|
444
444
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
445
|
-
id = 'id_example' # String |
|
|
445
|
+
id = 'id_example' # String | The catalog category 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`, but support for multiple catalogs & non-custom integrations is forthcoming.
|
|
446
446
|
|
|
447
447
|
begin
|
|
448
448
|
# Delete Catalog Category
|
|
@@ -474,7 +474,7 @@ end
|
|
|
474
474
|
|
|
475
475
|
| Name | Type | Description | Notes |
|
|
476
476
|
| ---- | ---- | ----------- | ----- |
|
|
477
|
-
| **id** | **String** | | |
|
|
477
|
+
| **id** | **String** | The catalog category 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`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
|
|
478
478
|
|
|
479
479
|
### Return type
|
|
480
480
|
|
|
@@ -586,7 +586,7 @@ KlaviyoAPI.configure do |config|
|
|
|
586
586
|
end
|
|
587
587
|
|
|
588
588
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
589
|
-
id = 'id_example' # String |
|
|
589
|
+
id = 'id_example' # String | The catalog item 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`, but support for multiple catalogs & non-custom integrations is forthcoming.
|
|
590
590
|
|
|
591
591
|
begin
|
|
592
592
|
# Delete Catalog Item
|
|
@@ -618,7 +618,7 @@ end
|
|
|
618
618
|
|
|
619
619
|
| Name | Type | Description | Notes |
|
|
620
620
|
| ---- | ---- | ----------- | ----- |
|
|
621
|
-
| **id** | **String** | | |
|
|
621
|
+
| **id** | **String** | The catalog item 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`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
|
|
622
622
|
|
|
623
623
|
### Return type
|
|
624
624
|
|
|
@@ -730,7 +730,7 @@ KlaviyoAPI.configure do |config|
|
|
|
730
730
|
end
|
|
731
731
|
|
|
732
732
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
733
|
-
id = 'id_example' # String |
|
|
733
|
+
id = 'id_example' # 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`, but support for multiple catalogs & non-custom integrations is forthcoming.
|
|
734
734
|
|
|
735
735
|
begin
|
|
736
736
|
# Delete Catalog Variant
|
|
@@ -762,7 +762,7 @@ end
|
|
|
762
762
|
|
|
763
763
|
| Name | Type | Description | Notes |
|
|
764
764
|
| ---- | ---- | ----------- | ----- |
|
|
765
|
-
| **id** | **String** | | |
|
|
765
|
+
| **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`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
|
|
766
766
|
|
|
767
767
|
### Return type
|
|
768
768
|
|
|
@@ -784,7 +784,7 @@ nil (empty response body)
|
|
|
784
784
|
|
|
785
785
|
Get Catalog Categories
|
|
786
786
|
|
|
787
|
-
Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created`
|
|
787
|
+
Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
788
788
|
|
|
789
789
|
### Examples
|
|
790
790
|
|
|
@@ -801,10 +801,10 @@ end
|
|
|
801
801
|
|
|
802
802
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
803
803
|
opts = {
|
|
804
|
-
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
805
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
806
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
807
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
804
|
+
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
805
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
|
806
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
807
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
808
808
|
}
|
|
809
809
|
|
|
810
810
|
begin
|
|
@@ -838,10 +838,10 @@ end
|
|
|
838
838
|
|
|
839
839
|
| Name | Type | Description | Notes |
|
|
840
840
|
| ---- | ---- | ----------- | ----- |
|
|
841
|
-
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
842
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
843
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
844
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
841
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
842
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains` | [optional] |
|
|
843
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
844
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
|
|
845
845
|
|
|
846
846
|
### Return type
|
|
847
847
|
|
|
@@ -879,9 +879,9 @@ KlaviyoAPI.configure do |config|
|
|
|
879
879
|
end
|
|
880
880
|
|
|
881
881
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
882
|
-
id = 'id_example' # String |
|
|
882
|
+
id = 'id_example' # String | The catalog category 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`, but support for multiple catalogs & non-custom integrations is forthcoming.
|
|
883
883
|
opts = {
|
|
884
|
-
fields_catalog_category: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
884
|
+
fields_catalog_category: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
885
885
|
}
|
|
886
886
|
|
|
887
887
|
begin
|
|
@@ -915,8 +915,8 @@ end
|
|
|
915
915
|
|
|
916
916
|
| Name | Type | Description | Notes |
|
|
917
917
|
| ---- | ---- | ----------- | ----- |
|
|
918
|
-
| **id** | **String** | | |
|
|
919
|
-
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
918
|
+
| **id** | **String** | The catalog category 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`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
|
|
919
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
920
920
|
|
|
921
921
|
### Return type
|
|
922
922
|
|
|
@@ -938,7 +938,7 @@ end
|
|
|
938
938
|
|
|
939
939
|
Get Catalog Category Items
|
|
940
940
|
|
|
941
|
-
Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created`
|
|
941
|
+
Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
942
942
|
|
|
943
943
|
### Examples
|
|
944
944
|
|
|
@@ -956,12 +956,12 @@ end
|
|
|
956
956
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
957
957
|
category_id = 'category_id_example' # String |
|
|
958
958
|
opts = {
|
|
959
|
-
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
960
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
961
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
962
|
-
include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
963
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
964
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
959
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
960
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
961
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
962
|
+
include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
963
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
964
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
965
965
|
}
|
|
966
966
|
|
|
967
967
|
begin
|
|
@@ -996,12 +996,12 @@ end
|
|
|
996
996
|
| Name | Type | Description | Notes |
|
|
997
997
|
| ---- | ---- | ----------- | ----- |
|
|
998
998
|
| **category_id** | **String** | | |
|
|
999
|
-
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1000
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1001
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1002
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1003
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1004
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
999
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1000
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1001
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals` | [optional] |
|
|
1002
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
|
|
1003
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
1004
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
|
|
1005
1005
|
|
|
1006
1006
|
### Return type
|
|
1007
1007
|
|
|
@@ -1023,7 +1023,7 @@ end
|
|
|
1023
1023
|
|
|
1024
1024
|
Get Catalog Category Relationships
|
|
1025
1025
|
|
|
1026
|
-
Get all items in the given category ID. Returns a maximum of 100 items per request
|
|
1026
|
+
Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1027
1027
|
|
|
1028
1028
|
### Examples
|
|
1029
1029
|
|
|
@@ -1042,7 +1042,7 @@ api_instance = KlaviyoAPI::CatalogsApi.new
|
|
|
1042
1042
|
id = 'id_example' # String |
|
|
1043
1043
|
related_resource = 'items' # String |
|
|
1044
1044
|
opts = {
|
|
1045
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1045
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1046
1046
|
}
|
|
1047
1047
|
|
|
1048
1048
|
begin
|
|
@@ -1078,7 +1078,7 @@ end
|
|
|
1078
1078
|
| ---- | ---- | ----------- | ----- |
|
|
1079
1079
|
| **id** | **String** | | |
|
|
1080
1080
|
| **related_resource** | **String** | | |
|
|
1081
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1081
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
1082
1082
|
|
|
1083
1083
|
### Return type
|
|
1084
1084
|
|
|
@@ -1100,7 +1100,7 @@ end
|
|
|
1100
1100
|
|
|
1101
1101
|
Get Catalog Item
|
|
1102
1102
|
|
|
1103
|
-
Get a specific catalog item with the given item ID.
|
|
1103
|
+
Get a specific catalog item with the given item ID. Include parameters can be provided to get the following related resource data: `variants`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1104
1104
|
|
|
1105
1105
|
### Examples
|
|
1106
1106
|
|
|
@@ -1118,9 +1118,9 @@ end
|
|
|
1118
1118
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
1119
1119
|
id = 'id_example' # String |
|
|
1120
1120
|
opts = {
|
|
1121
|
-
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1122
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1123
|
-
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1121
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1122
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1123
|
+
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1124
1124
|
}
|
|
1125
1125
|
|
|
1126
1126
|
begin
|
|
@@ -1155,9 +1155,9 @@ end
|
|
|
1155
1155
|
| Name | Type | Description | Notes |
|
|
1156
1156
|
| ---- | ---- | ----------- | ----- |
|
|
1157
1157
|
| **id** | **String** | | |
|
|
1158
|
-
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1159
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1160
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1158
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1159
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1160
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
|
|
1161
1161
|
|
|
1162
1162
|
### Return type
|
|
1163
1163
|
|
|
@@ -1179,7 +1179,7 @@ end
|
|
|
1179
1179
|
|
|
1180
1180
|
Get Catalog Item Categories
|
|
1181
1181
|
|
|
1182
|
-
Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created`
|
|
1182
|
+
Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1183
1183
|
|
|
1184
1184
|
### Examples
|
|
1185
1185
|
|
|
@@ -1197,10 +1197,10 @@ end
|
|
|
1197
1197
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
1198
1198
|
item_id = 'item_id_example' # String |
|
|
1199
1199
|
opts = {
|
|
1200
|
-
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1201
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1202
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1203
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1200
|
+
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1201
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
|
1202
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1203
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
1204
1204
|
}
|
|
1205
1205
|
|
|
1206
1206
|
begin
|
|
@@ -1235,10 +1235,10 @@ end
|
|
|
1235
1235
|
| Name | Type | Description | Notes |
|
|
1236
1236
|
| ---- | ---- | ----------- | ----- |
|
|
1237
1237
|
| **item_id** | **String** | | |
|
|
1238
|
-
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1239
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1240
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1241
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1238
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1239
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains` | [optional] |
|
|
1240
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
1241
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
|
|
1242
1242
|
|
|
1243
1243
|
### Return type
|
|
1244
1244
|
|
|
@@ -1260,7 +1260,7 @@ end
|
|
|
1260
1260
|
|
|
1261
1261
|
Get Catalog Item Relationships
|
|
1262
1262
|
|
|
1263
|
-
Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request
|
|
1263
|
+
Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1264
1264
|
|
|
1265
1265
|
### Examples
|
|
1266
1266
|
|
|
@@ -1279,7 +1279,7 @@ api_instance = KlaviyoAPI::CatalogsApi.new
|
|
|
1279
1279
|
id = 'id_example' # String |
|
|
1280
1280
|
related_resource = 'categories' # String |
|
|
1281
1281
|
opts = {
|
|
1282
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1282
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1283
1283
|
}
|
|
1284
1284
|
|
|
1285
1285
|
begin
|
|
@@ -1315,7 +1315,7 @@ end
|
|
|
1315
1315
|
| ---- | ---- | ----------- | ----- |
|
|
1316
1316
|
| **id** | **String** | | |
|
|
1317
1317
|
| **related_resource** | **String** | | |
|
|
1318
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1318
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
1319
1319
|
|
|
1320
1320
|
### Return type
|
|
1321
1321
|
|
|
@@ -1337,7 +1337,7 @@ end
|
|
|
1337
1337
|
|
|
1338
1338
|
Get Catalog Item Variants
|
|
1339
1339
|
|
|
1340
|
-
Get all variants related to the given item ID.
|
|
1340
|
+
Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1341
1341
|
|
|
1342
1342
|
### Examples
|
|
1343
1343
|
|
|
@@ -1353,12 +1353,12 @@ KlaviyoAPI.configure do |config|
|
|
|
1353
1353
|
end
|
|
1354
1354
|
|
|
1355
1355
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
1356
|
-
item_id = 'item_id_example' # String |
|
|
1356
|
+
item_id = 'item_id_example' # String | The catalog item 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`, but support for multiple catalogs & non-custom integrations is forthcoming.
|
|
1357
1357
|
opts = {
|
|
1358
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1359
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1360
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1361
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1358
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1359
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
1360
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1361
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
1362
1362
|
}
|
|
1363
1363
|
|
|
1364
1364
|
begin
|
|
@@ -1392,11 +1392,11 @@ end
|
|
|
1392
1392
|
|
|
1393
1393
|
| Name | Type | Description | Notes |
|
|
1394
1394
|
| ---- | ---- | ----------- | ----- |
|
|
1395
|
-
| **item_id** | **String** | | |
|
|
1396
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1397
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1398
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1399
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1395
|
+
| **item_id** | **String** | The catalog item 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`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
|
|
1396
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1397
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` | [optional] |
|
|
1398
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
1399
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
|
|
1400
1400
|
|
|
1401
1401
|
### Return type
|
|
1402
1402
|
|
|
@@ -1418,7 +1418,7 @@ end
|
|
|
1418
1418
|
|
|
1419
1419
|
Get Catalog Items
|
|
1420
1420
|
|
|
1421
|
-
Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created`
|
|
1421
|
+
Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1422
1422
|
|
|
1423
1423
|
### Examples
|
|
1424
1424
|
|
|
@@ -1435,12 +1435,12 @@ end
|
|
|
1435
1435
|
|
|
1436
1436
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
1437
1437
|
opts = {
|
|
1438
|
-
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1439
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1440
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1441
|
-
include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1442
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1443
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1438
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1439
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1440
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
1441
|
+
include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1442
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1443
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
1444
1444
|
}
|
|
1445
1445
|
|
|
1446
1446
|
begin
|
|
@@ -1474,12 +1474,12 @@ end
|
|
|
1474
1474
|
|
|
1475
1475
|
| Name | Type | Description | Notes |
|
|
1476
1476
|
| ---- | ---- | ----------- | ----- |
|
|
1477
|
-
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1478
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1479
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1480
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1481
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1482
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1477
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1478
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1479
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals` | [optional] |
|
|
1480
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
|
|
1481
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
1482
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
|
|
1483
1483
|
|
|
1484
1484
|
### Return type
|
|
1485
1485
|
|
|
@@ -1517,9 +1517,9 @@ KlaviyoAPI.configure do |config|
|
|
|
1517
1517
|
end
|
|
1518
1518
|
|
|
1519
1519
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
1520
|
-
id = 'id_example' # String |
|
|
1520
|
+
id = 'id_example' # 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`, but support for multiple catalogs & non-custom integrations is forthcoming.
|
|
1521
1521
|
opts = {
|
|
1522
|
-
fields_catalog_variant: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1522
|
+
fields_catalog_variant: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1523
1523
|
}
|
|
1524
1524
|
|
|
1525
1525
|
begin
|
|
@@ -1553,8 +1553,8 @@ end
|
|
|
1553
1553
|
|
|
1554
1554
|
| Name | Type | Description | Notes |
|
|
1555
1555
|
| ---- | ---- | ----------- | ----- |
|
|
1556
|
-
| **id** | **String** | | |
|
|
1557
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1556
|
+
| **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`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
|
|
1557
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1558
1558
|
|
|
1559
1559
|
### Return type
|
|
1560
1560
|
|
|
@@ -1576,7 +1576,7 @@ end
|
|
|
1576
1576
|
|
|
1577
1577
|
Get Catalog Variants
|
|
1578
1578
|
|
|
1579
|
-
Get all variants in an account.
|
|
1579
|
+
Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1580
1580
|
|
|
1581
1581
|
### Examples
|
|
1582
1582
|
|
|
@@ -1593,10 +1593,10 @@ end
|
|
|
1593
1593
|
|
|
1594
1594
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
1595
1595
|
opts = {
|
|
1596
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1597
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1598
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1599
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1596
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1597
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
|
1598
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1599
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
1600
1600
|
}
|
|
1601
1601
|
|
|
1602
1602
|
begin
|
|
@@ -1630,10 +1630,10 @@ end
|
|
|
1630
1630
|
|
|
1631
1631
|
| Name | Type | Description | Notes |
|
|
1632
1632
|
| ---- | ---- | ----------- | ----- |
|
|
1633
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1634
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1635
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1636
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1633
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1634
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` | [optional] |
|
|
1635
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
1636
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
|
|
1637
1637
|
|
|
1638
1638
|
### Return type
|
|
1639
1639
|
|
|
@@ -1673,9 +1673,9 @@ end
|
|
|
1673
1673
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
1674
1674
|
job_id = 'job_id_example' # String |
|
|
1675
1675
|
opts = {
|
|
1676
|
-
fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1677
|
-
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1678
|
-
include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1676
|
+
fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1677
|
+
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1678
|
+
include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1679
1679
|
}
|
|
1680
1680
|
|
|
1681
1681
|
begin
|
|
@@ -1710,9 +1710,9 @@ end
|
|
|
1710
1710
|
| Name | Type | Description | Notes |
|
|
1711
1711
|
| ---- | ---- | ----------- | ----- |
|
|
1712
1712
|
| **job_id** | **String** | | |
|
|
1713
|
-
| **fields_catalog_category_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1714
|
-
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1715
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1713
|
+
| **fields_catalog_category_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1714
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1715
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
|
|
1716
1716
|
|
|
1717
1717
|
### Return type
|
|
1718
1718
|
|
|
@@ -1734,7 +1734,7 @@ end
|
|
|
1734
1734
|
|
|
1735
1735
|
Get Create Categories Jobs
|
|
1736
1736
|
|
|
1737
|
-
Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request
|
|
1737
|
+
Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1738
1738
|
|
|
1739
1739
|
### Examples
|
|
1740
1740
|
|
|
@@ -1751,9 +1751,9 @@ end
|
|
|
1751
1751
|
|
|
1752
1752
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
1753
1753
|
opts = {
|
|
1754
|
-
fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1755
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1756
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1754
|
+
fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1755
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
1756
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1757
1757
|
}
|
|
1758
1758
|
|
|
1759
1759
|
begin
|
|
@@ -1787,9 +1787,9 @@ end
|
|
|
1787
1787
|
|
|
1788
1788
|
| Name | Type | Description | Notes |
|
|
1789
1789
|
| ---- | ---- | ----------- | ----- |
|
|
1790
|
-
| **fields_catalog_category_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1791
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1792
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1790
|
+
| **fields_catalog_category_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1791
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
|
1792
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
1793
1793
|
|
|
1794
1794
|
### Return type
|
|
1795
1795
|
|
|
@@ -1829,9 +1829,9 @@ end
|
|
|
1829
1829
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
1830
1830
|
job_id = 'job_id_example' # String |
|
|
1831
1831
|
opts = {
|
|
1832
|
-
fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1833
|
-
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1834
|
-
include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1832
|
+
fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1833
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1834
|
+
include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1835
1835
|
}
|
|
1836
1836
|
|
|
1837
1837
|
begin
|
|
@@ -1866,9 +1866,9 @@ end
|
|
|
1866
1866
|
| Name | Type | Description | Notes |
|
|
1867
1867
|
| ---- | ---- | ----------- | ----- |
|
|
1868
1868
|
| **job_id** | **String** | | |
|
|
1869
|
-
| **fields_catalog_item_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1870
|
-
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1871
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1869
|
+
| **fields_catalog_item_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1870
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1871
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
|
|
1872
1872
|
|
|
1873
1873
|
### Return type
|
|
1874
1874
|
|
|
@@ -1890,7 +1890,7 @@ end
|
|
|
1890
1890
|
|
|
1891
1891
|
Get Create Items Jobs
|
|
1892
1892
|
|
|
1893
|
-
Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request
|
|
1893
|
+
Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1894
1894
|
|
|
1895
1895
|
### Examples
|
|
1896
1896
|
|
|
@@ -1907,9 +1907,9 @@ end
|
|
|
1907
1907
|
|
|
1908
1908
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
1909
1909
|
opts = {
|
|
1910
|
-
fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1911
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1912
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
1910
|
+
fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1911
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
1912
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1913
1913
|
}
|
|
1914
1914
|
|
|
1915
1915
|
begin
|
|
@@ -1943,9 +1943,9 @@ end
|
|
|
1943
1943
|
|
|
1944
1944
|
| Name | Type | Description | Notes |
|
|
1945
1945
|
| ---- | ---- | ----------- | ----- |
|
|
1946
|
-
| **fields_catalog_item_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
1947
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1948
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
1946
|
+
| **fields_catalog_item_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1947
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
|
1948
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
1949
1949
|
|
|
1950
1950
|
### Return type
|
|
1951
1951
|
|
|
@@ -1985,9 +1985,9 @@ end
|
|
|
1985
1985
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
1986
1986
|
job_id = 'job_id_example' # String |
|
|
1987
1987
|
opts = {
|
|
1988
|
-
fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1989
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1990
|
-
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
1988
|
+
fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1989
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1990
|
+
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1991
1991
|
}
|
|
1992
1992
|
|
|
1993
1993
|
begin
|
|
@@ -2022,9 +2022,9 @@ end
|
|
|
2022
2022
|
| Name | Type | Description | Notes |
|
|
2023
2023
|
| ---- | ---- | ----------- | ----- |
|
|
2024
2024
|
| **job_id** | **String** | | |
|
|
2025
|
-
| **fields_catalog_variant_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2026
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2027
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2025
|
+
| **fields_catalog_variant_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2026
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2027
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
|
|
2028
2028
|
|
|
2029
2029
|
### Return type
|
|
2030
2030
|
|
|
@@ -2046,7 +2046,7 @@ end
|
|
|
2046
2046
|
|
|
2047
2047
|
Get Create Variants Jobs
|
|
2048
2048
|
|
|
2049
|
-
Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request
|
|
2049
|
+
Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2050
2050
|
|
|
2051
2051
|
### Examples
|
|
2052
2052
|
|
|
@@ -2063,9 +2063,9 @@ end
|
|
|
2063
2063
|
|
|
2064
2064
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2065
2065
|
opts = {
|
|
2066
|
-
fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2067
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2068
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2066
|
+
fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2067
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2068
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2069
2069
|
}
|
|
2070
2070
|
|
|
2071
2071
|
begin
|
|
@@ -2099,9 +2099,9 @@ end
|
|
|
2099
2099
|
|
|
2100
2100
|
| Name | Type | Description | Notes |
|
|
2101
2101
|
| ---- | ---- | ----------- | ----- |
|
|
2102
|
-
| **fields_catalog_variant_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2103
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
2104
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
2102
|
+
| **fields_catalog_variant_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2103
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
|
2104
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
2105
2105
|
|
|
2106
2106
|
### Return type
|
|
2107
2107
|
|
|
@@ -2141,7 +2141,7 @@ end
|
|
|
2141
2141
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2142
2142
|
job_id = 'job_id_example' # String |
|
|
2143
2143
|
opts = {
|
|
2144
|
-
fields_catalog_category_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2144
|
+
fields_catalog_category_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2145
2145
|
}
|
|
2146
2146
|
|
|
2147
2147
|
begin
|
|
@@ -2176,7 +2176,7 @@ end
|
|
|
2176
2176
|
| Name | Type | Description | Notes |
|
|
2177
2177
|
| ---- | ---- | ----------- | ----- |
|
|
2178
2178
|
| **job_id** | **String** | | |
|
|
2179
|
-
| **fields_catalog_category_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2179
|
+
| **fields_catalog_category_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2180
2180
|
|
|
2181
2181
|
### Return type
|
|
2182
2182
|
|
|
@@ -2198,7 +2198,7 @@ end
|
|
|
2198
2198
|
|
|
2199
2199
|
Get Delete Categories Jobs
|
|
2200
2200
|
|
|
2201
|
-
Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request
|
|
2201
|
+
Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2202
2202
|
|
|
2203
2203
|
### Examples
|
|
2204
2204
|
|
|
@@ -2215,9 +2215,9 @@ end
|
|
|
2215
2215
|
|
|
2216
2216
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2217
2217
|
opts = {
|
|
2218
|
-
fields_catalog_category_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2219
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2220
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2218
|
+
fields_catalog_category_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2219
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2220
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2221
2221
|
}
|
|
2222
2222
|
|
|
2223
2223
|
begin
|
|
@@ -2251,9 +2251,9 @@ end
|
|
|
2251
2251
|
|
|
2252
2252
|
| Name | Type | Description | Notes |
|
|
2253
2253
|
| ---- | ---- | ----------- | ----- |
|
|
2254
|
-
| **fields_catalog_category_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2255
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
2256
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
2254
|
+
| **fields_catalog_category_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2255
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
|
2256
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
2257
2257
|
|
|
2258
2258
|
### Return type
|
|
2259
2259
|
|
|
@@ -2293,7 +2293,7 @@ end
|
|
|
2293
2293
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2294
2294
|
job_id = 'job_id_example' # String |
|
|
2295
2295
|
opts = {
|
|
2296
|
-
fields_catalog_item_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2296
|
+
fields_catalog_item_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2297
2297
|
}
|
|
2298
2298
|
|
|
2299
2299
|
begin
|
|
@@ -2328,7 +2328,7 @@ end
|
|
|
2328
2328
|
| Name | Type | Description | Notes |
|
|
2329
2329
|
| ---- | ---- | ----------- | ----- |
|
|
2330
2330
|
| **job_id** | **String** | | |
|
|
2331
|
-
| **fields_catalog_item_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2331
|
+
| **fields_catalog_item_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2332
2332
|
|
|
2333
2333
|
### Return type
|
|
2334
2334
|
|
|
@@ -2350,7 +2350,7 @@ end
|
|
|
2350
2350
|
|
|
2351
2351
|
Get Delete Items Jobs
|
|
2352
2352
|
|
|
2353
|
-
Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request
|
|
2353
|
+
Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2354
2354
|
|
|
2355
2355
|
### Examples
|
|
2356
2356
|
|
|
@@ -2367,9 +2367,9 @@ end
|
|
|
2367
2367
|
|
|
2368
2368
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2369
2369
|
opts = {
|
|
2370
|
-
fields_catalog_item_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2371
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2372
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2370
|
+
fields_catalog_item_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2371
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2372
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2373
2373
|
}
|
|
2374
2374
|
|
|
2375
2375
|
begin
|
|
@@ -2403,9 +2403,9 @@ end
|
|
|
2403
2403
|
|
|
2404
2404
|
| Name | Type | Description | Notes |
|
|
2405
2405
|
| ---- | ---- | ----------- | ----- |
|
|
2406
|
-
| **fields_catalog_item_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2407
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
2408
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
2406
|
+
| **fields_catalog_item_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2407
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
|
2408
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
2409
2409
|
|
|
2410
2410
|
### Return type
|
|
2411
2411
|
|
|
@@ -2445,7 +2445,7 @@ end
|
|
|
2445
2445
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2446
2446
|
job_id = 'job_id_example' # String |
|
|
2447
2447
|
opts = {
|
|
2448
|
-
fields_catalog_variant_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2448
|
+
fields_catalog_variant_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2449
2449
|
}
|
|
2450
2450
|
|
|
2451
2451
|
begin
|
|
@@ -2480,7 +2480,7 @@ end
|
|
|
2480
2480
|
| Name | Type | Description | Notes |
|
|
2481
2481
|
| ---- | ---- | ----------- | ----- |
|
|
2482
2482
|
| **job_id** | **String** | | |
|
|
2483
|
-
| **fields_catalog_variant_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2483
|
+
| **fields_catalog_variant_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2484
2484
|
|
|
2485
2485
|
### Return type
|
|
2486
2486
|
|
|
@@ -2502,7 +2502,7 @@ end
|
|
|
2502
2502
|
|
|
2503
2503
|
Get Delete Variants Jobs
|
|
2504
2504
|
|
|
2505
|
-
Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request
|
|
2505
|
+
Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2506
2506
|
|
|
2507
2507
|
### Examples
|
|
2508
2508
|
|
|
@@ -2519,9 +2519,9 @@ end
|
|
|
2519
2519
|
|
|
2520
2520
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2521
2521
|
opts = {
|
|
2522
|
-
fields_catalog_variant_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2523
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2524
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2522
|
+
fields_catalog_variant_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2523
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2524
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2525
2525
|
}
|
|
2526
2526
|
|
|
2527
2527
|
begin
|
|
@@ -2555,9 +2555,9 @@ end
|
|
|
2555
2555
|
|
|
2556
2556
|
| Name | Type | Description | Notes |
|
|
2557
2557
|
| ---- | ---- | ----------- | ----- |
|
|
2558
|
-
| **fields_catalog_variant_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2559
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
2560
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
2558
|
+
| **fields_catalog_variant_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2559
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
|
2560
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
2561
2561
|
|
|
2562
2562
|
### Return type
|
|
2563
2563
|
|
|
@@ -2597,9 +2597,9 @@ end
|
|
|
2597
2597
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2598
2598
|
job_id = 'job_id_example' # String |
|
|
2599
2599
|
opts = {
|
|
2600
|
-
fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2601
|
-
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2602
|
-
include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2600
|
+
fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2601
|
+
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2602
|
+
include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
2603
2603
|
}
|
|
2604
2604
|
|
|
2605
2605
|
begin
|
|
@@ -2634,9 +2634,9 @@ end
|
|
|
2634
2634
|
| Name | Type | Description | Notes |
|
|
2635
2635
|
| ---- | ---- | ----------- | ----- |
|
|
2636
2636
|
| **job_id** | **String** | | |
|
|
2637
|
-
| **fields_catalog_category_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2638
|
-
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2639
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2637
|
+
| **fields_catalog_category_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2638
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2639
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
|
|
2640
2640
|
|
|
2641
2641
|
### Return type
|
|
2642
2642
|
|
|
@@ -2658,7 +2658,7 @@ end
|
|
|
2658
2658
|
|
|
2659
2659
|
Get Update Categories Jobs
|
|
2660
2660
|
|
|
2661
|
-
Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request
|
|
2661
|
+
Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2662
2662
|
|
|
2663
2663
|
### Examples
|
|
2664
2664
|
|
|
@@ -2675,9 +2675,9 @@ end
|
|
|
2675
2675
|
|
|
2676
2676
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2677
2677
|
opts = {
|
|
2678
|
-
fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2679
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2680
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2678
|
+
fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2679
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2680
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2681
2681
|
}
|
|
2682
2682
|
|
|
2683
2683
|
begin
|
|
@@ -2711,9 +2711,9 @@ end
|
|
|
2711
2711
|
|
|
2712
2712
|
| Name | Type | Description | Notes |
|
|
2713
2713
|
| ---- | ---- | ----------- | ----- |
|
|
2714
|
-
| **fields_catalog_category_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2715
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
2716
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
2714
|
+
| **fields_catalog_category_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2715
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
|
2716
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
2717
2717
|
|
|
2718
2718
|
### Return type
|
|
2719
2719
|
|
|
@@ -2753,9 +2753,9 @@ end
|
|
|
2753
2753
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2754
2754
|
job_id = 'job_id_example' # String |
|
|
2755
2755
|
opts = {
|
|
2756
|
-
fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2757
|
-
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2758
|
-
include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2756
|
+
fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2757
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2758
|
+
include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
2759
2759
|
}
|
|
2760
2760
|
|
|
2761
2761
|
begin
|
|
@@ -2790,9 +2790,9 @@ end
|
|
|
2790
2790
|
| Name | Type | Description | Notes |
|
|
2791
2791
|
| ---- | ---- | ----------- | ----- |
|
|
2792
2792
|
| **job_id** | **String** | | |
|
|
2793
|
-
| **fields_catalog_item_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2794
|
-
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2795
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2793
|
+
| **fields_catalog_item_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2794
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2795
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
|
|
2796
2796
|
|
|
2797
2797
|
### Return type
|
|
2798
2798
|
|
|
@@ -2814,7 +2814,7 @@ end
|
|
|
2814
2814
|
|
|
2815
2815
|
Get Update Items Jobs
|
|
2816
2816
|
|
|
2817
|
-
Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request
|
|
2817
|
+
Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2818
2818
|
|
|
2819
2819
|
### Examples
|
|
2820
2820
|
|
|
@@ -2831,9 +2831,9 @@ end
|
|
|
2831
2831
|
|
|
2832
2832
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2833
2833
|
opts = {
|
|
2834
|
-
fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2835
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2836
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2834
|
+
fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2835
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2836
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2837
2837
|
}
|
|
2838
2838
|
|
|
2839
2839
|
begin
|
|
@@ -2867,9 +2867,9 @@ end
|
|
|
2867
2867
|
|
|
2868
2868
|
| Name | Type | Description | Notes |
|
|
2869
2869
|
| ---- | ---- | ----------- | ----- |
|
|
2870
|
-
| **fields_catalog_item_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2871
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
2872
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
2870
|
+
| **fields_catalog_item_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2871
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
|
2872
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
2873
2873
|
|
|
2874
2874
|
### Return type
|
|
2875
2875
|
|
|
@@ -2909,9 +2909,9 @@ end
|
|
|
2909
2909
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2910
2910
|
job_id = 'job_id_example' # String |
|
|
2911
2911
|
opts = {
|
|
2912
|
-
fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2913
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2914
|
-
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2912
|
+
fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2913
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2914
|
+
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
2915
2915
|
}
|
|
2916
2916
|
|
|
2917
2917
|
begin
|
|
@@ -2946,9 +2946,9 @@ end
|
|
|
2946
2946
|
| Name | Type | Description | Notes |
|
|
2947
2947
|
| ---- | ---- | ----------- | ----- |
|
|
2948
2948
|
| **job_id** | **String** | | |
|
|
2949
|
-
| **fields_catalog_variant_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2950
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2951
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
2949
|
+
| **fields_catalog_variant_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2950
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
2951
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
|
|
2952
2952
|
|
|
2953
2953
|
### Return type
|
|
2954
2954
|
|
|
@@ -2970,7 +2970,7 @@ end
|
|
|
2970
2970
|
|
|
2971
2971
|
Get Update Variants Jobs
|
|
2972
2972
|
|
|
2973
|
-
Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request
|
|
2973
|
+
Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2974
2974
|
|
|
2975
2975
|
### Examples
|
|
2976
2976
|
|
|
@@ -2987,9 +2987,9 @@ end
|
|
|
2987
2987
|
|
|
2988
2988
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
2989
2989
|
opts = {
|
|
2990
|
-
fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
|
2991
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2992
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
|
2990
|
+
fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2991
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
|
2992
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2993
2993
|
}
|
|
2994
2994
|
|
|
2995
2995
|
begin
|
|
@@ -3023,9 +3023,9 @@ end
|
|
|
3023
3023
|
|
|
3024
3024
|
| Name | Type | Description | Notes |
|
|
3025
3025
|
| ---- | ---- | ----------- | ----- |
|
|
3026
|
-
| **fields_catalog_variant_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
|
3027
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
3028
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
|
3026
|
+
| **fields_catalog_variant_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
|
|
3027
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
|
3028
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
|
3029
3029
|
|
|
3030
3030
|
### Return type
|
|
3031
3031
|
|
|
@@ -3702,7 +3702,7 @@ KlaviyoAPI.configure do |config|
|
|
|
3702
3702
|
end
|
|
3703
3703
|
|
|
3704
3704
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
3705
|
-
id = 'id_example' # String |
|
|
3705
|
+
id = 'id_example' # String | The catalog category 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`, but support for multiple catalogs & non-custom integrations is forthcoming.
|
|
3706
3706
|
catalog_category_update_query = KlaviyoAPI::CatalogCategoryUpdateQuery.new({data: KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResource.new({type: 'catalog-category', id: 'id_example', attributes: KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResourceAttributes.new})}) # CatalogCategoryUpdateQuery |
|
|
3707
3707
|
|
|
3708
3708
|
begin
|
|
@@ -3736,7 +3736,7 @@ end
|
|
|
3736
3736
|
|
|
3737
3737
|
| Name | Type | Description | Notes |
|
|
3738
3738
|
| ---- | ---- | ----------- | ----- |
|
|
3739
|
-
| **id** | **String** | | |
|
|
3739
|
+
| **id** | **String** | The catalog category 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`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
|
|
3740
3740
|
| **catalog_category_update_query** | [**CatalogCategoryUpdateQuery**](CatalogCategoryUpdateQuery.md) | | |
|
|
3741
3741
|
|
|
3742
3742
|
### Return type
|
|
@@ -3849,7 +3849,7 @@ KlaviyoAPI.configure do |config|
|
|
|
3849
3849
|
end
|
|
3850
3850
|
|
|
3851
3851
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
3852
|
-
id = 'id_example' # String |
|
|
3852
|
+
id = 'id_example' # String | The catalog item 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`, but support for multiple catalogs & non-custom integrations is forthcoming.
|
|
3853
3853
|
catalog_item_update_query = KlaviyoAPI::CatalogItemUpdateQuery.new({data: KlaviyoAPI::CatalogItemUpdateQueryAsSubResource.new({type: 'catalog-item', id: 'id_example', attributes: KlaviyoAPI::CatalogItemUpdateQueryAsSubResourceAttributes.new})}) # CatalogItemUpdateQuery |
|
|
3854
3854
|
|
|
3855
3855
|
begin
|
|
@@ -3883,7 +3883,7 @@ end
|
|
|
3883
3883
|
|
|
3884
3884
|
| Name | Type | Description | Notes |
|
|
3885
3885
|
| ---- | ---- | ----------- | ----- |
|
|
3886
|
-
| **id** | **String** | | |
|
|
3886
|
+
| **id** | **String** | The catalog item 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`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
|
|
3887
3887
|
| **catalog_item_update_query** | [**CatalogItemUpdateQuery**](CatalogItemUpdateQuery.md) | | |
|
|
3888
3888
|
|
|
3889
3889
|
### Return type
|
|
@@ -3996,7 +3996,7 @@ KlaviyoAPI.configure do |config|
|
|
|
3996
3996
|
end
|
|
3997
3997
|
|
|
3998
3998
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
|
3999
|
-
id = 'id_example' # String |
|
|
3999
|
+
id = 'id_example' # 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`, but support for multiple catalogs & non-custom integrations is forthcoming.
|
|
4000
4000
|
catalog_variant_update_query = KlaviyoAPI::CatalogVariantUpdateQuery.new({data: KlaviyoAPI::CatalogVariantUpdateQueryAsSubResource.new({type: 'catalog-variant', id: 'id_example', attributes: KlaviyoAPI::CatalogVariantUpdateQueryAsSubResourceAttributes.new})}) # CatalogVariantUpdateQuery |
|
|
4001
4001
|
|
|
4002
4002
|
begin
|
|
@@ -4030,7 +4030,7 @@ end
|
|
|
4030
4030
|
|
|
4031
4031
|
| Name | Type | Description | Notes |
|
|
4032
4032
|
| ---- | ---- | ----------- | ----- |
|
|
4033
|
-
| **id** | **String** | | |
|
|
4033
|
+
| **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`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
|
|
4034
4034
|
| **catalog_variant_update_query** | [**CatalogVariantUpdateQuery**](CatalogVariantUpdateQuery.md) | | |
|
|
4035
4035
|
|
|
4036
4036
|
### Return type
|