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
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document:
|
|
6
|
+
The version of the OpenAPI document: 2023-01-24
|
|
7
7
|
Contact: developers@klaviyo.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 6.
|
|
9
|
+
OpenAPI Generator version: 6.2.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -51,7 +51,7 @@ module KlaviyoAPI
|
|
|
51
51
|
# header parameters
|
|
52
52
|
header_params = opts[:header_params] || {}
|
|
53
53
|
# klaviyo api revision
|
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
54
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
55
55
|
# HTTP header 'Accept' (if needed)
|
|
56
56
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
57
57
|
# HTTP header 'Content-Type'
|
|
@@ -138,7 +138,7 @@ module KlaviyoAPI
|
|
|
138
138
|
# header parameters
|
|
139
139
|
header_params = opts[:header_params] || {}
|
|
140
140
|
# klaviyo api revision
|
|
141
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
141
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
142
142
|
# HTTP header 'Accept' (if needed)
|
|
143
143
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
144
144
|
# HTTP header 'Content-Type'
|
|
@@ -208,7 +208,7 @@ module KlaviyoAPI
|
|
|
208
208
|
# header parameters
|
|
209
209
|
header_params = opts[:header_params] || {}
|
|
210
210
|
# klaviyo api revision
|
|
211
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
211
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
212
212
|
# HTTP header 'Accept' (if needed)
|
|
213
213
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
214
214
|
# HTTP header 'Content-Type'
|
|
@@ -295,7 +295,7 @@ module KlaviyoAPI
|
|
|
295
295
|
# header parameters
|
|
296
296
|
header_params = opts[:header_params] || {}
|
|
297
297
|
# klaviyo api revision
|
|
298
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
298
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
299
299
|
# HTTP header 'Accept' (if needed)
|
|
300
300
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
301
301
|
# HTTP header 'Content-Type'
|
|
@@ -365,7 +365,7 @@ module KlaviyoAPI
|
|
|
365
365
|
# header parameters
|
|
366
366
|
header_params = opts[:header_params] || {}
|
|
367
367
|
# klaviyo api revision
|
|
368
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
368
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
369
369
|
# HTTP header 'Accept' (if needed)
|
|
370
370
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
371
371
|
# HTTP header 'Content-Type'
|
|
@@ -405,7 +405,7 @@ module KlaviyoAPI
|
|
|
405
405
|
|
|
406
406
|
# Delete Catalog Category
|
|
407
407
|
# Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
|
408
|
-
# @param id [String]
|
|
408
|
+
# @param 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.
|
|
409
409
|
# @param [Hash] opts the optional parameters
|
|
410
410
|
# @return [nil]
|
|
411
411
|
def delete_catalog_category(id, opts = {})
|
|
@@ -415,7 +415,7 @@ module KlaviyoAPI
|
|
|
415
415
|
|
|
416
416
|
# Delete Catalog Category
|
|
417
417
|
# Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
|
418
|
-
# @param id [String]
|
|
418
|
+
# @param 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.
|
|
419
419
|
# @param [Hash] opts the optional parameters
|
|
420
420
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
421
421
|
def delete_catalog_category_with_http_info(id, opts = {})
|
|
@@ -435,7 +435,7 @@ module KlaviyoAPI
|
|
|
435
435
|
# header parameters
|
|
436
436
|
header_params = opts[:header_params] || {}
|
|
437
437
|
# klaviyo api revision
|
|
438
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
438
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
439
439
|
# HTTP header 'Accept' (if needed)
|
|
440
440
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
441
441
|
|
|
@@ -517,7 +517,7 @@ module KlaviyoAPI
|
|
|
517
517
|
# header parameters
|
|
518
518
|
header_params = opts[:header_params] || {}
|
|
519
519
|
# klaviyo api revision
|
|
520
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
520
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
521
521
|
# HTTP header 'Accept' (if needed)
|
|
522
522
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
523
523
|
# HTTP header 'Content-Type'
|
|
@@ -557,7 +557,7 @@ module KlaviyoAPI
|
|
|
557
557
|
|
|
558
558
|
# Delete Catalog Item
|
|
559
559
|
# Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
|
560
|
-
# @param id [String]
|
|
560
|
+
# @param 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.
|
|
561
561
|
# @param [Hash] opts the optional parameters
|
|
562
562
|
# @return [nil]
|
|
563
563
|
def delete_catalog_item(id, opts = {})
|
|
@@ -567,7 +567,7 @@ module KlaviyoAPI
|
|
|
567
567
|
|
|
568
568
|
# Delete Catalog Item
|
|
569
569
|
# Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
|
570
|
-
# @param id [String]
|
|
570
|
+
# @param 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.
|
|
571
571
|
# @param [Hash] opts the optional parameters
|
|
572
572
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
573
573
|
def delete_catalog_item_with_http_info(id, opts = {})
|
|
@@ -587,7 +587,7 @@ module KlaviyoAPI
|
|
|
587
587
|
# header parameters
|
|
588
588
|
header_params = opts[:header_params] || {}
|
|
589
589
|
# klaviyo api revision
|
|
590
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
590
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
591
591
|
# HTTP header 'Accept' (if needed)
|
|
592
592
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
593
593
|
|
|
@@ -669,7 +669,7 @@ module KlaviyoAPI
|
|
|
669
669
|
# header parameters
|
|
670
670
|
header_params = opts[:header_params] || {}
|
|
671
671
|
# klaviyo api revision
|
|
672
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
672
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
673
673
|
# HTTP header 'Accept' (if needed)
|
|
674
674
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
675
675
|
# HTTP header 'Content-Type'
|
|
@@ -709,7 +709,7 @@ module KlaviyoAPI
|
|
|
709
709
|
|
|
710
710
|
# Delete Catalog Variant
|
|
711
711
|
# Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
|
712
|
-
# @param id [String]
|
|
712
|
+
# @param 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.
|
|
713
713
|
# @param [Hash] opts the optional parameters
|
|
714
714
|
# @return [nil]
|
|
715
715
|
def delete_catalog_variant(id, opts = {})
|
|
@@ -719,7 +719,7 @@ module KlaviyoAPI
|
|
|
719
719
|
|
|
720
720
|
# Delete Catalog Variant
|
|
721
721
|
# Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
|
722
|
-
# @param id [String]
|
|
722
|
+
# @param 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.
|
|
723
723
|
# @param [Hash] opts the optional parameters
|
|
724
724
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
725
725
|
def delete_catalog_variant_with_http_info(id, opts = {})
|
|
@@ -739,7 +739,7 @@ module KlaviyoAPI
|
|
|
739
739
|
# header parameters
|
|
740
740
|
header_params = opts[:header_params] || {}
|
|
741
741
|
# klaviyo api revision
|
|
742
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
742
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
743
743
|
# HTTP header 'Accept' (if needed)
|
|
744
744
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
745
745
|
|
|
@@ -773,12 +773,12 @@ module KlaviyoAPI
|
|
|
773
773
|
end
|
|
774
774
|
|
|
775
775
|
# Get Catalog Categories
|
|
776
|
-
# Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created`
|
|
776
|
+
# 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`
|
|
777
777
|
# @param [Hash] opts the optional parameters
|
|
778
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
|
779
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
780
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
781
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
778
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
779
|
+
# @option opts [String] :filter 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`
|
|
780
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
781
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
782
782
|
# @return [Hash<String, Object>]
|
|
783
783
|
def get_catalog_categories(opts = {})
|
|
784
784
|
data, _status_code, _headers = get_catalog_categories_with_http_info(opts)
|
|
@@ -786,12 +786,12 @@ module KlaviyoAPI
|
|
|
786
786
|
end
|
|
787
787
|
|
|
788
788
|
# Get Catalog Categories
|
|
789
|
-
# Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created`
|
|
789
|
+
# 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`
|
|
790
790
|
# @param [Hash] opts the optional parameters
|
|
791
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
|
792
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
793
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
794
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
791
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
792
|
+
# @option opts [String] :filter 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`
|
|
793
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
794
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
795
795
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
796
796
|
def get_catalog_categories_with_http_info(opts = {})
|
|
797
797
|
if @api_client.config.debugging
|
|
@@ -818,7 +818,7 @@ module KlaviyoAPI
|
|
|
818
818
|
# header parameters
|
|
819
819
|
header_params = opts[:header_params] || {}
|
|
820
820
|
# klaviyo api revision
|
|
821
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
821
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
822
822
|
# HTTP header 'Accept' (if needed)
|
|
823
823
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
824
824
|
|
|
@@ -853,9 +853,9 @@ module KlaviyoAPI
|
|
|
853
853
|
|
|
854
854
|
# Get Catalog Category
|
|
855
855
|
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
856
|
-
# @param id [String]
|
|
856
|
+
# @param 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.
|
|
857
857
|
# @param [Hash] opts the optional parameters
|
|
858
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
|
858
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
859
859
|
# @return [Hash<String, Object>]
|
|
860
860
|
def get_catalog_category(id, opts = {})
|
|
861
861
|
data, _status_code, _headers = get_catalog_category_with_http_info(id, opts)
|
|
@@ -864,9 +864,9 @@ module KlaviyoAPI
|
|
|
864
864
|
|
|
865
865
|
# Get Catalog Category
|
|
866
866
|
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
867
|
-
# @param id [String]
|
|
867
|
+
# @param 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.
|
|
868
868
|
# @param [Hash] opts the optional parameters
|
|
869
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
|
869
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
870
870
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
871
871
|
def get_catalog_category_with_http_info(id, opts = {})
|
|
872
872
|
if @api_client.config.debugging
|
|
@@ -890,7 +890,7 @@ module KlaviyoAPI
|
|
|
890
890
|
# header parameters
|
|
891
891
|
header_params = opts[:header_params] || {}
|
|
892
892
|
# klaviyo api revision
|
|
893
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
893
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
894
894
|
# HTTP header 'Accept' (if needed)
|
|
895
895
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
896
896
|
|
|
@@ -924,15 +924,15 @@ module KlaviyoAPI
|
|
|
924
924
|
end
|
|
925
925
|
|
|
926
926
|
# Get Catalog Category Items
|
|
927
|
-
# 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`
|
|
927
|
+
# 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`
|
|
928
928
|
# @param category_id [String]
|
|
929
929
|
# @param [Hash] opts the optional parameters
|
|
930
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
|
931
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
932
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
933
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
934
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
935
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
930
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
931
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
932
|
+
# @option opts [String] :filter 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`
|
|
933
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
934
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
935
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
936
936
|
# @return [Hash<String, Object>]
|
|
937
937
|
def get_catalog_category_items(category_id, opts = {})
|
|
938
938
|
data, _status_code, _headers = get_catalog_category_items_with_http_info(category_id, opts)
|
|
@@ -940,15 +940,15 @@ module KlaviyoAPI
|
|
|
940
940
|
end
|
|
941
941
|
|
|
942
942
|
# Get Catalog Category Items
|
|
943
|
-
# 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`
|
|
943
|
+
# 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`
|
|
944
944
|
# @param category_id [String]
|
|
945
945
|
# @param [Hash] opts the optional parameters
|
|
946
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
|
947
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
948
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
949
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
950
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
951
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
946
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
947
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
948
|
+
# @option opts [String] :filter 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`
|
|
949
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
950
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
951
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
952
952
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
953
953
|
def get_catalog_category_items_with_http_info(category_id, opts = {})
|
|
954
954
|
if @api_client.config.debugging
|
|
@@ -989,7 +989,7 @@ module KlaviyoAPI
|
|
|
989
989
|
# header parameters
|
|
990
990
|
header_params = opts[:header_params] || {}
|
|
991
991
|
# klaviyo api revision
|
|
992
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
992
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
993
993
|
# HTTP header 'Accept' (if needed)
|
|
994
994
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
995
995
|
|
|
@@ -1023,11 +1023,11 @@ module KlaviyoAPI
|
|
|
1023
1023
|
end
|
|
1024
1024
|
|
|
1025
1025
|
# Get Catalog Category Relationships
|
|
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
|
# @param id [String]
|
|
1028
1028
|
# @param related_resource [String]
|
|
1029
1029
|
# @param [Hash] opts the optional parameters
|
|
1030
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1030
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1031
1031
|
# @return [Hash<String, Object>]
|
|
1032
1032
|
def get_catalog_category_relationships(id, related_resource, opts = {})
|
|
1033
1033
|
data, _status_code, _headers = get_catalog_category_relationships_with_http_info(id, related_resource, opts)
|
|
@@ -1035,11 +1035,11 @@ module KlaviyoAPI
|
|
|
1035
1035
|
end
|
|
1036
1036
|
|
|
1037
1037
|
# Get Catalog Category Relationships
|
|
1038
|
-
# Get all items in the given category ID. Returns a maximum of 100 items per request
|
|
1038
|
+
# 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`
|
|
1039
1039
|
# @param id [String]
|
|
1040
1040
|
# @param related_resource [String]
|
|
1041
1041
|
# @param [Hash] opts the optional parameters
|
|
1042
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1042
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1043
1043
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1044
1044
|
def get_catalog_category_relationships_with_http_info(id, related_resource, opts = {})
|
|
1045
1045
|
if @api_client.config.debugging
|
|
@@ -1068,7 +1068,7 @@ module KlaviyoAPI
|
|
|
1068
1068
|
# header parameters
|
|
1069
1069
|
header_params = opts[:header_params] || {}
|
|
1070
1070
|
# klaviyo api revision
|
|
1071
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
1071
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
1072
1072
|
# HTTP header 'Accept' (if needed)
|
|
1073
1073
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1074
1074
|
|
|
@@ -1102,12 +1102,12 @@ module KlaviyoAPI
|
|
|
1102
1102
|
end
|
|
1103
1103
|
|
|
1104
1104
|
# Get Catalog Item
|
|
1105
|
-
# Get a specific catalog item with the given item ID.
|
|
1105
|
+
# 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`
|
|
1106
1106
|
# @param id [String]
|
|
1107
1107
|
# @param [Hash] opts the optional parameters
|
|
1108
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
|
1109
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
1110
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
1108
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1109
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1110
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1111
1111
|
# @return [Hash<String, Object>]
|
|
1112
1112
|
def get_catalog_item(id, opts = {})
|
|
1113
1113
|
data, _status_code, _headers = get_catalog_item_with_http_info(id, opts)
|
|
@@ -1115,12 +1115,12 @@ module KlaviyoAPI
|
|
|
1115
1115
|
end
|
|
1116
1116
|
|
|
1117
1117
|
# Get Catalog Item
|
|
1118
|
-
# Get a specific catalog item with the given item ID.
|
|
1118
|
+
# 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`
|
|
1119
1119
|
# @param id [String]
|
|
1120
1120
|
# @param [Hash] opts the optional parameters
|
|
1121
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
|
1122
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
1123
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
1121
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1122
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1123
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1124
1124
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1125
1125
|
def get_catalog_item_with_http_info(id, opts = {})
|
|
1126
1126
|
if @api_client.config.debugging
|
|
@@ -1154,7 +1154,7 @@ module KlaviyoAPI
|
|
|
1154
1154
|
# header parameters
|
|
1155
1155
|
header_params = opts[:header_params] || {}
|
|
1156
1156
|
# klaviyo api revision
|
|
1157
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
1157
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
1158
1158
|
# HTTP header 'Accept' (if needed)
|
|
1159
1159
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1160
1160
|
|
|
@@ -1188,13 +1188,13 @@ module KlaviyoAPI
|
|
|
1188
1188
|
end
|
|
1189
1189
|
|
|
1190
1190
|
# Get Catalog Item Categories
|
|
1191
|
-
# 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`
|
|
1191
|
+
# 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`
|
|
1192
1192
|
# @param item_id [String]
|
|
1193
1193
|
# @param [Hash] opts the optional parameters
|
|
1194
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
|
1195
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
1196
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1197
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
1194
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1195
|
+
# @option opts [String] :filter 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`
|
|
1196
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1197
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
1198
1198
|
# @return [Hash<String, Object>]
|
|
1199
1199
|
def get_catalog_item_categories(item_id, opts = {})
|
|
1200
1200
|
data, _status_code, _headers = get_catalog_item_categories_with_http_info(item_id, opts)
|
|
@@ -1202,13 +1202,13 @@ module KlaviyoAPI
|
|
|
1202
1202
|
end
|
|
1203
1203
|
|
|
1204
1204
|
# Get Catalog Item Categories
|
|
1205
|
-
# 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`
|
|
1205
|
+
# 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`
|
|
1206
1206
|
# @param item_id [String]
|
|
1207
1207
|
# @param [Hash] opts the optional parameters
|
|
1208
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
|
1209
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
1210
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1211
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
1208
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1209
|
+
# @option opts [String] :filter 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`
|
|
1210
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1211
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
1212
1212
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1213
1213
|
def get_catalog_item_categories_with_http_info(item_id, opts = {})
|
|
1214
1214
|
if @api_client.config.debugging
|
|
@@ -1239,7 +1239,7 @@ module KlaviyoAPI
|
|
|
1239
1239
|
# header parameters
|
|
1240
1240
|
header_params = opts[:header_params] || {}
|
|
1241
1241
|
# klaviyo api revision
|
|
1242
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
1242
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
1243
1243
|
# HTTP header 'Accept' (if needed)
|
|
1244
1244
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1245
1245
|
|
|
@@ -1273,11 +1273,11 @@ module KlaviyoAPI
|
|
|
1273
1273
|
end
|
|
1274
1274
|
|
|
1275
1275
|
# Get Catalog Item Relationships
|
|
1276
|
-
# Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request
|
|
1276
|
+
# 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`
|
|
1277
1277
|
# @param id [String]
|
|
1278
1278
|
# @param related_resource [String]
|
|
1279
1279
|
# @param [Hash] opts the optional parameters
|
|
1280
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1280
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1281
1281
|
# @return [Hash<String, Object>]
|
|
1282
1282
|
def get_catalog_item_relationships(id, related_resource, opts = {})
|
|
1283
1283
|
data, _status_code, _headers = get_catalog_item_relationships_with_http_info(id, related_resource, opts)
|
|
@@ -1285,11 +1285,11 @@ module KlaviyoAPI
|
|
|
1285
1285
|
end
|
|
1286
1286
|
|
|
1287
1287
|
# Get Catalog Item Relationships
|
|
1288
|
-
# Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request
|
|
1288
|
+
# 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`
|
|
1289
1289
|
# @param id [String]
|
|
1290
1290
|
# @param related_resource [String]
|
|
1291
1291
|
# @param [Hash] opts the optional parameters
|
|
1292
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1292
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1293
1293
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1294
1294
|
def get_catalog_item_relationships_with_http_info(id, related_resource, opts = {})
|
|
1295
1295
|
if @api_client.config.debugging
|
|
@@ -1318,7 +1318,7 @@ module KlaviyoAPI
|
|
|
1318
1318
|
# header parameters
|
|
1319
1319
|
header_params = opts[:header_params] || {}
|
|
1320
1320
|
# klaviyo api revision
|
|
1321
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
1321
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
1322
1322
|
# HTTP header 'Accept' (if needed)
|
|
1323
1323
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1324
1324
|
|
|
@@ -1352,13 +1352,13 @@ module KlaviyoAPI
|
|
|
1352
1352
|
end
|
|
1353
1353
|
|
|
1354
1354
|
# Get Catalog Item Variants
|
|
1355
|
-
# Get all variants related to the given item ID.
|
|
1356
|
-
# @param item_id [String]
|
|
1355
|
+
# 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`
|
|
1356
|
+
# @param 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.
|
|
1357
1357
|
# @param [Hash] opts the optional parameters
|
|
1358
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
1359
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
1360
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1361
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
1358
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1359
|
+
# @option opts [String] :filter 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
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1361
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
1362
1362
|
# @return [Hash<String, Object>]
|
|
1363
1363
|
def get_catalog_item_variants(item_id, opts = {})
|
|
1364
1364
|
data, _status_code, _headers = get_catalog_item_variants_with_http_info(item_id, opts)
|
|
@@ -1366,13 +1366,13 @@ module KlaviyoAPI
|
|
|
1366
1366
|
end
|
|
1367
1367
|
|
|
1368
1368
|
# Get Catalog Item Variants
|
|
1369
|
-
# Get all variants related to the given item ID.
|
|
1370
|
-
# @param item_id [String]
|
|
1369
|
+
# 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`
|
|
1370
|
+
# @param 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.
|
|
1371
1371
|
# @param [Hash] opts the optional parameters
|
|
1372
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
1373
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
1374
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1375
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
1372
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1373
|
+
# @option opts [String] :filter 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`
|
|
1374
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1375
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
1376
1376
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1377
1377
|
def get_catalog_item_variants_with_http_info(item_id, opts = {})
|
|
1378
1378
|
if @api_client.config.debugging
|
|
@@ -1403,7 +1403,7 @@ module KlaviyoAPI
|
|
|
1403
1403
|
# header parameters
|
|
1404
1404
|
header_params = opts[:header_params] || {}
|
|
1405
1405
|
# klaviyo api revision
|
|
1406
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
1406
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
1407
1407
|
# HTTP header 'Accept' (if needed)
|
|
1408
1408
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1409
1409
|
|
|
@@ -1437,14 +1437,14 @@ module KlaviyoAPI
|
|
|
1437
1437
|
end
|
|
1438
1438
|
|
|
1439
1439
|
# Get Catalog Items
|
|
1440
|
-
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created`
|
|
1441
|
-
# @param [Hash] opts the optional parameters
|
|
1442
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
|
1443
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
1444
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
1445
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
1446
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1447
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
1440
|
+
# 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`
|
|
1441
|
+
# @param [Hash] opts the optional parameters
|
|
1442
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1443
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1444
|
+
# @option opts [String] :filter 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`
|
|
1445
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1446
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1447
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
1448
1448
|
# @return [Hash<String, Object>]
|
|
1449
1449
|
def get_catalog_items(opts = {})
|
|
1450
1450
|
data, _status_code, _headers = get_catalog_items_with_http_info(opts)
|
|
@@ -1452,14 +1452,14 @@ module KlaviyoAPI
|
|
|
1452
1452
|
end
|
|
1453
1453
|
|
|
1454
1454
|
# Get Catalog Items
|
|
1455
|
-
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created`
|
|
1456
|
-
# @param [Hash] opts the optional parameters
|
|
1457
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
|
1458
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
1459
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
1460
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
1461
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1462
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
1455
|
+
# 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`
|
|
1456
|
+
# @param [Hash] opts the optional parameters
|
|
1457
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1458
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1459
|
+
# @option opts [String] :filter 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`
|
|
1460
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1461
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1462
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
1463
1463
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1464
1464
|
def get_catalog_items_with_http_info(opts = {})
|
|
1465
1465
|
if @api_client.config.debugging
|
|
@@ -1496,7 +1496,7 @@ module KlaviyoAPI
|
|
|
1496
1496
|
# header parameters
|
|
1497
1497
|
header_params = opts[:header_params] || {}
|
|
1498
1498
|
# klaviyo api revision
|
|
1499
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
1499
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
1500
1500
|
# HTTP header 'Accept' (if needed)
|
|
1501
1501
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1502
1502
|
|
|
@@ -1531,9 +1531,9 @@ module KlaviyoAPI
|
|
|
1531
1531
|
|
|
1532
1532
|
# Get Catalog Variant
|
|
1533
1533
|
# Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1534
|
-
# @param id [String]
|
|
1534
|
+
# @param 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.
|
|
1535
1535
|
# @param [Hash] opts the optional parameters
|
|
1536
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
1536
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1537
1537
|
# @return [Hash<String, Object>]
|
|
1538
1538
|
def get_catalog_variant(id, opts = {})
|
|
1539
1539
|
data, _status_code, _headers = get_catalog_variant_with_http_info(id, opts)
|
|
@@ -1542,9 +1542,9 @@ module KlaviyoAPI
|
|
|
1542
1542
|
|
|
1543
1543
|
# Get Catalog Variant
|
|
1544
1544
|
# Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1545
|
-
# @param id [String]
|
|
1545
|
+
# @param 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.
|
|
1546
1546
|
# @param [Hash] opts the optional parameters
|
|
1547
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
1547
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1548
1548
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1549
1549
|
def get_catalog_variant_with_http_info(id, opts = {})
|
|
1550
1550
|
if @api_client.config.debugging
|
|
@@ -1568,7 +1568,7 @@ module KlaviyoAPI
|
|
|
1568
1568
|
# header parameters
|
|
1569
1569
|
header_params = opts[:header_params] || {}
|
|
1570
1570
|
# klaviyo api revision
|
|
1571
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
1571
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
1572
1572
|
# HTTP header 'Accept' (if needed)
|
|
1573
1573
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1574
1574
|
|
|
@@ -1602,12 +1602,12 @@ module KlaviyoAPI
|
|
|
1602
1602
|
end
|
|
1603
1603
|
|
|
1604
1604
|
# Get Catalog Variants
|
|
1605
|
-
# Get all variants in an account.
|
|
1605
|
+
# 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`
|
|
1606
1606
|
# @param [Hash] opts the optional parameters
|
|
1607
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
1608
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
1609
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1610
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
1607
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1608
|
+
# @option opts [String] :filter 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`
|
|
1609
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1610
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
1611
1611
|
# @return [Hash<String, Object>]
|
|
1612
1612
|
def get_catalog_variants(opts = {})
|
|
1613
1613
|
data, _status_code, _headers = get_catalog_variants_with_http_info(opts)
|
|
@@ -1615,12 +1615,12 @@ module KlaviyoAPI
|
|
|
1615
1615
|
end
|
|
1616
1616
|
|
|
1617
1617
|
# Get Catalog Variants
|
|
1618
|
-
# Get all variants in an account.
|
|
1618
|
+
# 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`
|
|
1619
1619
|
# @param [Hash] opts the optional parameters
|
|
1620
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
1621
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
1622
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1623
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
|
1620
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1621
|
+
# @option opts [String] :filter 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`
|
|
1622
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1623
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
|
|
1624
1624
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1625
1625
|
def get_catalog_variants_with_http_info(opts = {})
|
|
1626
1626
|
if @api_client.config.debugging
|
|
@@ -1647,7 +1647,7 @@ module KlaviyoAPI
|
|
|
1647
1647
|
# header parameters
|
|
1648
1648
|
header_params = opts[:header_params] || {}
|
|
1649
1649
|
# klaviyo api revision
|
|
1650
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
1650
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
1651
1651
|
# HTTP header 'Accept' (if needed)
|
|
1652
1652
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1653
1653
|
|
|
@@ -1684,9 +1684,9 @@ module KlaviyoAPI
|
|
|
1684
1684
|
# Get a catalog category bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: `categories`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1685
1685
|
# @param job_id [String]
|
|
1686
1686
|
# @param [Hash] opts the optional parameters
|
|
1687
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
|
1688
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
|
1689
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
1687
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1688
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1689
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1690
1690
|
# @return [Hash<String, Object>]
|
|
1691
1691
|
def get_create_categories_job(job_id, opts = {})
|
|
1692
1692
|
data, _status_code, _headers = get_create_categories_job_with_http_info(job_id, opts)
|
|
@@ -1697,9 +1697,9 @@ module KlaviyoAPI
|
|
|
1697
1697
|
# Get a catalog category bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: `categories`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1698
1698
|
# @param job_id [String]
|
|
1699
1699
|
# @param [Hash] opts the optional parameters
|
|
1700
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
|
1701
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
|
1702
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
1700
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1701
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1702
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1703
1703
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1704
1704
|
def get_create_categories_job_with_http_info(job_id, opts = {})
|
|
1705
1705
|
if @api_client.config.debugging
|
|
@@ -1733,7 +1733,7 @@ module KlaviyoAPI
|
|
|
1733
1733
|
# header parameters
|
|
1734
1734
|
header_params = opts[:header_params] || {}
|
|
1735
1735
|
# klaviyo api revision
|
|
1736
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
1736
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
1737
1737
|
# HTTP header 'Accept' (if needed)
|
|
1738
1738
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1739
1739
|
|
|
@@ -1767,11 +1767,11 @@ module KlaviyoAPI
|
|
|
1767
1767
|
end
|
|
1768
1768
|
|
|
1769
1769
|
# Get Create Categories Jobs
|
|
1770
|
-
# Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request
|
|
1770
|
+
# 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`
|
|
1771
1771
|
# @param [Hash] opts the optional parameters
|
|
1772
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
|
1773
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
1774
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1772
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1773
|
+
# @option opts [String] :filter 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`
|
|
1774
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1775
1775
|
# @return [Hash<String, Object>]
|
|
1776
1776
|
def get_create_categories_jobs(opts = {})
|
|
1777
1777
|
data, _status_code, _headers = get_create_categories_jobs_with_http_info(opts)
|
|
@@ -1779,11 +1779,11 @@ module KlaviyoAPI
|
|
|
1779
1779
|
end
|
|
1780
1780
|
|
|
1781
1781
|
# Get Create Categories Jobs
|
|
1782
|
-
# Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request
|
|
1782
|
+
# 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`
|
|
1783
1783
|
# @param [Hash] opts the optional parameters
|
|
1784
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
|
1785
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
1786
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1784
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1785
|
+
# @option opts [String] :filter 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`
|
|
1786
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1787
1787
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1788
1788
|
def get_create_categories_jobs_with_http_info(opts = {})
|
|
1789
1789
|
if @api_client.config.debugging
|
|
@@ -1805,7 +1805,7 @@ module KlaviyoAPI
|
|
|
1805
1805
|
# header parameters
|
|
1806
1806
|
header_params = opts[:header_params] || {}
|
|
1807
1807
|
# klaviyo api revision
|
|
1808
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
1808
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
1809
1809
|
# HTTP header 'Accept' (if needed)
|
|
1810
1810
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1811
1811
|
|
|
@@ -1842,9 +1842,9 @@ module KlaviyoAPI
|
|
|
1842
1842
|
# Get a catalog item bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: `items`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1843
1843
|
# @param job_id [String]
|
|
1844
1844
|
# @param [Hash] opts the optional parameters
|
|
1845
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
|
1846
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
|
1847
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
1845
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1846
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1847
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1848
1848
|
# @return [Hash<String, Object>]
|
|
1849
1849
|
def get_create_items_job(job_id, opts = {})
|
|
1850
1850
|
data, _status_code, _headers = get_create_items_job_with_http_info(job_id, opts)
|
|
@@ -1855,9 +1855,9 @@ module KlaviyoAPI
|
|
|
1855
1855
|
# Get a catalog item bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: `items`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
1856
1856
|
# @param job_id [String]
|
|
1857
1857
|
# @param [Hash] opts the optional parameters
|
|
1858
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
|
1859
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
|
1860
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
1858
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1859
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1860
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
1861
1861
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1862
1862
|
def get_create_items_job_with_http_info(job_id, opts = {})
|
|
1863
1863
|
if @api_client.config.debugging
|
|
@@ -1891,7 +1891,7 @@ module KlaviyoAPI
|
|
|
1891
1891
|
# header parameters
|
|
1892
1892
|
header_params = opts[:header_params] || {}
|
|
1893
1893
|
# klaviyo api revision
|
|
1894
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
1894
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
1895
1895
|
# HTTP header 'Accept' (if needed)
|
|
1896
1896
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1897
1897
|
|
|
@@ -1925,11 +1925,11 @@ module KlaviyoAPI
|
|
|
1925
1925
|
end
|
|
1926
1926
|
|
|
1927
1927
|
# Get Create Items Jobs
|
|
1928
|
-
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request
|
|
1928
|
+
# 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`
|
|
1929
1929
|
# @param [Hash] opts the optional parameters
|
|
1930
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
|
1931
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
1932
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1930
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1931
|
+
# @option opts [String] :filter 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`
|
|
1932
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1933
1933
|
# @return [Hash<String, Object>]
|
|
1934
1934
|
def get_create_items_jobs(opts = {})
|
|
1935
1935
|
data, _status_code, _headers = get_create_items_jobs_with_http_info(opts)
|
|
@@ -1937,11 +1937,11 @@ module KlaviyoAPI
|
|
|
1937
1937
|
end
|
|
1938
1938
|
|
|
1939
1939
|
# Get Create Items Jobs
|
|
1940
|
-
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request
|
|
1940
|
+
# 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`
|
|
1941
1941
|
# @param [Hash] opts the optional parameters
|
|
1942
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
|
1943
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
1944
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
1942
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
1943
|
+
# @option opts [String] :filter 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`
|
|
1944
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
1945
1945
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1946
1946
|
def get_create_items_jobs_with_http_info(opts = {})
|
|
1947
1947
|
if @api_client.config.debugging
|
|
@@ -1963,7 +1963,7 @@ module KlaviyoAPI
|
|
|
1963
1963
|
# header parameters
|
|
1964
1964
|
header_params = opts[:header_params] || {}
|
|
1965
1965
|
# klaviyo api revision
|
|
1966
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
1966
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
1967
1967
|
# HTTP header 'Accept' (if needed)
|
|
1968
1968
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1969
1969
|
|
|
@@ -2000,9 +2000,9 @@ module KlaviyoAPI
|
|
|
2000
2000
|
# Get a catalog variant bulk create job with the given job 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`
|
|
2001
2001
|
# @param job_id [String]
|
|
2002
2002
|
# @param [Hash] opts the optional parameters
|
|
2003
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
|
2004
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
2005
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
2003
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2004
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2005
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
2006
2006
|
# @return [Hash<String, Object>]
|
|
2007
2007
|
def get_create_variants_job(job_id, opts = {})
|
|
2008
2008
|
data, _status_code, _headers = get_create_variants_job_with_http_info(job_id, opts)
|
|
@@ -2013,9 +2013,9 @@ module KlaviyoAPI
|
|
|
2013
2013
|
# Get a catalog variant bulk create job with the given job 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`
|
|
2014
2014
|
# @param job_id [String]
|
|
2015
2015
|
# @param [Hash] opts the optional parameters
|
|
2016
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
|
2017
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
2018
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
2016
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2017
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2018
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
2019
2019
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2020
2020
|
def get_create_variants_job_with_http_info(job_id, opts = {})
|
|
2021
2021
|
if @api_client.config.debugging
|
|
@@ -2049,7 +2049,7 @@ module KlaviyoAPI
|
|
|
2049
2049
|
# header parameters
|
|
2050
2050
|
header_params = opts[:header_params] || {}
|
|
2051
2051
|
# klaviyo api revision
|
|
2052
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2052
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2053
2053
|
# HTTP header 'Accept' (if needed)
|
|
2054
2054
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2055
2055
|
|
|
@@ -2083,11 +2083,11 @@ module KlaviyoAPI
|
|
|
2083
2083
|
end
|
|
2084
2084
|
|
|
2085
2085
|
# Get Create Variants Jobs
|
|
2086
|
-
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request
|
|
2086
|
+
# 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`
|
|
2087
2087
|
# @param [Hash] opts the optional parameters
|
|
2088
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
|
2089
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2090
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2088
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2089
|
+
# @option opts [String] :filter 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`
|
|
2090
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2091
2091
|
# @return [Hash<String, Object>]
|
|
2092
2092
|
def get_create_variants_jobs(opts = {})
|
|
2093
2093
|
data, _status_code, _headers = get_create_variants_jobs_with_http_info(opts)
|
|
@@ -2095,11 +2095,11 @@ module KlaviyoAPI
|
|
|
2095
2095
|
end
|
|
2096
2096
|
|
|
2097
2097
|
# Get Create Variants Jobs
|
|
2098
|
-
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request
|
|
2098
|
+
# 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`
|
|
2099
2099
|
# @param [Hash] opts the optional parameters
|
|
2100
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
|
2101
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2102
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2100
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2101
|
+
# @option opts [String] :filter 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`
|
|
2102
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2103
2103
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2104
2104
|
def get_create_variants_jobs_with_http_info(opts = {})
|
|
2105
2105
|
if @api_client.config.debugging
|
|
@@ -2121,7 +2121,7 @@ module KlaviyoAPI
|
|
|
2121
2121
|
# header parameters
|
|
2122
2122
|
header_params = opts[:header_params] || {}
|
|
2123
2123
|
# klaviyo api revision
|
|
2124
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2124
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2125
2125
|
# HTTP header 'Accept' (if needed)
|
|
2126
2126
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2127
2127
|
|
|
@@ -2158,7 +2158,7 @@ module KlaviyoAPI
|
|
|
2158
2158
|
# Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2159
2159
|
# @param job_id [String]
|
|
2160
2160
|
# @param [Hash] opts the optional parameters
|
|
2161
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
|
2161
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2162
2162
|
# @return [Hash<String, Object>]
|
|
2163
2163
|
def get_delete_categories_job(job_id, opts = {})
|
|
2164
2164
|
data, _status_code, _headers = get_delete_categories_job_with_http_info(job_id, opts)
|
|
@@ -2169,7 +2169,7 @@ module KlaviyoAPI
|
|
|
2169
2169
|
# Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2170
2170
|
# @param job_id [String]
|
|
2171
2171
|
# @param [Hash] opts the optional parameters
|
|
2172
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
|
2172
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2173
2173
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2174
2174
|
def get_delete_categories_job_with_http_info(job_id, opts = {})
|
|
2175
2175
|
if @api_client.config.debugging
|
|
@@ -2193,7 +2193,7 @@ module KlaviyoAPI
|
|
|
2193
2193
|
# header parameters
|
|
2194
2194
|
header_params = opts[:header_params] || {}
|
|
2195
2195
|
# klaviyo api revision
|
|
2196
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2196
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2197
2197
|
# HTTP header 'Accept' (if needed)
|
|
2198
2198
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2199
2199
|
|
|
@@ -2227,11 +2227,11 @@ module KlaviyoAPI
|
|
|
2227
2227
|
end
|
|
2228
2228
|
|
|
2229
2229
|
# Get Delete Categories Jobs
|
|
2230
|
-
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request
|
|
2230
|
+
# 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`
|
|
2231
2231
|
# @param [Hash] opts the optional parameters
|
|
2232
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
|
2233
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2234
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2232
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2233
|
+
# @option opts [String] :filter 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`
|
|
2234
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2235
2235
|
# @return [Hash<String, Object>]
|
|
2236
2236
|
def get_delete_categories_jobs(opts = {})
|
|
2237
2237
|
data, _status_code, _headers = get_delete_categories_jobs_with_http_info(opts)
|
|
@@ -2239,11 +2239,11 @@ module KlaviyoAPI
|
|
|
2239
2239
|
end
|
|
2240
2240
|
|
|
2241
2241
|
# Get Delete Categories Jobs
|
|
2242
|
-
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request
|
|
2242
|
+
# 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`
|
|
2243
2243
|
# @param [Hash] opts the optional parameters
|
|
2244
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
|
2245
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2246
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2244
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2245
|
+
# @option opts [String] :filter 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`
|
|
2246
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2247
2247
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2248
2248
|
def get_delete_categories_jobs_with_http_info(opts = {})
|
|
2249
2249
|
if @api_client.config.debugging
|
|
@@ -2265,7 +2265,7 @@ module KlaviyoAPI
|
|
|
2265
2265
|
# header parameters
|
|
2266
2266
|
header_params = opts[:header_params] || {}
|
|
2267
2267
|
# klaviyo api revision
|
|
2268
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2268
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2269
2269
|
# HTTP header 'Accept' (if needed)
|
|
2270
2270
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2271
2271
|
|
|
@@ -2302,7 +2302,7 @@ module KlaviyoAPI
|
|
|
2302
2302
|
# Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2303
2303
|
# @param job_id [String]
|
|
2304
2304
|
# @param [Hash] opts the optional parameters
|
|
2305
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
|
2305
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2306
2306
|
# @return [Hash<String, Object>]
|
|
2307
2307
|
def get_delete_items_job(job_id, opts = {})
|
|
2308
2308
|
data, _status_code, _headers = get_delete_items_job_with_http_info(job_id, opts)
|
|
@@ -2313,7 +2313,7 @@ module KlaviyoAPI
|
|
|
2313
2313
|
# Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2314
2314
|
# @param job_id [String]
|
|
2315
2315
|
# @param [Hash] opts the optional parameters
|
|
2316
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
|
2316
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2317
2317
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2318
2318
|
def get_delete_items_job_with_http_info(job_id, opts = {})
|
|
2319
2319
|
if @api_client.config.debugging
|
|
@@ -2337,7 +2337,7 @@ module KlaviyoAPI
|
|
|
2337
2337
|
# header parameters
|
|
2338
2338
|
header_params = opts[:header_params] || {}
|
|
2339
2339
|
# klaviyo api revision
|
|
2340
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2340
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2341
2341
|
# HTTP header 'Accept' (if needed)
|
|
2342
2342
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2343
2343
|
|
|
@@ -2371,11 +2371,11 @@ module KlaviyoAPI
|
|
|
2371
2371
|
end
|
|
2372
2372
|
|
|
2373
2373
|
# Get Delete Items Jobs
|
|
2374
|
-
# Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request
|
|
2374
|
+
# 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`
|
|
2375
2375
|
# @param [Hash] opts the optional parameters
|
|
2376
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
|
2377
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2378
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2376
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2377
|
+
# @option opts [String] :filter 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`
|
|
2378
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2379
2379
|
# @return [Hash<String, Object>]
|
|
2380
2380
|
def get_delete_items_jobs(opts = {})
|
|
2381
2381
|
data, _status_code, _headers = get_delete_items_jobs_with_http_info(opts)
|
|
@@ -2383,11 +2383,11 @@ module KlaviyoAPI
|
|
|
2383
2383
|
end
|
|
2384
2384
|
|
|
2385
2385
|
# Get Delete Items Jobs
|
|
2386
|
-
# Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request
|
|
2386
|
+
# 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`
|
|
2387
2387
|
# @param [Hash] opts the optional parameters
|
|
2388
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
|
2389
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2390
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2388
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2389
|
+
# @option opts [String] :filter 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`
|
|
2390
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2391
2391
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2392
2392
|
def get_delete_items_jobs_with_http_info(opts = {})
|
|
2393
2393
|
if @api_client.config.debugging
|
|
@@ -2409,7 +2409,7 @@ module KlaviyoAPI
|
|
|
2409
2409
|
# header parameters
|
|
2410
2410
|
header_params = opts[:header_params] || {}
|
|
2411
2411
|
# klaviyo api revision
|
|
2412
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2412
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2413
2413
|
# HTTP header 'Accept' (if needed)
|
|
2414
2414
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2415
2415
|
|
|
@@ -2446,7 +2446,7 @@ module KlaviyoAPI
|
|
|
2446
2446
|
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2447
2447
|
# @param job_id [String]
|
|
2448
2448
|
# @param [Hash] opts the optional parameters
|
|
2449
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
|
2449
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2450
2450
|
# @return [Hash<String, Object>]
|
|
2451
2451
|
def get_delete_variants_job(job_id, opts = {})
|
|
2452
2452
|
data, _status_code, _headers = get_delete_variants_job_with_http_info(job_id, opts)
|
|
@@ -2457,7 +2457,7 @@ module KlaviyoAPI
|
|
|
2457
2457
|
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2458
2458
|
# @param job_id [String]
|
|
2459
2459
|
# @param [Hash] opts the optional parameters
|
|
2460
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
|
2460
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2461
2461
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2462
2462
|
def get_delete_variants_job_with_http_info(job_id, opts = {})
|
|
2463
2463
|
if @api_client.config.debugging
|
|
@@ -2481,7 +2481,7 @@ module KlaviyoAPI
|
|
|
2481
2481
|
# header parameters
|
|
2482
2482
|
header_params = opts[:header_params] || {}
|
|
2483
2483
|
# klaviyo api revision
|
|
2484
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2484
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2485
2485
|
# HTTP header 'Accept' (if needed)
|
|
2486
2486
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2487
2487
|
|
|
@@ -2515,11 +2515,11 @@ module KlaviyoAPI
|
|
|
2515
2515
|
end
|
|
2516
2516
|
|
|
2517
2517
|
# Get Delete Variants Jobs
|
|
2518
|
-
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request
|
|
2518
|
+
# 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`
|
|
2519
2519
|
# @param [Hash] opts the optional parameters
|
|
2520
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
|
2521
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2522
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2520
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2521
|
+
# @option opts [String] :filter 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`
|
|
2522
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2523
2523
|
# @return [Hash<String, Object>]
|
|
2524
2524
|
def get_delete_variants_jobs(opts = {})
|
|
2525
2525
|
data, _status_code, _headers = get_delete_variants_jobs_with_http_info(opts)
|
|
@@ -2527,11 +2527,11 @@ module KlaviyoAPI
|
|
|
2527
2527
|
end
|
|
2528
2528
|
|
|
2529
2529
|
# Get Delete Variants Jobs
|
|
2530
|
-
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request
|
|
2530
|
+
# 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`
|
|
2531
2531
|
# @param [Hash] opts the optional parameters
|
|
2532
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
|
2533
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2534
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2532
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2533
|
+
# @option opts [String] :filter 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`
|
|
2534
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2535
2535
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2536
2536
|
def get_delete_variants_jobs_with_http_info(opts = {})
|
|
2537
2537
|
if @api_client.config.debugging
|
|
@@ -2553,7 +2553,7 @@ module KlaviyoAPI
|
|
|
2553
2553
|
# header parameters
|
|
2554
2554
|
header_params = opts[:header_params] || {}
|
|
2555
2555
|
# klaviyo api revision
|
|
2556
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2556
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2557
2557
|
# HTTP header 'Accept' (if needed)
|
|
2558
2558
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2559
2559
|
|
|
@@ -2590,9 +2590,9 @@ module KlaviyoAPI
|
|
|
2590
2590
|
# Get a catalog category bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: `categories`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2591
2591
|
# @param job_id [String]
|
|
2592
2592
|
# @param [Hash] opts the optional parameters
|
|
2593
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
|
2594
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
|
2595
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
2593
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2594
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2595
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
2596
2596
|
# @return [Hash<String, Object>]
|
|
2597
2597
|
def get_update_categories_job(job_id, opts = {})
|
|
2598
2598
|
data, _status_code, _headers = get_update_categories_job_with_http_info(job_id, opts)
|
|
@@ -2603,9 +2603,9 @@ module KlaviyoAPI
|
|
|
2603
2603
|
# Get a catalog category bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: `categories`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2604
2604
|
# @param job_id [String]
|
|
2605
2605
|
# @param [Hash] opts the optional parameters
|
|
2606
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
|
2607
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/
|
|
2608
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
2606
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2607
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2608
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
2609
2609
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2610
2610
|
def get_update_categories_job_with_http_info(job_id, opts = {})
|
|
2611
2611
|
if @api_client.config.debugging
|
|
@@ -2639,7 +2639,7 @@ module KlaviyoAPI
|
|
|
2639
2639
|
# header parameters
|
|
2640
2640
|
header_params = opts[:header_params] || {}
|
|
2641
2641
|
# klaviyo api revision
|
|
2642
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2642
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2643
2643
|
# HTTP header 'Accept' (if needed)
|
|
2644
2644
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2645
2645
|
|
|
@@ -2673,11 +2673,11 @@ module KlaviyoAPI
|
|
|
2673
2673
|
end
|
|
2674
2674
|
|
|
2675
2675
|
# Get Update Categories Jobs
|
|
2676
|
-
# Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request
|
|
2676
|
+
# 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`
|
|
2677
2677
|
# @param [Hash] opts the optional parameters
|
|
2678
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
|
2679
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2680
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2678
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2679
|
+
# @option opts [String] :filter 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
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2681
2681
|
# @return [Hash<String, Object>]
|
|
2682
2682
|
def get_update_categories_jobs(opts = {})
|
|
2683
2683
|
data, _status_code, _headers = get_update_categories_jobs_with_http_info(opts)
|
|
@@ -2685,11 +2685,11 @@ module KlaviyoAPI
|
|
|
2685
2685
|
end
|
|
2686
2686
|
|
|
2687
2687
|
# Get Update Categories Jobs
|
|
2688
|
-
# Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request
|
|
2688
|
+
# 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`
|
|
2689
2689
|
# @param [Hash] opts the optional parameters
|
|
2690
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
|
2691
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2692
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2690
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2691
|
+
# @option opts [String] :filter 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`
|
|
2692
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2693
2693
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2694
2694
|
def get_update_categories_jobs_with_http_info(opts = {})
|
|
2695
2695
|
if @api_client.config.debugging
|
|
@@ -2711,7 +2711,7 @@ module KlaviyoAPI
|
|
|
2711
2711
|
# header parameters
|
|
2712
2712
|
header_params = opts[:header_params] || {}
|
|
2713
2713
|
# klaviyo api revision
|
|
2714
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2714
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2715
2715
|
# HTTP header 'Accept' (if needed)
|
|
2716
2716
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2717
2717
|
|
|
@@ -2748,9 +2748,9 @@ module KlaviyoAPI
|
|
|
2748
2748
|
# Get a catalog item bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: `items`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2749
2749
|
# @param job_id [String]
|
|
2750
2750
|
# @param [Hash] opts the optional parameters
|
|
2751
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
|
2752
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
|
2753
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
2751
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2752
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2753
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
2754
2754
|
# @return [Hash<String, Object>]
|
|
2755
2755
|
def get_update_items_job(job_id, opts = {})
|
|
2756
2756
|
data, _status_code, _headers = get_update_items_job_with_http_info(job_id, opts)
|
|
@@ -2761,9 +2761,9 @@ module KlaviyoAPI
|
|
|
2761
2761
|
# Get a catalog item bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: `items`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
|
2762
2762
|
# @param job_id [String]
|
|
2763
2763
|
# @param [Hash] opts the optional parameters
|
|
2764
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
|
2765
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/
|
|
2766
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
2764
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2765
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2766
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
2767
2767
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2768
2768
|
def get_update_items_job_with_http_info(job_id, opts = {})
|
|
2769
2769
|
if @api_client.config.debugging
|
|
@@ -2797,7 +2797,7 @@ module KlaviyoAPI
|
|
|
2797
2797
|
# header parameters
|
|
2798
2798
|
header_params = opts[:header_params] || {}
|
|
2799
2799
|
# klaviyo api revision
|
|
2800
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2800
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2801
2801
|
# HTTP header 'Accept' (if needed)
|
|
2802
2802
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2803
2803
|
|
|
@@ -2831,11 +2831,11 @@ module KlaviyoAPI
|
|
|
2831
2831
|
end
|
|
2832
2832
|
|
|
2833
2833
|
# Get Update Items Jobs
|
|
2834
|
-
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request
|
|
2834
|
+
# 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`
|
|
2835
2835
|
# @param [Hash] opts the optional parameters
|
|
2836
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
|
2837
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2838
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2836
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2837
|
+
# @option opts [String] :filter 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`
|
|
2838
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2839
2839
|
# @return [Hash<String, Object>]
|
|
2840
2840
|
def get_update_items_jobs(opts = {})
|
|
2841
2841
|
data, _status_code, _headers = get_update_items_jobs_with_http_info(opts)
|
|
@@ -2843,11 +2843,11 @@ module KlaviyoAPI
|
|
|
2843
2843
|
end
|
|
2844
2844
|
|
|
2845
2845
|
# Get Update Items Jobs
|
|
2846
|
-
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request
|
|
2846
|
+
# 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`
|
|
2847
2847
|
# @param [Hash] opts the optional parameters
|
|
2848
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
|
2849
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2850
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2848
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2849
|
+
# @option opts [String] :filter 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`
|
|
2850
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2851
2851
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2852
2852
|
def get_update_items_jobs_with_http_info(opts = {})
|
|
2853
2853
|
if @api_client.config.debugging
|
|
@@ -2869,7 +2869,7 @@ module KlaviyoAPI
|
|
|
2869
2869
|
# header parameters
|
|
2870
2870
|
header_params = opts[:header_params] || {}
|
|
2871
2871
|
# klaviyo api revision
|
|
2872
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2872
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2873
2873
|
# HTTP header 'Accept' (if needed)
|
|
2874
2874
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2875
2875
|
|
|
@@ -2906,9 +2906,9 @@ module KlaviyoAPI
|
|
|
2906
2906
|
# Get a catalog variate bulk update job with the given job 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`
|
|
2907
2907
|
# @param job_id [String]
|
|
2908
2908
|
# @param [Hash] opts the optional parameters
|
|
2909
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
|
2910
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
2911
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
2909
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2910
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2911
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
2912
2912
|
# @return [Hash<String, Object>]
|
|
2913
2913
|
def get_update_variants_job(job_id, opts = {})
|
|
2914
2914
|
data, _status_code, _headers = get_update_variants_job_with_http_info(job_id, opts)
|
|
@@ -2919,9 +2919,9 @@ module KlaviyoAPI
|
|
|
2919
2919
|
# Get a catalog variate bulk update job with the given job 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`
|
|
2920
2920
|
# @param job_id [String]
|
|
2921
2921
|
# @param [Hash] opts the optional parameters
|
|
2922
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
|
2923
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/
|
|
2924
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
|
2922
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2923
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2924
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
|
|
2925
2925
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2926
2926
|
def get_update_variants_job_with_http_info(job_id, opts = {})
|
|
2927
2927
|
if @api_client.config.debugging
|
|
@@ -2955,7 +2955,7 @@ module KlaviyoAPI
|
|
|
2955
2955
|
# header parameters
|
|
2956
2956
|
header_params = opts[:header_params] || {}
|
|
2957
2957
|
# klaviyo api revision
|
|
2958
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
2958
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
2959
2959
|
# HTTP header 'Accept' (if needed)
|
|
2960
2960
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2961
2961
|
|
|
@@ -2989,11 +2989,11 @@ module KlaviyoAPI
|
|
|
2989
2989
|
end
|
|
2990
2990
|
|
|
2991
2991
|
# Get Update Variants Jobs
|
|
2992
|
-
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request
|
|
2992
|
+
# 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`
|
|
2993
2993
|
# @param [Hash] opts the optional parameters
|
|
2994
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
|
2995
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
2996
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
2994
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
2995
|
+
# @option opts [String] :filter 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`
|
|
2996
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
2997
2997
|
# @return [Hash<String, Object>]
|
|
2998
2998
|
def get_update_variants_jobs(opts = {})
|
|
2999
2999
|
data, _status_code, _headers = get_update_variants_jobs_with_http_info(opts)
|
|
@@ -3001,11 +3001,11 @@ module KlaviyoAPI
|
|
|
3001
3001
|
end
|
|
3002
3002
|
|
|
3003
3003
|
# Get Update Variants Jobs
|
|
3004
|
-
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request
|
|
3004
|
+
# 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`
|
|
3005
3005
|
# @param [Hash] opts the optional parameters
|
|
3006
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/
|
|
3007
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
|
3008
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
|
3006
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
|
|
3007
|
+
# @option opts [String] :filter 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`
|
|
3008
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
|
|
3009
3009
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3010
3010
|
def get_update_variants_jobs_with_http_info(opts = {})
|
|
3011
3011
|
if @api_client.config.debugging
|
|
@@ -3027,7 +3027,7 @@ module KlaviyoAPI
|
|
|
3027
3027
|
# header parameters
|
|
3028
3028
|
header_params = opts[:header_params] || {}
|
|
3029
3029
|
# klaviyo api revision
|
|
3030
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3030
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3031
3031
|
# HTTP header 'Accept' (if needed)
|
|
3032
3032
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3033
3033
|
|
|
@@ -3092,7 +3092,7 @@ module KlaviyoAPI
|
|
|
3092
3092
|
# header parameters
|
|
3093
3093
|
header_params = opts[:header_params] || {}
|
|
3094
3094
|
# klaviyo api revision
|
|
3095
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3095
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3096
3096
|
# HTTP header 'Accept' (if needed)
|
|
3097
3097
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3098
3098
|
# HTTP header 'Content-Type'
|
|
@@ -3162,7 +3162,7 @@ module KlaviyoAPI
|
|
|
3162
3162
|
# header parameters
|
|
3163
3163
|
header_params = opts[:header_params] || {}
|
|
3164
3164
|
# klaviyo api revision
|
|
3165
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3165
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3166
3166
|
# HTTP header 'Accept' (if needed)
|
|
3167
3167
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3168
3168
|
# HTTP header 'Content-Type'
|
|
@@ -3232,7 +3232,7 @@ module KlaviyoAPI
|
|
|
3232
3232
|
# header parameters
|
|
3233
3233
|
header_params = opts[:header_params] || {}
|
|
3234
3234
|
# klaviyo api revision
|
|
3235
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3235
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3236
3236
|
# HTTP header 'Accept' (if needed)
|
|
3237
3237
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3238
3238
|
# HTTP header 'Content-Type'
|
|
@@ -3302,7 +3302,7 @@ module KlaviyoAPI
|
|
|
3302
3302
|
# header parameters
|
|
3303
3303
|
header_params = opts[:header_params] || {}
|
|
3304
3304
|
# klaviyo api revision
|
|
3305
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3305
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3306
3306
|
# HTTP header 'Accept' (if needed)
|
|
3307
3307
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3308
3308
|
# HTTP header 'Content-Type'
|
|
@@ -3372,7 +3372,7 @@ module KlaviyoAPI
|
|
|
3372
3372
|
# header parameters
|
|
3373
3373
|
header_params = opts[:header_params] || {}
|
|
3374
3374
|
# klaviyo api revision
|
|
3375
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3375
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3376
3376
|
# HTTP header 'Accept' (if needed)
|
|
3377
3377
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3378
3378
|
# HTTP header 'Content-Type'
|
|
@@ -3442,7 +3442,7 @@ module KlaviyoAPI
|
|
|
3442
3442
|
# header parameters
|
|
3443
3443
|
header_params = opts[:header_params] || {}
|
|
3444
3444
|
# klaviyo api revision
|
|
3445
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3445
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3446
3446
|
# HTTP header 'Accept' (if needed)
|
|
3447
3447
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3448
3448
|
# HTTP header 'Content-Type'
|
|
@@ -3512,7 +3512,7 @@ module KlaviyoAPI
|
|
|
3512
3512
|
# header parameters
|
|
3513
3513
|
header_params = opts[:header_params] || {}
|
|
3514
3514
|
# klaviyo api revision
|
|
3515
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3515
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3516
3516
|
# HTTP header 'Accept' (if needed)
|
|
3517
3517
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3518
3518
|
# HTTP header 'Content-Type'
|
|
@@ -3582,7 +3582,7 @@ module KlaviyoAPI
|
|
|
3582
3582
|
# header parameters
|
|
3583
3583
|
header_params = opts[:header_params] || {}
|
|
3584
3584
|
# klaviyo api revision
|
|
3585
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3585
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3586
3586
|
# HTTP header 'Accept' (if needed)
|
|
3587
3587
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3588
3588
|
# HTTP header 'Content-Type'
|
|
@@ -3652,7 +3652,7 @@ module KlaviyoAPI
|
|
|
3652
3652
|
# header parameters
|
|
3653
3653
|
header_params = opts[:header_params] || {}
|
|
3654
3654
|
# klaviyo api revision
|
|
3655
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3655
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3656
3656
|
# HTTP header 'Accept' (if needed)
|
|
3657
3657
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3658
3658
|
# HTTP header 'Content-Type'
|
|
@@ -3692,7 +3692,7 @@ module KlaviyoAPI
|
|
|
3692
3692
|
|
|
3693
3693
|
# Update Catalog Category
|
|
3694
3694
|
# Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
|
3695
|
-
# @param id [String]
|
|
3695
|
+
# @param 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.
|
|
3696
3696
|
# @param catalog_category_update_query [CatalogCategoryUpdateQuery]
|
|
3697
3697
|
# @param [Hash] opts the optional parameters
|
|
3698
3698
|
# @return [Hash<String, Object>]
|
|
@@ -3703,7 +3703,7 @@ module KlaviyoAPI
|
|
|
3703
3703
|
|
|
3704
3704
|
# Update Catalog Category
|
|
3705
3705
|
# Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
|
3706
|
-
# @param id [String]
|
|
3706
|
+
# @param 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.
|
|
3707
3707
|
# @param catalog_category_update_query [CatalogCategoryUpdateQuery]
|
|
3708
3708
|
# @param [Hash] opts the optional parameters
|
|
3709
3709
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -3728,7 +3728,7 @@ module KlaviyoAPI
|
|
|
3728
3728
|
# header parameters
|
|
3729
3729
|
header_params = opts[:header_params] || {}
|
|
3730
3730
|
# klaviyo api revision
|
|
3731
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3731
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3732
3732
|
# HTTP header 'Accept' (if needed)
|
|
3733
3733
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3734
3734
|
# HTTP header 'Content-Type'
|
|
@@ -3815,7 +3815,7 @@ module KlaviyoAPI
|
|
|
3815
3815
|
# header parameters
|
|
3816
3816
|
header_params = opts[:header_params] || {}
|
|
3817
3817
|
# klaviyo api revision
|
|
3818
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3818
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3819
3819
|
# HTTP header 'Accept' (if needed)
|
|
3820
3820
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3821
3821
|
# HTTP header 'Content-Type'
|
|
@@ -3855,7 +3855,7 @@ module KlaviyoAPI
|
|
|
3855
3855
|
|
|
3856
3856
|
# Update Catalog Item
|
|
3857
3857
|
# Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
|
3858
|
-
# @param id [String]
|
|
3858
|
+
# @param 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.
|
|
3859
3859
|
# @param catalog_item_update_query [CatalogItemUpdateQuery]
|
|
3860
3860
|
# @param [Hash] opts the optional parameters
|
|
3861
3861
|
# @return [Hash<String, Object>]
|
|
@@ -3866,7 +3866,7 @@ module KlaviyoAPI
|
|
|
3866
3866
|
|
|
3867
3867
|
# Update Catalog Item
|
|
3868
3868
|
# Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
|
3869
|
-
# @param id [String]
|
|
3869
|
+
# @param 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.
|
|
3870
3870
|
# @param catalog_item_update_query [CatalogItemUpdateQuery]
|
|
3871
3871
|
# @param [Hash] opts the optional parameters
|
|
3872
3872
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -3891,7 +3891,7 @@ module KlaviyoAPI
|
|
|
3891
3891
|
# header parameters
|
|
3892
3892
|
header_params = opts[:header_params] || {}
|
|
3893
3893
|
# klaviyo api revision
|
|
3894
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3894
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3895
3895
|
# HTTP header 'Accept' (if needed)
|
|
3896
3896
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3897
3897
|
# HTTP header 'Content-Type'
|
|
@@ -3978,7 +3978,7 @@ module KlaviyoAPI
|
|
|
3978
3978
|
# header parameters
|
|
3979
3979
|
header_params = opts[:header_params] || {}
|
|
3980
3980
|
# klaviyo api revision
|
|
3981
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
3981
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
3982
3982
|
# HTTP header 'Accept' (if needed)
|
|
3983
3983
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3984
3984
|
# HTTP header 'Content-Type'
|
|
@@ -4018,7 +4018,7 @@ module KlaviyoAPI
|
|
|
4018
4018
|
|
|
4019
4019
|
# Update Catalog Variant
|
|
4020
4020
|
# Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
|
4021
|
-
# @param id [String]
|
|
4021
|
+
# @param 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.
|
|
4022
4022
|
# @param catalog_variant_update_query [CatalogVariantUpdateQuery]
|
|
4023
4023
|
# @param [Hash] opts the optional parameters
|
|
4024
4024
|
# @return [Hash<String, Object>]
|
|
@@ -4029,7 +4029,7 @@ module KlaviyoAPI
|
|
|
4029
4029
|
|
|
4030
4030
|
# Update Catalog Variant
|
|
4031
4031
|
# Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
|
4032
|
-
# @param id [String]
|
|
4032
|
+
# @param 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.
|
|
4033
4033
|
# @param catalog_variant_update_query [CatalogVariantUpdateQuery]
|
|
4034
4034
|
# @param [Hash] opts the optional parameters
|
|
4035
4035
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -4054,7 +4054,7 @@ module KlaviyoAPI
|
|
|
4054
4054
|
# header parameters
|
|
4055
4055
|
header_params = opts[:header_params] || {}
|
|
4056
4056
|
# klaviyo api revision
|
|
4057
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
|
4057
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
|
|
4058
4058
|
# HTTP header 'Accept' (if needed)
|
|
4059
4059
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4060
4060
|
# HTTP header 'Content-Type'
|