klaviyo-api-sdk 1.0.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 +7 -0
- data/CHANGELOG.md +17 -0
- data/Gemfile +9 -0
- data/LICENSE.md +21 -0
- data/README.md +1316 -0
- data/Rakefile +10 -0
- data/docs/CatalogCategoryCreateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateQueryAsSubResource.md +22 -0
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +24 -0
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryItemOp.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryUpdateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +24 -0
- data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemCategoryOp.md +18 -0
- data/docs/CatalogItemCreateJobCreateQuery.md +18 -0
- data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemCreateQuery.md +18 -0
- data/docs/CatalogItemCreateQueryAsSubResource.md +22 -0
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +38 -0
- data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md +18 -0
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md +18 -0
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemDeleteQueryAsSubResource.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemUpdateQuery.md +18 -0
- data/docs/CatalogItemUpdateQueryAsSubResource.md +24 -0
- data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +32 -0
- data/docs/CatalogJobErrorPayload.md +26 -0
- data/docs/CatalogVariantCreateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogVariantCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateQueryAsSubResource.md +22 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +46 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md +18 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md +18 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogVariantUpdateQuery.md +18 -0
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +22 -0
- data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +38 -0
- data/docs/CatalogsApi.md +4048 -0
- data/docs/ClientApi.md +205 -0
- data/docs/EmailMessageContent.md +24 -0
- data/docs/EmailTrackingOptions.md +24 -0
- data/docs/ErrorSource.md +18 -0
- data/docs/EventCreateQuery.md +18 -0
- data/docs/EventCreateQueryAsSubResource.md +20 -0
- data/docs/EventCreateQueryAsSubResourceAttributes.md +28 -0
- data/docs/EventsApi.md +472 -0
- data/docs/FlowUpdateQuery.md +18 -0
- data/docs/FlowUpdateQueryAsSubResource.md +22 -0
- data/docs/FlowUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/FlowsApi.md +951 -0
- data/docs/GetCatalogItems4XXResponse.md +18 -0
- data/docs/GetCatalogItems4XXResponseErrorsInner.md +26 -0
- data/docs/GetCatalogItems4XXResponseErrorsInnerSource.md +20 -0
- data/docs/IncludedCategories.md +24 -0
- data/docs/IncludedCategoriesAttributes.md +22 -0
- data/docs/IncludedFlowAction.md +24 -0
- data/docs/IncludedFlowActions.md +24 -0
- data/docs/IncludedFlowActionsAttributes.md +32 -0
- data/docs/IncludedFlowActionsAttributesTrackingOptions.md +49 -0
- data/docs/IncludedFlowMessages.md +24 -0
- data/docs/IncludedFlowMessagesAttributes.md +26 -0
- data/docs/IncludedFlowMessagesAttributesContent.md +49 -0
- data/docs/IncludedFlows.md +24 -0
- data/docs/IncludedFlowsAttributes.md +28 -0
- data/docs/IncludedItems.md +24 -0
- data/docs/IncludedItemsAttributes.md +38 -0
- data/docs/IncludedLists.md +24 -0
- data/docs/IncludedListsAttributes.md +22 -0
- data/docs/IncludedMetrics.md +24 -0
- data/docs/IncludedMetricsAttributes.md +24 -0
- data/docs/IncludedProfile.md +24 -0
- data/docs/IncludedProfiles.md +24 -0
- data/docs/IncludedProfilesAttributes.md +44 -0
- data/docs/IncludedSegments.md +24 -0
- data/docs/IncludedVariants.md +24 -0
- data/docs/IncludedVariantsAttributes.md +46 -0
- data/docs/IncludedVariantsLinks.md +18 -0
- data/docs/ListCreateQuery.md +18 -0
- data/docs/ListCreateQueryAsSubResource.md +20 -0
- data/docs/ListCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/ListDeleteQueryAsSubResource.md +20 -0
- data/docs/ListMembersAddQuery.md +18 -0
- data/docs/ListMembersAddQueryDataInner.md +20 -0
- data/docs/ListMembersDeleteQuery.md +18 -0
- data/docs/ListPartialUpdateQuery.md +18 -0
- data/docs/ListPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/ListsApi.md +686 -0
- data/docs/MetricAggregateQuery.md +18 -0
- data/docs/MetricAggregateQueryAsSubResource.md +20 -0
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +36 -0
- data/docs/MetricAggregateRowDTO.md +20 -0
- data/docs/MetricCreateQuery.md +20 -0
- data/docs/MetricsApi.md +233 -0
- data/docs/OnsiteProfileCreateQuery.md +18 -0
- data/docs/OnsiteProfileCreateQueryAsSubResource.md +22 -0
- data/docs/OnsiteProfileMeta.md +18 -0
- data/docs/OnsiteProfileMetaIdentifiers.md +28 -0
- data/docs/OnsiteSubscriptionCreateQuery.md +18 -0
- data/docs/OnsiteSubscriptionCreateQueryAsSubResource.md +20 -0
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +26 -0
- data/docs/ProfileCreateQuery.md +18 -0
- data/docs/ProfileCreateQueryAsSubResource.md +20 -0
- data/docs/ProfileCreateQueryAsSubResourceAttributes.md +38 -0
- data/docs/ProfileLocation.md +34 -0
- data/docs/ProfileLocationLatitude.md +49 -0
- data/docs/ProfilePartialUpdateQuery.md +18 -0
- data/docs/ProfilePartialUpdateQueryAsSubResource.md +22 -0
- data/docs/ProfilesApi.md +825 -0
- data/docs/SMSMessageContent.md +20 -0
- data/docs/SMSRenderOptions.md +24 -0
- data/docs/SMSTrackingOptions.md +20 -0
- data/docs/SegmentPartialUpdateQuery.md +18 -0
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/SegmentsApi.md +390 -0
- data/docs/SendOptions.md +20 -0
- data/docs/Subscription.md +20 -0
- data/docs/SubscriptionCreateJobCreateQuery.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +22 -0
- data/docs/Suppression.md +18 -0
- data/docs/SuppressionCreateJobCreateQuery.md +18 -0
- data/docs/SuppressionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/TemplateCloneQuery.md +18 -0
- data/docs/TemplateCloneQueryAsSubResource.md +20 -0
- data/docs/TemplateCloneQueryAsSubResourceAttributes.md +20 -0
- data/docs/TemplateCreateQuery.md +18 -0
- data/docs/TemplateCreateQueryAsSubResource.md +20 -0
- data/docs/TemplateCreateQueryAsSubResourceAttributes.md +26 -0
- data/docs/TemplateDeleteQueryAsSubResource.md +20 -0
- data/docs/TemplateUpdateQuery.md +18 -0
- data/docs/TemplateUpdateQueryAsSubResource.md +22 -0
- data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +24 -0
- data/docs/TemplatesApi.md +529 -0
- data/docs/UnsubscriptionCreateJobCreateQuery.md +18 -0
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +22 -0
- data/docs/UnsuppressionCreateJobCreateQuery.md +18 -0
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/UtmParamInfo.md +20 -0
- data/docs/V2TemplateRenderQuery.md +18 -0
- data/docs/V2TemplateRenderQueryAsSubResource.md +20 -0
- data/docs/V2TemplateRenderQueryAsSubResourceAttributes.md +20 -0
- data/git_push.sh +57 -0
- data/klaviyo-api-sdk.gemspec +40 -0
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +4095 -0
- data/lib/klaviyo-api-sdk/api/client_api.rb +249 -0
- data/lib/klaviyo-api-sdk/api/events_api.rb +505 -0
- data/lib/klaviyo-api-sdk/api/flows_api.rb +1009 -0
- data/lib/klaviyo-api-sdk/api/lists_api.rb +708 -0
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +236 -0
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +840 -0
- data/lib/klaviyo-api-sdk/api/segments_api.rb +392 -0
- data/lib/klaviyo-api-sdk/api/templates_api.rb +536 -0
- data/lib/klaviyo-api-sdk/api_client.rb +390 -0
- data/lib/klaviyo-api-sdk/api_error.rb +57 -0
- data/lib/klaviyo-api-sdk/configuration.rb +283 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +291 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +295 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +366 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +295 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +284 -0
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +280 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +435 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +346 -0
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +266 -0
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +268 -0
- data/lib/klaviyo-api-sdk/models/error_source.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +279 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +226 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +275 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +228 -0
- data/lib/klaviyo-api-sdk/models/included_categories.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +282 -0
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +105 -0
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +270 -0
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +105 -0
- data/lib/klaviyo-api-sdk/models/included_flows.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +264 -0
- data/lib/klaviyo-api-sdk/models/included_items.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +311 -0
- data/lib/klaviyo-api-sdk/models/included_lists.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +246 -0
- data/lib/klaviyo-api-sdk/models/included_profile.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +336 -0
- data/lib/klaviyo-api-sdk/models/included_segments.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_variants.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +382 -0
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +226 -0
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +226 -0
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +380 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +240 -0
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +233 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +264 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +260 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +309 -0
- data/lib/klaviyo-api-sdk/models/profile_location.rb +291 -0
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +105 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/send_options.rb +238 -0
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +238 -0
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +266 -0
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +240 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +228 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +249 -0
- data/lib/klaviyo-api-sdk/models/suppression.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +267 -0
- data/lib/klaviyo-api-sdk/models/template_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +248 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +246 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +238 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/version.rb +15 -0
- data/lib/klaviyo-api-sdk.rb +253 -0
- data/spec/api/catalogs_api_spec.rb +759 -0
- data/spec/api/client_api_spec.rb +74 -0
- data/spec/api/events_api_spec.rb +120 -0
- data/spec/api/flows_api_spec.rb +209 -0
- data/spec/api/lists_api_spec.rb +156 -0
- data/spec/api/metrics_api_spec.rb +74 -0
- data/spec/api/profiles_api_spec.rb +178 -0
- data/spec/api/segments_api_spec.rb +103 -0
- data/spec/api/templates_api_spec.rb +126 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +56 -0
- data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_category_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_item_op_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +56 -0
- data/spec/models/catalog_category_update_query_spec.rb +34 -0
- data/spec/models/catalog_item_category_op_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +98 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +44 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_item_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +76 -0
- data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +56 -0
- data/spec/models/catalog_item_update_query_spec.rb +34 -0
- data/spec/models/catalog_job_error_payload_spec.rb +58 -0
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +126 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +44 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_variant_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +98 -0
- data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_variant_update_query_spec.rb +34 -0
- data/spec/models/email_message_content_spec.rb +52 -0
- data/spec/models/email_tracking_options_spec.rb +52 -0
- data/spec/models/error_source_spec.rb +34 -0
- data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +64 -0
- data/spec/models/event_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/event_create_query_spec.rb +34 -0
- data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/flow_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/flow_update_query_spec.rb +34 -0
- data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +40 -0
- data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +58 -0
- data/spec/models/get_catalog_items4_xx_response_spec.rb +34 -0
- data/spec/models/included_categories_attributes_spec.rb +46 -0
- data/spec/models/included_categories_spec.rb +56 -0
- data/spec/models/included_flow_action_spec.rb +56 -0
- data/spec/models/included_flow_actions_attributes_spec.rb +76 -0
- data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +31 -0
- data/spec/models/included_flow_actions_spec.rb +56 -0
- data/spec/models/included_flow_messages_attributes_content_spec.rb +31 -0
- data/spec/models/included_flow_messages_attributes_spec.rb +58 -0
- data/spec/models/included_flow_messages_spec.rb +56 -0
- data/spec/models/included_flows_attributes_spec.rb +64 -0
- data/spec/models/included_flows_spec.rb +56 -0
- data/spec/models/included_items_attributes_spec.rb +94 -0
- data/spec/models/included_items_spec.rb +56 -0
- data/spec/models/included_lists_attributes_spec.rb +46 -0
- data/spec/models/included_lists_spec.rb +56 -0
- data/spec/models/included_metrics_attributes_spec.rb +52 -0
- data/spec/models/included_metrics_spec.rb +56 -0
- data/spec/models/included_profile_spec.rb +56 -0
- data/spec/models/included_profiles_attributes_spec.rb +112 -0
- data/spec/models/included_profiles_spec.rb +56 -0
- data/spec/models/included_segments_spec.rb +56 -0
- data/spec/models/included_variants_attributes_spec.rb +122 -0
- data/spec/models/included_variants_links_spec.rb +34 -0
- data/spec/models/included_variants_spec.rb +56 -0
- data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/list_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/list_create_query_spec.rb +34 -0
- data/spec/models/list_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/list_members_add_query_data_inner_spec.rb +44 -0
- data/spec/models/list_members_add_query_spec.rb +34 -0
- data/spec/models/list_members_delete_query_spec.rb +34 -0
- data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/list_partial_update_query_spec.rb +34 -0
- data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +104 -0
- data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/metric_aggregate_query_spec.rb +34 -0
- data/spec/models/metric_aggregate_row_dto_spec.rb +40 -0
- data/spec/models/metric_create_query_spec.rb +40 -0
- data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/onsite_profile_create_query_spec.rb +34 -0
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +64 -0
- data/spec/models/onsite_profile_meta_spec.rb +34 -0
- data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +58 -0
- data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/onsite_subscription_create_query_spec.rb +34 -0
- data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +94 -0
- data/spec/models/profile_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/profile_create_query_spec.rb +34 -0
- data/spec/models/profile_location_latitude_spec.rb +31 -0
- data/spec/models/profile_location_spec.rb +82 -0
- data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/profile_partial_update_query_spec.rb +34 -0
- data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/segment_partial_update_query_spec.rb +34 -0
- data/spec/models/send_options_spec.rb +40 -0
- data/spec/models/sms_message_content_spec.rb +40 -0
- data/spec/models/sms_render_options_spec.rb +52 -0
- data/spec/models/sms_tracking_options_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/subscription_create_job_create_query_spec.rb +34 -0
- data/spec/models/subscription_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/suppression_create_job_create_query_spec.rb +34 -0
- data/spec/models/suppression_spec.rb +34 -0
- data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/template_clone_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/template_clone_query_spec.rb +34 -0
- data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +58 -0
- data/spec/models/template_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/template_create_query_spec.rb +34 -0
- data/spec/models/template_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +52 -0
- data/spec/models/template_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/template_update_query_spec.rb +34 -0
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/unsubscription_create_job_create_query_spec.rb +34 -0
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/unsuppression_create_job_create_query_spec.rb +34 -0
- data/spec/models/utm_param_info_spec.rb +40 -0
- data/spec/models/v2_template_render_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/v2_template_render_query_spec.rb +34 -0
- data/spec/spec_helper.rb +111 -0
- metadata +583 -0
data/docs/CatalogsApi.md
ADDED
@@ -0,0 +1,4048 @@
|
|
1
|
+
# KlaviyoAPI::CatalogsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://a.klaviyo.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_catalog_category**](CatalogsApi.md#create_catalog_category) | **POST** /api/catalog-categories/ | Create Catalog Category |
|
8
|
+
| [**create_catalog_category_relationships**](CatalogsApi.md#create_catalog_category_relationships) | **POST** /api/catalog-categories/{id}/relationships/{related_resource}/ | Create Catalog Category Relationships |
|
9
|
+
| [**create_catalog_item**](CatalogsApi.md#create_catalog_item) | **POST** /api/catalog-items/ | Create Catalog Item |
|
10
|
+
| [**create_catalog_item_relationships**](CatalogsApi.md#create_catalog_item_relationships) | **POST** /api/catalog-items/{id}/relationships/{related_resource}/ | Create Catalog Item Relationships |
|
11
|
+
| [**create_catalog_variant**](CatalogsApi.md#create_catalog_variant) | **POST** /api/catalog-variants/ | Create Catalog Variant |
|
12
|
+
| [**delete_catalog_category**](CatalogsApi.md#delete_catalog_category) | **DELETE** /api/catalog-categories/{id}/ | Delete Catalog Category |
|
13
|
+
| [**delete_catalog_category_relationships**](CatalogsApi.md#delete_catalog_category_relationships) | **DELETE** /api/catalog-categories/{id}/relationships/{related_resource}/ | Delete Catalog Category Relationships |
|
14
|
+
| [**delete_catalog_item**](CatalogsApi.md#delete_catalog_item) | **DELETE** /api/catalog-items/{id}/ | Delete Catalog Item |
|
15
|
+
| [**delete_catalog_item_relationships**](CatalogsApi.md#delete_catalog_item_relationships) | **DELETE** /api/catalog-items/{id}/relationships/{related_resource}/ | Delete Catalog Item Relationships |
|
16
|
+
| [**delete_catalog_variant**](CatalogsApi.md#delete_catalog_variant) | **DELETE** /api/catalog-variants/{id}/ | Delete Catalog Variant |
|
17
|
+
| [**get_catalog_categories**](CatalogsApi.md#get_catalog_categories) | **GET** /api/catalog-categories/ | Get Catalog Categories |
|
18
|
+
| [**get_catalog_category**](CatalogsApi.md#get_catalog_category) | **GET** /api/catalog-categories/{id}/ | Get Catalog Category |
|
19
|
+
| [**get_catalog_category_items**](CatalogsApi.md#get_catalog_category_items) | **GET** /api/catalog-categories/{category_id}/items/ | Get Catalog Category Items |
|
20
|
+
| [**get_catalog_category_relationships**](CatalogsApi.md#get_catalog_category_relationships) | **GET** /api/catalog-categories/{id}/relationships/{related_resource}/ | Get Catalog Category Relationships |
|
21
|
+
| [**get_catalog_item**](CatalogsApi.md#get_catalog_item) | **GET** /api/catalog-items/{id}/ | Get Catalog Item |
|
22
|
+
| [**get_catalog_item_categories**](CatalogsApi.md#get_catalog_item_categories) | **GET** /api/catalog-items/{item_id}/categories/ | Get Catalog Item Categories |
|
23
|
+
| [**get_catalog_item_relationships**](CatalogsApi.md#get_catalog_item_relationships) | **GET** /api/catalog-items/{id}/relationships/{related_resource}/ | Get Catalog Item Relationships |
|
24
|
+
| [**get_catalog_item_variants**](CatalogsApi.md#get_catalog_item_variants) | **GET** /api/catalog-items/{item_id}/variants/ | Get Catalog Item Variants |
|
25
|
+
| [**get_catalog_items**](CatalogsApi.md#get_catalog_items) | **GET** /api/catalog-items/ | Get Catalog Items |
|
26
|
+
| [**get_catalog_variant**](CatalogsApi.md#get_catalog_variant) | **GET** /api/catalog-variants/{id}/ | Get Catalog Variant |
|
27
|
+
| [**get_catalog_variants**](CatalogsApi.md#get_catalog_variants) | **GET** /api/catalog-variants/ | Get Catalog Variants |
|
28
|
+
| [**get_create_categories_job**](CatalogsApi.md#get_create_categories_job) | **GET** /api/catalog-category-bulk-create-jobs/{job_id}/ | Get Create Categories Job |
|
29
|
+
| [**get_create_categories_jobs**](CatalogsApi.md#get_create_categories_jobs) | **GET** /api/catalog-category-bulk-create-jobs/ | Get Create Categories Jobs |
|
30
|
+
| [**get_create_items_job**](CatalogsApi.md#get_create_items_job) | **GET** /api/catalog-item-bulk-create-jobs/{job_id}/ | Get Create Items Job |
|
31
|
+
| [**get_create_items_jobs**](CatalogsApi.md#get_create_items_jobs) | **GET** /api/catalog-item-bulk-create-jobs/ | Get Create Items Jobs |
|
32
|
+
| [**get_create_variants_job**](CatalogsApi.md#get_create_variants_job) | **GET** /api/catalog-variant-bulk-create-jobs/{job_id}/ | Get Create Variants Job |
|
33
|
+
| [**get_create_variants_jobs**](CatalogsApi.md#get_create_variants_jobs) | **GET** /api/catalog-variant-bulk-create-jobs/ | Get Create Variants Jobs |
|
34
|
+
| [**get_delete_categories_job**](CatalogsApi.md#get_delete_categories_job) | **GET** /api/catalog-category-bulk-delete-jobs/{job_id}/ | Get Delete Categories Job |
|
35
|
+
| [**get_delete_categories_jobs**](CatalogsApi.md#get_delete_categories_jobs) | **GET** /api/catalog-category-bulk-delete-jobs/ | Get Delete Categories Jobs |
|
36
|
+
| [**get_delete_items_job**](CatalogsApi.md#get_delete_items_job) | **GET** /api/catalog-item-bulk-delete-jobs/{job_id}/ | Get Delete Items Job |
|
37
|
+
| [**get_delete_items_jobs**](CatalogsApi.md#get_delete_items_jobs) | **GET** /api/catalog-item-bulk-delete-jobs/ | Get Delete Items Jobs |
|
38
|
+
| [**get_delete_variants_job**](CatalogsApi.md#get_delete_variants_job) | **GET** /api/catalog-variant-bulk-delete-jobs/{job_id}/ | Get Delete Variants Job |
|
39
|
+
| [**get_delete_variants_jobs**](CatalogsApi.md#get_delete_variants_jobs) | **GET** /api/catalog-variant-bulk-delete-jobs/ | Get Delete Variants Jobs |
|
40
|
+
| [**get_update_categories_job**](CatalogsApi.md#get_update_categories_job) | **GET** /api/catalog-category-bulk-update-jobs/{job_id}/ | Get Update Categories Job |
|
41
|
+
| [**get_update_categories_jobs**](CatalogsApi.md#get_update_categories_jobs) | **GET** /api/catalog-category-bulk-update-jobs/ | Get Update Categories Jobs |
|
42
|
+
| [**get_update_items_job**](CatalogsApi.md#get_update_items_job) | **GET** /api/catalog-item-bulk-update-jobs/{job_id}/ | Get Update Items Job |
|
43
|
+
| [**get_update_items_jobs**](CatalogsApi.md#get_update_items_jobs) | **GET** /api/catalog-item-bulk-update-jobs/ | Get Update Items Jobs |
|
44
|
+
| [**get_update_variants_job**](CatalogsApi.md#get_update_variants_job) | **GET** /api/catalog-variant-bulk-update-jobs/{job_id}/ | Get Update Variants Job |
|
45
|
+
| [**get_update_variants_jobs**](CatalogsApi.md#get_update_variants_jobs) | **GET** /api/catalog-variant-bulk-update-jobs/ | Get Update Variants Jobs |
|
46
|
+
| [**spawn_create_categories_job**](CatalogsApi.md#spawn_create_categories_job) | **POST** /api/catalog-category-bulk-create-jobs/ | Spawn Create Categories Job |
|
47
|
+
| [**spawn_create_items_job**](CatalogsApi.md#spawn_create_items_job) | **POST** /api/catalog-item-bulk-create-jobs/ | Spawn Create Items Job |
|
48
|
+
| [**spawn_create_variants_job**](CatalogsApi.md#spawn_create_variants_job) | **POST** /api/catalog-variant-bulk-create-jobs/ | Spawn Create Variants Job |
|
49
|
+
| [**spawn_delete_categories_job**](CatalogsApi.md#spawn_delete_categories_job) | **POST** /api/catalog-category-bulk-delete-jobs/ | Spawn Delete Categories Job |
|
50
|
+
| [**spawn_delete_items_job**](CatalogsApi.md#spawn_delete_items_job) | **POST** /api/catalog-item-bulk-delete-jobs/ | Spawn Delete Items Job |
|
51
|
+
| [**spawn_delete_variants_job**](CatalogsApi.md#spawn_delete_variants_job) | **POST** /api/catalog-variant-bulk-delete-jobs/ | Spawn Delete Variants Job |
|
52
|
+
| [**spawn_update_categories_job**](CatalogsApi.md#spawn_update_categories_job) | **POST** /api/catalog-category-bulk-update-jobs/ | Spawn Update Categories Job |
|
53
|
+
| [**spawn_update_items_job**](CatalogsApi.md#spawn_update_items_job) | **POST** /api/catalog-item-bulk-update-jobs/ | Spawn Update Items Job |
|
54
|
+
| [**spawn_update_variants_job**](CatalogsApi.md#spawn_update_variants_job) | **POST** /api/catalog-variant-bulk-update-jobs/ | Spawn Update Variants Job |
|
55
|
+
| [**update_catalog_category**](CatalogsApi.md#update_catalog_category) | **PATCH** /api/catalog-categories/{id}/ | Update Catalog Category |
|
56
|
+
| [**update_catalog_category_relationships**](CatalogsApi.md#update_catalog_category_relationships) | **PATCH** /api/catalog-categories/{id}/relationships/{related_resource}/ | Update Catalog Category Relationships |
|
57
|
+
| [**update_catalog_item**](CatalogsApi.md#update_catalog_item) | **PATCH** /api/catalog-items/{id}/ | Update Catalog Item |
|
58
|
+
| [**update_catalog_item_relationships**](CatalogsApi.md#update_catalog_item_relationships) | **PATCH** /api/catalog-items/{id}/relationships/{related_resource}/ | Update Catalog Item Relationships |
|
59
|
+
| [**update_catalog_variant**](CatalogsApi.md#update_catalog_variant) | **PATCH** /api/catalog-variants/{id}/ | Update Catalog Variant |
|
60
|
+
|
61
|
+
|
62
|
+
## create_catalog_category
|
63
|
+
|
64
|
+
> Hash<String, Object> create_catalog_category(catalog_category_create_query)
|
65
|
+
|
66
|
+
Create Catalog Category
|
67
|
+
|
68
|
+
Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
69
|
+
|
70
|
+
### Examples
|
71
|
+
|
72
|
+
```ruby
|
73
|
+
require 'time'
|
74
|
+
require 'klaviyo-api-sdk'
|
75
|
+
# setup authorization
|
76
|
+
KlaviyoAPI.configure do |config|
|
77
|
+
# Configure API key authorization: Klaviyo-API-Key
|
78
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
79
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
80
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
81
|
+
end
|
82
|
+
|
83
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
84
|
+
catalog_category_create_query = KlaviyoAPI::CatalogCategoryCreateQuery.new({data: KlaviyoAPI::CatalogCategoryCreateQueryAsSubResource.new({type: 'catalog-category', attributes: KlaviyoAPI::CatalogCategoryCreateQueryAsSubResourceAttributes.new({external_id: 'external_id_example', name: 'name_example'})})}) # CatalogCategoryCreateQuery |
|
85
|
+
|
86
|
+
begin
|
87
|
+
# Create Catalog Category
|
88
|
+
result = api_instance.create_catalog_category(catalog_category_create_query)
|
89
|
+
p result
|
90
|
+
rescue KlaviyoAPI::ApiError => e
|
91
|
+
puts "Error when calling CatalogsApi->create_catalog_category: #{e}"
|
92
|
+
end
|
93
|
+
```
|
94
|
+
|
95
|
+
#### Using the create_catalog_category_with_http_info variant
|
96
|
+
|
97
|
+
This returns an Array which contains the response data, status code and headers.
|
98
|
+
|
99
|
+
> <Array(Hash<String, Object>, Integer, Hash)> create_catalog_category_with_http_info(catalog_category_create_query)
|
100
|
+
|
101
|
+
```ruby
|
102
|
+
begin
|
103
|
+
# Create Catalog Category
|
104
|
+
data, status_code, headers = api_instance.create_catalog_category_with_http_info(catalog_category_create_query)
|
105
|
+
p status_code # => 2xx
|
106
|
+
p headers # => { ... }
|
107
|
+
p data # => Hash<String, Object>
|
108
|
+
rescue KlaviyoAPI::ApiError => e
|
109
|
+
puts "Error when calling CatalogsApi->create_catalog_category_with_http_info: #{e}"
|
110
|
+
end
|
111
|
+
```
|
112
|
+
|
113
|
+
### Parameters
|
114
|
+
|
115
|
+
| Name | Type | Description | Notes |
|
116
|
+
| ---- | ---- | ----------- | ----- |
|
117
|
+
| **catalog_category_create_query** | [**CatalogCategoryCreateQuery**](CatalogCategoryCreateQuery.md) | | |
|
118
|
+
|
119
|
+
### Return type
|
120
|
+
|
121
|
+
**Hash<String, Object>**
|
122
|
+
|
123
|
+
### Authorization
|
124
|
+
|
125
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
126
|
+
|
127
|
+
### HTTP request headers
|
128
|
+
|
129
|
+
- **Content-Type**: application/json
|
130
|
+
- **Accept**: application/json
|
131
|
+
|
132
|
+
|
133
|
+
## create_catalog_category_relationships
|
134
|
+
|
135
|
+
> create_catalog_category_relationships(id, related_resource, catalog_category_item_op)
|
136
|
+
|
137
|
+
Create Catalog Category Relationships
|
138
|
+
|
139
|
+
Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
140
|
+
|
141
|
+
### Examples
|
142
|
+
|
143
|
+
```ruby
|
144
|
+
require 'time'
|
145
|
+
require 'klaviyo-api-sdk'
|
146
|
+
# setup authorization
|
147
|
+
KlaviyoAPI.configure do |config|
|
148
|
+
# Configure API key authorization: Klaviyo-API-Key
|
149
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
150
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
151
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
152
|
+
end
|
153
|
+
|
154
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
155
|
+
id = 'id_example' # String |
|
156
|
+
related_resource = 'items' # String |
|
157
|
+
catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
|
158
|
+
|
159
|
+
begin
|
160
|
+
# Create Catalog Category Relationships
|
161
|
+
api_instance.create_catalog_category_relationships(id, related_resource, catalog_category_item_op)
|
162
|
+
rescue KlaviyoAPI::ApiError => e
|
163
|
+
puts "Error when calling CatalogsApi->create_catalog_category_relationships: #{e}"
|
164
|
+
end
|
165
|
+
```
|
166
|
+
|
167
|
+
#### Using the create_catalog_category_relationships_with_http_info variant
|
168
|
+
|
169
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
170
|
+
|
171
|
+
> <Array(nil, Integer, Hash)> create_catalog_category_relationships_with_http_info(id, related_resource, catalog_category_item_op)
|
172
|
+
|
173
|
+
```ruby
|
174
|
+
begin
|
175
|
+
# Create Catalog Category Relationships
|
176
|
+
data, status_code, headers = api_instance.create_catalog_category_relationships_with_http_info(id, related_resource, catalog_category_item_op)
|
177
|
+
p status_code # => 2xx
|
178
|
+
p headers # => { ... }
|
179
|
+
p data # => nil
|
180
|
+
rescue KlaviyoAPI::ApiError => e
|
181
|
+
puts "Error when calling CatalogsApi->create_catalog_category_relationships_with_http_info: #{e}"
|
182
|
+
end
|
183
|
+
```
|
184
|
+
|
185
|
+
### Parameters
|
186
|
+
|
187
|
+
| Name | Type | Description | Notes |
|
188
|
+
| ---- | ---- | ----------- | ----- |
|
189
|
+
| **id** | **String** | | |
|
190
|
+
| **related_resource** | **String** | | |
|
191
|
+
| **catalog_category_item_op** | [**CatalogCategoryItemOp**](CatalogCategoryItemOp.md) | | |
|
192
|
+
|
193
|
+
### Return type
|
194
|
+
|
195
|
+
nil (empty response body)
|
196
|
+
|
197
|
+
### Authorization
|
198
|
+
|
199
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
200
|
+
|
201
|
+
### HTTP request headers
|
202
|
+
|
203
|
+
- **Content-Type**: application/json
|
204
|
+
- **Accept**: application/json
|
205
|
+
|
206
|
+
|
207
|
+
## create_catalog_item
|
208
|
+
|
209
|
+
> Hash<String, Object> create_catalog_item(catalog_item_create_query)
|
210
|
+
|
211
|
+
Create Catalog Item
|
212
|
+
|
213
|
+
Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
214
|
+
|
215
|
+
### Examples
|
216
|
+
|
217
|
+
```ruby
|
218
|
+
require 'time'
|
219
|
+
require 'klaviyo-api-sdk'
|
220
|
+
# setup authorization
|
221
|
+
KlaviyoAPI.configure do |config|
|
222
|
+
# Configure API key authorization: Klaviyo-API-Key
|
223
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
224
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
225
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
226
|
+
end
|
227
|
+
|
228
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
229
|
+
catalog_item_create_query = KlaviyoAPI::CatalogItemCreateQuery.new({data: KlaviyoAPI::CatalogItemCreateQueryAsSubResource.new({type: 'catalog-item', attributes: KlaviyoAPI::CatalogItemCreateQueryAsSubResourceAttributes.new({external_id: 'external_id_example', title: 'title_example', description: 'description_example', url: 'url_example'})})}) # CatalogItemCreateQuery |
|
230
|
+
|
231
|
+
begin
|
232
|
+
# Create Catalog Item
|
233
|
+
result = api_instance.create_catalog_item(catalog_item_create_query)
|
234
|
+
p result
|
235
|
+
rescue KlaviyoAPI::ApiError => e
|
236
|
+
puts "Error when calling CatalogsApi->create_catalog_item: #{e}"
|
237
|
+
end
|
238
|
+
```
|
239
|
+
|
240
|
+
#### Using the create_catalog_item_with_http_info variant
|
241
|
+
|
242
|
+
This returns an Array which contains the response data, status code and headers.
|
243
|
+
|
244
|
+
> <Array(Hash<String, Object>, Integer, Hash)> create_catalog_item_with_http_info(catalog_item_create_query)
|
245
|
+
|
246
|
+
```ruby
|
247
|
+
begin
|
248
|
+
# Create Catalog Item
|
249
|
+
data, status_code, headers = api_instance.create_catalog_item_with_http_info(catalog_item_create_query)
|
250
|
+
p status_code # => 2xx
|
251
|
+
p headers # => { ... }
|
252
|
+
p data # => Hash<String, Object>
|
253
|
+
rescue KlaviyoAPI::ApiError => e
|
254
|
+
puts "Error when calling CatalogsApi->create_catalog_item_with_http_info: #{e}"
|
255
|
+
end
|
256
|
+
```
|
257
|
+
|
258
|
+
### Parameters
|
259
|
+
|
260
|
+
| Name | Type | Description | Notes |
|
261
|
+
| ---- | ---- | ----------- | ----- |
|
262
|
+
| **catalog_item_create_query** | [**CatalogItemCreateQuery**](CatalogItemCreateQuery.md) | | |
|
263
|
+
|
264
|
+
### Return type
|
265
|
+
|
266
|
+
**Hash<String, Object>**
|
267
|
+
|
268
|
+
### Authorization
|
269
|
+
|
270
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
271
|
+
|
272
|
+
### HTTP request headers
|
273
|
+
|
274
|
+
- **Content-Type**: application/json
|
275
|
+
- **Accept**: application/json
|
276
|
+
|
277
|
+
|
278
|
+
## create_catalog_item_relationships
|
279
|
+
|
280
|
+
> create_catalog_item_relationships(id, related_resource, catalog_item_category_op)
|
281
|
+
|
282
|
+
Create Catalog Item Relationships
|
283
|
+
|
284
|
+
Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
285
|
+
|
286
|
+
### Examples
|
287
|
+
|
288
|
+
```ruby
|
289
|
+
require 'time'
|
290
|
+
require 'klaviyo-api-sdk'
|
291
|
+
# setup authorization
|
292
|
+
KlaviyoAPI.configure do |config|
|
293
|
+
# Configure API key authorization: Klaviyo-API-Key
|
294
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
295
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
296
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
297
|
+
end
|
298
|
+
|
299
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
300
|
+
id = 'id_example' # String |
|
301
|
+
related_resource = 'categories' # String |
|
302
|
+
catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
|
303
|
+
|
304
|
+
begin
|
305
|
+
# Create Catalog Item Relationships
|
306
|
+
api_instance.create_catalog_item_relationships(id, related_resource, catalog_item_category_op)
|
307
|
+
rescue KlaviyoAPI::ApiError => e
|
308
|
+
puts "Error when calling CatalogsApi->create_catalog_item_relationships: #{e}"
|
309
|
+
end
|
310
|
+
```
|
311
|
+
|
312
|
+
#### Using the create_catalog_item_relationships_with_http_info variant
|
313
|
+
|
314
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
315
|
+
|
316
|
+
> <Array(nil, Integer, Hash)> create_catalog_item_relationships_with_http_info(id, related_resource, catalog_item_category_op)
|
317
|
+
|
318
|
+
```ruby
|
319
|
+
begin
|
320
|
+
# Create Catalog Item Relationships
|
321
|
+
data, status_code, headers = api_instance.create_catalog_item_relationships_with_http_info(id, related_resource, catalog_item_category_op)
|
322
|
+
p status_code # => 2xx
|
323
|
+
p headers # => { ... }
|
324
|
+
p data # => nil
|
325
|
+
rescue KlaviyoAPI::ApiError => e
|
326
|
+
puts "Error when calling CatalogsApi->create_catalog_item_relationships_with_http_info: #{e}"
|
327
|
+
end
|
328
|
+
```
|
329
|
+
|
330
|
+
### Parameters
|
331
|
+
|
332
|
+
| Name | Type | Description | Notes |
|
333
|
+
| ---- | ---- | ----------- | ----- |
|
334
|
+
| **id** | **String** | | |
|
335
|
+
| **related_resource** | **String** | | |
|
336
|
+
| **catalog_item_category_op** | [**CatalogItemCategoryOp**](CatalogItemCategoryOp.md) | | |
|
337
|
+
|
338
|
+
### Return type
|
339
|
+
|
340
|
+
nil (empty response body)
|
341
|
+
|
342
|
+
### Authorization
|
343
|
+
|
344
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
345
|
+
|
346
|
+
### HTTP request headers
|
347
|
+
|
348
|
+
- **Content-Type**: application/json
|
349
|
+
- **Accept**: application/json
|
350
|
+
|
351
|
+
|
352
|
+
## create_catalog_variant
|
353
|
+
|
354
|
+
> Hash<String, Object> create_catalog_variant(catalog_variant_create_query)
|
355
|
+
|
356
|
+
Create Catalog Variant
|
357
|
+
|
358
|
+
Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
359
|
+
|
360
|
+
### Examples
|
361
|
+
|
362
|
+
```ruby
|
363
|
+
require 'time'
|
364
|
+
require 'klaviyo-api-sdk'
|
365
|
+
# setup authorization
|
366
|
+
KlaviyoAPI.configure do |config|
|
367
|
+
# Configure API key authorization: Klaviyo-API-Key
|
368
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
369
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
370
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
371
|
+
end
|
372
|
+
|
373
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
374
|
+
catalog_variant_create_query = KlaviyoAPI::CatalogVariantCreateQuery.new({data: KlaviyoAPI::CatalogVariantCreateQueryAsSubResource.new({type: 'catalog-variant', attributes: KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes.new({external_id: 'external_id_example', title: 'title_example', description: 'description_example', sku: 'sku_example', inventory_policy: 0, inventory_quantity: 3.56, price: 3.56, url: 'url_example'})})}) # CatalogVariantCreateQuery |
|
375
|
+
|
376
|
+
begin
|
377
|
+
# Create Catalog Variant
|
378
|
+
result = api_instance.create_catalog_variant(catalog_variant_create_query)
|
379
|
+
p result
|
380
|
+
rescue KlaviyoAPI::ApiError => e
|
381
|
+
puts "Error when calling CatalogsApi->create_catalog_variant: #{e}"
|
382
|
+
end
|
383
|
+
```
|
384
|
+
|
385
|
+
#### Using the create_catalog_variant_with_http_info variant
|
386
|
+
|
387
|
+
This returns an Array which contains the response data, status code and headers.
|
388
|
+
|
389
|
+
> <Array(Hash<String, Object>, Integer, Hash)> create_catalog_variant_with_http_info(catalog_variant_create_query)
|
390
|
+
|
391
|
+
```ruby
|
392
|
+
begin
|
393
|
+
# Create Catalog Variant
|
394
|
+
data, status_code, headers = api_instance.create_catalog_variant_with_http_info(catalog_variant_create_query)
|
395
|
+
p status_code # => 2xx
|
396
|
+
p headers # => { ... }
|
397
|
+
p data # => Hash<String, Object>
|
398
|
+
rescue KlaviyoAPI::ApiError => e
|
399
|
+
puts "Error when calling CatalogsApi->create_catalog_variant_with_http_info: #{e}"
|
400
|
+
end
|
401
|
+
```
|
402
|
+
|
403
|
+
### Parameters
|
404
|
+
|
405
|
+
| Name | Type | Description | Notes |
|
406
|
+
| ---- | ---- | ----------- | ----- |
|
407
|
+
| **catalog_variant_create_query** | [**CatalogVariantCreateQuery**](CatalogVariantCreateQuery.md) | | |
|
408
|
+
|
409
|
+
### Return type
|
410
|
+
|
411
|
+
**Hash<String, Object>**
|
412
|
+
|
413
|
+
### Authorization
|
414
|
+
|
415
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
416
|
+
|
417
|
+
### HTTP request headers
|
418
|
+
|
419
|
+
- **Content-Type**: application/json
|
420
|
+
- **Accept**: application/json
|
421
|
+
|
422
|
+
|
423
|
+
## delete_catalog_category
|
424
|
+
|
425
|
+
> delete_catalog_category(id)
|
426
|
+
|
427
|
+
Delete Catalog Category
|
428
|
+
|
429
|
+
Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
430
|
+
|
431
|
+
### Examples
|
432
|
+
|
433
|
+
```ruby
|
434
|
+
require 'time'
|
435
|
+
require 'klaviyo-api-sdk'
|
436
|
+
# setup authorization
|
437
|
+
KlaviyoAPI.configure do |config|
|
438
|
+
# Configure API key authorization: Klaviyo-API-Key
|
439
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
440
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
441
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
442
|
+
end
|
443
|
+
|
444
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
445
|
+
id = 'id_example' # String |
|
446
|
+
|
447
|
+
begin
|
448
|
+
# Delete Catalog Category
|
449
|
+
api_instance.delete_catalog_category(id)
|
450
|
+
rescue KlaviyoAPI::ApiError => e
|
451
|
+
puts "Error when calling CatalogsApi->delete_catalog_category: #{e}"
|
452
|
+
end
|
453
|
+
```
|
454
|
+
|
455
|
+
#### Using the delete_catalog_category_with_http_info variant
|
456
|
+
|
457
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
458
|
+
|
459
|
+
> <Array(nil, Integer, Hash)> delete_catalog_category_with_http_info(id)
|
460
|
+
|
461
|
+
```ruby
|
462
|
+
begin
|
463
|
+
# Delete Catalog Category
|
464
|
+
data, status_code, headers = api_instance.delete_catalog_category_with_http_info(id)
|
465
|
+
p status_code # => 2xx
|
466
|
+
p headers # => { ... }
|
467
|
+
p data # => nil
|
468
|
+
rescue KlaviyoAPI::ApiError => e
|
469
|
+
puts "Error when calling CatalogsApi->delete_catalog_category_with_http_info: #{e}"
|
470
|
+
end
|
471
|
+
```
|
472
|
+
|
473
|
+
### Parameters
|
474
|
+
|
475
|
+
| Name | Type | Description | Notes |
|
476
|
+
| ---- | ---- | ----------- | ----- |
|
477
|
+
| **id** | **String** | | |
|
478
|
+
|
479
|
+
### Return type
|
480
|
+
|
481
|
+
nil (empty response body)
|
482
|
+
|
483
|
+
### Authorization
|
484
|
+
|
485
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
486
|
+
|
487
|
+
### HTTP request headers
|
488
|
+
|
489
|
+
- **Content-Type**: Not defined
|
490
|
+
- **Accept**: application/json
|
491
|
+
|
492
|
+
|
493
|
+
## delete_catalog_category_relationships
|
494
|
+
|
495
|
+
> delete_catalog_category_relationships(id, related_resource, catalog_category_item_op)
|
496
|
+
|
497
|
+
Delete Catalog Category Relationships
|
498
|
+
|
499
|
+
Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
500
|
+
|
501
|
+
### Examples
|
502
|
+
|
503
|
+
```ruby
|
504
|
+
require 'time'
|
505
|
+
require 'klaviyo-api-sdk'
|
506
|
+
# setup authorization
|
507
|
+
KlaviyoAPI.configure do |config|
|
508
|
+
# Configure API key authorization: Klaviyo-API-Key
|
509
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
510
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
511
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
512
|
+
end
|
513
|
+
|
514
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
515
|
+
id = 'id_example' # String |
|
516
|
+
related_resource = 'items' # String |
|
517
|
+
catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
|
518
|
+
|
519
|
+
begin
|
520
|
+
# Delete Catalog Category Relationships
|
521
|
+
api_instance.delete_catalog_category_relationships(id, related_resource, catalog_category_item_op)
|
522
|
+
rescue KlaviyoAPI::ApiError => e
|
523
|
+
puts "Error when calling CatalogsApi->delete_catalog_category_relationships: #{e}"
|
524
|
+
end
|
525
|
+
```
|
526
|
+
|
527
|
+
#### Using the delete_catalog_category_relationships_with_http_info variant
|
528
|
+
|
529
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
530
|
+
|
531
|
+
> <Array(nil, Integer, Hash)> delete_catalog_category_relationships_with_http_info(id, related_resource, catalog_category_item_op)
|
532
|
+
|
533
|
+
```ruby
|
534
|
+
begin
|
535
|
+
# Delete Catalog Category Relationships
|
536
|
+
data, status_code, headers = api_instance.delete_catalog_category_relationships_with_http_info(id, related_resource, catalog_category_item_op)
|
537
|
+
p status_code # => 2xx
|
538
|
+
p headers # => { ... }
|
539
|
+
p data # => nil
|
540
|
+
rescue KlaviyoAPI::ApiError => e
|
541
|
+
puts "Error when calling CatalogsApi->delete_catalog_category_relationships_with_http_info: #{e}"
|
542
|
+
end
|
543
|
+
```
|
544
|
+
|
545
|
+
### Parameters
|
546
|
+
|
547
|
+
| Name | Type | Description | Notes |
|
548
|
+
| ---- | ---- | ----------- | ----- |
|
549
|
+
| **id** | **String** | | |
|
550
|
+
| **related_resource** | **String** | | |
|
551
|
+
| **catalog_category_item_op** | [**CatalogCategoryItemOp**](CatalogCategoryItemOp.md) | | |
|
552
|
+
|
553
|
+
### Return type
|
554
|
+
|
555
|
+
nil (empty response body)
|
556
|
+
|
557
|
+
### Authorization
|
558
|
+
|
559
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
560
|
+
|
561
|
+
### HTTP request headers
|
562
|
+
|
563
|
+
- **Content-Type**: application/json
|
564
|
+
- **Accept**: application/json
|
565
|
+
|
566
|
+
|
567
|
+
## delete_catalog_item
|
568
|
+
|
569
|
+
> delete_catalog_item(id)
|
570
|
+
|
571
|
+
Delete Catalog Item
|
572
|
+
|
573
|
+
Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
574
|
+
|
575
|
+
### Examples
|
576
|
+
|
577
|
+
```ruby
|
578
|
+
require 'time'
|
579
|
+
require 'klaviyo-api-sdk'
|
580
|
+
# setup authorization
|
581
|
+
KlaviyoAPI.configure do |config|
|
582
|
+
# Configure API key authorization: Klaviyo-API-Key
|
583
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
584
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
585
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
586
|
+
end
|
587
|
+
|
588
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
589
|
+
id = 'id_example' # String |
|
590
|
+
|
591
|
+
begin
|
592
|
+
# Delete Catalog Item
|
593
|
+
api_instance.delete_catalog_item(id)
|
594
|
+
rescue KlaviyoAPI::ApiError => e
|
595
|
+
puts "Error when calling CatalogsApi->delete_catalog_item: #{e}"
|
596
|
+
end
|
597
|
+
```
|
598
|
+
|
599
|
+
#### Using the delete_catalog_item_with_http_info variant
|
600
|
+
|
601
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
602
|
+
|
603
|
+
> <Array(nil, Integer, Hash)> delete_catalog_item_with_http_info(id)
|
604
|
+
|
605
|
+
```ruby
|
606
|
+
begin
|
607
|
+
# Delete Catalog Item
|
608
|
+
data, status_code, headers = api_instance.delete_catalog_item_with_http_info(id)
|
609
|
+
p status_code # => 2xx
|
610
|
+
p headers # => { ... }
|
611
|
+
p data # => nil
|
612
|
+
rescue KlaviyoAPI::ApiError => e
|
613
|
+
puts "Error when calling CatalogsApi->delete_catalog_item_with_http_info: #{e}"
|
614
|
+
end
|
615
|
+
```
|
616
|
+
|
617
|
+
### Parameters
|
618
|
+
|
619
|
+
| Name | Type | Description | Notes |
|
620
|
+
| ---- | ---- | ----------- | ----- |
|
621
|
+
| **id** | **String** | | |
|
622
|
+
|
623
|
+
### Return type
|
624
|
+
|
625
|
+
nil (empty response body)
|
626
|
+
|
627
|
+
### Authorization
|
628
|
+
|
629
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
630
|
+
|
631
|
+
### HTTP request headers
|
632
|
+
|
633
|
+
- **Content-Type**: Not defined
|
634
|
+
- **Accept**: application/json
|
635
|
+
|
636
|
+
|
637
|
+
## delete_catalog_item_relationships
|
638
|
+
|
639
|
+
> delete_catalog_item_relationships(id, related_resource, catalog_item_category_op)
|
640
|
+
|
641
|
+
Delete Catalog Item Relationships
|
642
|
+
|
643
|
+
Delete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
644
|
+
|
645
|
+
### Examples
|
646
|
+
|
647
|
+
```ruby
|
648
|
+
require 'time'
|
649
|
+
require 'klaviyo-api-sdk'
|
650
|
+
# setup authorization
|
651
|
+
KlaviyoAPI.configure do |config|
|
652
|
+
# Configure API key authorization: Klaviyo-API-Key
|
653
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
654
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
655
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
656
|
+
end
|
657
|
+
|
658
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
659
|
+
id = 'id_example' # String |
|
660
|
+
related_resource = 'categories' # String |
|
661
|
+
catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
|
662
|
+
|
663
|
+
begin
|
664
|
+
# Delete Catalog Item Relationships
|
665
|
+
api_instance.delete_catalog_item_relationships(id, related_resource, catalog_item_category_op)
|
666
|
+
rescue KlaviyoAPI::ApiError => e
|
667
|
+
puts "Error when calling CatalogsApi->delete_catalog_item_relationships: #{e}"
|
668
|
+
end
|
669
|
+
```
|
670
|
+
|
671
|
+
#### Using the delete_catalog_item_relationships_with_http_info variant
|
672
|
+
|
673
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
674
|
+
|
675
|
+
> <Array(nil, Integer, Hash)> delete_catalog_item_relationships_with_http_info(id, related_resource, catalog_item_category_op)
|
676
|
+
|
677
|
+
```ruby
|
678
|
+
begin
|
679
|
+
# Delete Catalog Item Relationships
|
680
|
+
data, status_code, headers = api_instance.delete_catalog_item_relationships_with_http_info(id, related_resource, catalog_item_category_op)
|
681
|
+
p status_code # => 2xx
|
682
|
+
p headers # => { ... }
|
683
|
+
p data # => nil
|
684
|
+
rescue KlaviyoAPI::ApiError => e
|
685
|
+
puts "Error when calling CatalogsApi->delete_catalog_item_relationships_with_http_info: #{e}"
|
686
|
+
end
|
687
|
+
```
|
688
|
+
|
689
|
+
### Parameters
|
690
|
+
|
691
|
+
| Name | Type | Description | Notes |
|
692
|
+
| ---- | ---- | ----------- | ----- |
|
693
|
+
| **id** | **String** | | |
|
694
|
+
| **related_resource** | **String** | | |
|
695
|
+
| **catalog_item_category_op** | [**CatalogItemCategoryOp**](CatalogItemCategoryOp.md) | | |
|
696
|
+
|
697
|
+
### Return type
|
698
|
+
|
699
|
+
nil (empty response body)
|
700
|
+
|
701
|
+
### Authorization
|
702
|
+
|
703
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
704
|
+
|
705
|
+
### HTTP request headers
|
706
|
+
|
707
|
+
- **Content-Type**: application/json
|
708
|
+
- **Accept**: application/json
|
709
|
+
|
710
|
+
|
711
|
+
## delete_catalog_variant
|
712
|
+
|
713
|
+
> delete_catalog_variant(id)
|
714
|
+
|
715
|
+
Delete Catalog Variant
|
716
|
+
|
717
|
+
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`
|
718
|
+
|
719
|
+
### Examples
|
720
|
+
|
721
|
+
```ruby
|
722
|
+
require 'time'
|
723
|
+
require 'klaviyo-api-sdk'
|
724
|
+
# setup authorization
|
725
|
+
KlaviyoAPI.configure do |config|
|
726
|
+
# Configure API key authorization: Klaviyo-API-Key
|
727
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
728
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
729
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
730
|
+
end
|
731
|
+
|
732
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
733
|
+
id = 'id_example' # String |
|
734
|
+
|
735
|
+
begin
|
736
|
+
# Delete Catalog Variant
|
737
|
+
api_instance.delete_catalog_variant(id)
|
738
|
+
rescue KlaviyoAPI::ApiError => e
|
739
|
+
puts "Error when calling CatalogsApi->delete_catalog_variant: #{e}"
|
740
|
+
end
|
741
|
+
```
|
742
|
+
|
743
|
+
#### Using the delete_catalog_variant_with_http_info variant
|
744
|
+
|
745
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
746
|
+
|
747
|
+
> <Array(nil, Integer, Hash)> delete_catalog_variant_with_http_info(id)
|
748
|
+
|
749
|
+
```ruby
|
750
|
+
begin
|
751
|
+
# Delete Catalog Variant
|
752
|
+
data, status_code, headers = api_instance.delete_catalog_variant_with_http_info(id)
|
753
|
+
p status_code # => 2xx
|
754
|
+
p headers # => { ... }
|
755
|
+
p data # => nil
|
756
|
+
rescue KlaviyoAPI::ApiError => e
|
757
|
+
puts "Error when calling CatalogsApi->delete_catalog_variant_with_http_info: #{e}"
|
758
|
+
end
|
759
|
+
```
|
760
|
+
|
761
|
+
### Parameters
|
762
|
+
|
763
|
+
| Name | Type | Description | Notes |
|
764
|
+
| ---- | ---- | ----------- | ----- |
|
765
|
+
| **id** | **String** | | |
|
766
|
+
|
767
|
+
### Return type
|
768
|
+
|
769
|
+
nil (empty response body)
|
770
|
+
|
771
|
+
### Authorization
|
772
|
+
|
773
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
774
|
+
|
775
|
+
### HTTP request headers
|
776
|
+
|
777
|
+
- **Content-Type**: Not defined
|
778
|
+
- **Accept**: application/json
|
779
|
+
|
780
|
+
|
781
|
+
## get_catalog_categories
|
782
|
+
|
783
|
+
> Hash<String, Object> get_catalog_categories(opts)
|
784
|
+
|
785
|
+
Get Catalog Categories
|
786
|
+
|
787
|
+
Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Use filters to return specific fields. Request specific fields [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 100 categories per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
788
|
+
|
789
|
+
### Examples
|
790
|
+
|
791
|
+
```ruby
|
792
|
+
require 'time'
|
793
|
+
require 'klaviyo-api-sdk'
|
794
|
+
# setup authorization
|
795
|
+
KlaviyoAPI.configure do |config|
|
796
|
+
# Configure API key authorization: Klaviyo-API-Key
|
797
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
798
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
799
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
800
|
+
end
|
801
|
+
|
802
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
803
|
+
opts = {
|
804
|
+
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
805
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
806
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
807
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
808
|
+
}
|
809
|
+
|
810
|
+
begin
|
811
|
+
# Get Catalog Categories
|
812
|
+
result = api_instance.get_catalog_categories(opts)
|
813
|
+
p result
|
814
|
+
rescue KlaviyoAPI::ApiError => e
|
815
|
+
puts "Error when calling CatalogsApi->get_catalog_categories: #{e}"
|
816
|
+
end
|
817
|
+
```
|
818
|
+
|
819
|
+
#### Using the get_catalog_categories_with_http_info variant
|
820
|
+
|
821
|
+
This returns an Array which contains the response data, status code and headers.
|
822
|
+
|
823
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_categories_with_http_info(opts)
|
824
|
+
|
825
|
+
```ruby
|
826
|
+
begin
|
827
|
+
# Get Catalog Categories
|
828
|
+
data, status_code, headers = api_instance.get_catalog_categories_with_http_info(opts)
|
829
|
+
p status_code # => 2xx
|
830
|
+
p headers # => { ... }
|
831
|
+
p data # => Hash<String, Object>
|
832
|
+
rescue KlaviyoAPI::ApiError => e
|
833
|
+
puts "Error when calling CatalogsApi->get_catalog_categories_with_http_info: #{e}"
|
834
|
+
end
|
835
|
+
```
|
836
|
+
|
837
|
+
### Parameters
|
838
|
+
|
839
|
+
| Name | Type | Description | Notes |
|
840
|
+
| ---- | ---- | ----------- | ----- |
|
841
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
842
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains` | [optional] |
|
843
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
844
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
|
845
|
+
|
846
|
+
### Return type
|
847
|
+
|
848
|
+
**Hash<String, Object>**
|
849
|
+
|
850
|
+
### Authorization
|
851
|
+
|
852
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
853
|
+
|
854
|
+
### HTTP request headers
|
855
|
+
|
856
|
+
- **Content-Type**: Not defined
|
857
|
+
- **Accept**: application/json
|
858
|
+
|
859
|
+
|
860
|
+
## get_catalog_category
|
861
|
+
|
862
|
+
> Hash<String, Object> get_catalog_category(id, opts)
|
863
|
+
|
864
|
+
Get Catalog Category
|
865
|
+
|
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
|
+
|
868
|
+
### Examples
|
869
|
+
|
870
|
+
```ruby
|
871
|
+
require 'time'
|
872
|
+
require 'klaviyo-api-sdk'
|
873
|
+
# setup authorization
|
874
|
+
KlaviyoAPI.configure do |config|
|
875
|
+
# Configure API key authorization: Klaviyo-API-Key
|
876
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
877
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
878
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
879
|
+
end
|
880
|
+
|
881
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
882
|
+
id = 'id_example' # String |
|
883
|
+
opts = {
|
884
|
+
fields_catalog_category: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
885
|
+
}
|
886
|
+
|
887
|
+
begin
|
888
|
+
# Get Catalog Category
|
889
|
+
result = api_instance.get_catalog_category(id, opts)
|
890
|
+
p result
|
891
|
+
rescue KlaviyoAPI::ApiError => e
|
892
|
+
puts "Error when calling CatalogsApi->get_catalog_category: #{e}"
|
893
|
+
end
|
894
|
+
```
|
895
|
+
|
896
|
+
#### Using the get_catalog_category_with_http_info variant
|
897
|
+
|
898
|
+
This returns an Array which contains the response data, status code and headers.
|
899
|
+
|
900
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_category_with_http_info(id, opts)
|
901
|
+
|
902
|
+
```ruby
|
903
|
+
begin
|
904
|
+
# Get Catalog Category
|
905
|
+
data, status_code, headers = api_instance.get_catalog_category_with_http_info(id, opts)
|
906
|
+
p status_code # => 2xx
|
907
|
+
p headers # => { ... }
|
908
|
+
p data # => Hash<String, Object>
|
909
|
+
rescue KlaviyoAPI::ApiError => e
|
910
|
+
puts "Error when calling CatalogsApi->get_catalog_category_with_http_info: #{e}"
|
911
|
+
end
|
912
|
+
```
|
913
|
+
|
914
|
+
### Parameters
|
915
|
+
|
916
|
+
| Name | Type | Description | Notes |
|
917
|
+
| ---- | ---- | ----------- | ----- |
|
918
|
+
| **id** | **String** | | |
|
919
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
920
|
+
|
921
|
+
### Return type
|
922
|
+
|
923
|
+
**Hash<String, Object>**
|
924
|
+
|
925
|
+
### Authorization
|
926
|
+
|
927
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
928
|
+
|
929
|
+
### HTTP request headers
|
930
|
+
|
931
|
+
- **Content-Type**: Not defined
|
932
|
+
- **Accept**: application/json
|
933
|
+
|
934
|
+
|
935
|
+
## get_catalog_category_items
|
936
|
+
|
937
|
+
> Hash<String, Object> get_catalog_category_items(category_id, opts)
|
938
|
+
|
939
|
+
Get Catalog Category Items
|
940
|
+
|
941
|
+
Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Use filters to return specific fields and any variants. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
942
|
+
|
943
|
+
### Examples
|
944
|
+
|
945
|
+
```ruby
|
946
|
+
require 'time'
|
947
|
+
require 'klaviyo-api-sdk'
|
948
|
+
# setup authorization
|
949
|
+
KlaviyoAPI.configure do |config|
|
950
|
+
# Configure API key authorization: Klaviyo-API-Key
|
951
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
952
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
953
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
954
|
+
end
|
955
|
+
|
956
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
957
|
+
category_id = 'category_id_example' # String |
|
958
|
+
opts = {
|
959
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
960
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
961
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
962
|
+
include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
963
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
964
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
965
|
+
}
|
966
|
+
|
967
|
+
begin
|
968
|
+
# Get Catalog Category Items
|
969
|
+
result = api_instance.get_catalog_category_items(category_id, opts)
|
970
|
+
p result
|
971
|
+
rescue KlaviyoAPI::ApiError => e
|
972
|
+
puts "Error when calling CatalogsApi->get_catalog_category_items: #{e}"
|
973
|
+
end
|
974
|
+
```
|
975
|
+
|
976
|
+
#### Using the get_catalog_category_items_with_http_info variant
|
977
|
+
|
978
|
+
This returns an Array which contains the response data, status code and headers.
|
979
|
+
|
980
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_category_items_with_http_info(category_id, opts)
|
981
|
+
|
982
|
+
```ruby
|
983
|
+
begin
|
984
|
+
# Get Catalog Category Items
|
985
|
+
data, status_code, headers = api_instance.get_catalog_category_items_with_http_info(category_id, opts)
|
986
|
+
p status_code # => 2xx
|
987
|
+
p headers # => { ... }
|
988
|
+
p data # => Hash<String, Object>
|
989
|
+
rescue KlaviyoAPI::ApiError => e
|
990
|
+
puts "Error when calling CatalogsApi->get_catalog_category_items_with_http_info: #{e}"
|
991
|
+
end
|
992
|
+
```
|
993
|
+
|
994
|
+
### Parameters
|
995
|
+
|
996
|
+
| Name | Type | Description | Notes |
|
997
|
+
| ---- | ---- | ----------- | ----- |
|
998
|
+
| **category_id** | **String** | | |
|
999
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1000
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1001
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals` | [optional] |
|
1002
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
1003
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
1004
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
|
1005
|
+
|
1006
|
+
### Return type
|
1007
|
+
|
1008
|
+
**Hash<String, Object>**
|
1009
|
+
|
1010
|
+
### Authorization
|
1011
|
+
|
1012
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1013
|
+
|
1014
|
+
### HTTP request headers
|
1015
|
+
|
1016
|
+
- **Content-Type**: Not defined
|
1017
|
+
- **Accept**: application/json
|
1018
|
+
|
1019
|
+
|
1020
|
+
## get_catalog_category_relationships
|
1021
|
+
|
1022
|
+
> Hash<String, Object> get_catalog_category_relationships(id, related_resource, opts)
|
1023
|
+
|
1024
|
+
Get Catalog Category Relationships
|
1025
|
+
|
1026
|
+
Get all items in the given category ID. Returns a maximum of 100 items per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
1027
|
+
|
1028
|
+
### Examples
|
1029
|
+
|
1030
|
+
```ruby
|
1031
|
+
require 'time'
|
1032
|
+
require 'klaviyo-api-sdk'
|
1033
|
+
# setup authorization
|
1034
|
+
KlaviyoAPI.configure do |config|
|
1035
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1036
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1037
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1038
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1039
|
+
end
|
1040
|
+
|
1041
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1042
|
+
id = 'id_example' # String |
|
1043
|
+
related_resource = 'items' # String |
|
1044
|
+
opts = {
|
1045
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
1046
|
+
}
|
1047
|
+
|
1048
|
+
begin
|
1049
|
+
# Get Catalog Category Relationships
|
1050
|
+
result = api_instance.get_catalog_category_relationships(id, related_resource, opts)
|
1051
|
+
p result
|
1052
|
+
rescue KlaviyoAPI::ApiError => e
|
1053
|
+
puts "Error when calling CatalogsApi->get_catalog_category_relationships: #{e}"
|
1054
|
+
end
|
1055
|
+
```
|
1056
|
+
|
1057
|
+
#### Using the get_catalog_category_relationships_with_http_info variant
|
1058
|
+
|
1059
|
+
This returns an Array which contains the response data, status code and headers.
|
1060
|
+
|
1061
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_category_relationships_with_http_info(id, related_resource, opts)
|
1062
|
+
|
1063
|
+
```ruby
|
1064
|
+
begin
|
1065
|
+
# Get Catalog Category Relationships
|
1066
|
+
data, status_code, headers = api_instance.get_catalog_category_relationships_with_http_info(id, related_resource, opts)
|
1067
|
+
p status_code # => 2xx
|
1068
|
+
p headers # => { ... }
|
1069
|
+
p data # => Hash<String, Object>
|
1070
|
+
rescue KlaviyoAPI::ApiError => e
|
1071
|
+
puts "Error when calling CatalogsApi->get_catalog_category_relationships_with_http_info: #{e}"
|
1072
|
+
end
|
1073
|
+
```
|
1074
|
+
|
1075
|
+
### Parameters
|
1076
|
+
|
1077
|
+
| Name | Type | Description | Notes |
|
1078
|
+
| ---- | ---- | ----------- | ----- |
|
1079
|
+
| **id** | **String** | | |
|
1080
|
+
| **related_resource** | **String** | | |
|
1081
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
1082
|
+
|
1083
|
+
### Return type
|
1084
|
+
|
1085
|
+
**Hash<String, Object>**
|
1086
|
+
|
1087
|
+
### Authorization
|
1088
|
+
|
1089
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1090
|
+
|
1091
|
+
### HTTP request headers
|
1092
|
+
|
1093
|
+
- **Content-Type**: Not defined
|
1094
|
+
- **Accept**: application/json
|
1095
|
+
|
1096
|
+
|
1097
|
+
## get_catalog_item
|
1098
|
+
|
1099
|
+
> Hash<String, Object> get_catalog_item(id, opts)
|
1100
|
+
|
1101
|
+
Get Catalog Item
|
1102
|
+
|
1103
|
+
Get a specific catalog item with the given item ID. Request specific fields and variants using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: `variants`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
1104
|
+
|
1105
|
+
### Examples
|
1106
|
+
|
1107
|
+
```ruby
|
1108
|
+
require 'time'
|
1109
|
+
require 'klaviyo-api-sdk'
|
1110
|
+
# setup authorization
|
1111
|
+
KlaviyoAPI.configure do |config|
|
1112
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1113
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1114
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1115
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1116
|
+
end
|
1117
|
+
|
1118
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1119
|
+
id = 'id_example' # String |
|
1120
|
+
opts = {
|
1121
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1122
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1123
|
+
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
1124
|
+
}
|
1125
|
+
|
1126
|
+
begin
|
1127
|
+
# Get Catalog Item
|
1128
|
+
result = api_instance.get_catalog_item(id, opts)
|
1129
|
+
p result
|
1130
|
+
rescue KlaviyoAPI::ApiError => e
|
1131
|
+
puts "Error when calling CatalogsApi->get_catalog_item: #{e}"
|
1132
|
+
end
|
1133
|
+
```
|
1134
|
+
|
1135
|
+
#### Using the get_catalog_item_with_http_info variant
|
1136
|
+
|
1137
|
+
This returns an Array which contains the response data, status code and headers.
|
1138
|
+
|
1139
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_item_with_http_info(id, opts)
|
1140
|
+
|
1141
|
+
```ruby
|
1142
|
+
begin
|
1143
|
+
# Get Catalog Item
|
1144
|
+
data, status_code, headers = api_instance.get_catalog_item_with_http_info(id, opts)
|
1145
|
+
p status_code # => 2xx
|
1146
|
+
p headers # => { ... }
|
1147
|
+
p data # => Hash<String, Object>
|
1148
|
+
rescue KlaviyoAPI::ApiError => e
|
1149
|
+
puts "Error when calling CatalogsApi->get_catalog_item_with_http_info: #{e}"
|
1150
|
+
end
|
1151
|
+
```
|
1152
|
+
|
1153
|
+
### Parameters
|
1154
|
+
|
1155
|
+
| Name | Type | Description | Notes |
|
1156
|
+
| ---- | ---- | ----------- | ----- |
|
1157
|
+
| **id** | **String** | | |
|
1158
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1159
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1160
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
1161
|
+
|
1162
|
+
### Return type
|
1163
|
+
|
1164
|
+
**Hash<String, Object>**
|
1165
|
+
|
1166
|
+
### Authorization
|
1167
|
+
|
1168
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1169
|
+
|
1170
|
+
### HTTP request headers
|
1171
|
+
|
1172
|
+
- **Content-Type**: Not defined
|
1173
|
+
- **Accept**: application/json
|
1174
|
+
|
1175
|
+
|
1176
|
+
## get_catalog_item_categories
|
1177
|
+
|
1178
|
+
> Hash<String, Object> get_catalog_item_categories(item_id, opts)
|
1179
|
+
|
1180
|
+
Get Catalog Item Categories
|
1181
|
+
|
1182
|
+
Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Use filters to return specific fields. Request specific fields [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 100 categories per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
1183
|
+
|
1184
|
+
### Examples
|
1185
|
+
|
1186
|
+
```ruby
|
1187
|
+
require 'time'
|
1188
|
+
require 'klaviyo-api-sdk'
|
1189
|
+
# setup authorization
|
1190
|
+
KlaviyoAPI.configure do |config|
|
1191
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1192
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1193
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1194
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1195
|
+
end
|
1196
|
+
|
1197
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1198
|
+
item_id = 'item_id_example' # String |
|
1199
|
+
opts = {
|
1200
|
+
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1201
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
1202
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
1203
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
1204
|
+
}
|
1205
|
+
|
1206
|
+
begin
|
1207
|
+
# Get Catalog Item Categories
|
1208
|
+
result = api_instance.get_catalog_item_categories(item_id, opts)
|
1209
|
+
p result
|
1210
|
+
rescue KlaviyoAPI::ApiError => e
|
1211
|
+
puts "Error when calling CatalogsApi->get_catalog_item_categories: #{e}"
|
1212
|
+
end
|
1213
|
+
```
|
1214
|
+
|
1215
|
+
#### Using the get_catalog_item_categories_with_http_info variant
|
1216
|
+
|
1217
|
+
This returns an Array which contains the response data, status code and headers.
|
1218
|
+
|
1219
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_item_categories_with_http_info(item_id, opts)
|
1220
|
+
|
1221
|
+
```ruby
|
1222
|
+
begin
|
1223
|
+
# Get Catalog Item Categories
|
1224
|
+
data, status_code, headers = api_instance.get_catalog_item_categories_with_http_info(item_id, opts)
|
1225
|
+
p status_code # => 2xx
|
1226
|
+
p headers # => { ... }
|
1227
|
+
p data # => Hash<String, Object>
|
1228
|
+
rescue KlaviyoAPI::ApiError => e
|
1229
|
+
puts "Error when calling CatalogsApi->get_catalog_item_categories_with_http_info: #{e}"
|
1230
|
+
end
|
1231
|
+
```
|
1232
|
+
|
1233
|
+
### Parameters
|
1234
|
+
|
1235
|
+
| Name | Type | Description | Notes |
|
1236
|
+
| ---- | ---- | ----------- | ----- |
|
1237
|
+
| **item_id** | **String** | | |
|
1238
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1239
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains` | [optional] |
|
1240
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
1241
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
|
1242
|
+
|
1243
|
+
### Return type
|
1244
|
+
|
1245
|
+
**Hash<String, Object>**
|
1246
|
+
|
1247
|
+
### Authorization
|
1248
|
+
|
1249
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1250
|
+
|
1251
|
+
### HTTP request headers
|
1252
|
+
|
1253
|
+
- **Content-Type**: Not defined
|
1254
|
+
- **Accept**: application/json
|
1255
|
+
|
1256
|
+
|
1257
|
+
## get_catalog_item_relationships
|
1258
|
+
|
1259
|
+
> Hash<String, Object> get_catalog_item_relationships(id, related_resource, opts)
|
1260
|
+
|
1261
|
+
Get Catalog Item Relationships
|
1262
|
+
|
1263
|
+
Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
1264
|
+
|
1265
|
+
### Examples
|
1266
|
+
|
1267
|
+
```ruby
|
1268
|
+
require 'time'
|
1269
|
+
require 'klaviyo-api-sdk'
|
1270
|
+
# setup authorization
|
1271
|
+
KlaviyoAPI.configure do |config|
|
1272
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1273
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1274
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1275
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1276
|
+
end
|
1277
|
+
|
1278
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1279
|
+
id = 'id_example' # String |
|
1280
|
+
related_resource = 'categories' # String |
|
1281
|
+
opts = {
|
1282
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
1283
|
+
}
|
1284
|
+
|
1285
|
+
begin
|
1286
|
+
# Get Catalog Item Relationships
|
1287
|
+
result = api_instance.get_catalog_item_relationships(id, related_resource, opts)
|
1288
|
+
p result
|
1289
|
+
rescue KlaviyoAPI::ApiError => e
|
1290
|
+
puts "Error when calling CatalogsApi->get_catalog_item_relationships: #{e}"
|
1291
|
+
end
|
1292
|
+
```
|
1293
|
+
|
1294
|
+
#### Using the get_catalog_item_relationships_with_http_info variant
|
1295
|
+
|
1296
|
+
This returns an Array which contains the response data, status code and headers.
|
1297
|
+
|
1298
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_item_relationships_with_http_info(id, related_resource, opts)
|
1299
|
+
|
1300
|
+
```ruby
|
1301
|
+
begin
|
1302
|
+
# Get Catalog Item Relationships
|
1303
|
+
data, status_code, headers = api_instance.get_catalog_item_relationships_with_http_info(id, related_resource, opts)
|
1304
|
+
p status_code # => 2xx
|
1305
|
+
p headers # => { ... }
|
1306
|
+
p data # => Hash<String, Object>
|
1307
|
+
rescue KlaviyoAPI::ApiError => e
|
1308
|
+
puts "Error when calling CatalogsApi->get_catalog_item_relationships_with_http_info: #{e}"
|
1309
|
+
end
|
1310
|
+
```
|
1311
|
+
|
1312
|
+
### Parameters
|
1313
|
+
|
1314
|
+
| Name | Type | Description | Notes |
|
1315
|
+
| ---- | ---- | ----------- | ----- |
|
1316
|
+
| **id** | **String** | | |
|
1317
|
+
| **related_resource** | **String** | | |
|
1318
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
1319
|
+
|
1320
|
+
### Return type
|
1321
|
+
|
1322
|
+
**Hash<String, Object>**
|
1323
|
+
|
1324
|
+
### Authorization
|
1325
|
+
|
1326
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1327
|
+
|
1328
|
+
### HTTP request headers
|
1329
|
+
|
1330
|
+
- **Content-Type**: Not defined
|
1331
|
+
- **Accept**: application/json
|
1332
|
+
|
1333
|
+
|
1334
|
+
## get_catalog_item_variants
|
1335
|
+
|
1336
|
+
> Hash<String, Object> get_catalog_item_variants(item_id, opts)
|
1337
|
+
|
1338
|
+
Get Catalog Item Variants
|
1339
|
+
|
1340
|
+
Get all variants related to the given item ID. Use filters to return specific fields. Request specific fields [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
1341
|
+
|
1342
|
+
### Examples
|
1343
|
+
|
1344
|
+
```ruby
|
1345
|
+
require 'time'
|
1346
|
+
require 'klaviyo-api-sdk'
|
1347
|
+
# setup authorization
|
1348
|
+
KlaviyoAPI.configure do |config|
|
1349
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1350
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1351
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1352
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1353
|
+
end
|
1354
|
+
|
1355
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1356
|
+
item_id = 'item_id_example' # String |
|
1357
|
+
opts = {
|
1358
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1359
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1360
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
1361
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
1362
|
+
}
|
1363
|
+
|
1364
|
+
begin
|
1365
|
+
# Get Catalog Item Variants
|
1366
|
+
result = api_instance.get_catalog_item_variants(item_id, opts)
|
1367
|
+
p result
|
1368
|
+
rescue KlaviyoAPI::ApiError => e
|
1369
|
+
puts "Error when calling CatalogsApi->get_catalog_item_variants: #{e}"
|
1370
|
+
end
|
1371
|
+
```
|
1372
|
+
|
1373
|
+
#### Using the get_catalog_item_variants_with_http_info variant
|
1374
|
+
|
1375
|
+
This returns an Array which contains the response data, status code and headers.
|
1376
|
+
|
1377
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_item_variants_with_http_info(item_id, opts)
|
1378
|
+
|
1379
|
+
```ruby
|
1380
|
+
begin
|
1381
|
+
# Get Catalog Item Variants
|
1382
|
+
data, status_code, headers = api_instance.get_catalog_item_variants_with_http_info(item_id, opts)
|
1383
|
+
p status_code # => 2xx
|
1384
|
+
p headers # => { ... }
|
1385
|
+
p data # => Hash<String, Object>
|
1386
|
+
rescue KlaviyoAPI::ApiError => e
|
1387
|
+
puts "Error when calling CatalogsApi->get_catalog_item_variants_with_http_info: #{e}"
|
1388
|
+
end
|
1389
|
+
```
|
1390
|
+
|
1391
|
+
### Parameters
|
1392
|
+
|
1393
|
+
| Name | Type | Description | Notes |
|
1394
|
+
| ---- | ---- | ----------- | ----- |
|
1395
|
+
| **item_id** | **String** | | |
|
1396
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1397
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` | [optional] |
|
1398
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
1399
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
|
1400
|
+
|
1401
|
+
### Return type
|
1402
|
+
|
1403
|
+
**Hash<String, Object>**
|
1404
|
+
|
1405
|
+
### Authorization
|
1406
|
+
|
1407
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1408
|
+
|
1409
|
+
### HTTP request headers
|
1410
|
+
|
1411
|
+
- **Content-Type**: Not defined
|
1412
|
+
- **Accept**: application/json
|
1413
|
+
|
1414
|
+
|
1415
|
+
## get_catalog_items
|
1416
|
+
|
1417
|
+
> Hash<String, Object> get_catalog_items(opts)
|
1418
|
+
|
1419
|
+
Get Catalog Items
|
1420
|
+
|
1421
|
+
Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Use filters to return specific fields and any variants. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
1422
|
+
|
1423
|
+
### Examples
|
1424
|
+
|
1425
|
+
```ruby
|
1426
|
+
require 'time'
|
1427
|
+
require 'klaviyo-api-sdk'
|
1428
|
+
# setup authorization
|
1429
|
+
KlaviyoAPI.configure do |config|
|
1430
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1431
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1432
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1433
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1434
|
+
end
|
1435
|
+
|
1436
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1437
|
+
opts = {
|
1438
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1439
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1440
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1441
|
+
include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
1442
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
1443
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
1444
|
+
}
|
1445
|
+
|
1446
|
+
begin
|
1447
|
+
# Get Catalog Items
|
1448
|
+
result = api_instance.get_catalog_items(opts)
|
1449
|
+
p result
|
1450
|
+
rescue KlaviyoAPI::ApiError => e
|
1451
|
+
puts "Error when calling CatalogsApi->get_catalog_items: #{e}"
|
1452
|
+
end
|
1453
|
+
```
|
1454
|
+
|
1455
|
+
#### Using the get_catalog_items_with_http_info variant
|
1456
|
+
|
1457
|
+
This returns an Array which contains the response data, status code and headers.
|
1458
|
+
|
1459
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_items_with_http_info(opts)
|
1460
|
+
|
1461
|
+
```ruby
|
1462
|
+
begin
|
1463
|
+
# Get Catalog Items
|
1464
|
+
data, status_code, headers = api_instance.get_catalog_items_with_http_info(opts)
|
1465
|
+
p status_code # => 2xx
|
1466
|
+
p headers # => { ... }
|
1467
|
+
p data # => Hash<String, Object>
|
1468
|
+
rescue KlaviyoAPI::ApiError => e
|
1469
|
+
puts "Error when calling CatalogsApi->get_catalog_items_with_http_info: #{e}"
|
1470
|
+
end
|
1471
|
+
```
|
1472
|
+
|
1473
|
+
### Parameters
|
1474
|
+
|
1475
|
+
| Name | Type | Description | Notes |
|
1476
|
+
| ---- | ---- | ----------- | ----- |
|
1477
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1478
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1479
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals` | [optional] |
|
1480
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
1481
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
1482
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
|
1483
|
+
|
1484
|
+
### Return type
|
1485
|
+
|
1486
|
+
**Hash<String, Object>**
|
1487
|
+
|
1488
|
+
### Authorization
|
1489
|
+
|
1490
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1491
|
+
|
1492
|
+
### HTTP request headers
|
1493
|
+
|
1494
|
+
- **Content-Type**: Not defined
|
1495
|
+
- **Accept**: application/json
|
1496
|
+
|
1497
|
+
|
1498
|
+
## get_catalog_variant
|
1499
|
+
|
1500
|
+
> Hash<String, Object> get_catalog_variant(id, opts)
|
1501
|
+
|
1502
|
+
Get Catalog Variant
|
1503
|
+
|
1504
|
+
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`
|
1505
|
+
|
1506
|
+
### Examples
|
1507
|
+
|
1508
|
+
```ruby
|
1509
|
+
require 'time'
|
1510
|
+
require 'klaviyo-api-sdk'
|
1511
|
+
# setup authorization
|
1512
|
+
KlaviyoAPI.configure do |config|
|
1513
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1514
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1515
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1516
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1517
|
+
end
|
1518
|
+
|
1519
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1520
|
+
id = 'id_example' # String |
|
1521
|
+
opts = {
|
1522
|
+
fields_catalog_variant: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1523
|
+
}
|
1524
|
+
|
1525
|
+
begin
|
1526
|
+
# Get Catalog Variant
|
1527
|
+
result = api_instance.get_catalog_variant(id, opts)
|
1528
|
+
p result
|
1529
|
+
rescue KlaviyoAPI::ApiError => e
|
1530
|
+
puts "Error when calling CatalogsApi->get_catalog_variant: #{e}"
|
1531
|
+
end
|
1532
|
+
```
|
1533
|
+
|
1534
|
+
#### Using the get_catalog_variant_with_http_info variant
|
1535
|
+
|
1536
|
+
This returns an Array which contains the response data, status code and headers.
|
1537
|
+
|
1538
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_variant_with_http_info(id, opts)
|
1539
|
+
|
1540
|
+
```ruby
|
1541
|
+
begin
|
1542
|
+
# Get Catalog Variant
|
1543
|
+
data, status_code, headers = api_instance.get_catalog_variant_with_http_info(id, opts)
|
1544
|
+
p status_code # => 2xx
|
1545
|
+
p headers # => { ... }
|
1546
|
+
p data # => Hash<String, Object>
|
1547
|
+
rescue KlaviyoAPI::ApiError => e
|
1548
|
+
puts "Error when calling CatalogsApi->get_catalog_variant_with_http_info: #{e}"
|
1549
|
+
end
|
1550
|
+
```
|
1551
|
+
|
1552
|
+
### Parameters
|
1553
|
+
|
1554
|
+
| Name | Type | Description | Notes |
|
1555
|
+
| ---- | ---- | ----------- | ----- |
|
1556
|
+
| **id** | **String** | | |
|
1557
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1558
|
+
|
1559
|
+
### Return type
|
1560
|
+
|
1561
|
+
**Hash<String, Object>**
|
1562
|
+
|
1563
|
+
### Authorization
|
1564
|
+
|
1565
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1566
|
+
|
1567
|
+
### HTTP request headers
|
1568
|
+
|
1569
|
+
- **Content-Type**: Not defined
|
1570
|
+
- **Accept**: application/json
|
1571
|
+
|
1572
|
+
|
1573
|
+
## get_catalog_variants
|
1574
|
+
|
1575
|
+
> Hash<String, Object> get_catalog_variants(opts)
|
1576
|
+
|
1577
|
+
Get Catalog Variants
|
1578
|
+
|
1579
|
+
Get all variants in an account. Use filters to return specific fields. Request specific fields [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
1580
|
+
|
1581
|
+
### Examples
|
1582
|
+
|
1583
|
+
```ruby
|
1584
|
+
require 'time'
|
1585
|
+
require 'klaviyo-api-sdk'
|
1586
|
+
# setup authorization
|
1587
|
+
KlaviyoAPI.configure do |config|
|
1588
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1589
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1590
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1591
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1592
|
+
end
|
1593
|
+
|
1594
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1595
|
+
opts = {
|
1596
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1597
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1598
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
1599
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
1600
|
+
}
|
1601
|
+
|
1602
|
+
begin
|
1603
|
+
# Get Catalog Variants
|
1604
|
+
result = api_instance.get_catalog_variants(opts)
|
1605
|
+
p result
|
1606
|
+
rescue KlaviyoAPI::ApiError => e
|
1607
|
+
puts "Error when calling CatalogsApi->get_catalog_variants: #{e}"
|
1608
|
+
end
|
1609
|
+
```
|
1610
|
+
|
1611
|
+
#### Using the get_catalog_variants_with_http_info variant
|
1612
|
+
|
1613
|
+
This returns an Array which contains the response data, status code and headers.
|
1614
|
+
|
1615
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_variants_with_http_info(opts)
|
1616
|
+
|
1617
|
+
```ruby
|
1618
|
+
begin
|
1619
|
+
# Get Catalog Variants
|
1620
|
+
data, status_code, headers = api_instance.get_catalog_variants_with_http_info(opts)
|
1621
|
+
p status_code # => 2xx
|
1622
|
+
p headers # => { ... }
|
1623
|
+
p data # => Hash<String, Object>
|
1624
|
+
rescue KlaviyoAPI::ApiError => e
|
1625
|
+
puts "Error when calling CatalogsApi->get_catalog_variants_with_http_info: #{e}"
|
1626
|
+
end
|
1627
|
+
```
|
1628
|
+
|
1629
|
+
### Parameters
|
1630
|
+
|
1631
|
+
| Name | Type | Description | Notes |
|
1632
|
+
| ---- | ---- | ----------- | ----- |
|
1633
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1634
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` | [optional] |
|
1635
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
1636
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
|
1637
|
+
|
1638
|
+
### Return type
|
1639
|
+
|
1640
|
+
**Hash<String, Object>**
|
1641
|
+
|
1642
|
+
### Authorization
|
1643
|
+
|
1644
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1645
|
+
|
1646
|
+
### HTTP request headers
|
1647
|
+
|
1648
|
+
- **Content-Type**: Not defined
|
1649
|
+
- **Accept**: application/json
|
1650
|
+
|
1651
|
+
|
1652
|
+
## get_create_categories_job
|
1653
|
+
|
1654
|
+
> Hash<String, Object> get_create_categories_job(job_id, opts)
|
1655
|
+
|
1656
|
+
Get Create Categories Job
|
1657
|
+
|
1658
|
+
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`
|
1659
|
+
|
1660
|
+
### Examples
|
1661
|
+
|
1662
|
+
```ruby
|
1663
|
+
require 'time'
|
1664
|
+
require 'klaviyo-api-sdk'
|
1665
|
+
# setup authorization
|
1666
|
+
KlaviyoAPI.configure do |config|
|
1667
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1668
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1669
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1670
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1671
|
+
end
|
1672
|
+
|
1673
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1674
|
+
job_id = 'job_id_example' # String |
|
1675
|
+
opts = {
|
1676
|
+
fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1677
|
+
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1678
|
+
include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
1679
|
+
}
|
1680
|
+
|
1681
|
+
begin
|
1682
|
+
# Get Create Categories Job
|
1683
|
+
result = api_instance.get_create_categories_job(job_id, opts)
|
1684
|
+
p result
|
1685
|
+
rescue KlaviyoAPI::ApiError => e
|
1686
|
+
puts "Error when calling CatalogsApi->get_create_categories_job: #{e}"
|
1687
|
+
end
|
1688
|
+
```
|
1689
|
+
|
1690
|
+
#### Using the get_create_categories_job_with_http_info variant
|
1691
|
+
|
1692
|
+
This returns an Array which contains the response data, status code and headers.
|
1693
|
+
|
1694
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_create_categories_job_with_http_info(job_id, opts)
|
1695
|
+
|
1696
|
+
```ruby
|
1697
|
+
begin
|
1698
|
+
# Get Create Categories Job
|
1699
|
+
data, status_code, headers = api_instance.get_create_categories_job_with_http_info(job_id, opts)
|
1700
|
+
p status_code # => 2xx
|
1701
|
+
p headers # => { ... }
|
1702
|
+
p data # => Hash<String, Object>
|
1703
|
+
rescue KlaviyoAPI::ApiError => e
|
1704
|
+
puts "Error when calling CatalogsApi->get_create_categories_job_with_http_info: #{e}"
|
1705
|
+
end
|
1706
|
+
```
|
1707
|
+
|
1708
|
+
### Parameters
|
1709
|
+
|
1710
|
+
| Name | Type | Description | Notes |
|
1711
|
+
| ---- | ---- | ----------- | ----- |
|
1712
|
+
| **job_id** | **String** | | |
|
1713
|
+
| **fields_catalog_category_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1714
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1715
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
1716
|
+
|
1717
|
+
### Return type
|
1718
|
+
|
1719
|
+
**Hash<String, Object>**
|
1720
|
+
|
1721
|
+
### Authorization
|
1722
|
+
|
1723
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1724
|
+
|
1725
|
+
### HTTP request headers
|
1726
|
+
|
1727
|
+
- **Content-Type**: Not defined
|
1728
|
+
- **Accept**: application/json
|
1729
|
+
|
1730
|
+
|
1731
|
+
## get_create_categories_jobs
|
1732
|
+
|
1733
|
+
> Hash<String, Object> get_create_categories_jobs(opts)
|
1734
|
+
|
1735
|
+
Get Create Categories Jobs
|
1736
|
+
|
1737
|
+
Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
1738
|
+
|
1739
|
+
### Examples
|
1740
|
+
|
1741
|
+
```ruby
|
1742
|
+
require 'time'
|
1743
|
+
require 'klaviyo-api-sdk'
|
1744
|
+
# setup authorization
|
1745
|
+
KlaviyoAPI.configure do |config|
|
1746
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1747
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1748
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1749
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1750
|
+
end
|
1751
|
+
|
1752
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1753
|
+
opts = {
|
1754
|
+
fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1755
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1756
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
1757
|
+
}
|
1758
|
+
|
1759
|
+
begin
|
1760
|
+
# Get Create Categories Jobs
|
1761
|
+
result = api_instance.get_create_categories_jobs(opts)
|
1762
|
+
p result
|
1763
|
+
rescue KlaviyoAPI::ApiError => e
|
1764
|
+
puts "Error when calling CatalogsApi->get_create_categories_jobs: #{e}"
|
1765
|
+
end
|
1766
|
+
```
|
1767
|
+
|
1768
|
+
#### Using the get_create_categories_jobs_with_http_info variant
|
1769
|
+
|
1770
|
+
This returns an Array which contains the response data, status code and headers.
|
1771
|
+
|
1772
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_create_categories_jobs_with_http_info(opts)
|
1773
|
+
|
1774
|
+
```ruby
|
1775
|
+
begin
|
1776
|
+
# Get Create Categories Jobs
|
1777
|
+
data, status_code, headers = api_instance.get_create_categories_jobs_with_http_info(opts)
|
1778
|
+
p status_code # => 2xx
|
1779
|
+
p headers # => { ... }
|
1780
|
+
p data # => Hash<String, Object>
|
1781
|
+
rescue KlaviyoAPI::ApiError => e
|
1782
|
+
puts "Error when calling CatalogsApi->get_create_categories_jobs_with_http_info: #{e}"
|
1783
|
+
end
|
1784
|
+
```
|
1785
|
+
|
1786
|
+
### Parameters
|
1787
|
+
|
1788
|
+
| Name | Type | Description | Notes |
|
1789
|
+
| ---- | ---- | ----------- | ----- |
|
1790
|
+
| **fields_catalog_category_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1791
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
1792
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
1793
|
+
|
1794
|
+
### Return type
|
1795
|
+
|
1796
|
+
**Hash<String, Object>**
|
1797
|
+
|
1798
|
+
### Authorization
|
1799
|
+
|
1800
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1801
|
+
|
1802
|
+
### HTTP request headers
|
1803
|
+
|
1804
|
+
- **Content-Type**: Not defined
|
1805
|
+
- **Accept**: application/json
|
1806
|
+
|
1807
|
+
|
1808
|
+
## get_create_items_job
|
1809
|
+
|
1810
|
+
> Hash<String, Object> get_create_items_job(job_id, opts)
|
1811
|
+
|
1812
|
+
Get Create Items Job
|
1813
|
+
|
1814
|
+
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`
|
1815
|
+
|
1816
|
+
### Examples
|
1817
|
+
|
1818
|
+
```ruby
|
1819
|
+
require 'time'
|
1820
|
+
require 'klaviyo-api-sdk'
|
1821
|
+
# setup authorization
|
1822
|
+
KlaviyoAPI.configure do |config|
|
1823
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1824
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1825
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1826
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1827
|
+
end
|
1828
|
+
|
1829
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1830
|
+
job_id = 'job_id_example' # String |
|
1831
|
+
opts = {
|
1832
|
+
fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1833
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1834
|
+
include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
1835
|
+
}
|
1836
|
+
|
1837
|
+
begin
|
1838
|
+
# Get Create Items Job
|
1839
|
+
result = api_instance.get_create_items_job(job_id, opts)
|
1840
|
+
p result
|
1841
|
+
rescue KlaviyoAPI::ApiError => e
|
1842
|
+
puts "Error when calling CatalogsApi->get_create_items_job: #{e}"
|
1843
|
+
end
|
1844
|
+
```
|
1845
|
+
|
1846
|
+
#### Using the get_create_items_job_with_http_info variant
|
1847
|
+
|
1848
|
+
This returns an Array which contains the response data, status code and headers.
|
1849
|
+
|
1850
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_create_items_job_with_http_info(job_id, opts)
|
1851
|
+
|
1852
|
+
```ruby
|
1853
|
+
begin
|
1854
|
+
# Get Create Items Job
|
1855
|
+
data, status_code, headers = api_instance.get_create_items_job_with_http_info(job_id, opts)
|
1856
|
+
p status_code # => 2xx
|
1857
|
+
p headers # => { ... }
|
1858
|
+
p data # => Hash<String, Object>
|
1859
|
+
rescue KlaviyoAPI::ApiError => e
|
1860
|
+
puts "Error when calling CatalogsApi->get_create_items_job_with_http_info: #{e}"
|
1861
|
+
end
|
1862
|
+
```
|
1863
|
+
|
1864
|
+
### Parameters
|
1865
|
+
|
1866
|
+
| Name | Type | Description | Notes |
|
1867
|
+
| ---- | ---- | ----------- | ----- |
|
1868
|
+
| **job_id** | **String** | | |
|
1869
|
+
| **fields_catalog_item_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1870
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1871
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
1872
|
+
|
1873
|
+
### Return type
|
1874
|
+
|
1875
|
+
**Hash<String, Object>**
|
1876
|
+
|
1877
|
+
### Authorization
|
1878
|
+
|
1879
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1880
|
+
|
1881
|
+
### HTTP request headers
|
1882
|
+
|
1883
|
+
- **Content-Type**: Not defined
|
1884
|
+
- **Accept**: application/json
|
1885
|
+
|
1886
|
+
|
1887
|
+
## get_create_items_jobs
|
1888
|
+
|
1889
|
+
> Hash<String, Object> get_create_items_jobs(opts)
|
1890
|
+
|
1891
|
+
Get Create Items Jobs
|
1892
|
+
|
1893
|
+
Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
1894
|
+
|
1895
|
+
### Examples
|
1896
|
+
|
1897
|
+
```ruby
|
1898
|
+
require 'time'
|
1899
|
+
require 'klaviyo-api-sdk'
|
1900
|
+
# setup authorization
|
1901
|
+
KlaviyoAPI.configure do |config|
|
1902
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1903
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1904
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1905
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1906
|
+
end
|
1907
|
+
|
1908
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1909
|
+
opts = {
|
1910
|
+
fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1911
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1912
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
1913
|
+
}
|
1914
|
+
|
1915
|
+
begin
|
1916
|
+
# Get Create Items Jobs
|
1917
|
+
result = api_instance.get_create_items_jobs(opts)
|
1918
|
+
p result
|
1919
|
+
rescue KlaviyoAPI::ApiError => e
|
1920
|
+
puts "Error when calling CatalogsApi->get_create_items_jobs: #{e}"
|
1921
|
+
end
|
1922
|
+
```
|
1923
|
+
|
1924
|
+
#### Using the get_create_items_jobs_with_http_info variant
|
1925
|
+
|
1926
|
+
This returns an Array which contains the response data, status code and headers.
|
1927
|
+
|
1928
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_create_items_jobs_with_http_info(opts)
|
1929
|
+
|
1930
|
+
```ruby
|
1931
|
+
begin
|
1932
|
+
# Get Create Items Jobs
|
1933
|
+
data, status_code, headers = api_instance.get_create_items_jobs_with_http_info(opts)
|
1934
|
+
p status_code # => 2xx
|
1935
|
+
p headers # => { ... }
|
1936
|
+
p data # => Hash<String, Object>
|
1937
|
+
rescue KlaviyoAPI::ApiError => e
|
1938
|
+
puts "Error when calling CatalogsApi->get_create_items_jobs_with_http_info: #{e}"
|
1939
|
+
end
|
1940
|
+
```
|
1941
|
+
|
1942
|
+
### Parameters
|
1943
|
+
|
1944
|
+
| Name | Type | Description | Notes |
|
1945
|
+
| ---- | ---- | ----------- | ----- |
|
1946
|
+
| **fields_catalog_item_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
1947
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
1948
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
1949
|
+
|
1950
|
+
### Return type
|
1951
|
+
|
1952
|
+
**Hash<String, Object>**
|
1953
|
+
|
1954
|
+
### Authorization
|
1955
|
+
|
1956
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1957
|
+
|
1958
|
+
### HTTP request headers
|
1959
|
+
|
1960
|
+
- **Content-Type**: Not defined
|
1961
|
+
- **Accept**: application/json
|
1962
|
+
|
1963
|
+
|
1964
|
+
## get_create_variants_job
|
1965
|
+
|
1966
|
+
> Hash<String, Object> get_create_variants_job(job_id, opts)
|
1967
|
+
|
1968
|
+
Get Create Variants Job
|
1969
|
+
|
1970
|
+
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`
|
1971
|
+
|
1972
|
+
### Examples
|
1973
|
+
|
1974
|
+
```ruby
|
1975
|
+
require 'time'
|
1976
|
+
require 'klaviyo-api-sdk'
|
1977
|
+
# setup authorization
|
1978
|
+
KlaviyoAPI.configure do |config|
|
1979
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1980
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1981
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1982
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1983
|
+
end
|
1984
|
+
|
1985
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
1986
|
+
job_id = 'job_id_example' # String |
|
1987
|
+
opts = {
|
1988
|
+
fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1989
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
1990
|
+
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
1991
|
+
}
|
1992
|
+
|
1993
|
+
begin
|
1994
|
+
# Get Create Variants Job
|
1995
|
+
result = api_instance.get_create_variants_job(job_id, opts)
|
1996
|
+
p result
|
1997
|
+
rescue KlaviyoAPI::ApiError => e
|
1998
|
+
puts "Error when calling CatalogsApi->get_create_variants_job: #{e}"
|
1999
|
+
end
|
2000
|
+
```
|
2001
|
+
|
2002
|
+
#### Using the get_create_variants_job_with_http_info variant
|
2003
|
+
|
2004
|
+
This returns an Array which contains the response data, status code and headers.
|
2005
|
+
|
2006
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_create_variants_job_with_http_info(job_id, opts)
|
2007
|
+
|
2008
|
+
```ruby
|
2009
|
+
begin
|
2010
|
+
# Get Create Variants Job
|
2011
|
+
data, status_code, headers = api_instance.get_create_variants_job_with_http_info(job_id, opts)
|
2012
|
+
p status_code # => 2xx
|
2013
|
+
p headers # => { ... }
|
2014
|
+
p data # => Hash<String, Object>
|
2015
|
+
rescue KlaviyoAPI::ApiError => e
|
2016
|
+
puts "Error when calling CatalogsApi->get_create_variants_job_with_http_info: #{e}"
|
2017
|
+
end
|
2018
|
+
```
|
2019
|
+
|
2020
|
+
### Parameters
|
2021
|
+
|
2022
|
+
| Name | Type | Description | Notes |
|
2023
|
+
| ---- | ---- | ----------- | ----- |
|
2024
|
+
| **job_id** | **String** | | |
|
2025
|
+
| **fields_catalog_variant_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2026
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2027
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
2028
|
+
|
2029
|
+
### Return type
|
2030
|
+
|
2031
|
+
**Hash<String, Object>**
|
2032
|
+
|
2033
|
+
### Authorization
|
2034
|
+
|
2035
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2036
|
+
|
2037
|
+
### HTTP request headers
|
2038
|
+
|
2039
|
+
- **Content-Type**: Not defined
|
2040
|
+
- **Accept**: application/json
|
2041
|
+
|
2042
|
+
|
2043
|
+
## get_create_variants_jobs
|
2044
|
+
|
2045
|
+
> Hash<String, Object> get_create_variants_jobs(opts)
|
2046
|
+
|
2047
|
+
Get Create Variants Jobs
|
2048
|
+
|
2049
|
+
Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
2050
|
+
|
2051
|
+
### Examples
|
2052
|
+
|
2053
|
+
```ruby
|
2054
|
+
require 'time'
|
2055
|
+
require 'klaviyo-api-sdk'
|
2056
|
+
# setup authorization
|
2057
|
+
KlaviyoAPI.configure do |config|
|
2058
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2059
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2060
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2061
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2062
|
+
end
|
2063
|
+
|
2064
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2065
|
+
opts = {
|
2066
|
+
fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2067
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2068
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
2069
|
+
}
|
2070
|
+
|
2071
|
+
begin
|
2072
|
+
# Get Create Variants Jobs
|
2073
|
+
result = api_instance.get_create_variants_jobs(opts)
|
2074
|
+
p result
|
2075
|
+
rescue KlaviyoAPI::ApiError => e
|
2076
|
+
puts "Error when calling CatalogsApi->get_create_variants_jobs: #{e}"
|
2077
|
+
end
|
2078
|
+
```
|
2079
|
+
|
2080
|
+
#### Using the get_create_variants_jobs_with_http_info variant
|
2081
|
+
|
2082
|
+
This returns an Array which contains the response data, status code and headers.
|
2083
|
+
|
2084
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_create_variants_jobs_with_http_info(opts)
|
2085
|
+
|
2086
|
+
```ruby
|
2087
|
+
begin
|
2088
|
+
# Get Create Variants Jobs
|
2089
|
+
data, status_code, headers = api_instance.get_create_variants_jobs_with_http_info(opts)
|
2090
|
+
p status_code # => 2xx
|
2091
|
+
p headers # => { ... }
|
2092
|
+
p data # => Hash<String, Object>
|
2093
|
+
rescue KlaviyoAPI::ApiError => e
|
2094
|
+
puts "Error when calling CatalogsApi->get_create_variants_jobs_with_http_info: #{e}"
|
2095
|
+
end
|
2096
|
+
```
|
2097
|
+
|
2098
|
+
### Parameters
|
2099
|
+
|
2100
|
+
| Name | Type | Description | Notes |
|
2101
|
+
| ---- | ---- | ----------- | ----- |
|
2102
|
+
| **fields_catalog_variant_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2103
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
2104
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
2105
|
+
|
2106
|
+
### Return type
|
2107
|
+
|
2108
|
+
**Hash<String, Object>**
|
2109
|
+
|
2110
|
+
### Authorization
|
2111
|
+
|
2112
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2113
|
+
|
2114
|
+
### HTTP request headers
|
2115
|
+
|
2116
|
+
- **Content-Type**: Not defined
|
2117
|
+
- **Accept**: application/json
|
2118
|
+
|
2119
|
+
|
2120
|
+
## get_delete_categories_job
|
2121
|
+
|
2122
|
+
> Hash<String, Object> get_delete_categories_job(job_id, opts)
|
2123
|
+
|
2124
|
+
Get Delete Categories Job
|
2125
|
+
|
2126
|
+
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`
|
2127
|
+
|
2128
|
+
### Examples
|
2129
|
+
|
2130
|
+
```ruby
|
2131
|
+
require 'time'
|
2132
|
+
require 'klaviyo-api-sdk'
|
2133
|
+
# setup authorization
|
2134
|
+
KlaviyoAPI.configure do |config|
|
2135
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2136
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2137
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2138
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2139
|
+
end
|
2140
|
+
|
2141
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2142
|
+
job_id = 'job_id_example' # String |
|
2143
|
+
opts = {
|
2144
|
+
fields_catalog_category_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2145
|
+
}
|
2146
|
+
|
2147
|
+
begin
|
2148
|
+
# Get Delete Categories Job
|
2149
|
+
result = api_instance.get_delete_categories_job(job_id, opts)
|
2150
|
+
p result
|
2151
|
+
rescue KlaviyoAPI::ApiError => e
|
2152
|
+
puts "Error when calling CatalogsApi->get_delete_categories_job: #{e}"
|
2153
|
+
end
|
2154
|
+
```
|
2155
|
+
|
2156
|
+
#### Using the get_delete_categories_job_with_http_info variant
|
2157
|
+
|
2158
|
+
This returns an Array which contains the response data, status code and headers.
|
2159
|
+
|
2160
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_delete_categories_job_with_http_info(job_id, opts)
|
2161
|
+
|
2162
|
+
```ruby
|
2163
|
+
begin
|
2164
|
+
# Get Delete Categories Job
|
2165
|
+
data, status_code, headers = api_instance.get_delete_categories_job_with_http_info(job_id, opts)
|
2166
|
+
p status_code # => 2xx
|
2167
|
+
p headers # => { ... }
|
2168
|
+
p data # => Hash<String, Object>
|
2169
|
+
rescue KlaviyoAPI::ApiError => e
|
2170
|
+
puts "Error when calling CatalogsApi->get_delete_categories_job_with_http_info: #{e}"
|
2171
|
+
end
|
2172
|
+
```
|
2173
|
+
|
2174
|
+
### Parameters
|
2175
|
+
|
2176
|
+
| Name | Type | Description | Notes |
|
2177
|
+
| ---- | ---- | ----------- | ----- |
|
2178
|
+
| **job_id** | **String** | | |
|
2179
|
+
| **fields_catalog_category_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2180
|
+
|
2181
|
+
### Return type
|
2182
|
+
|
2183
|
+
**Hash<String, Object>**
|
2184
|
+
|
2185
|
+
### Authorization
|
2186
|
+
|
2187
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2188
|
+
|
2189
|
+
### HTTP request headers
|
2190
|
+
|
2191
|
+
- **Content-Type**: Not defined
|
2192
|
+
- **Accept**: application/json
|
2193
|
+
|
2194
|
+
|
2195
|
+
## get_delete_categories_jobs
|
2196
|
+
|
2197
|
+
> Hash<String, Object> get_delete_categories_jobs(opts)
|
2198
|
+
|
2199
|
+
Get Delete Categories Jobs
|
2200
|
+
|
2201
|
+
Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
2202
|
+
|
2203
|
+
### Examples
|
2204
|
+
|
2205
|
+
```ruby
|
2206
|
+
require 'time'
|
2207
|
+
require 'klaviyo-api-sdk'
|
2208
|
+
# setup authorization
|
2209
|
+
KlaviyoAPI.configure do |config|
|
2210
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2211
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2212
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2213
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2214
|
+
end
|
2215
|
+
|
2216
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2217
|
+
opts = {
|
2218
|
+
fields_catalog_category_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2219
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2220
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
2221
|
+
}
|
2222
|
+
|
2223
|
+
begin
|
2224
|
+
# Get Delete Categories Jobs
|
2225
|
+
result = api_instance.get_delete_categories_jobs(opts)
|
2226
|
+
p result
|
2227
|
+
rescue KlaviyoAPI::ApiError => e
|
2228
|
+
puts "Error when calling CatalogsApi->get_delete_categories_jobs: #{e}"
|
2229
|
+
end
|
2230
|
+
```
|
2231
|
+
|
2232
|
+
#### Using the get_delete_categories_jobs_with_http_info variant
|
2233
|
+
|
2234
|
+
This returns an Array which contains the response data, status code and headers.
|
2235
|
+
|
2236
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_delete_categories_jobs_with_http_info(opts)
|
2237
|
+
|
2238
|
+
```ruby
|
2239
|
+
begin
|
2240
|
+
# Get Delete Categories Jobs
|
2241
|
+
data, status_code, headers = api_instance.get_delete_categories_jobs_with_http_info(opts)
|
2242
|
+
p status_code # => 2xx
|
2243
|
+
p headers # => { ... }
|
2244
|
+
p data # => Hash<String, Object>
|
2245
|
+
rescue KlaviyoAPI::ApiError => e
|
2246
|
+
puts "Error when calling CatalogsApi->get_delete_categories_jobs_with_http_info: #{e}"
|
2247
|
+
end
|
2248
|
+
```
|
2249
|
+
|
2250
|
+
### Parameters
|
2251
|
+
|
2252
|
+
| Name | Type | Description | Notes |
|
2253
|
+
| ---- | ---- | ----------- | ----- |
|
2254
|
+
| **fields_catalog_category_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2255
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
2256
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
2257
|
+
|
2258
|
+
### Return type
|
2259
|
+
|
2260
|
+
**Hash<String, Object>**
|
2261
|
+
|
2262
|
+
### Authorization
|
2263
|
+
|
2264
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2265
|
+
|
2266
|
+
### HTTP request headers
|
2267
|
+
|
2268
|
+
- **Content-Type**: Not defined
|
2269
|
+
- **Accept**: application/json
|
2270
|
+
|
2271
|
+
|
2272
|
+
## get_delete_items_job
|
2273
|
+
|
2274
|
+
> Hash<String, Object> get_delete_items_job(job_id, opts)
|
2275
|
+
|
2276
|
+
Get Delete Items Job
|
2277
|
+
|
2278
|
+
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`
|
2279
|
+
|
2280
|
+
### Examples
|
2281
|
+
|
2282
|
+
```ruby
|
2283
|
+
require 'time'
|
2284
|
+
require 'klaviyo-api-sdk'
|
2285
|
+
# setup authorization
|
2286
|
+
KlaviyoAPI.configure do |config|
|
2287
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2288
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2289
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2290
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2291
|
+
end
|
2292
|
+
|
2293
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2294
|
+
job_id = 'job_id_example' # String |
|
2295
|
+
opts = {
|
2296
|
+
fields_catalog_item_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2297
|
+
}
|
2298
|
+
|
2299
|
+
begin
|
2300
|
+
# Get Delete Items Job
|
2301
|
+
result = api_instance.get_delete_items_job(job_id, opts)
|
2302
|
+
p result
|
2303
|
+
rescue KlaviyoAPI::ApiError => e
|
2304
|
+
puts "Error when calling CatalogsApi->get_delete_items_job: #{e}"
|
2305
|
+
end
|
2306
|
+
```
|
2307
|
+
|
2308
|
+
#### Using the get_delete_items_job_with_http_info variant
|
2309
|
+
|
2310
|
+
This returns an Array which contains the response data, status code and headers.
|
2311
|
+
|
2312
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_delete_items_job_with_http_info(job_id, opts)
|
2313
|
+
|
2314
|
+
```ruby
|
2315
|
+
begin
|
2316
|
+
# Get Delete Items Job
|
2317
|
+
data, status_code, headers = api_instance.get_delete_items_job_with_http_info(job_id, opts)
|
2318
|
+
p status_code # => 2xx
|
2319
|
+
p headers # => { ... }
|
2320
|
+
p data # => Hash<String, Object>
|
2321
|
+
rescue KlaviyoAPI::ApiError => e
|
2322
|
+
puts "Error when calling CatalogsApi->get_delete_items_job_with_http_info: #{e}"
|
2323
|
+
end
|
2324
|
+
```
|
2325
|
+
|
2326
|
+
### Parameters
|
2327
|
+
|
2328
|
+
| Name | Type | Description | Notes |
|
2329
|
+
| ---- | ---- | ----------- | ----- |
|
2330
|
+
| **job_id** | **String** | | |
|
2331
|
+
| **fields_catalog_item_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2332
|
+
|
2333
|
+
### Return type
|
2334
|
+
|
2335
|
+
**Hash<String, Object>**
|
2336
|
+
|
2337
|
+
### Authorization
|
2338
|
+
|
2339
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2340
|
+
|
2341
|
+
### HTTP request headers
|
2342
|
+
|
2343
|
+
- **Content-Type**: Not defined
|
2344
|
+
- **Accept**: application/json
|
2345
|
+
|
2346
|
+
|
2347
|
+
## get_delete_items_jobs
|
2348
|
+
|
2349
|
+
> Hash<String, Object> get_delete_items_jobs(opts)
|
2350
|
+
|
2351
|
+
Get Delete Items Jobs
|
2352
|
+
|
2353
|
+
Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
2354
|
+
|
2355
|
+
### Examples
|
2356
|
+
|
2357
|
+
```ruby
|
2358
|
+
require 'time'
|
2359
|
+
require 'klaviyo-api-sdk'
|
2360
|
+
# setup authorization
|
2361
|
+
KlaviyoAPI.configure do |config|
|
2362
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2363
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2364
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2365
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2366
|
+
end
|
2367
|
+
|
2368
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2369
|
+
opts = {
|
2370
|
+
fields_catalog_item_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2371
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2372
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
2373
|
+
}
|
2374
|
+
|
2375
|
+
begin
|
2376
|
+
# Get Delete Items Jobs
|
2377
|
+
result = api_instance.get_delete_items_jobs(opts)
|
2378
|
+
p result
|
2379
|
+
rescue KlaviyoAPI::ApiError => e
|
2380
|
+
puts "Error when calling CatalogsApi->get_delete_items_jobs: #{e}"
|
2381
|
+
end
|
2382
|
+
```
|
2383
|
+
|
2384
|
+
#### Using the get_delete_items_jobs_with_http_info variant
|
2385
|
+
|
2386
|
+
This returns an Array which contains the response data, status code and headers.
|
2387
|
+
|
2388
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_delete_items_jobs_with_http_info(opts)
|
2389
|
+
|
2390
|
+
```ruby
|
2391
|
+
begin
|
2392
|
+
# Get Delete Items Jobs
|
2393
|
+
data, status_code, headers = api_instance.get_delete_items_jobs_with_http_info(opts)
|
2394
|
+
p status_code # => 2xx
|
2395
|
+
p headers # => { ... }
|
2396
|
+
p data # => Hash<String, Object>
|
2397
|
+
rescue KlaviyoAPI::ApiError => e
|
2398
|
+
puts "Error when calling CatalogsApi->get_delete_items_jobs_with_http_info: #{e}"
|
2399
|
+
end
|
2400
|
+
```
|
2401
|
+
|
2402
|
+
### Parameters
|
2403
|
+
|
2404
|
+
| Name | Type | Description | Notes |
|
2405
|
+
| ---- | ---- | ----------- | ----- |
|
2406
|
+
| **fields_catalog_item_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2407
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
2408
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
2409
|
+
|
2410
|
+
### Return type
|
2411
|
+
|
2412
|
+
**Hash<String, Object>**
|
2413
|
+
|
2414
|
+
### Authorization
|
2415
|
+
|
2416
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2417
|
+
|
2418
|
+
### HTTP request headers
|
2419
|
+
|
2420
|
+
- **Content-Type**: Not defined
|
2421
|
+
- **Accept**: application/json
|
2422
|
+
|
2423
|
+
|
2424
|
+
## get_delete_variants_job
|
2425
|
+
|
2426
|
+
> Hash<String, Object> get_delete_variants_job(job_id, opts)
|
2427
|
+
|
2428
|
+
Get Delete Variants Job
|
2429
|
+
|
2430
|
+
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`
|
2431
|
+
|
2432
|
+
### Examples
|
2433
|
+
|
2434
|
+
```ruby
|
2435
|
+
require 'time'
|
2436
|
+
require 'klaviyo-api-sdk'
|
2437
|
+
# setup authorization
|
2438
|
+
KlaviyoAPI.configure do |config|
|
2439
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2440
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2441
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2442
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2443
|
+
end
|
2444
|
+
|
2445
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2446
|
+
job_id = 'job_id_example' # String |
|
2447
|
+
opts = {
|
2448
|
+
fields_catalog_variant_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2449
|
+
}
|
2450
|
+
|
2451
|
+
begin
|
2452
|
+
# Get Delete Variants Job
|
2453
|
+
result = api_instance.get_delete_variants_job(job_id, opts)
|
2454
|
+
p result
|
2455
|
+
rescue KlaviyoAPI::ApiError => e
|
2456
|
+
puts "Error when calling CatalogsApi->get_delete_variants_job: #{e}"
|
2457
|
+
end
|
2458
|
+
```
|
2459
|
+
|
2460
|
+
#### Using the get_delete_variants_job_with_http_info variant
|
2461
|
+
|
2462
|
+
This returns an Array which contains the response data, status code and headers.
|
2463
|
+
|
2464
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_delete_variants_job_with_http_info(job_id, opts)
|
2465
|
+
|
2466
|
+
```ruby
|
2467
|
+
begin
|
2468
|
+
# Get Delete Variants Job
|
2469
|
+
data, status_code, headers = api_instance.get_delete_variants_job_with_http_info(job_id, opts)
|
2470
|
+
p status_code # => 2xx
|
2471
|
+
p headers # => { ... }
|
2472
|
+
p data # => Hash<String, Object>
|
2473
|
+
rescue KlaviyoAPI::ApiError => e
|
2474
|
+
puts "Error when calling CatalogsApi->get_delete_variants_job_with_http_info: #{e}"
|
2475
|
+
end
|
2476
|
+
```
|
2477
|
+
|
2478
|
+
### Parameters
|
2479
|
+
|
2480
|
+
| Name | Type | Description | Notes |
|
2481
|
+
| ---- | ---- | ----------- | ----- |
|
2482
|
+
| **job_id** | **String** | | |
|
2483
|
+
| **fields_catalog_variant_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2484
|
+
|
2485
|
+
### Return type
|
2486
|
+
|
2487
|
+
**Hash<String, Object>**
|
2488
|
+
|
2489
|
+
### Authorization
|
2490
|
+
|
2491
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2492
|
+
|
2493
|
+
### HTTP request headers
|
2494
|
+
|
2495
|
+
- **Content-Type**: Not defined
|
2496
|
+
- **Accept**: application/json
|
2497
|
+
|
2498
|
+
|
2499
|
+
## get_delete_variants_jobs
|
2500
|
+
|
2501
|
+
> Hash<String, Object> get_delete_variants_jobs(opts)
|
2502
|
+
|
2503
|
+
Get Delete Variants Jobs
|
2504
|
+
|
2505
|
+
Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
2506
|
+
|
2507
|
+
### Examples
|
2508
|
+
|
2509
|
+
```ruby
|
2510
|
+
require 'time'
|
2511
|
+
require 'klaviyo-api-sdk'
|
2512
|
+
# setup authorization
|
2513
|
+
KlaviyoAPI.configure do |config|
|
2514
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2515
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2516
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2517
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2518
|
+
end
|
2519
|
+
|
2520
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2521
|
+
opts = {
|
2522
|
+
fields_catalog_variant_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2523
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2524
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
2525
|
+
}
|
2526
|
+
|
2527
|
+
begin
|
2528
|
+
# Get Delete Variants Jobs
|
2529
|
+
result = api_instance.get_delete_variants_jobs(opts)
|
2530
|
+
p result
|
2531
|
+
rescue KlaviyoAPI::ApiError => e
|
2532
|
+
puts "Error when calling CatalogsApi->get_delete_variants_jobs: #{e}"
|
2533
|
+
end
|
2534
|
+
```
|
2535
|
+
|
2536
|
+
#### Using the get_delete_variants_jobs_with_http_info variant
|
2537
|
+
|
2538
|
+
This returns an Array which contains the response data, status code and headers.
|
2539
|
+
|
2540
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_delete_variants_jobs_with_http_info(opts)
|
2541
|
+
|
2542
|
+
```ruby
|
2543
|
+
begin
|
2544
|
+
# Get Delete Variants Jobs
|
2545
|
+
data, status_code, headers = api_instance.get_delete_variants_jobs_with_http_info(opts)
|
2546
|
+
p status_code # => 2xx
|
2547
|
+
p headers # => { ... }
|
2548
|
+
p data # => Hash<String, Object>
|
2549
|
+
rescue KlaviyoAPI::ApiError => e
|
2550
|
+
puts "Error when calling CatalogsApi->get_delete_variants_jobs_with_http_info: #{e}"
|
2551
|
+
end
|
2552
|
+
```
|
2553
|
+
|
2554
|
+
### Parameters
|
2555
|
+
|
2556
|
+
| Name | Type | Description | Notes |
|
2557
|
+
| ---- | ---- | ----------- | ----- |
|
2558
|
+
| **fields_catalog_variant_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2559
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
2560
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
2561
|
+
|
2562
|
+
### Return type
|
2563
|
+
|
2564
|
+
**Hash<String, Object>**
|
2565
|
+
|
2566
|
+
### Authorization
|
2567
|
+
|
2568
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2569
|
+
|
2570
|
+
### HTTP request headers
|
2571
|
+
|
2572
|
+
- **Content-Type**: Not defined
|
2573
|
+
- **Accept**: application/json
|
2574
|
+
|
2575
|
+
|
2576
|
+
## get_update_categories_job
|
2577
|
+
|
2578
|
+
> Hash<String, Object> get_update_categories_job(job_id, opts)
|
2579
|
+
|
2580
|
+
Get Update Categories Job
|
2581
|
+
|
2582
|
+
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`
|
2583
|
+
|
2584
|
+
### Examples
|
2585
|
+
|
2586
|
+
```ruby
|
2587
|
+
require 'time'
|
2588
|
+
require 'klaviyo-api-sdk'
|
2589
|
+
# setup authorization
|
2590
|
+
KlaviyoAPI.configure do |config|
|
2591
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2592
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2593
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2594
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2595
|
+
end
|
2596
|
+
|
2597
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2598
|
+
job_id = 'job_id_example' # String |
|
2599
|
+
opts = {
|
2600
|
+
fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2601
|
+
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2602
|
+
include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
2603
|
+
}
|
2604
|
+
|
2605
|
+
begin
|
2606
|
+
# Get Update Categories Job
|
2607
|
+
result = api_instance.get_update_categories_job(job_id, opts)
|
2608
|
+
p result
|
2609
|
+
rescue KlaviyoAPI::ApiError => e
|
2610
|
+
puts "Error when calling CatalogsApi->get_update_categories_job: #{e}"
|
2611
|
+
end
|
2612
|
+
```
|
2613
|
+
|
2614
|
+
#### Using the get_update_categories_job_with_http_info variant
|
2615
|
+
|
2616
|
+
This returns an Array which contains the response data, status code and headers.
|
2617
|
+
|
2618
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_update_categories_job_with_http_info(job_id, opts)
|
2619
|
+
|
2620
|
+
```ruby
|
2621
|
+
begin
|
2622
|
+
# Get Update Categories Job
|
2623
|
+
data, status_code, headers = api_instance.get_update_categories_job_with_http_info(job_id, opts)
|
2624
|
+
p status_code # => 2xx
|
2625
|
+
p headers # => { ... }
|
2626
|
+
p data # => Hash<String, Object>
|
2627
|
+
rescue KlaviyoAPI::ApiError => e
|
2628
|
+
puts "Error when calling CatalogsApi->get_update_categories_job_with_http_info: #{e}"
|
2629
|
+
end
|
2630
|
+
```
|
2631
|
+
|
2632
|
+
### Parameters
|
2633
|
+
|
2634
|
+
| Name | Type | Description | Notes |
|
2635
|
+
| ---- | ---- | ----------- | ----- |
|
2636
|
+
| **job_id** | **String** | | |
|
2637
|
+
| **fields_catalog_category_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2638
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2639
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
2640
|
+
|
2641
|
+
### Return type
|
2642
|
+
|
2643
|
+
**Hash<String, Object>**
|
2644
|
+
|
2645
|
+
### Authorization
|
2646
|
+
|
2647
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2648
|
+
|
2649
|
+
### HTTP request headers
|
2650
|
+
|
2651
|
+
- **Content-Type**: Not defined
|
2652
|
+
- **Accept**: application/json
|
2653
|
+
|
2654
|
+
|
2655
|
+
## get_update_categories_jobs
|
2656
|
+
|
2657
|
+
> Hash<String, Object> get_update_categories_jobs(opts)
|
2658
|
+
|
2659
|
+
Get Update Categories Jobs
|
2660
|
+
|
2661
|
+
Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
2662
|
+
|
2663
|
+
### Examples
|
2664
|
+
|
2665
|
+
```ruby
|
2666
|
+
require 'time'
|
2667
|
+
require 'klaviyo-api-sdk'
|
2668
|
+
# setup authorization
|
2669
|
+
KlaviyoAPI.configure do |config|
|
2670
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2671
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2672
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2673
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2674
|
+
end
|
2675
|
+
|
2676
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2677
|
+
opts = {
|
2678
|
+
fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2679
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2680
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
2681
|
+
}
|
2682
|
+
|
2683
|
+
begin
|
2684
|
+
# Get Update Categories Jobs
|
2685
|
+
result = api_instance.get_update_categories_jobs(opts)
|
2686
|
+
p result
|
2687
|
+
rescue KlaviyoAPI::ApiError => e
|
2688
|
+
puts "Error when calling CatalogsApi->get_update_categories_jobs: #{e}"
|
2689
|
+
end
|
2690
|
+
```
|
2691
|
+
|
2692
|
+
#### Using the get_update_categories_jobs_with_http_info variant
|
2693
|
+
|
2694
|
+
This returns an Array which contains the response data, status code and headers.
|
2695
|
+
|
2696
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_update_categories_jobs_with_http_info(opts)
|
2697
|
+
|
2698
|
+
```ruby
|
2699
|
+
begin
|
2700
|
+
# Get Update Categories Jobs
|
2701
|
+
data, status_code, headers = api_instance.get_update_categories_jobs_with_http_info(opts)
|
2702
|
+
p status_code # => 2xx
|
2703
|
+
p headers # => { ... }
|
2704
|
+
p data # => Hash<String, Object>
|
2705
|
+
rescue KlaviyoAPI::ApiError => e
|
2706
|
+
puts "Error when calling CatalogsApi->get_update_categories_jobs_with_http_info: #{e}"
|
2707
|
+
end
|
2708
|
+
```
|
2709
|
+
|
2710
|
+
### Parameters
|
2711
|
+
|
2712
|
+
| Name | Type | Description | Notes |
|
2713
|
+
| ---- | ---- | ----------- | ----- |
|
2714
|
+
| **fields_catalog_category_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2715
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
2716
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
2717
|
+
|
2718
|
+
### Return type
|
2719
|
+
|
2720
|
+
**Hash<String, Object>**
|
2721
|
+
|
2722
|
+
### Authorization
|
2723
|
+
|
2724
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2725
|
+
|
2726
|
+
### HTTP request headers
|
2727
|
+
|
2728
|
+
- **Content-Type**: Not defined
|
2729
|
+
- **Accept**: application/json
|
2730
|
+
|
2731
|
+
|
2732
|
+
## get_update_items_job
|
2733
|
+
|
2734
|
+
> Hash<String, Object> get_update_items_job(job_id, opts)
|
2735
|
+
|
2736
|
+
Get Update Items Job
|
2737
|
+
|
2738
|
+
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`
|
2739
|
+
|
2740
|
+
### Examples
|
2741
|
+
|
2742
|
+
```ruby
|
2743
|
+
require 'time'
|
2744
|
+
require 'klaviyo-api-sdk'
|
2745
|
+
# setup authorization
|
2746
|
+
KlaviyoAPI.configure do |config|
|
2747
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2748
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2749
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2750
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2751
|
+
end
|
2752
|
+
|
2753
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2754
|
+
job_id = 'job_id_example' # String |
|
2755
|
+
opts = {
|
2756
|
+
fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2757
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2758
|
+
include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
2759
|
+
}
|
2760
|
+
|
2761
|
+
begin
|
2762
|
+
# Get Update Items Job
|
2763
|
+
result = api_instance.get_update_items_job(job_id, opts)
|
2764
|
+
p result
|
2765
|
+
rescue KlaviyoAPI::ApiError => e
|
2766
|
+
puts "Error when calling CatalogsApi->get_update_items_job: #{e}"
|
2767
|
+
end
|
2768
|
+
```
|
2769
|
+
|
2770
|
+
#### Using the get_update_items_job_with_http_info variant
|
2771
|
+
|
2772
|
+
This returns an Array which contains the response data, status code and headers.
|
2773
|
+
|
2774
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_update_items_job_with_http_info(job_id, opts)
|
2775
|
+
|
2776
|
+
```ruby
|
2777
|
+
begin
|
2778
|
+
# Get Update Items Job
|
2779
|
+
data, status_code, headers = api_instance.get_update_items_job_with_http_info(job_id, opts)
|
2780
|
+
p status_code # => 2xx
|
2781
|
+
p headers # => { ... }
|
2782
|
+
p data # => Hash<String, Object>
|
2783
|
+
rescue KlaviyoAPI::ApiError => e
|
2784
|
+
puts "Error when calling CatalogsApi->get_update_items_job_with_http_info: #{e}"
|
2785
|
+
end
|
2786
|
+
```
|
2787
|
+
|
2788
|
+
### Parameters
|
2789
|
+
|
2790
|
+
| Name | Type | Description | Notes |
|
2791
|
+
| ---- | ---- | ----------- | ----- |
|
2792
|
+
| **job_id** | **String** | | |
|
2793
|
+
| **fields_catalog_item_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2794
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2795
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
2796
|
+
|
2797
|
+
### Return type
|
2798
|
+
|
2799
|
+
**Hash<String, Object>**
|
2800
|
+
|
2801
|
+
### Authorization
|
2802
|
+
|
2803
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2804
|
+
|
2805
|
+
### HTTP request headers
|
2806
|
+
|
2807
|
+
- **Content-Type**: Not defined
|
2808
|
+
- **Accept**: application/json
|
2809
|
+
|
2810
|
+
|
2811
|
+
## get_update_items_jobs
|
2812
|
+
|
2813
|
+
> Hash<String, Object> get_update_items_jobs(opts)
|
2814
|
+
|
2815
|
+
Get Update Items Jobs
|
2816
|
+
|
2817
|
+
Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
2818
|
+
|
2819
|
+
### Examples
|
2820
|
+
|
2821
|
+
```ruby
|
2822
|
+
require 'time'
|
2823
|
+
require 'klaviyo-api-sdk'
|
2824
|
+
# setup authorization
|
2825
|
+
KlaviyoAPI.configure do |config|
|
2826
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2827
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2828
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2829
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2830
|
+
end
|
2831
|
+
|
2832
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2833
|
+
opts = {
|
2834
|
+
fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2835
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2836
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
2837
|
+
}
|
2838
|
+
|
2839
|
+
begin
|
2840
|
+
# Get Update Items Jobs
|
2841
|
+
result = api_instance.get_update_items_jobs(opts)
|
2842
|
+
p result
|
2843
|
+
rescue KlaviyoAPI::ApiError => e
|
2844
|
+
puts "Error when calling CatalogsApi->get_update_items_jobs: #{e}"
|
2845
|
+
end
|
2846
|
+
```
|
2847
|
+
|
2848
|
+
#### Using the get_update_items_jobs_with_http_info variant
|
2849
|
+
|
2850
|
+
This returns an Array which contains the response data, status code and headers.
|
2851
|
+
|
2852
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_update_items_jobs_with_http_info(opts)
|
2853
|
+
|
2854
|
+
```ruby
|
2855
|
+
begin
|
2856
|
+
# Get Update Items Jobs
|
2857
|
+
data, status_code, headers = api_instance.get_update_items_jobs_with_http_info(opts)
|
2858
|
+
p status_code # => 2xx
|
2859
|
+
p headers # => { ... }
|
2860
|
+
p data # => Hash<String, Object>
|
2861
|
+
rescue KlaviyoAPI::ApiError => e
|
2862
|
+
puts "Error when calling CatalogsApi->get_update_items_jobs_with_http_info: #{e}"
|
2863
|
+
end
|
2864
|
+
```
|
2865
|
+
|
2866
|
+
### Parameters
|
2867
|
+
|
2868
|
+
| Name | Type | Description | Notes |
|
2869
|
+
| ---- | ---- | ----------- | ----- |
|
2870
|
+
| **fields_catalog_item_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2871
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
2872
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
2873
|
+
|
2874
|
+
### Return type
|
2875
|
+
|
2876
|
+
**Hash<String, Object>**
|
2877
|
+
|
2878
|
+
### Authorization
|
2879
|
+
|
2880
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2881
|
+
|
2882
|
+
### HTTP request headers
|
2883
|
+
|
2884
|
+
- **Content-Type**: Not defined
|
2885
|
+
- **Accept**: application/json
|
2886
|
+
|
2887
|
+
|
2888
|
+
## get_update_variants_job
|
2889
|
+
|
2890
|
+
> Hash<String, Object> get_update_variants_job(job_id, opts)
|
2891
|
+
|
2892
|
+
Get Update Variants Job
|
2893
|
+
|
2894
|
+
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`
|
2895
|
+
|
2896
|
+
### Examples
|
2897
|
+
|
2898
|
+
```ruby
|
2899
|
+
require 'time'
|
2900
|
+
require 'klaviyo-api-sdk'
|
2901
|
+
# setup authorization
|
2902
|
+
KlaviyoAPI.configure do |config|
|
2903
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2904
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2905
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2906
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2907
|
+
end
|
2908
|
+
|
2909
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2910
|
+
job_id = 'job_id_example' # String |
|
2911
|
+
opts = {
|
2912
|
+
fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2913
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2914
|
+
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
|
2915
|
+
}
|
2916
|
+
|
2917
|
+
begin
|
2918
|
+
# Get Update Variants Job
|
2919
|
+
result = api_instance.get_update_variants_job(job_id, opts)
|
2920
|
+
p result
|
2921
|
+
rescue KlaviyoAPI::ApiError => e
|
2922
|
+
puts "Error when calling CatalogsApi->get_update_variants_job: #{e}"
|
2923
|
+
end
|
2924
|
+
```
|
2925
|
+
|
2926
|
+
#### Using the get_update_variants_job_with_http_info variant
|
2927
|
+
|
2928
|
+
This returns an Array which contains the response data, status code and headers.
|
2929
|
+
|
2930
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_update_variants_job_with_http_info(job_id, opts)
|
2931
|
+
|
2932
|
+
```ruby
|
2933
|
+
begin
|
2934
|
+
# Get Update Variants Job
|
2935
|
+
data, status_code, headers = api_instance.get_update_variants_job_with_http_info(job_id, opts)
|
2936
|
+
p status_code # => 2xx
|
2937
|
+
p headers # => { ... }
|
2938
|
+
p data # => Hash<String, Object>
|
2939
|
+
rescue KlaviyoAPI::ApiError => e
|
2940
|
+
puts "Error when calling CatalogsApi->get_update_variants_job_with_http_info: #{e}"
|
2941
|
+
end
|
2942
|
+
```
|
2943
|
+
|
2944
|
+
### Parameters
|
2945
|
+
|
2946
|
+
| Name | Type | Description | Notes |
|
2947
|
+
| ---- | ---- | ----------- | ----- |
|
2948
|
+
| **job_id** | **String** | | |
|
2949
|
+
| **fields_catalog_variant_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2950
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
2951
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
|
2952
|
+
|
2953
|
+
### Return type
|
2954
|
+
|
2955
|
+
**Hash<String, Object>**
|
2956
|
+
|
2957
|
+
### Authorization
|
2958
|
+
|
2959
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
2960
|
+
|
2961
|
+
### HTTP request headers
|
2962
|
+
|
2963
|
+
- **Content-Type**: Not defined
|
2964
|
+
- **Accept**: application/json
|
2965
|
+
|
2966
|
+
|
2967
|
+
## get_update_variants_jobs
|
2968
|
+
|
2969
|
+
> Hash<String, Object> get_update_variants_jobs(opts)
|
2970
|
+
|
2971
|
+
Get Update Variants Jobs
|
2972
|
+
|
2973
|
+
Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
2974
|
+
|
2975
|
+
### Examples
|
2976
|
+
|
2977
|
+
```ruby
|
2978
|
+
require 'time'
|
2979
|
+
require 'klaviyo-api-sdk'
|
2980
|
+
# setup authorization
|
2981
|
+
KlaviyoAPI.configure do |config|
|
2982
|
+
# Configure API key authorization: Klaviyo-API-Key
|
2983
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
2984
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2985
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
2986
|
+
end
|
2987
|
+
|
2988
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
2989
|
+
opts = {
|
2990
|
+
fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
2991
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2992
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
2993
|
+
}
|
2994
|
+
|
2995
|
+
begin
|
2996
|
+
# Get Update Variants Jobs
|
2997
|
+
result = api_instance.get_update_variants_jobs(opts)
|
2998
|
+
p result
|
2999
|
+
rescue KlaviyoAPI::ApiError => e
|
3000
|
+
puts "Error when calling CatalogsApi->get_update_variants_jobs: #{e}"
|
3001
|
+
end
|
3002
|
+
```
|
3003
|
+
|
3004
|
+
#### Using the get_update_variants_jobs_with_http_info variant
|
3005
|
+
|
3006
|
+
This returns an Array which contains the response data, status code and headers.
|
3007
|
+
|
3008
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_update_variants_jobs_with_http_info(opts)
|
3009
|
+
|
3010
|
+
```ruby
|
3011
|
+
begin
|
3012
|
+
# Get Update Variants Jobs
|
3013
|
+
data, status_code, headers = api_instance.get_update_variants_jobs_with_http_info(opts)
|
3014
|
+
p status_code # => 2xx
|
3015
|
+
p headers # => { ... }
|
3016
|
+
p data # => Hash<String, Object>
|
3017
|
+
rescue KlaviyoAPI::ApiError => e
|
3018
|
+
puts "Error when calling CatalogsApi->get_update_variants_jobs_with_http_info: #{e}"
|
3019
|
+
end
|
3020
|
+
```
|
3021
|
+
|
3022
|
+
### Parameters
|
3023
|
+
|
3024
|
+
| Name | Type | Description | Notes |
|
3025
|
+
| ---- | ---- | ----------- | ----- |
|
3026
|
+
| **fields_catalog_variant_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
3027
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
3028
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
3029
|
+
|
3030
|
+
### Return type
|
3031
|
+
|
3032
|
+
**Hash<String, Object>**
|
3033
|
+
|
3034
|
+
### Authorization
|
3035
|
+
|
3036
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3037
|
+
|
3038
|
+
### HTTP request headers
|
3039
|
+
|
3040
|
+
- **Content-Type**: Not defined
|
3041
|
+
- **Accept**: application/json
|
3042
|
+
|
3043
|
+
|
3044
|
+
## spawn_create_categories_job
|
3045
|
+
|
3046
|
+
> Hash<String, Object> spawn_create_categories_job(catalog_category_create_job_create_query)
|
3047
|
+
|
3048
|
+
Spawn Create Categories Job
|
3049
|
+
|
3050
|
+
Create a catalog category bulk create job to create a batch of catalog categories.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3051
|
+
|
3052
|
+
### Examples
|
3053
|
+
|
3054
|
+
```ruby
|
3055
|
+
require 'time'
|
3056
|
+
require 'klaviyo-api-sdk'
|
3057
|
+
# setup authorization
|
3058
|
+
KlaviyoAPI.configure do |config|
|
3059
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3060
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3061
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3062
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3063
|
+
end
|
3064
|
+
|
3065
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3066
|
+
catalog_category_create_job_create_query = KlaviyoAPI::CatalogCategoryCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryCreateJobCreateQueryAsSubResource.new({type: 'catalog-category-bulk-create-job', attributes: KlaviyoAPI::CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.new({categories: [KlaviyoAPI::CatalogCategoryCreateQueryAsSubResource.new({type: 'catalog-category', attributes: KlaviyoAPI::CatalogCategoryCreateQueryAsSubResourceAttributes.new({external_id: 'external_id_example', name: 'name_example'})})]})})}) # CatalogCategoryCreateJobCreateQuery |
|
3067
|
+
|
3068
|
+
begin
|
3069
|
+
# Spawn Create Categories Job
|
3070
|
+
result = api_instance.spawn_create_categories_job(catalog_category_create_job_create_query)
|
3071
|
+
p result
|
3072
|
+
rescue KlaviyoAPI::ApiError => e
|
3073
|
+
puts "Error when calling CatalogsApi->spawn_create_categories_job: #{e}"
|
3074
|
+
end
|
3075
|
+
```
|
3076
|
+
|
3077
|
+
#### Using the spawn_create_categories_job_with_http_info variant
|
3078
|
+
|
3079
|
+
This returns an Array which contains the response data, status code and headers.
|
3080
|
+
|
3081
|
+
> <Array(Hash<String, Object>, Integer, Hash)> spawn_create_categories_job_with_http_info(catalog_category_create_job_create_query)
|
3082
|
+
|
3083
|
+
```ruby
|
3084
|
+
begin
|
3085
|
+
# Spawn Create Categories Job
|
3086
|
+
data, status_code, headers = api_instance.spawn_create_categories_job_with_http_info(catalog_category_create_job_create_query)
|
3087
|
+
p status_code # => 2xx
|
3088
|
+
p headers # => { ... }
|
3089
|
+
p data # => Hash<String, Object>
|
3090
|
+
rescue KlaviyoAPI::ApiError => e
|
3091
|
+
puts "Error when calling CatalogsApi->spawn_create_categories_job_with_http_info: #{e}"
|
3092
|
+
end
|
3093
|
+
```
|
3094
|
+
|
3095
|
+
### Parameters
|
3096
|
+
|
3097
|
+
| Name | Type | Description | Notes |
|
3098
|
+
| ---- | ---- | ----------- | ----- |
|
3099
|
+
| **catalog_category_create_job_create_query** | [**CatalogCategoryCreateJobCreateQuery**](CatalogCategoryCreateJobCreateQuery.md) | | |
|
3100
|
+
|
3101
|
+
### Return type
|
3102
|
+
|
3103
|
+
**Hash<String, Object>**
|
3104
|
+
|
3105
|
+
### Authorization
|
3106
|
+
|
3107
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3108
|
+
|
3109
|
+
### HTTP request headers
|
3110
|
+
|
3111
|
+
- **Content-Type**: application/json
|
3112
|
+
- **Accept**: application/json
|
3113
|
+
|
3114
|
+
|
3115
|
+
## spawn_create_items_job
|
3116
|
+
|
3117
|
+
> Hash<String, Object> spawn_create_items_job(catalog_item_create_job_create_query)
|
3118
|
+
|
3119
|
+
Spawn Create Items Job
|
3120
|
+
|
3121
|
+
Create a catalog item bulk create job to create a batch of catalog items.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3122
|
+
|
3123
|
+
### Examples
|
3124
|
+
|
3125
|
+
```ruby
|
3126
|
+
require 'time'
|
3127
|
+
require 'klaviyo-api-sdk'
|
3128
|
+
# setup authorization
|
3129
|
+
KlaviyoAPI.configure do |config|
|
3130
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3131
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3132
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3133
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3134
|
+
end
|
3135
|
+
|
3136
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3137
|
+
catalog_item_create_job_create_query = KlaviyoAPI::CatalogItemCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogItemCreateJobCreateQueryAsSubResource.new({type: 'catalog-item-bulk-create-job', attributes: KlaviyoAPI::CatalogItemCreateJobCreateQueryAsSubResourceAttributes.new({items: [KlaviyoAPI::CatalogItemCreateQueryAsSubResource.new({type: 'catalog-item', attributes: KlaviyoAPI::CatalogItemCreateQueryAsSubResourceAttributes.new({external_id: 'external_id_example', title: 'title_example', description: 'description_example', url: 'url_example'})})]})})}) # CatalogItemCreateJobCreateQuery |
|
3138
|
+
|
3139
|
+
begin
|
3140
|
+
# Spawn Create Items Job
|
3141
|
+
result = api_instance.spawn_create_items_job(catalog_item_create_job_create_query)
|
3142
|
+
p result
|
3143
|
+
rescue KlaviyoAPI::ApiError => e
|
3144
|
+
puts "Error when calling CatalogsApi->spawn_create_items_job: #{e}"
|
3145
|
+
end
|
3146
|
+
```
|
3147
|
+
|
3148
|
+
#### Using the spawn_create_items_job_with_http_info variant
|
3149
|
+
|
3150
|
+
This returns an Array which contains the response data, status code and headers.
|
3151
|
+
|
3152
|
+
> <Array(Hash<String, Object>, Integer, Hash)> spawn_create_items_job_with_http_info(catalog_item_create_job_create_query)
|
3153
|
+
|
3154
|
+
```ruby
|
3155
|
+
begin
|
3156
|
+
# Spawn Create Items Job
|
3157
|
+
data, status_code, headers = api_instance.spawn_create_items_job_with_http_info(catalog_item_create_job_create_query)
|
3158
|
+
p status_code # => 2xx
|
3159
|
+
p headers # => { ... }
|
3160
|
+
p data # => Hash<String, Object>
|
3161
|
+
rescue KlaviyoAPI::ApiError => e
|
3162
|
+
puts "Error when calling CatalogsApi->spawn_create_items_job_with_http_info: #{e}"
|
3163
|
+
end
|
3164
|
+
```
|
3165
|
+
|
3166
|
+
### Parameters
|
3167
|
+
|
3168
|
+
| Name | Type | Description | Notes |
|
3169
|
+
| ---- | ---- | ----------- | ----- |
|
3170
|
+
| **catalog_item_create_job_create_query** | [**CatalogItemCreateJobCreateQuery**](CatalogItemCreateJobCreateQuery.md) | | |
|
3171
|
+
|
3172
|
+
### Return type
|
3173
|
+
|
3174
|
+
**Hash<String, Object>**
|
3175
|
+
|
3176
|
+
### Authorization
|
3177
|
+
|
3178
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3179
|
+
|
3180
|
+
### HTTP request headers
|
3181
|
+
|
3182
|
+
- **Content-Type**: application/json
|
3183
|
+
- **Accept**: application/json
|
3184
|
+
|
3185
|
+
|
3186
|
+
## spawn_create_variants_job
|
3187
|
+
|
3188
|
+
> Hash<String, Object> spawn_create_variants_job(catalog_variant_create_job_create_query)
|
3189
|
+
|
3190
|
+
Spawn Create Variants Job
|
3191
|
+
|
3192
|
+
Create a catalog variant bulk create job to create a batch of catalog variants.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3193
|
+
|
3194
|
+
### Examples
|
3195
|
+
|
3196
|
+
```ruby
|
3197
|
+
require 'time'
|
3198
|
+
require 'klaviyo-api-sdk'
|
3199
|
+
# setup authorization
|
3200
|
+
KlaviyoAPI.configure do |config|
|
3201
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3202
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3203
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3204
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3205
|
+
end
|
3206
|
+
|
3207
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3208
|
+
catalog_variant_create_job_create_query = KlaviyoAPI::CatalogVariantCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantCreateJobCreateQueryAsSubResource.new({type: 'catalog-variant-bulk-create-job', attributes: KlaviyoAPI::CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.new({variants: [KlaviyoAPI::CatalogVariantCreateQueryAsSubResource.new({type: 'catalog-variant', attributes: KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes.new({external_id: 'external_id_example', title: 'title_example', description: 'description_example', sku: 'sku_example', inventory_policy: 0, inventory_quantity: 3.56, price: 3.56, url: 'url_example'})})]})})}) # CatalogVariantCreateJobCreateQuery |
|
3209
|
+
|
3210
|
+
begin
|
3211
|
+
# Spawn Create Variants Job
|
3212
|
+
result = api_instance.spawn_create_variants_job(catalog_variant_create_job_create_query)
|
3213
|
+
p result
|
3214
|
+
rescue KlaviyoAPI::ApiError => e
|
3215
|
+
puts "Error when calling CatalogsApi->spawn_create_variants_job: #{e}"
|
3216
|
+
end
|
3217
|
+
```
|
3218
|
+
|
3219
|
+
#### Using the spawn_create_variants_job_with_http_info variant
|
3220
|
+
|
3221
|
+
This returns an Array which contains the response data, status code and headers.
|
3222
|
+
|
3223
|
+
> <Array(Hash<String, Object>, Integer, Hash)> spawn_create_variants_job_with_http_info(catalog_variant_create_job_create_query)
|
3224
|
+
|
3225
|
+
```ruby
|
3226
|
+
begin
|
3227
|
+
# Spawn Create Variants Job
|
3228
|
+
data, status_code, headers = api_instance.spawn_create_variants_job_with_http_info(catalog_variant_create_job_create_query)
|
3229
|
+
p status_code # => 2xx
|
3230
|
+
p headers # => { ... }
|
3231
|
+
p data # => Hash<String, Object>
|
3232
|
+
rescue KlaviyoAPI::ApiError => e
|
3233
|
+
puts "Error when calling CatalogsApi->spawn_create_variants_job_with_http_info: #{e}"
|
3234
|
+
end
|
3235
|
+
```
|
3236
|
+
|
3237
|
+
### Parameters
|
3238
|
+
|
3239
|
+
| Name | Type | Description | Notes |
|
3240
|
+
| ---- | ---- | ----------- | ----- |
|
3241
|
+
| **catalog_variant_create_job_create_query** | [**CatalogVariantCreateJobCreateQuery**](CatalogVariantCreateJobCreateQuery.md) | | |
|
3242
|
+
|
3243
|
+
### Return type
|
3244
|
+
|
3245
|
+
**Hash<String, Object>**
|
3246
|
+
|
3247
|
+
### Authorization
|
3248
|
+
|
3249
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3250
|
+
|
3251
|
+
### HTTP request headers
|
3252
|
+
|
3253
|
+
- **Content-Type**: application/json
|
3254
|
+
- **Accept**: application/json
|
3255
|
+
|
3256
|
+
|
3257
|
+
## spawn_delete_categories_job
|
3258
|
+
|
3259
|
+
> Hash<String, Object> spawn_delete_categories_job(catalog_category_delete_job_create_query)
|
3260
|
+
|
3261
|
+
Spawn Delete Categories Job
|
3262
|
+
|
3263
|
+
Create a catalog category bulk delete job to delete a batch of catalog categories.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3264
|
+
|
3265
|
+
### Examples
|
3266
|
+
|
3267
|
+
```ruby
|
3268
|
+
require 'time'
|
3269
|
+
require 'klaviyo-api-sdk'
|
3270
|
+
# setup authorization
|
3271
|
+
KlaviyoAPI.configure do |config|
|
3272
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3273
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3274
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3275
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3276
|
+
end
|
3277
|
+
|
3278
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3279
|
+
catalog_category_delete_job_create_query = KlaviyoAPI::CatalogCategoryDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryDeleteJobCreateQueryAsSubResource.new({type: 'catalog-category-bulk-delete-job', attributes: KlaviyoAPI::CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.new({categories: [KlaviyoAPI::CatalogCategoryDeleteQueryAsSubResource.new({type: 'catalog-category', id: 'id_example'})]})})}) # CatalogCategoryDeleteJobCreateQuery |
|
3280
|
+
|
3281
|
+
begin
|
3282
|
+
# Spawn Delete Categories Job
|
3283
|
+
result = api_instance.spawn_delete_categories_job(catalog_category_delete_job_create_query)
|
3284
|
+
p result
|
3285
|
+
rescue KlaviyoAPI::ApiError => e
|
3286
|
+
puts "Error when calling CatalogsApi->spawn_delete_categories_job: #{e}"
|
3287
|
+
end
|
3288
|
+
```
|
3289
|
+
|
3290
|
+
#### Using the spawn_delete_categories_job_with_http_info variant
|
3291
|
+
|
3292
|
+
This returns an Array which contains the response data, status code and headers.
|
3293
|
+
|
3294
|
+
> <Array(Hash<String, Object>, Integer, Hash)> spawn_delete_categories_job_with_http_info(catalog_category_delete_job_create_query)
|
3295
|
+
|
3296
|
+
```ruby
|
3297
|
+
begin
|
3298
|
+
# Spawn Delete Categories Job
|
3299
|
+
data, status_code, headers = api_instance.spawn_delete_categories_job_with_http_info(catalog_category_delete_job_create_query)
|
3300
|
+
p status_code # => 2xx
|
3301
|
+
p headers # => { ... }
|
3302
|
+
p data # => Hash<String, Object>
|
3303
|
+
rescue KlaviyoAPI::ApiError => e
|
3304
|
+
puts "Error when calling CatalogsApi->spawn_delete_categories_job_with_http_info: #{e}"
|
3305
|
+
end
|
3306
|
+
```
|
3307
|
+
|
3308
|
+
### Parameters
|
3309
|
+
|
3310
|
+
| Name | Type | Description | Notes |
|
3311
|
+
| ---- | ---- | ----------- | ----- |
|
3312
|
+
| **catalog_category_delete_job_create_query** | [**CatalogCategoryDeleteJobCreateQuery**](CatalogCategoryDeleteJobCreateQuery.md) | | |
|
3313
|
+
|
3314
|
+
### Return type
|
3315
|
+
|
3316
|
+
**Hash<String, Object>**
|
3317
|
+
|
3318
|
+
### Authorization
|
3319
|
+
|
3320
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3321
|
+
|
3322
|
+
### HTTP request headers
|
3323
|
+
|
3324
|
+
- **Content-Type**: application/json
|
3325
|
+
- **Accept**: application/json
|
3326
|
+
|
3327
|
+
|
3328
|
+
## spawn_delete_items_job
|
3329
|
+
|
3330
|
+
> Hash<String, Object> spawn_delete_items_job(catalog_item_delete_job_create_query)
|
3331
|
+
|
3332
|
+
Spawn Delete Items Job
|
3333
|
+
|
3334
|
+
Create a catalog item bulk delete job to delete a batch of catalog items.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3335
|
+
|
3336
|
+
### Examples
|
3337
|
+
|
3338
|
+
```ruby
|
3339
|
+
require 'time'
|
3340
|
+
require 'klaviyo-api-sdk'
|
3341
|
+
# setup authorization
|
3342
|
+
KlaviyoAPI.configure do |config|
|
3343
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3344
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3345
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3346
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3347
|
+
end
|
3348
|
+
|
3349
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3350
|
+
catalog_item_delete_job_create_query = KlaviyoAPI::CatalogItemDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogItemDeleteJobCreateQueryAsSubResource.new({type: 'catalog-item-bulk-delete-job', attributes: KlaviyoAPI::CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.new({items: [KlaviyoAPI::CatalogItemDeleteQueryAsSubResource.new({type: 'catalog-item', id: 'id_example'})]})})}) # CatalogItemDeleteJobCreateQuery |
|
3351
|
+
|
3352
|
+
begin
|
3353
|
+
# Spawn Delete Items Job
|
3354
|
+
result = api_instance.spawn_delete_items_job(catalog_item_delete_job_create_query)
|
3355
|
+
p result
|
3356
|
+
rescue KlaviyoAPI::ApiError => e
|
3357
|
+
puts "Error when calling CatalogsApi->spawn_delete_items_job: #{e}"
|
3358
|
+
end
|
3359
|
+
```
|
3360
|
+
|
3361
|
+
#### Using the spawn_delete_items_job_with_http_info variant
|
3362
|
+
|
3363
|
+
This returns an Array which contains the response data, status code and headers.
|
3364
|
+
|
3365
|
+
> <Array(Hash<String, Object>, Integer, Hash)> spawn_delete_items_job_with_http_info(catalog_item_delete_job_create_query)
|
3366
|
+
|
3367
|
+
```ruby
|
3368
|
+
begin
|
3369
|
+
# Spawn Delete Items Job
|
3370
|
+
data, status_code, headers = api_instance.spawn_delete_items_job_with_http_info(catalog_item_delete_job_create_query)
|
3371
|
+
p status_code # => 2xx
|
3372
|
+
p headers # => { ... }
|
3373
|
+
p data # => Hash<String, Object>
|
3374
|
+
rescue KlaviyoAPI::ApiError => e
|
3375
|
+
puts "Error when calling CatalogsApi->spawn_delete_items_job_with_http_info: #{e}"
|
3376
|
+
end
|
3377
|
+
```
|
3378
|
+
|
3379
|
+
### Parameters
|
3380
|
+
|
3381
|
+
| Name | Type | Description | Notes |
|
3382
|
+
| ---- | ---- | ----------- | ----- |
|
3383
|
+
| **catalog_item_delete_job_create_query** | [**CatalogItemDeleteJobCreateQuery**](CatalogItemDeleteJobCreateQuery.md) | | |
|
3384
|
+
|
3385
|
+
### Return type
|
3386
|
+
|
3387
|
+
**Hash<String, Object>**
|
3388
|
+
|
3389
|
+
### Authorization
|
3390
|
+
|
3391
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3392
|
+
|
3393
|
+
### HTTP request headers
|
3394
|
+
|
3395
|
+
- **Content-Type**: application/json
|
3396
|
+
- **Accept**: application/json
|
3397
|
+
|
3398
|
+
|
3399
|
+
## spawn_delete_variants_job
|
3400
|
+
|
3401
|
+
> Hash<String, Object> spawn_delete_variants_job(catalog_variant_delete_job_create_query)
|
3402
|
+
|
3403
|
+
Spawn Delete Variants Job
|
3404
|
+
|
3405
|
+
Create a catalog variant bulk delete job to delete a batch of catalog variants.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3406
|
+
|
3407
|
+
### Examples
|
3408
|
+
|
3409
|
+
```ruby
|
3410
|
+
require 'time'
|
3411
|
+
require 'klaviyo-api-sdk'
|
3412
|
+
# setup authorization
|
3413
|
+
KlaviyoAPI.configure do |config|
|
3414
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3415
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3416
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3417
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3418
|
+
end
|
3419
|
+
|
3420
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3421
|
+
catalog_variant_delete_job_create_query = KlaviyoAPI::CatalogVariantDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantDeleteJobCreateQueryAsSubResource.new({type: 'catalog-variant-bulk-delete-job', attributes: KlaviyoAPI::CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.new({variants: [KlaviyoAPI::CatalogVariantDeleteQueryAsSubResource.new({type: 'catalog-variant', id: 'id_example'})]})})}) # CatalogVariantDeleteJobCreateQuery |
|
3422
|
+
|
3423
|
+
begin
|
3424
|
+
# Spawn Delete Variants Job
|
3425
|
+
result = api_instance.spawn_delete_variants_job(catalog_variant_delete_job_create_query)
|
3426
|
+
p result
|
3427
|
+
rescue KlaviyoAPI::ApiError => e
|
3428
|
+
puts "Error when calling CatalogsApi->spawn_delete_variants_job: #{e}"
|
3429
|
+
end
|
3430
|
+
```
|
3431
|
+
|
3432
|
+
#### Using the spawn_delete_variants_job_with_http_info variant
|
3433
|
+
|
3434
|
+
This returns an Array which contains the response data, status code and headers.
|
3435
|
+
|
3436
|
+
> <Array(Hash<String, Object>, Integer, Hash)> spawn_delete_variants_job_with_http_info(catalog_variant_delete_job_create_query)
|
3437
|
+
|
3438
|
+
```ruby
|
3439
|
+
begin
|
3440
|
+
# Spawn Delete Variants Job
|
3441
|
+
data, status_code, headers = api_instance.spawn_delete_variants_job_with_http_info(catalog_variant_delete_job_create_query)
|
3442
|
+
p status_code # => 2xx
|
3443
|
+
p headers # => { ... }
|
3444
|
+
p data # => Hash<String, Object>
|
3445
|
+
rescue KlaviyoAPI::ApiError => e
|
3446
|
+
puts "Error when calling CatalogsApi->spawn_delete_variants_job_with_http_info: #{e}"
|
3447
|
+
end
|
3448
|
+
```
|
3449
|
+
|
3450
|
+
### Parameters
|
3451
|
+
|
3452
|
+
| Name | Type | Description | Notes |
|
3453
|
+
| ---- | ---- | ----------- | ----- |
|
3454
|
+
| **catalog_variant_delete_job_create_query** | [**CatalogVariantDeleteJobCreateQuery**](CatalogVariantDeleteJobCreateQuery.md) | | |
|
3455
|
+
|
3456
|
+
### Return type
|
3457
|
+
|
3458
|
+
**Hash<String, Object>**
|
3459
|
+
|
3460
|
+
### Authorization
|
3461
|
+
|
3462
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3463
|
+
|
3464
|
+
### HTTP request headers
|
3465
|
+
|
3466
|
+
- **Content-Type**: application/json
|
3467
|
+
- **Accept**: application/json
|
3468
|
+
|
3469
|
+
|
3470
|
+
## spawn_update_categories_job
|
3471
|
+
|
3472
|
+
> Hash<String, Object> spawn_update_categories_job(catalog_category_update_job_create_query)
|
3473
|
+
|
3474
|
+
Spawn Update Categories Job
|
3475
|
+
|
3476
|
+
Create a catalog category bulk update job to update a batch of catalog categories.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3477
|
+
|
3478
|
+
### Examples
|
3479
|
+
|
3480
|
+
```ruby
|
3481
|
+
require 'time'
|
3482
|
+
require 'klaviyo-api-sdk'
|
3483
|
+
# setup authorization
|
3484
|
+
KlaviyoAPI.configure do |config|
|
3485
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3486
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3487
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3488
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3489
|
+
end
|
3490
|
+
|
3491
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3492
|
+
catalog_category_update_job_create_query = KlaviyoAPI::CatalogCategoryUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryUpdateJobCreateQueryAsSubResource.new({type: 'catalog-category-bulk-update-job', attributes: KlaviyoAPI::CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.new({categories: [KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResource.new({type: 'catalog-category', id: 'id_example', attributes: KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResourceAttributes.new})]})})}) # CatalogCategoryUpdateJobCreateQuery |
|
3493
|
+
|
3494
|
+
begin
|
3495
|
+
# Spawn Update Categories Job
|
3496
|
+
result = api_instance.spawn_update_categories_job(catalog_category_update_job_create_query)
|
3497
|
+
p result
|
3498
|
+
rescue KlaviyoAPI::ApiError => e
|
3499
|
+
puts "Error when calling CatalogsApi->spawn_update_categories_job: #{e}"
|
3500
|
+
end
|
3501
|
+
```
|
3502
|
+
|
3503
|
+
#### Using the spawn_update_categories_job_with_http_info variant
|
3504
|
+
|
3505
|
+
This returns an Array which contains the response data, status code and headers.
|
3506
|
+
|
3507
|
+
> <Array(Hash<String, Object>, Integer, Hash)> spawn_update_categories_job_with_http_info(catalog_category_update_job_create_query)
|
3508
|
+
|
3509
|
+
```ruby
|
3510
|
+
begin
|
3511
|
+
# Spawn Update Categories Job
|
3512
|
+
data, status_code, headers = api_instance.spawn_update_categories_job_with_http_info(catalog_category_update_job_create_query)
|
3513
|
+
p status_code # => 2xx
|
3514
|
+
p headers # => { ... }
|
3515
|
+
p data # => Hash<String, Object>
|
3516
|
+
rescue KlaviyoAPI::ApiError => e
|
3517
|
+
puts "Error when calling CatalogsApi->spawn_update_categories_job_with_http_info: #{e}"
|
3518
|
+
end
|
3519
|
+
```
|
3520
|
+
|
3521
|
+
### Parameters
|
3522
|
+
|
3523
|
+
| Name | Type | Description | Notes |
|
3524
|
+
| ---- | ---- | ----------- | ----- |
|
3525
|
+
| **catalog_category_update_job_create_query** | [**CatalogCategoryUpdateJobCreateQuery**](CatalogCategoryUpdateJobCreateQuery.md) | | |
|
3526
|
+
|
3527
|
+
### Return type
|
3528
|
+
|
3529
|
+
**Hash<String, Object>**
|
3530
|
+
|
3531
|
+
### Authorization
|
3532
|
+
|
3533
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3534
|
+
|
3535
|
+
### HTTP request headers
|
3536
|
+
|
3537
|
+
- **Content-Type**: application/json
|
3538
|
+
- **Accept**: application/json
|
3539
|
+
|
3540
|
+
|
3541
|
+
## spawn_update_items_job
|
3542
|
+
|
3543
|
+
> Hash<String, Object> spawn_update_items_job(catalog_item_update_job_create_query)
|
3544
|
+
|
3545
|
+
Spawn Update Items Job
|
3546
|
+
|
3547
|
+
Create a catalog item bulk update job to update a batch of catalog items.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3548
|
+
|
3549
|
+
### Examples
|
3550
|
+
|
3551
|
+
```ruby
|
3552
|
+
require 'time'
|
3553
|
+
require 'klaviyo-api-sdk'
|
3554
|
+
# setup authorization
|
3555
|
+
KlaviyoAPI.configure do |config|
|
3556
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3557
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3558
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3559
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3560
|
+
end
|
3561
|
+
|
3562
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3563
|
+
catalog_item_update_job_create_query = KlaviyoAPI::CatalogItemUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogItemUpdateJobCreateQueryAsSubResource.new({type: 'catalog-item-bulk-update-job', attributes: KlaviyoAPI::CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.new({items: [KlaviyoAPI::CatalogItemUpdateQueryAsSubResource.new({type: 'catalog-item', id: 'id_example', attributes: KlaviyoAPI::CatalogItemUpdateQueryAsSubResourceAttributes.new})]})})}) # CatalogItemUpdateJobCreateQuery |
|
3564
|
+
|
3565
|
+
begin
|
3566
|
+
# Spawn Update Items Job
|
3567
|
+
result = api_instance.spawn_update_items_job(catalog_item_update_job_create_query)
|
3568
|
+
p result
|
3569
|
+
rescue KlaviyoAPI::ApiError => e
|
3570
|
+
puts "Error when calling CatalogsApi->spawn_update_items_job: #{e}"
|
3571
|
+
end
|
3572
|
+
```
|
3573
|
+
|
3574
|
+
#### Using the spawn_update_items_job_with_http_info variant
|
3575
|
+
|
3576
|
+
This returns an Array which contains the response data, status code and headers.
|
3577
|
+
|
3578
|
+
> <Array(Hash<String, Object>, Integer, Hash)> spawn_update_items_job_with_http_info(catalog_item_update_job_create_query)
|
3579
|
+
|
3580
|
+
```ruby
|
3581
|
+
begin
|
3582
|
+
# Spawn Update Items Job
|
3583
|
+
data, status_code, headers = api_instance.spawn_update_items_job_with_http_info(catalog_item_update_job_create_query)
|
3584
|
+
p status_code # => 2xx
|
3585
|
+
p headers # => { ... }
|
3586
|
+
p data # => Hash<String, Object>
|
3587
|
+
rescue KlaviyoAPI::ApiError => e
|
3588
|
+
puts "Error when calling CatalogsApi->spawn_update_items_job_with_http_info: #{e}"
|
3589
|
+
end
|
3590
|
+
```
|
3591
|
+
|
3592
|
+
### Parameters
|
3593
|
+
|
3594
|
+
| Name | Type | Description | Notes |
|
3595
|
+
| ---- | ---- | ----------- | ----- |
|
3596
|
+
| **catalog_item_update_job_create_query** | [**CatalogItemUpdateJobCreateQuery**](CatalogItemUpdateJobCreateQuery.md) | | |
|
3597
|
+
|
3598
|
+
### Return type
|
3599
|
+
|
3600
|
+
**Hash<String, Object>**
|
3601
|
+
|
3602
|
+
### Authorization
|
3603
|
+
|
3604
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3605
|
+
|
3606
|
+
### HTTP request headers
|
3607
|
+
|
3608
|
+
- **Content-Type**: application/json
|
3609
|
+
- **Accept**: application/json
|
3610
|
+
|
3611
|
+
|
3612
|
+
## spawn_update_variants_job
|
3613
|
+
|
3614
|
+
> Hash<String, Object> spawn_update_variants_job(catalog_variant_update_job_create_query)
|
3615
|
+
|
3616
|
+
Spawn Update Variants Job
|
3617
|
+
|
3618
|
+
Create a catalog variant bulk update job to update a batch of catalog variants.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3619
|
+
|
3620
|
+
### Examples
|
3621
|
+
|
3622
|
+
```ruby
|
3623
|
+
require 'time'
|
3624
|
+
require 'klaviyo-api-sdk'
|
3625
|
+
# setup authorization
|
3626
|
+
KlaviyoAPI.configure do |config|
|
3627
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3628
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3629
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3630
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3631
|
+
end
|
3632
|
+
|
3633
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3634
|
+
catalog_variant_update_job_create_query = KlaviyoAPI::CatalogVariantUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantUpdateJobCreateQueryAsSubResource.new({type: 'catalog-variant-bulk-update-job', attributes: KlaviyoAPI::CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.new({variants: [KlaviyoAPI::CatalogVariantUpdateQueryAsSubResource.new({type: 'catalog-variant', id: 'id_example', attributes: KlaviyoAPI::CatalogVariantUpdateQueryAsSubResourceAttributes.new})]})})}) # CatalogVariantUpdateJobCreateQuery |
|
3635
|
+
|
3636
|
+
begin
|
3637
|
+
# Spawn Update Variants Job
|
3638
|
+
result = api_instance.spawn_update_variants_job(catalog_variant_update_job_create_query)
|
3639
|
+
p result
|
3640
|
+
rescue KlaviyoAPI::ApiError => e
|
3641
|
+
puts "Error when calling CatalogsApi->spawn_update_variants_job: #{e}"
|
3642
|
+
end
|
3643
|
+
```
|
3644
|
+
|
3645
|
+
#### Using the spawn_update_variants_job_with_http_info variant
|
3646
|
+
|
3647
|
+
This returns an Array which contains the response data, status code and headers.
|
3648
|
+
|
3649
|
+
> <Array(Hash<String, Object>, Integer, Hash)> spawn_update_variants_job_with_http_info(catalog_variant_update_job_create_query)
|
3650
|
+
|
3651
|
+
```ruby
|
3652
|
+
begin
|
3653
|
+
# Spawn Update Variants Job
|
3654
|
+
data, status_code, headers = api_instance.spawn_update_variants_job_with_http_info(catalog_variant_update_job_create_query)
|
3655
|
+
p status_code # => 2xx
|
3656
|
+
p headers # => { ... }
|
3657
|
+
p data # => Hash<String, Object>
|
3658
|
+
rescue KlaviyoAPI::ApiError => e
|
3659
|
+
puts "Error when calling CatalogsApi->spawn_update_variants_job_with_http_info: #{e}"
|
3660
|
+
end
|
3661
|
+
```
|
3662
|
+
|
3663
|
+
### Parameters
|
3664
|
+
|
3665
|
+
| Name | Type | Description | Notes |
|
3666
|
+
| ---- | ---- | ----------- | ----- |
|
3667
|
+
| **catalog_variant_update_job_create_query** | [**CatalogVariantUpdateJobCreateQuery**](CatalogVariantUpdateJobCreateQuery.md) | | |
|
3668
|
+
|
3669
|
+
### Return type
|
3670
|
+
|
3671
|
+
**Hash<String, Object>**
|
3672
|
+
|
3673
|
+
### Authorization
|
3674
|
+
|
3675
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3676
|
+
|
3677
|
+
### HTTP request headers
|
3678
|
+
|
3679
|
+
- **Content-Type**: application/json
|
3680
|
+
- **Accept**: application/json
|
3681
|
+
|
3682
|
+
|
3683
|
+
## update_catalog_category
|
3684
|
+
|
3685
|
+
> Hash<String, Object> update_catalog_category(id, catalog_category_update_query)
|
3686
|
+
|
3687
|
+
Update Catalog Category
|
3688
|
+
|
3689
|
+
Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3690
|
+
|
3691
|
+
### Examples
|
3692
|
+
|
3693
|
+
```ruby
|
3694
|
+
require 'time'
|
3695
|
+
require 'klaviyo-api-sdk'
|
3696
|
+
# setup authorization
|
3697
|
+
KlaviyoAPI.configure do |config|
|
3698
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3699
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3700
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3701
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3702
|
+
end
|
3703
|
+
|
3704
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3705
|
+
id = 'id_example' # String |
|
3706
|
+
catalog_category_update_query = KlaviyoAPI::CatalogCategoryUpdateQuery.new({data: KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResource.new({type: 'catalog-category', id: 'id_example', attributes: KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResourceAttributes.new})}) # CatalogCategoryUpdateQuery |
|
3707
|
+
|
3708
|
+
begin
|
3709
|
+
# Update Catalog Category
|
3710
|
+
result = api_instance.update_catalog_category(id, catalog_category_update_query)
|
3711
|
+
p result
|
3712
|
+
rescue KlaviyoAPI::ApiError => e
|
3713
|
+
puts "Error when calling CatalogsApi->update_catalog_category: #{e}"
|
3714
|
+
end
|
3715
|
+
```
|
3716
|
+
|
3717
|
+
#### Using the update_catalog_category_with_http_info variant
|
3718
|
+
|
3719
|
+
This returns an Array which contains the response data, status code and headers.
|
3720
|
+
|
3721
|
+
> <Array(Hash<String, Object>, Integer, Hash)> update_catalog_category_with_http_info(id, catalog_category_update_query)
|
3722
|
+
|
3723
|
+
```ruby
|
3724
|
+
begin
|
3725
|
+
# Update Catalog Category
|
3726
|
+
data, status_code, headers = api_instance.update_catalog_category_with_http_info(id, catalog_category_update_query)
|
3727
|
+
p status_code # => 2xx
|
3728
|
+
p headers # => { ... }
|
3729
|
+
p data # => Hash<String, Object>
|
3730
|
+
rescue KlaviyoAPI::ApiError => e
|
3731
|
+
puts "Error when calling CatalogsApi->update_catalog_category_with_http_info: #{e}"
|
3732
|
+
end
|
3733
|
+
```
|
3734
|
+
|
3735
|
+
### Parameters
|
3736
|
+
|
3737
|
+
| Name | Type | Description | Notes |
|
3738
|
+
| ---- | ---- | ----------- | ----- |
|
3739
|
+
| **id** | **String** | | |
|
3740
|
+
| **catalog_category_update_query** | [**CatalogCategoryUpdateQuery**](CatalogCategoryUpdateQuery.md) | | |
|
3741
|
+
|
3742
|
+
### Return type
|
3743
|
+
|
3744
|
+
**Hash<String, Object>**
|
3745
|
+
|
3746
|
+
### Authorization
|
3747
|
+
|
3748
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3749
|
+
|
3750
|
+
### HTTP request headers
|
3751
|
+
|
3752
|
+
- **Content-Type**: application/json
|
3753
|
+
- **Accept**: application/json
|
3754
|
+
|
3755
|
+
|
3756
|
+
## update_catalog_category_relationships
|
3757
|
+
|
3758
|
+
> update_catalog_category_relationships(id, related_resource, catalog_category_item_op)
|
3759
|
+
|
3760
|
+
Update Catalog Category Relationships
|
3761
|
+
|
3762
|
+
Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3763
|
+
|
3764
|
+
### Examples
|
3765
|
+
|
3766
|
+
```ruby
|
3767
|
+
require 'time'
|
3768
|
+
require 'klaviyo-api-sdk'
|
3769
|
+
# setup authorization
|
3770
|
+
KlaviyoAPI.configure do |config|
|
3771
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3772
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3773
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3774
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3775
|
+
end
|
3776
|
+
|
3777
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3778
|
+
id = 'id_example' # String |
|
3779
|
+
related_resource = 'items' # String |
|
3780
|
+
catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
|
3781
|
+
|
3782
|
+
begin
|
3783
|
+
# Update Catalog Category Relationships
|
3784
|
+
api_instance.update_catalog_category_relationships(id, related_resource, catalog_category_item_op)
|
3785
|
+
rescue KlaviyoAPI::ApiError => e
|
3786
|
+
puts "Error when calling CatalogsApi->update_catalog_category_relationships: #{e}"
|
3787
|
+
end
|
3788
|
+
```
|
3789
|
+
|
3790
|
+
#### Using the update_catalog_category_relationships_with_http_info variant
|
3791
|
+
|
3792
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
3793
|
+
|
3794
|
+
> <Array(nil, Integer, Hash)> update_catalog_category_relationships_with_http_info(id, related_resource, catalog_category_item_op)
|
3795
|
+
|
3796
|
+
```ruby
|
3797
|
+
begin
|
3798
|
+
# Update Catalog Category Relationships
|
3799
|
+
data, status_code, headers = api_instance.update_catalog_category_relationships_with_http_info(id, related_resource, catalog_category_item_op)
|
3800
|
+
p status_code # => 2xx
|
3801
|
+
p headers # => { ... }
|
3802
|
+
p data # => nil
|
3803
|
+
rescue KlaviyoAPI::ApiError => e
|
3804
|
+
puts "Error when calling CatalogsApi->update_catalog_category_relationships_with_http_info: #{e}"
|
3805
|
+
end
|
3806
|
+
```
|
3807
|
+
|
3808
|
+
### Parameters
|
3809
|
+
|
3810
|
+
| Name | Type | Description | Notes |
|
3811
|
+
| ---- | ---- | ----------- | ----- |
|
3812
|
+
| **id** | **String** | | |
|
3813
|
+
| **related_resource** | **String** | | |
|
3814
|
+
| **catalog_category_item_op** | [**CatalogCategoryItemOp**](CatalogCategoryItemOp.md) | | |
|
3815
|
+
|
3816
|
+
### Return type
|
3817
|
+
|
3818
|
+
nil (empty response body)
|
3819
|
+
|
3820
|
+
### Authorization
|
3821
|
+
|
3822
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3823
|
+
|
3824
|
+
### HTTP request headers
|
3825
|
+
|
3826
|
+
- **Content-Type**: application/json
|
3827
|
+
- **Accept**: application/json
|
3828
|
+
|
3829
|
+
|
3830
|
+
## update_catalog_item
|
3831
|
+
|
3832
|
+
> Hash<String, Object> update_catalog_item(id, catalog_item_update_query)
|
3833
|
+
|
3834
|
+
Update Catalog Item
|
3835
|
+
|
3836
|
+
Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3837
|
+
|
3838
|
+
### Examples
|
3839
|
+
|
3840
|
+
```ruby
|
3841
|
+
require 'time'
|
3842
|
+
require 'klaviyo-api-sdk'
|
3843
|
+
# setup authorization
|
3844
|
+
KlaviyoAPI.configure do |config|
|
3845
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3846
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3847
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3848
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3849
|
+
end
|
3850
|
+
|
3851
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3852
|
+
id = 'id_example' # String |
|
3853
|
+
catalog_item_update_query = KlaviyoAPI::CatalogItemUpdateQuery.new({data: KlaviyoAPI::CatalogItemUpdateQueryAsSubResource.new({type: 'catalog-item', id: 'id_example', attributes: KlaviyoAPI::CatalogItemUpdateQueryAsSubResourceAttributes.new})}) # CatalogItemUpdateQuery |
|
3854
|
+
|
3855
|
+
begin
|
3856
|
+
# Update Catalog Item
|
3857
|
+
result = api_instance.update_catalog_item(id, catalog_item_update_query)
|
3858
|
+
p result
|
3859
|
+
rescue KlaviyoAPI::ApiError => e
|
3860
|
+
puts "Error when calling CatalogsApi->update_catalog_item: #{e}"
|
3861
|
+
end
|
3862
|
+
```
|
3863
|
+
|
3864
|
+
#### Using the update_catalog_item_with_http_info variant
|
3865
|
+
|
3866
|
+
This returns an Array which contains the response data, status code and headers.
|
3867
|
+
|
3868
|
+
> <Array(Hash<String, Object>, Integer, Hash)> update_catalog_item_with_http_info(id, catalog_item_update_query)
|
3869
|
+
|
3870
|
+
```ruby
|
3871
|
+
begin
|
3872
|
+
# Update Catalog Item
|
3873
|
+
data, status_code, headers = api_instance.update_catalog_item_with_http_info(id, catalog_item_update_query)
|
3874
|
+
p status_code # => 2xx
|
3875
|
+
p headers # => { ... }
|
3876
|
+
p data # => Hash<String, Object>
|
3877
|
+
rescue KlaviyoAPI::ApiError => e
|
3878
|
+
puts "Error when calling CatalogsApi->update_catalog_item_with_http_info: #{e}"
|
3879
|
+
end
|
3880
|
+
```
|
3881
|
+
|
3882
|
+
### Parameters
|
3883
|
+
|
3884
|
+
| Name | Type | Description | Notes |
|
3885
|
+
| ---- | ---- | ----------- | ----- |
|
3886
|
+
| **id** | **String** | | |
|
3887
|
+
| **catalog_item_update_query** | [**CatalogItemUpdateQuery**](CatalogItemUpdateQuery.md) | | |
|
3888
|
+
|
3889
|
+
### Return type
|
3890
|
+
|
3891
|
+
**Hash<String, Object>**
|
3892
|
+
|
3893
|
+
### Authorization
|
3894
|
+
|
3895
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3896
|
+
|
3897
|
+
### HTTP request headers
|
3898
|
+
|
3899
|
+
- **Content-Type**: application/json
|
3900
|
+
- **Accept**: application/json
|
3901
|
+
|
3902
|
+
|
3903
|
+
## update_catalog_item_relationships
|
3904
|
+
|
3905
|
+
> update_catalog_item_relationships(id, related_resource, catalog_item_category_op)
|
3906
|
+
|
3907
|
+
Update Catalog Item Relationships
|
3908
|
+
|
3909
|
+
Update catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3910
|
+
|
3911
|
+
### Examples
|
3912
|
+
|
3913
|
+
```ruby
|
3914
|
+
require 'time'
|
3915
|
+
require 'klaviyo-api-sdk'
|
3916
|
+
# setup authorization
|
3917
|
+
KlaviyoAPI.configure do |config|
|
3918
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3919
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3920
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3921
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3922
|
+
end
|
3923
|
+
|
3924
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3925
|
+
id = 'id_example' # String |
|
3926
|
+
related_resource = 'categories' # String |
|
3927
|
+
catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
|
3928
|
+
|
3929
|
+
begin
|
3930
|
+
# Update Catalog Item Relationships
|
3931
|
+
api_instance.update_catalog_item_relationships(id, related_resource, catalog_item_category_op)
|
3932
|
+
rescue KlaviyoAPI::ApiError => e
|
3933
|
+
puts "Error when calling CatalogsApi->update_catalog_item_relationships: #{e}"
|
3934
|
+
end
|
3935
|
+
```
|
3936
|
+
|
3937
|
+
#### Using the update_catalog_item_relationships_with_http_info variant
|
3938
|
+
|
3939
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
3940
|
+
|
3941
|
+
> <Array(nil, Integer, Hash)> update_catalog_item_relationships_with_http_info(id, related_resource, catalog_item_category_op)
|
3942
|
+
|
3943
|
+
```ruby
|
3944
|
+
begin
|
3945
|
+
# Update Catalog Item Relationships
|
3946
|
+
data, status_code, headers = api_instance.update_catalog_item_relationships_with_http_info(id, related_resource, catalog_item_category_op)
|
3947
|
+
p status_code # => 2xx
|
3948
|
+
p headers # => { ... }
|
3949
|
+
p data # => nil
|
3950
|
+
rescue KlaviyoAPI::ApiError => e
|
3951
|
+
puts "Error when calling CatalogsApi->update_catalog_item_relationships_with_http_info: #{e}"
|
3952
|
+
end
|
3953
|
+
```
|
3954
|
+
|
3955
|
+
### Parameters
|
3956
|
+
|
3957
|
+
| Name | Type | Description | Notes |
|
3958
|
+
| ---- | ---- | ----------- | ----- |
|
3959
|
+
| **id** | **String** | | |
|
3960
|
+
| **related_resource** | **String** | | |
|
3961
|
+
| **catalog_item_category_op** | [**CatalogItemCategoryOp**](CatalogItemCategoryOp.md) | | |
|
3962
|
+
|
3963
|
+
### Return type
|
3964
|
+
|
3965
|
+
nil (empty response body)
|
3966
|
+
|
3967
|
+
### Authorization
|
3968
|
+
|
3969
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
3970
|
+
|
3971
|
+
### HTTP request headers
|
3972
|
+
|
3973
|
+
- **Content-Type**: application/json
|
3974
|
+
- **Accept**: application/json
|
3975
|
+
|
3976
|
+
|
3977
|
+
## update_catalog_variant
|
3978
|
+
|
3979
|
+
> Hash<String, Object> update_catalog_variant(id, catalog_variant_update_query)
|
3980
|
+
|
3981
|
+
Update Catalog Variant
|
3982
|
+
|
3983
|
+
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`
|
3984
|
+
|
3985
|
+
### Examples
|
3986
|
+
|
3987
|
+
```ruby
|
3988
|
+
require 'time'
|
3989
|
+
require 'klaviyo-api-sdk'
|
3990
|
+
# setup authorization
|
3991
|
+
KlaviyoAPI.configure do |config|
|
3992
|
+
# Configure API key authorization: Klaviyo-API-Key
|
3993
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
3994
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3995
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
3996
|
+
end
|
3997
|
+
|
3998
|
+
api_instance = KlaviyoAPI::CatalogsApi.new
|
3999
|
+
id = 'id_example' # String |
|
4000
|
+
catalog_variant_update_query = KlaviyoAPI::CatalogVariantUpdateQuery.new({data: KlaviyoAPI::CatalogVariantUpdateQueryAsSubResource.new({type: 'catalog-variant', id: 'id_example', attributes: KlaviyoAPI::CatalogVariantUpdateQueryAsSubResourceAttributes.new})}) # CatalogVariantUpdateQuery |
|
4001
|
+
|
4002
|
+
begin
|
4003
|
+
# Update Catalog Variant
|
4004
|
+
result = api_instance.update_catalog_variant(id, catalog_variant_update_query)
|
4005
|
+
p result
|
4006
|
+
rescue KlaviyoAPI::ApiError => e
|
4007
|
+
puts "Error when calling CatalogsApi->update_catalog_variant: #{e}"
|
4008
|
+
end
|
4009
|
+
```
|
4010
|
+
|
4011
|
+
#### Using the update_catalog_variant_with_http_info variant
|
4012
|
+
|
4013
|
+
This returns an Array which contains the response data, status code and headers.
|
4014
|
+
|
4015
|
+
> <Array(Hash<String, Object>, Integer, Hash)> update_catalog_variant_with_http_info(id, catalog_variant_update_query)
|
4016
|
+
|
4017
|
+
```ruby
|
4018
|
+
begin
|
4019
|
+
# Update Catalog Variant
|
4020
|
+
data, status_code, headers = api_instance.update_catalog_variant_with_http_info(id, catalog_variant_update_query)
|
4021
|
+
p status_code # => 2xx
|
4022
|
+
p headers # => { ... }
|
4023
|
+
p data # => Hash<String, Object>
|
4024
|
+
rescue KlaviyoAPI::ApiError => e
|
4025
|
+
puts "Error when calling CatalogsApi->update_catalog_variant_with_http_info: #{e}"
|
4026
|
+
end
|
4027
|
+
```
|
4028
|
+
|
4029
|
+
### Parameters
|
4030
|
+
|
4031
|
+
| Name | Type | Description | Notes |
|
4032
|
+
| ---- | ---- | ----------- | ----- |
|
4033
|
+
| **id** | **String** | | |
|
4034
|
+
| **catalog_variant_update_query** | [**CatalogVariantUpdateQuery**](CatalogVariantUpdateQuery.md) | | |
|
4035
|
+
|
4036
|
+
### Return type
|
4037
|
+
|
4038
|
+
**Hash<String, Object>**
|
4039
|
+
|
4040
|
+
### Authorization
|
4041
|
+
|
4042
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
4043
|
+
|
4044
|
+
### HTTP request headers
|
4045
|
+
|
4046
|
+
- **Content-Type**: application/json
|
4047
|
+
- **Accept**: application/json
|
4048
|
+
|