klaviyo-api-sdk 1.1.0 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +507 -170
- data/docs/CampaignCloneQuery.md +1 -1
- data/docs/CampaignCloneQueryResourceObject.md +20 -0
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +20 -0
- data/docs/CampaignCreateQuery.md +1 -1
- data/docs/CampaignCreateQueryResourceObject.md +20 -0
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +28 -0
- data/docs/CampaignEnum.md +15 -0
- data/docs/CampaignMessageAssignTemplateQuery.md +1 -1
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +20 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +20 -0
- data/docs/CampaignMessageEnum.md +15 -0
- data/docs/CampaignMessagePartialUpdateQuery.md +1 -1
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +20 -0
- data/docs/CampaignPartialUpdateQuery.md +1 -1
- data/docs/CampaignPartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +26 -0
- data/docs/CampaignRecipientEstimationEnum.md +15 -0
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignRecipientEstimationJobEnum.md +15 -0
- data/docs/CampaignSendJobCreateQuery.md +1 -1
- data/docs/CampaignSendJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignSendJobEnum.md +15 -0
- data/docs/CampaignSendJobPartialUpdateQuery.md +1 -1
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignsApi.md +1275 -0
- data/docs/CatalogCategoryBulkCreateJobEnum.md +15 -0
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogCategoryCreateJobCreateQuery.md +1 -1
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryCreateQuery.md +1 -1
- data/docs/CatalogCategoryCreateQueryResourceObject.md +22 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +24 -0
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +1 -1
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryEnum.md +15 -0
- data/docs/CatalogCategoryItemOp.md +1 -1
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +1 -1
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryUpdateQuery.md +1 -1
- data/docs/CatalogCategoryUpdateQueryResourceObject.md +24 -0
- data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemBulkCreateJobEnum.md +15 -0
- data/docs/CatalogItemBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogItemBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogItemCategoryOp.md +1 -1
- data/docs/CatalogItemCreateJobCreateQuery.md +1 -1
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemCreateQuery.md +1 -1
- data/docs/CatalogItemCreateQueryResourceObject.md +22 -0
- data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +40 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +18 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQuery.md +1 -1
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogItemEnum.md +15 -0
- data/docs/CatalogItemUpdateJobCreateQuery.md +1 -1
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemUpdateQuery.md +1 -1
- data/docs/CatalogItemUpdateQueryResourceObject.md +24 -0
- data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +34 -0
- data/docs/CatalogJobErrorPayload.md +8 -8
- data/docs/CatalogVariantBulkCreateJobEnum.md +15 -0
- data/docs/CatalogVariantBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogVariantBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogVariantCreateJobCreateQuery.md +1 -1
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantCreateQuery.md +1 -1
- data/docs/CatalogVariantCreateQueryResourceObject.md +22 -0
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +46 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItems.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQuery.md +1 -1
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogVariantEnum.md +15 -0
- data/docs/CatalogVariantUpdateJobCreateQuery.md +1 -1
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantUpdateQuery.md +1 -1
- data/docs/CatalogVariantUpdateQueryResourceObject.md +22 -0
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +40 -0
- data/docs/CatalogsApi.md +340 -356
- data/docs/ClientApi.md +3 -3
- data/docs/CollectionLinks.md +26 -0
- data/docs/DataPrivacyApi.md +1 -1
- data/docs/DataPrivacyCreateDeletionJobQuery.md +1 -1
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +20 -0
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +22 -0
- data/docs/DataPrivacyDeletionJobEnum.md +15 -0
- data/docs/EmailChannel.md +18 -0
- data/docs/EmailMarketing.md +32 -0
- data/docs/EmailMarketingListSuppression.md +22 -0
- data/docs/EmailMarketingSuppression.md +20 -0
- data/docs/ErrorSource.md +1 -1
- data/docs/EventCreateQuery.md +1 -1
- data/docs/EventCreateQueryResourceObject.md +20 -0
- data/docs/EventCreateQueryResourceObjectAttributes.md +28 -0
- data/docs/EventEnum.md +15 -0
- data/docs/EventsApi.md +114 -42
- data/docs/FlowActionEnum.md +15 -0
- data/docs/FlowEnum.md +15 -0
- data/docs/FlowMessageEnum.md +15 -0
- data/docs/FlowUpdateQuery.md +1 -1
- data/docs/FlowUpdateQueryResourceObject.md +22 -0
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/FlowsApi.md +254 -102
- data/docs/GetCampaigns4XXResponse.md +18 -0
- data/docs/GetCampaigns4XXResponseErrorsInner.md +26 -0
- data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +20 -0
- data/docs/ListCreateQuery.md +1 -1
- data/docs/ListCreateQueryResourceObject.md +20 -0
- data/docs/ListCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/ListEnum.md +15 -0
- data/docs/ListPartialUpdateQuery.md +1 -1
- data/docs/ListPartialUpdateQueryResourceObject.md +22 -0
- data/docs/ListsApi.md +135 -65
- data/docs/MetricAggregateEnum.md +15 -0
- data/docs/MetricAggregateQuery.md +1 -1
- data/docs/MetricAggregateQueryResourceObject.md +20 -0
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +36 -0
- data/docs/MetricEnum.md +15 -0
- data/docs/MetricsApi.md +10 -10
- data/docs/ObjectLinks.md +18 -0
- data/docs/OnsiteProfileCreateQuery.md +1 -1
- data/docs/OnsiteProfileCreateQueryResourceObject.md +22 -0
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +38 -0
- data/docs/OnsiteProfileMetaIdentifiers.md +10 -10
- data/docs/OnsiteSubscriptionCreateQuery.md +1 -1
- data/docs/OnsiteSubscriptionCreateQueryResourceObject.md +20 -0
- data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md +26 -0
- data/docs/PredictiveAnalytics.md +34 -0
- data/docs/ProfileAggregateEnum.md +15 -0
- data/docs/ProfileCreateQuery.md +1 -1
- data/docs/ProfileCreateQueryResourceObject.md +20 -0
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +36 -0
- data/docs/ProfileEnum.md +15 -0
- data/docs/ProfileLocation.md +15 -15
- data/docs/ProfileLocationLongitude.md +49 -0
- data/docs/ProfilePartialUpdateQuery.md +1 -1
- data/docs/ProfilePartialUpdateQueryResourceObject.md +22 -0
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileUnsubscriptionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileUnsuppressionBulkCreateJobEnum.md +15 -0
- data/docs/ProfilesApi.md +140 -56
- data/docs/SMSChannel.md +18 -0
- data/docs/SMSMarketing.md +24 -0
- data/docs/STOScheduleOptions.md +18 -0
- data/docs/SegmentEnum.md +15 -0
- data/docs/SegmentPartialUpdateQuery.md +1 -1
- data/docs/SegmentPartialUpdateQueryResourceObject.md +22 -0
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/SegmentsApi.md +107 -33
- data/docs/SendOptionsSubObject.md +1 -3
- data/docs/SendStrategySubObject.md +4 -2
- data/docs/Subscription.md +8 -4
- data/docs/SubscriptionChannels.md +20 -0
- data/docs/SubscriptionCreateJobCreateQuery.md +1 -1
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +22 -0
- data/docs/SubscriptionEnum.md +15 -0
- data/docs/Subscriptions.md +20 -0
- data/docs/Suppression.md +1 -1
- data/docs/SuppressionCreateJobCreateQuery.md +1 -1
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/TagCampaignOp.md +18 -0
- data/docs/TagCampaignOpDataInner.md +20 -0
- data/docs/TagCreateQuery.md +1 -1
- data/docs/TagCreateQueryResourceObject.md +20 -0
- data/docs/TagCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagEnum.md +15 -0
- data/docs/TagFlowOp.md +18 -0
- data/docs/TagFlowOpDataInner.md +20 -0
- data/docs/TagGroupCreateQuery.md +1 -1
- data/docs/TagGroupCreateQueryResourceObject.md +20 -0
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagGroupEnum.md +15 -0
- data/docs/TagGroupUpdateQuery.md +1 -1
- data/docs/TagGroupUpdateQueryResourceObject.md +22 -0
- data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagListOp.md +18 -0
- data/docs/TagListOpDataInner.md +20 -0
- data/docs/TagUpdateQuery.md +1 -1
- data/docs/TagUpdateQueryResourceObject.md +22 -0
- data/docs/TagUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/TagsApi.md +894 -176
- data/docs/TemplateCloneQuery.md +1 -1
- data/docs/TemplateCloneQueryResourceObject.md +20 -0
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +22 -0
- data/docs/TemplateCreateQuery.md +1 -1
- data/docs/TemplateCreateQueryResourceObject.md +20 -0
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +32 -0
- data/docs/TemplateEnum.md +15 -0
- data/docs/TemplateRenderQuery.md +1 -1
- data/docs/TemplateRenderQueryResourceObject.md +20 -0
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +22 -0
- data/docs/TemplateUpdateQuery.md +1 -1
- data/docs/TemplateUpdateQueryResourceObject.md +22 -0
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +30 -0
- data/docs/TemplatesApi.md +15 -15
- data/docs/TestApiAnalyticsSampleEnum.md +15 -0
- data/docs/TestListEnum.md +15 -0
- data/docs/ThrottledScheduleOptions.md +1 -1
- data/docs/UnsubscriptionCreateJobCreateQuery.md +1 -1
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.md +22 -0
- data/docs/UnsuppressionCreateJobCreateQuery.md +1 -1
- data/docs/UnsuppressionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/UnsuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +1269 -0
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +385 -473
- data/lib/klaviyo-api-sdk/api/client_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/events_api.rb +118 -57
- data/lib/klaviyo-api-sdk/api/flows_api.rb +256 -137
- data/lib/klaviyo-api-sdk/api/lists_api.rb +138 -96
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +153 -68
- data/lib/klaviyo-api-sdk/api/segments_api.rb +110 -46
- data/lib/klaviyo-api-sdk/api/tags_api.rb +831 -159
- data/lib/klaviyo-api-sdk/api/templates_api.rb +20 -20
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +291 -0
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +256 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +296 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +262 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +220 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +390 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +262 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +302 -0
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +5 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +447 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_items.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_items_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +366 -0
- data/lib/klaviyo-api-sdk/models/collection_links.rb +260 -0
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/email_channel.rb +219 -0
- data/lib/klaviyo-api-sdk/models/email_marketing.rb +298 -0
- data/lib/klaviyo-api-sdk/models/email_marketing_list_suppression.rb +255 -0
- data/lib/klaviyo-api-sdk/models/email_marketing_suppression.rb +240 -0
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/error_source.rb +2 -1
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object_attributes.rb +284 -0
- data/lib/klaviyo-api-sdk/models/event_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_action_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response.rb +226 -0
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner.rb +275 -0
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner_source.rb +228 -0
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/list_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +388 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/object_links.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +318 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +16 -11
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object_attributes.rb +265 -0
- data/lib/klaviyo-api-sdk/models/predictive_analytics.rb +300 -0
- data/lib/klaviyo-api-sdk/models/profile_aggregate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +309 -0
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_location.rb +9 -2
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/send_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +5 -15
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +15 -6
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_channel.rb +219 -0
- data/lib/klaviyo-api-sdk/models/sms_marketing.rb +270 -0
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +225 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +26 -5
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/subscription_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/subscriptions.rb +228 -0
- data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +234 -0
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +236 -0
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +247 -0
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/test_api_analytics_sample_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/test_list_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object_attributes.rb +244 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +1 -1
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +162 -123
- data/spec/api/campaigns_api_spec.rb +255 -0
- data/spec/api/catalogs_api_spec.rb +162 -170
- data/spec/api/client_api_spec.rb +3 -3
- data/spec/api/data_privacy_api_spec.rb +1 -1
- data/spec/api/events_api_spec.rb +33 -21
- data/spec/api/flows_api_spec.rb +76 -49
- data/spec/api/lists_api_spec.rb +38 -27
- data/spec/api/metrics_api_spec.rb +8 -8
- data/spec/api/profiles_api_spec.rb +41 -25
- data/spec/api/segments_api_spec.rb +30 -17
- data/spec/api/tags_api_spec.rb +155 -33
- data/spec/api/templates_api_spec.rb +12 -14
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/audiences_sub_object_spec.rb +1 -1
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/campaign_clone_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_clone_query_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +64 -0
- data/spec/models/campaign_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_create_query_spec.rb +1 -1
- data/spec/models/campaign_enum_spec.rb +28 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_spec.rb +1 -1
- data/spec/models/campaign_message_enum_spec.rb +28 -0
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_message_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +58 -0
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_enum_spec.rb +28 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +28 -0
- data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_send_job_create_query_spec.rb +1 -1
- data/spec/models/campaign_send_job_enum_spec.rb +28 -0
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +56 -0
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_category_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_enum_spec.rb +28 -0
- data/spec/models/catalog_category_item_op_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +52 -0
- data/spec/models/catalog_category_update_query_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_category_op_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +44 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_item_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_enum_spec.rb +28 -0
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +82 -0
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +52 -0
- data/spec/models/catalog_item_update_query_spec.rb +1 -1
- data/spec/models/catalog_job_error_payload_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +126 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_data_inner_spec.rb +44 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_variant_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_variant_update_query_spec.rb +1 -1
- data/spec/models/collection_links_spec.rb +58 -0
- data/spec/models/content_sub_object_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +40 -0
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +1 -1
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +28 -0
- data/spec/models/email_channel_spec.rb +34 -0
- data/spec/models/email_marketing_list_suppression_spec.rb +46 -0
- data/spec/models/email_marketing_spec.rb +76 -0
- data/spec/models/email_marketing_suppression_spec.rb +40 -0
- data/spec/models/email_message_content_spec.rb +1 -1
- data/spec/models/email_tracking_options_spec.rb +1 -1
- data/spec/models/error_source_spec.rb +1 -1
- data/spec/models/event_create_query_resource_object_attributes_spec.rb +64 -0
- data/spec/models/event_create_query_resource_object_spec.rb +40 -0
- data/spec/models/event_create_query_spec.rb +1 -1
- data/spec/models/event_enum_spec.rb +28 -0
- data/spec/models/flow_action_enum_spec.rb +28 -0
- data/spec/models/flow_enum_spec.rb +28 -0
- data/spec/models/flow_message_enum_spec.rb +28 -0
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/flow_update_query_resource_object_spec.rb +46 -0
- data/spec/models/flow_update_query_spec.rb +1 -1
- data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +40 -0
- data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +58 -0
- data/spec/models/get_campaigns4_xx_response_spec.rb +34 -0
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/list_create_query_resource_object_spec.rb +40 -0
- data/spec/models/list_create_query_spec.rb +1 -1
- data/spec/models/list_enum_spec.rb +28 -0
- data/spec/models/list_members_add_query_data_inner_spec.rb +1 -1
- data/spec/models/list_members_add_query_spec.rb +1 -1
- data/spec/models/list_members_delete_query_spec.rb +1 -1
- data/spec/models/list_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/list_partial_update_query_spec.rb +1 -1
- data/spec/models/metric_aggregate_enum_spec.rb +28 -0
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +40 -0
- data/spec/models/metric_aggregate_query_spec.rb +1 -1
- data/spec/models/metric_aggregate_row_dto_spec.rb +1 -1
- data/spec/models/metric_create_query_spec.rb +1 -1
- data/spec/models/metric_enum_spec.rb +28 -0
- data/spec/models/object_links_spec.rb +34 -0
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +94 -0
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +46 -0
- data/spec/models/onsite_profile_create_query_spec.rb +1 -1
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +4 -4
- data/spec/models/onsite_profile_meta_spec.rb +1 -1
- data/spec/models/onsite_subscription_create_query_resource_object_attributes_spec.rb +58 -0
- data/spec/models/onsite_subscription_create_query_resource_object_spec.rb +40 -0
- data/spec/models/onsite_subscription_create_query_spec.rb +1 -1
- data/spec/models/predictive_analytics_spec.rb +82 -0
- data/spec/models/profile_aggregate_enum_spec.rb +28 -0
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +88 -0
- data/spec/models/profile_create_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_create_query_spec.rb +1 -1
- data/spec/models/profile_enum_spec.rb +28 -0
- data/spec/models/profile_location_latitude_spec.rb +1 -1
- data/spec/models/profile_location_longitude_spec.rb +31 -0
- data/spec/models/profile_location_spec.rb +1 -1
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/profile_partial_update_query_spec.rb +1 -1
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_unsubscription_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_unsuppression_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/segment_enum_spec.rb +28 -0
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/segment_partial_update_query_spec.rb +1 -1
- data/spec/models/send_options_spec.rb +1 -1
- data/spec/models/send_options_sub_object_spec.rb +1 -7
- data/spec/models/send_strategy_sub_object_spec.rb +7 -1
- data/spec/models/send_time_sub_object_spec.rb +1 -1
- data/spec/models/sms_channel_spec.rb +34 -0
- data/spec/models/sms_marketing_spec.rb +52 -0
- data/spec/models/sms_message_content_spec.rb +1 -1
- data/spec/models/sms_render_options_spec.rb +1 -1
- data/spec/models/sms_tracking_options_spec.rb +1 -1
- data/spec/models/static_schedule_options_spec.rb +1 -1
- data/spec/models/sto_schedule_options_spec.rb +34 -0
- data/spec/models/subscription_channels_spec.rb +48 -0
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_spec.rb +1 -1
- data/spec/models/subscription_enum_spec.rb +28 -0
- data/spec/models/subscription_spec.rb +13 -1
- data/spec/models/subscriptions_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_spec.rb +1 -1
- data/spec/models/suppression_spec.rb +1 -1
- data/spec/models/tag_campaign_op_data_inner_spec.rb +44 -0
- data/spec/models/tag_campaign_op_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_create_query_resource_object_spec.rb +40 -0
- data/spec/models/tag_create_query_spec.rb +1 -1
- data/spec/models/tag_enum_spec.rb +28 -0
- data/spec/models/tag_flow_op_data_inner_spec.rb +44 -0
- data/spec/models/tag_flow_op_spec.rb +34 -0
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_group_create_query_resource_object_spec.rb +40 -0
- data/spec/models/tag_group_create_query_spec.rb +1 -1
- data/spec/models/tag_group_enum_spec.rb +28 -0
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_group_update_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_group_update_query_spec.rb +1 -1
- data/spec/models/tag_list_op_data_inner_spec.rb +44 -0
- data/spec/models/tag_list_op_spec.rb +34 -0
- data/spec/models/tag_segment_op_data_inner_spec.rb +1 -1
- data/spec/models/tag_segment_op_spec.rb +1 -1
- data/spec/models/tag_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/tag_update_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_update_query_spec.rb +1 -1
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/template_clone_query_resource_object_spec.rb +40 -0
- data/spec/models/template_clone_query_spec.rb +1 -1
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +58 -0
- data/spec/models/template_create_query_resource_object_spec.rb +40 -0
- data/spec/models/template_create_query_spec.rb +1 -1
- data/spec/models/template_enum_spec.rb +28 -0
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/template_render_query_resource_object_spec.rb +40 -0
- data/spec/models/template_render_query_spec.rb +1 -1
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +52 -0
- data/spec/models/template_update_query_resource_object_spec.rb +46 -0
- data/spec/models/template_update_query_spec.rb +1 -1
- data/spec/models/test_api_analytics_sample_enum_spec.rb +28 -0
- data/spec/models/test_list_enum_spec.rb +28 -0
- data/spec/models/throttled_schedule_options_spec.rb +1 -1
- data/spec/models/tracking_options_sub_object_spec.rb +1 -1
- data/spec/models/unsubscription_create_job_create_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/unsubscription_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/unsubscription_create_job_create_query_spec.rb +1 -1
- data/spec/models/unsuppression_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/unsuppression_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/unsuppression_create_job_create_query_spec.rb +1 -1
- data/spec/models/utm_param_info_spec.rb +1 -1
- data/spec/models/utm_params_sub_object_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +487 -370
- data/CHANGELOG.md +0 -31
- data/docs/CampaignCloneQueryAsSubResource.md +0 -20
- data/docs/CampaignCloneQueryAsSubResourceAttributes.md +0 -20
- data/docs/CampaignCreateQueryAsSubResource.md +0 -20
- data/docs/CampaignCreateQueryAsSubResourceAttributes.md +0 -28
- data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +0 -20
- data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +0 -20
- data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +0 -22
- data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +0 -20
- data/docs/CampaignPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +0 -26
- data/docs/CampaignSendJobCreateQueryAsSubResource.md +0 -20
- data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryCreateQueryAsSubResource.md +0 -22
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +0 -24
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +0 -24
- data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemCreateQueryAsSubResource.md +0 -22
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +0 -38
- data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md +0 -18
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md +0 -18
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemDeleteQueryAsSubResource.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemUpdateQueryAsSubResource.md +0 -24
- data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +0 -32
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogVariantCreateQueryAsSubResource.md +0 -22
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +0 -46
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md +0 -18
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md +0 -18
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +0 -22
- data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +0 -38
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +0 -20
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +0 -22
- data/docs/EventCreateQueryAsSubResource.md +0 -20
- data/docs/EventCreateQueryAsSubResourceAttributes.md +0 -28
- data/docs/FlowUpdateQueryAsSubResource.md +0 -22
- data/docs/FlowUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/GetCatalogItems4XXResponse.md +0 -18
- data/docs/GetCatalogItems4XXResponseErrorsInner.md +0 -26
- data/docs/GetCatalogItems4XXResponseErrorsInnerSource.md +0 -20
- data/docs/IncludedCategories.md +0 -24
- data/docs/IncludedCategoriesAttributes.md +0 -22
- data/docs/IncludedFlowAction.md +0 -24
- data/docs/IncludedFlowActions.md +0 -24
- data/docs/IncludedFlowActionsAttributes.md +0 -32
- data/docs/IncludedFlowActionsAttributesTrackingOptions.md +0 -49
- data/docs/IncludedFlowMessages.md +0 -24
- data/docs/IncludedFlowMessagesAttributes.md +0 -26
- data/docs/IncludedFlowMessagesAttributesContent.md +0 -49
- data/docs/IncludedFlows.md +0 -24
- data/docs/IncludedFlowsAttributes.md +0 -28
- data/docs/IncludedItems.md +0 -24
- data/docs/IncludedItemsAttributes.md +0 -38
- data/docs/IncludedLists.md +0 -24
- data/docs/IncludedListsAttributes.md +0 -22
- data/docs/IncludedMetrics.md +0 -24
- data/docs/IncludedMetricsAttributes.md +0 -24
- data/docs/IncludedProfiles.md +0 -24
- data/docs/IncludedProfilesAttributes.md +0 -44
- data/docs/IncludedSegments.md +0 -24
- data/docs/IncludedVariants.md +0 -24
- data/docs/IncludedVariantsAttributes.md +0 -46
- data/docs/IncludedVariantsLinks.md +0 -18
- data/docs/ListCreateQueryAsSubResource.md +0 -20
- data/docs/ListCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/ListPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/MetricAggregateQueryAsSubResource.md +0 -20
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +0 -36
- data/docs/OnsiteProfileCreateQueryAsSubResource.md +0 -22
- data/docs/OnsiteSubscriptionCreateQueryAsSubResource.md +0 -20
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +0 -26
- data/docs/ProfileCreateQueryAsSubResource.md +0 -20
- data/docs/ProfileCreateQueryAsSubResourceAttributes.md +0 -38
- data/docs/ProfilePartialUpdateQueryAsSubResource.md +0 -22
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/SubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
- data/docs/SuppressionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/TagCreateQueryAsSubResource.md +0 -20
- data/docs/TagCreateQueryAsSubResourceAttributes.md +0 -20
- data/docs/TagGroupCreateQueryAsSubResource.md +0 -20
- data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +0 -20
- data/docs/TagGroupUpdateQueryAsSubResource.md +0 -22
- data/docs/TagGroupUpdateQueryAsSubResourceAttributes.md +0 -20
- data/docs/TagUpdateQueryAsSubResource.md +0 -22
- data/docs/TagUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/TemplateCloneQueryAsSubResource.md +0 -22
- data/docs/TemplateCloneQueryAsSubResourceAttributes.md +0 -22
- data/docs/TemplateCreateQueryAsSubResource.md +0 -20
- data/docs/TemplateCreateQueryAsSubResourceAttributes.md +0 -32
- data/docs/TemplateRenderQueryAsSubResource.md +0 -20
- data/docs/TemplateRenderQueryAsSubResourceAttributes.md +0 -22
- data/docs/TemplateUpdateQueryAsSubResource.md +0 -22
- data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +0 -30
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/V2TemplateRenderQueryAsSubResource.md +0 -18
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +0 -235
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +0 -291
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +0 -229
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +0 -256
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +0 -225
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +0 -225
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +0 -293
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +0 -273
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +0 -296
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +0 -219
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +0 -370
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +0 -219
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +0 -273
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +0 -296
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +0 -284
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +0 -439
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +0 -219
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +0 -273
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +0 -346
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +0 -284
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +0 -224
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +0 -226
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +0 -275
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +0 -228
- data/lib/klaviyo-api-sdk/models/included_categories.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +0 -237
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +0 -282
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +0 -105
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +0 -270
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +0 -105
- data/lib/klaviyo-api-sdk/models/included_flows.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +0 -264
- data/lib/klaviyo-api-sdk/models/included_items.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +0 -311
- data/lib/klaviyo-api-sdk/models/included_lists.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +0 -237
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +0 -250
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +0 -336
- data/lib/klaviyo-api-sdk/models/included_segments.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_variants.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +0 -382
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +0 -224
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +0 -224
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +0 -386
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +0 -265
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +0 -309
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +0 -252
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +0 -235
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +0 -234
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource_attributes.rb +0 -236
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +0 -225
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +0 -283
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +0 -247
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +0 -252
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +0 -252
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +0 -244
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +0 -221
- data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +0 -64
- data/spec/models/campaign_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +0 -58
- data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +0 -56
- data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +0 -56
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +0 -98
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +0 -76
- data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +0 -56
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +0 -126
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +0 -98
- data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +0 -64
- data/spec/models/event_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/flow_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +0 -40
- data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +0 -58
- data/spec/models/get_catalog_items4_xx_response_spec.rb +0 -34
- data/spec/models/included_categories_attributes_spec.rb +0 -46
- data/spec/models/included_categories_spec.rb +0 -56
- data/spec/models/included_flow_action_spec.rb +0 -56
- data/spec/models/included_flow_actions_attributes_spec.rb +0 -76
- data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +0 -31
- data/spec/models/included_flow_actions_spec.rb +0 -56
- data/spec/models/included_flow_messages_attributes_content_spec.rb +0 -31
- data/spec/models/included_flow_messages_attributes_spec.rb +0 -58
- data/spec/models/included_flow_messages_spec.rb +0 -56
- data/spec/models/included_flows_attributes_spec.rb +0 -64
- data/spec/models/included_flows_spec.rb +0 -56
- data/spec/models/included_items_attributes_spec.rb +0 -94
- data/spec/models/included_items_spec.rb +0 -56
- data/spec/models/included_lists_attributes_spec.rb +0 -46
- data/spec/models/included_lists_spec.rb +0 -56
- data/spec/models/included_metrics_attributes_spec.rb +0 -52
- data/spec/models/included_metrics_spec.rb +0 -56
- data/spec/models/included_profiles_attributes_spec.rb +0 -112
- data/spec/models/included_profiles_spec.rb +0 -56
- data/spec/models/included_segments_spec.rb +0 -56
- data/spec/models/included_variants_attributes_spec.rb +0 -122
- data/spec/models/included_variants_links_spec.rb +0 -34
- data/spec/models/included_variants_spec.rb +0 -56
- data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/list_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +0 -104
- data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +0 -58
- data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +0 -94
- data/spec/models/profile_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/tag_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/tag_group_update_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/tag_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/template_clone_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +0 -58
- data/spec/models/template_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/template_render_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +0 -52
- data/spec/models/template_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +0 -34
data/docs/CatalogsApi.md
CHANGED
@@ -5,22 +5,22 @@ All URIs are relative to *https://a.klaviyo.com*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**create_catalog_category**](CatalogsApi.md#create_catalog_category) | **POST** /api/catalog-categories/ | Create Catalog Category |
|
8
|
-
| [**
|
8
|
+
| [**create_catalog_category_relationships_items**](CatalogsApi.md#create_catalog_category_relationships_items) | **POST** /api/catalog-categories/{id}/relationships/items/ | Create Catalog Category Relationships Items |
|
9
9
|
| [**create_catalog_item**](CatalogsApi.md#create_catalog_item) | **POST** /api/catalog-items/ | Create Catalog Item |
|
10
|
-
| [**
|
10
|
+
| [**create_catalog_item_relationships_categories**](CatalogsApi.md#create_catalog_item_relationships_categories) | **POST** /api/catalog-items/{id}/relationships/categories/ | Create Catalog Item Relationships Categories |
|
11
11
|
| [**create_catalog_variant**](CatalogsApi.md#create_catalog_variant) | **POST** /api/catalog-variants/ | Create Catalog Variant |
|
12
12
|
| [**delete_catalog_category**](CatalogsApi.md#delete_catalog_category) | **DELETE** /api/catalog-categories/{id}/ | Delete Catalog Category |
|
13
|
-
| [**
|
13
|
+
| [**delete_catalog_category_relationships_items**](CatalogsApi.md#delete_catalog_category_relationships_items) | **DELETE** /api/catalog-categories/{id}/relationships/items/ | Delete Catalog Category Relationships Items |
|
14
14
|
| [**delete_catalog_item**](CatalogsApi.md#delete_catalog_item) | **DELETE** /api/catalog-items/{id}/ | Delete Catalog Item |
|
15
|
-
| [**
|
15
|
+
| [**delete_catalog_item_relationships_categories**](CatalogsApi.md#delete_catalog_item_relationships_categories) | **DELETE** /api/catalog-items/{id}/relationships/categories/ | Delete Catalog Item Relationships Categories |
|
16
16
|
| [**delete_catalog_variant**](CatalogsApi.md#delete_catalog_variant) | **DELETE** /api/catalog-variants/{id}/ | Delete Catalog Variant |
|
17
17
|
| [**get_catalog_categories**](CatalogsApi.md#get_catalog_categories) | **GET** /api/catalog-categories/ | Get Catalog Categories |
|
18
18
|
| [**get_catalog_category**](CatalogsApi.md#get_catalog_category) | **GET** /api/catalog-categories/{id}/ | Get Catalog Category |
|
19
19
|
| [**get_catalog_category_items**](CatalogsApi.md#get_catalog_category_items) | **GET** /api/catalog-categories/{category_id}/items/ | Get Catalog Category Items |
|
20
|
-
| [**
|
20
|
+
| [**get_catalog_category_relationships_items**](CatalogsApi.md#get_catalog_category_relationships_items) | **GET** /api/catalog-categories/{id}/relationships/items/ | Get Catalog Category Relationships Items |
|
21
21
|
| [**get_catalog_item**](CatalogsApi.md#get_catalog_item) | **GET** /api/catalog-items/{id}/ | Get Catalog Item |
|
22
22
|
| [**get_catalog_item_categories**](CatalogsApi.md#get_catalog_item_categories) | **GET** /api/catalog-items/{item_id}/categories/ | Get Catalog Item Categories |
|
23
|
-
| [**
|
23
|
+
| [**get_catalog_item_relationships_categories**](CatalogsApi.md#get_catalog_item_relationships_categories) | **GET** /api/catalog-items/{id}/relationships/categories/ | Get Catalog Item Relationships Categories |
|
24
24
|
| [**get_catalog_item_variants**](CatalogsApi.md#get_catalog_item_variants) | **GET** /api/catalog-items/{item_id}/variants/ | Get Catalog Item Variants |
|
25
25
|
| [**get_catalog_items**](CatalogsApi.md#get_catalog_items) | **GET** /api/catalog-items/ | Get Catalog Items |
|
26
26
|
| [**get_catalog_variant**](CatalogsApi.md#get_catalog_variant) | **GET** /api/catalog-variants/{id}/ | Get Catalog Variant |
|
@@ -53,9 +53,9 @@ All URIs are relative to *https://a.klaviyo.com*
|
|
53
53
|
| [**spawn_update_items_job**](CatalogsApi.md#spawn_update_items_job) | **POST** /api/catalog-item-bulk-update-jobs/ | Spawn Update Items Job |
|
54
54
|
| [**spawn_update_variants_job**](CatalogsApi.md#spawn_update_variants_job) | **POST** /api/catalog-variant-bulk-update-jobs/ | Spawn Update Variants Job |
|
55
55
|
| [**update_catalog_category**](CatalogsApi.md#update_catalog_category) | **PATCH** /api/catalog-categories/{id}/ | Update Catalog Category |
|
56
|
-
| [**
|
56
|
+
| [**update_catalog_category_relationships_items**](CatalogsApi.md#update_catalog_category_relationships_items) | **PATCH** /api/catalog-categories/{id}/relationships/items/ | Update Catalog Category Relationships Items |
|
57
57
|
| [**update_catalog_item**](CatalogsApi.md#update_catalog_item) | **PATCH** /api/catalog-items/{id}/ | Update Catalog Item |
|
58
|
-
| [**
|
58
|
+
| [**update_catalog_item_relationships_categories**](CatalogsApi.md#update_catalog_item_relationships_categories) | **PATCH** /api/catalog-items/{id}/relationships/categories/ | Update Catalog Item Relationships Categories |
|
59
59
|
| [**update_catalog_variant**](CatalogsApi.md#update_catalog_variant) | **PATCH** /api/catalog-variants/{id}/ | Update Catalog Variant |
|
60
60
|
|
61
61
|
|
@@ -81,7 +81,7 @@ KlaviyoAPI.configure do |config|
|
|
81
81
|
end
|
82
82
|
|
83
83
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
84
|
-
catalog_category_create_query = KlaviyoAPI::CatalogCategoryCreateQuery.new({data: KlaviyoAPI::
|
84
|
+
catalog_category_create_query = KlaviyoAPI::CatalogCategoryCreateQuery.new({data: KlaviyoAPI::CatalogCategoryCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, attributes: KlaviyoAPI::CatalogCategoryCreateQueryResourceObjectAttributes.new({external_id: 'SAMPLE-DATA-CATEGORY-APPAREL', name: 'Sample Data Category Apparel'})})}) # CatalogCategoryCreateQuery |
|
85
85
|
|
86
86
|
begin
|
87
87
|
# Create Catalog Category
|
@@ -130,11 +130,11 @@ end
|
|
130
130
|
- **Accept**: application/json
|
131
131
|
|
132
132
|
|
133
|
-
##
|
133
|
+
## create_catalog_category_relationships_items
|
134
134
|
|
135
|
-
>
|
135
|
+
> create_catalog_category_relationships_items(id, catalog_category_item_op)
|
136
136
|
|
137
|
-
Create Catalog Category Relationships
|
137
|
+
Create Catalog Category Relationships Items
|
138
138
|
|
139
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
140
|
|
@@ -153,32 +153,31 @@ end
|
|
153
153
|
|
154
154
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
155
155
|
id = 'id_example' # String |
|
156
|
-
|
157
|
-
catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
|
156
|
+
catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
|
158
157
|
|
159
158
|
begin
|
160
|
-
# Create Catalog Category Relationships
|
161
|
-
api_instance.
|
159
|
+
# Create Catalog Category Relationships Items
|
160
|
+
api_instance.create_catalog_category_relationships_items(id, catalog_category_item_op)
|
162
161
|
rescue KlaviyoAPI::ApiError => e
|
163
|
-
puts "Error when calling CatalogsApi->
|
162
|
+
puts "Error when calling CatalogsApi->create_catalog_category_relationships_items: #{e}"
|
164
163
|
end
|
165
164
|
```
|
166
165
|
|
167
|
-
#### Using the
|
166
|
+
#### Using the create_catalog_category_relationships_items_with_http_info variant
|
168
167
|
|
169
168
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
170
169
|
|
171
|
-
> <Array(nil, Integer, Hash)>
|
170
|
+
> <Array(nil, Integer, Hash)> create_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
|
172
171
|
|
173
172
|
```ruby
|
174
173
|
begin
|
175
|
-
# Create Catalog Category Relationships
|
176
|
-
data, status_code, headers = api_instance.
|
174
|
+
# Create Catalog Category Relationships Items
|
175
|
+
data, status_code, headers = api_instance.create_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
|
177
176
|
p status_code # => 2xx
|
178
177
|
p headers # => { ... }
|
179
178
|
p data # => nil
|
180
179
|
rescue KlaviyoAPI::ApiError => e
|
181
|
-
puts "Error when calling CatalogsApi->
|
180
|
+
puts "Error when calling CatalogsApi->create_catalog_category_relationships_items_with_http_info: #{e}"
|
182
181
|
end
|
183
182
|
```
|
184
183
|
|
@@ -187,7 +186,6 @@ end
|
|
187
186
|
| Name | Type | Description | Notes |
|
188
187
|
| ---- | ---- | ----------- | ----- |
|
189
188
|
| **id** | **String** | | |
|
190
|
-
| **related_resource** | **String** | | |
|
191
189
|
| **catalog_category_item_op** | [**CatalogCategoryItemOp**](CatalogCategoryItemOp.md) | | |
|
192
190
|
|
193
191
|
### Return type
|
@@ -226,7 +224,7 @@ KlaviyoAPI.configure do |config|
|
|
226
224
|
end
|
227
225
|
|
228
226
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
229
|
-
catalog_item_create_query = KlaviyoAPI::CatalogItemCreateQuery.new({data: KlaviyoAPI::
|
227
|
+
catalog_item_create_query = KlaviyoAPI::CatalogItemCreateQuery.new({data: KlaviyoAPI::CatalogItemCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, attributes: KlaviyoAPI::CatalogItemCreateQueryResourceObjectAttributes.new({external_id: 'SAMPLE-DATA-ITEM-1', title: 'Ocean Blue Shirt (Sample)', description: 'Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.', url: 'https://via.placeholder.com/150'})})}) # CatalogItemCreateQuery |
|
230
228
|
|
231
229
|
begin
|
232
230
|
# Create Catalog Item
|
@@ -275,11 +273,11 @@ end
|
|
275
273
|
- **Accept**: application/json
|
276
274
|
|
277
275
|
|
278
|
-
##
|
276
|
+
## create_catalog_item_relationships_categories
|
279
277
|
|
280
|
-
>
|
278
|
+
> create_catalog_item_relationships_categories(id, catalog_item_category_op)
|
281
279
|
|
282
|
-
Create Catalog Item Relationships
|
280
|
+
Create Catalog Item Relationships Categories
|
283
281
|
|
284
282
|
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
283
|
|
@@ -298,32 +296,31 @@ end
|
|
298
296
|
|
299
297
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
300
298
|
id = 'id_example' # String |
|
301
|
-
|
302
|
-
catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
|
299
|
+
catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
|
303
300
|
|
304
301
|
begin
|
305
|
-
# Create Catalog Item Relationships
|
306
|
-
api_instance.
|
302
|
+
# Create Catalog Item Relationships Categories
|
303
|
+
api_instance.create_catalog_item_relationships_categories(id, catalog_item_category_op)
|
307
304
|
rescue KlaviyoAPI::ApiError => e
|
308
|
-
puts "Error when calling CatalogsApi->
|
305
|
+
puts "Error when calling CatalogsApi->create_catalog_item_relationships_categories: #{e}"
|
309
306
|
end
|
310
307
|
```
|
311
308
|
|
312
|
-
#### Using the
|
309
|
+
#### Using the create_catalog_item_relationships_categories_with_http_info variant
|
313
310
|
|
314
311
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
315
312
|
|
316
|
-
> <Array(nil, Integer, Hash)>
|
313
|
+
> <Array(nil, Integer, Hash)> create_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
|
317
314
|
|
318
315
|
```ruby
|
319
316
|
begin
|
320
|
-
# Create Catalog Item Relationships
|
321
|
-
data, status_code, headers = api_instance.
|
317
|
+
# Create Catalog Item Relationships Categories
|
318
|
+
data, status_code, headers = api_instance.create_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
|
322
319
|
p status_code # => 2xx
|
323
320
|
p headers # => { ... }
|
324
321
|
p data # => nil
|
325
322
|
rescue KlaviyoAPI::ApiError => e
|
326
|
-
puts "Error when calling CatalogsApi->
|
323
|
+
puts "Error when calling CatalogsApi->create_catalog_item_relationships_categories_with_http_info: #{e}"
|
327
324
|
end
|
328
325
|
```
|
329
326
|
|
@@ -332,7 +329,6 @@ end
|
|
332
329
|
| Name | Type | Description | Notes |
|
333
330
|
| ---- | ---- | ----------- | ----- |
|
334
331
|
| **id** | **String** | | |
|
335
|
-
| **related_resource** | **String** | | |
|
336
332
|
| **catalog_item_category_op** | [**CatalogItemCategoryOp**](CatalogItemCategoryOp.md) | | |
|
337
333
|
|
338
334
|
### Return type
|
@@ -371,7 +367,7 @@ KlaviyoAPI.configure do |config|
|
|
371
367
|
end
|
372
368
|
|
373
369
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
374
|
-
catalog_variant_create_query = KlaviyoAPI::CatalogVariantCreateQuery.new({data: KlaviyoAPI::
|
370
|
+
catalog_variant_create_query = KlaviyoAPI::CatalogVariantCreateQuery.new({data: KlaviyoAPI::CatalogVariantCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantEnum::CATALOG_VARIANT, attributes: KlaviyoAPI::CatalogVariantCreateQueryResourceObjectAttributes.new({external_id: 'SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM', title: 'Ocean Blue Shirt (Sample) Variant Medium', description: 'Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.', sku: 'OBS-MD', inventory_quantity: 25, price: 42, url: 'https://via.placeholder.com/150'})})}) # CatalogVariantCreateQuery |
|
375
371
|
|
376
372
|
begin
|
377
373
|
# Create Catalog Variant
|
@@ -442,7 +438,7 @@ KlaviyoAPI.configure do |config|
|
|
442
438
|
end
|
443
439
|
|
444
440
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
445
|
-
id = '
|
441
|
+
id = '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL' # String | The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
446
442
|
|
447
443
|
begin
|
448
444
|
# Delete Catalog Category
|
@@ -474,7 +470,7 @@ end
|
|
474
470
|
|
475
471
|
| Name | Type | Description | Notes |
|
476
472
|
| ---- | ---- | ----------- | ----- |
|
477
|
-
| **id** | **String** | The catalog category ID is a compound ID (string), with format: `
|
473
|
+
| **id** | **String** | The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
478
474
|
|
479
475
|
### Return type
|
480
476
|
|
@@ -490,11 +486,11 @@ nil (empty response body)
|
|
490
486
|
- **Accept**: application/json
|
491
487
|
|
492
488
|
|
493
|
-
##
|
489
|
+
## delete_catalog_category_relationships_items
|
494
490
|
|
495
|
-
>
|
491
|
+
> delete_catalog_category_relationships_items(id, catalog_category_item_op)
|
496
492
|
|
497
|
-
Delete Catalog Category Relationships
|
493
|
+
Delete Catalog Category Relationships Items
|
498
494
|
|
499
495
|
Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
500
496
|
|
@@ -513,32 +509,31 @@ end
|
|
513
509
|
|
514
510
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
515
511
|
id = 'id_example' # String |
|
516
|
-
|
517
|
-
catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
|
512
|
+
catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
|
518
513
|
|
519
514
|
begin
|
520
|
-
# Delete Catalog Category Relationships
|
521
|
-
api_instance.
|
515
|
+
# Delete Catalog Category Relationships Items
|
516
|
+
api_instance.delete_catalog_category_relationships_items(id, catalog_category_item_op)
|
522
517
|
rescue KlaviyoAPI::ApiError => e
|
523
|
-
puts "Error when calling CatalogsApi->
|
518
|
+
puts "Error when calling CatalogsApi->delete_catalog_category_relationships_items: #{e}"
|
524
519
|
end
|
525
520
|
```
|
526
521
|
|
527
|
-
#### Using the
|
522
|
+
#### Using the delete_catalog_category_relationships_items_with_http_info variant
|
528
523
|
|
529
524
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
530
525
|
|
531
|
-
> <Array(nil, Integer, Hash)>
|
526
|
+
> <Array(nil, Integer, Hash)> delete_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
|
532
527
|
|
533
528
|
```ruby
|
534
529
|
begin
|
535
|
-
# Delete Catalog Category Relationships
|
536
|
-
data, status_code, headers = api_instance.
|
530
|
+
# Delete Catalog Category Relationships Items
|
531
|
+
data, status_code, headers = api_instance.delete_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
|
537
532
|
p status_code # => 2xx
|
538
533
|
p headers # => { ... }
|
539
534
|
p data # => nil
|
540
535
|
rescue KlaviyoAPI::ApiError => e
|
541
|
-
puts "Error when calling CatalogsApi->
|
536
|
+
puts "Error when calling CatalogsApi->delete_catalog_category_relationships_items_with_http_info: #{e}"
|
542
537
|
end
|
543
538
|
```
|
544
539
|
|
@@ -547,7 +542,6 @@ end
|
|
547
542
|
| Name | Type | Description | Notes |
|
548
543
|
| ---- | ---- | ----------- | ----- |
|
549
544
|
| **id** | **String** | | |
|
550
|
-
| **related_resource** | **String** | | |
|
551
545
|
| **catalog_category_item_op** | [**CatalogCategoryItemOp**](CatalogCategoryItemOp.md) | | |
|
552
546
|
|
553
547
|
### Return type
|
@@ -586,7 +580,7 @@ KlaviyoAPI.configure do |config|
|
|
586
580
|
end
|
587
581
|
|
588
582
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
589
|
-
id = '
|
583
|
+
id = '$custom:::$default:::SAMPLE-DATA-ITEM-1' # String | The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
590
584
|
|
591
585
|
begin
|
592
586
|
# Delete Catalog Item
|
@@ -618,7 +612,7 @@ end
|
|
618
612
|
|
619
613
|
| Name | Type | Description | Notes |
|
620
614
|
| ---- | ---- | ----------- | ----- |
|
621
|
-
| **id** | **String** | The catalog item ID is a compound ID (string), with format: `
|
615
|
+
| **id** | **String** | The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
622
616
|
|
623
617
|
### Return type
|
624
618
|
|
@@ -634,11 +628,11 @@ nil (empty response body)
|
|
634
628
|
- **Accept**: application/json
|
635
629
|
|
636
630
|
|
637
|
-
##
|
631
|
+
## delete_catalog_item_relationships_categories
|
638
632
|
|
639
|
-
>
|
633
|
+
> delete_catalog_item_relationships_categories(id, catalog_item_category_op)
|
640
634
|
|
641
|
-
Delete Catalog Item Relationships
|
635
|
+
Delete Catalog Item Relationships Categories
|
642
636
|
|
643
637
|
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
638
|
|
@@ -657,32 +651,31 @@ end
|
|
657
651
|
|
658
652
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
659
653
|
id = 'id_example' # String |
|
660
|
-
|
661
|
-
catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
|
654
|
+
catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
|
662
655
|
|
663
656
|
begin
|
664
|
-
# Delete Catalog Item Relationships
|
665
|
-
api_instance.
|
657
|
+
# Delete Catalog Item Relationships Categories
|
658
|
+
api_instance.delete_catalog_item_relationships_categories(id, catalog_item_category_op)
|
666
659
|
rescue KlaviyoAPI::ApiError => e
|
667
|
-
puts "Error when calling CatalogsApi->
|
660
|
+
puts "Error when calling CatalogsApi->delete_catalog_item_relationships_categories: #{e}"
|
668
661
|
end
|
669
662
|
```
|
670
663
|
|
671
|
-
#### Using the
|
664
|
+
#### Using the delete_catalog_item_relationships_categories_with_http_info variant
|
672
665
|
|
673
666
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
674
667
|
|
675
|
-
> <Array(nil, Integer, Hash)>
|
668
|
+
> <Array(nil, Integer, Hash)> delete_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
|
676
669
|
|
677
670
|
```ruby
|
678
671
|
begin
|
679
|
-
# Delete Catalog Item Relationships
|
680
|
-
data, status_code, headers = api_instance.
|
672
|
+
# Delete Catalog Item Relationships Categories
|
673
|
+
data, status_code, headers = api_instance.delete_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
|
681
674
|
p status_code # => 2xx
|
682
675
|
p headers # => { ... }
|
683
676
|
p data # => nil
|
684
677
|
rescue KlaviyoAPI::ApiError => e
|
685
|
-
puts "Error when calling CatalogsApi->
|
678
|
+
puts "Error when calling CatalogsApi->delete_catalog_item_relationships_categories_with_http_info: #{e}"
|
686
679
|
end
|
687
680
|
```
|
688
681
|
|
@@ -691,7 +684,6 @@ end
|
|
691
684
|
| Name | Type | Description | Notes |
|
692
685
|
| ---- | ---- | ----------- | ----- |
|
693
686
|
| **id** | **String** | | |
|
694
|
-
| **related_resource** | **String** | | |
|
695
687
|
| **catalog_item_category_op** | [**CatalogItemCategoryOp**](CatalogItemCategoryOp.md) | | |
|
696
688
|
|
697
689
|
### Return type
|
@@ -730,7 +722,7 @@ KlaviyoAPI.configure do |config|
|
|
730
722
|
end
|
731
723
|
|
732
724
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
733
|
-
id = '
|
725
|
+
id = '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM' # String | The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
734
726
|
|
735
727
|
begin
|
736
728
|
# Delete Catalog Variant
|
@@ -762,7 +754,7 @@ end
|
|
762
754
|
|
763
755
|
| Name | Type | Description | Notes |
|
764
756
|
| ---- | ---- | ----------- | ----- |
|
765
|
-
| **id** | **String** | The catalog variant ID is a compound ID (string), with format: `
|
757
|
+
| **id** | **String** | The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
766
758
|
|
767
759
|
### Return type
|
768
760
|
|
@@ -801,10 +793,10 @@ end
|
|
801
793
|
|
802
794
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
803
795
|
opts = {
|
804
|
-
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
805
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
806
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
807
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
796
|
+
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
797
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
798
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
799
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
808
800
|
}
|
809
801
|
|
810
802
|
begin
|
@@ -838,10 +830,10 @@ end
|
|
838
830
|
|
839
831
|
| Name | Type | Description | Notes |
|
840
832
|
| ---- | ---- | ----------- | ----- |
|
841
|
-
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
842
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
843
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
844
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
833
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
834
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains` | [optional] |
|
835
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
836
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
|
845
837
|
|
846
838
|
### Return type
|
847
839
|
|
@@ -879,9 +871,9 @@ KlaviyoAPI.configure do |config|
|
|
879
871
|
end
|
880
872
|
|
881
873
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
882
|
-
id = '
|
874
|
+
id = '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL' # String | The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
883
875
|
opts = {
|
884
|
-
fields_catalog_category: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
876
|
+
fields_catalog_category: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
885
877
|
}
|
886
878
|
|
887
879
|
begin
|
@@ -915,8 +907,8 @@ end
|
|
915
907
|
|
916
908
|
| Name | Type | Description | Notes |
|
917
909
|
| ---- | ---- | ----------- | ----- |
|
918
|
-
| **id** | **String** | The catalog category ID is a compound ID (string), with format: `
|
919
|
-
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
910
|
+
| **id** | **String** | The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
911
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
920
912
|
|
921
913
|
### Return type
|
922
914
|
|
@@ -954,14 +946,14 @@ KlaviyoAPI.configure do |config|
|
|
954
946
|
end
|
955
947
|
|
956
948
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
957
|
-
category_id = '
|
949
|
+
category_id = '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL' # String | The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
958
950
|
opts = {
|
959
|
-
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
960
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
961
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
962
|
-
include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
963
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
964
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
951
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
952
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
953
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
954
|
+
include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
955
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
956
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
965
957
|
}
|
966
958
|
|
967
959
|
begin
|
@@ -995,13 +987,13 @@ end
|
|
995
987
|
|
996
988
|
| Name | Type | Description | Notes |
|
997
989
|
| ---- | ---- | ----------- | ----- |
|
998
|
-
| **category_id** | **String** |
|
999
|
-
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1000
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1001
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1002
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1003
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1004
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
990
|
+
| **category_id** | **String** | The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
991
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
992
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
993
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals` | [optional] |
|
994
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
|
995
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
996
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
|
1005
997
|
|
1006
998
|
### Return type
|
1007
999
|
|
@@ -1017,11 +1009,11 @@ end
|
|
1017
1009
|
- **Accept**: application/json
|
1018
1010
|
|
1019
1011
|
|
1020
|
-
##
|
1012
|
+
## get_catalog_category_relationships_items
|
1021
1013
|
|
1022
|
-
> Hash<String, Object>
|
1014
|
+
> Hash<String, Object> get_catalog_category_relationships_items(id, opts)
|
1023
1015
|
|
1024
|
-
Get Catalog Category Relationships
|
1016
|
+
Get Catalog Category Relationships Items
|
1025
1017
|
|
1026
1018
|
Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
1027
1019
|
|
@@ -1040,35 +1032,34 @@ end
|
|
1040
1032
|
|
1041
1033
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1042
1034
|
id = 'id_example' # String |
|
1043
|
-
related_resource = 'items' # String |
|
1044
1035
|
opts = {
|
1045
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1036
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
1046
1037
|
}
|
1047
1038
|
|
1048
1039
|
begin
|
1049
|
-
# Get Catalog Category Relationships
|
1050
|
-
result = api_instance.
|
1040
|
+
# Get Catalog Category Relationships Items
|
1041
|
+
result = api_instance.get_catalog_category_relationships_items(id, opts)
|
1051
1042
|
p result
|
1052
1043
|
rescue KlaviyoAPI::ApiError => e
|
1053
|
-
puts "Error when calling CatalogsApi->
|
1044
|
+
puts "Error when calling CatalogsApi->get_catalog_category_relationships_items: #{e}"
|
1054
1045
|
end
|
1055
1046
|
```
|
1056
1047
|
|
1057
|
-
#### Using the
|
1048
|
+
#### Using the get_catalog_category_relationships_items_with_http_info variant
|
1058
1049
|
|
1059
1050
|
This returns an Array which contains the response data, status code and headers.
|
1060
1051
|
|
1061
|
-
> <Array(Hash<String, Object>, Integer, Hash)>
|
1052
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_category_relationships_items_with_http_info(id, opts)
|
1062
1053
|
|
1063
1054
|
```ruby
|
1064
1055
|
begin
|
1065
|
-
# Get Catalog Category Relationships
|
1066
|
-
data, status_code, headers = api_instance.
|
1056
|
+
# Get Catalog Category Relationships Items
|
1057
|
+
data, status_code, headers = api_instance.get_catalog_category_relationships_items_with_http_info(id, opts)
|
1067
1058
|
p status_code # => 2xx
|
1068
1059
|
p headers # => { ... }
|
1069
1060
|
p data # => Hash<String, Object>
|
1070
1061
|
rescue KlaviyoAPI::ApiError => e
|
1071
|
-
puts "Error when calling CatalogsApi->
|
1062
|
+
puts "Error when calling CatalogsApi->get_catalog_category_relationships_items_with_http_info: #{e}"
|
1072
1063
|
end
|
1073
1064
|
```
|
1074
1065
|
|
@@ -1077,8 +1068,7 @@ end
|
|
1077
1068
|
| Name | Type | Description | Notes |
|
1078
1069
|
| ---- | ---- | ----------- | ----- |
|
1079
1070
|
| **id** | **String** | | |
|
1080
|
-
| **
|
1081
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
1071
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
1082
1072
|
|
1083
1073
|
### Return type
|
1084
1074
|
|
@@ -1116,11 +1106,11 @@ KlaviyoAPI.configure do |config|
|
|
1116
1106
|
end
|
1117
1107
|
|
1118
1108
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1119
|
-
id = '
|
1109
|
+
id = '$custom:::$default:::SAMPLE-DATA-ITEM-1' # String | The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
1120
1110
|
opts = {
|
1121
|
-
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1122
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1123
|
-
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1111
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1112
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1113
|
+
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
1124
1114
|
}
|
1125
1115
|
|
1126
1116
|
begin
|
@@ -1154,10 +1144,10 @@ end
|
|
1154
1144
|
|
1155
1145
|
| Name | Type | Description | Notes |
|
1156
1146
|
| ---- | ---- | ----------- | ----- |
|
1157
|
-
| **id** | **String** |
|
1158
|
-
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1159
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1160
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1147
|
+
| **id** | **String** | The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
1148
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1149
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1150
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
|
1161
1151
|
|
1162
1152
|
### Return type
|
1163
1153
|
|
@@ -1195,12 +1185,12 @@ KlaviyoAPI.configure do |config|
|
|
1195
1185
|
end
|
1196
1186
|
|
1197
1187
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1198
|
-
item_id = '
|
1188
|
+
item_id = '$custom:::$default:::SAMPLE-DATA-ITEM-1' # String | The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
1199
1189
|
opts = {
|
1200
|
-
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1201
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1202
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1203
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1190
|
+
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1191
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
1192
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
1193
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
1204
1194
|
}
|
1205
1195
|
|
1206
1196
|
begin
|
@@ -1234,11 +1224,11 @@ end
|
|
1234
1224
|
|
1235
1225
|
| Name | Type | Description | Notes |
|
1236
1226
|
| ---- | ---- | ----------- | ----- |
|
1237
|
-
| **item_id** | **String** |
|
1238
|
-
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1239
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1240
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1241
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1227
|
+
| **item_id** | **String** | The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
1228
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1229
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains` | [optional] |
|
1230
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
1231
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
|
1242
1232
|
|
1243
1233
|
### Return type
|
1244
1234
|
|
@@ -1254,11 +1244,11 @@ end
|
|
1254
1244
|
- **Accept**: application/json
|
1255
1245
|
|
1256
1246
|
|
1257
|
-
##
|
1247
|
+
## get_catalog_item_relationships_categories
|
1258
1248
|
|
1259
|
-
> Hash<String, Object>
|
1249
|
+
> Hash<String, Object> get_catalog_item_relationships_categories(id, opts)
|
1260
1250
|
|
1261
|
-
Get Catalog Item Relationships
|
1251
|
+
Get Catalog Item Relationships Categories
|
1262
1252
|
|
1263
1253
|
Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
|
1264
1254
|
|
@@ -1277,35 +1267,34 @@ end
|
|
1277
1267
|
|
1278
1268
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1279
1269
|
id = 'id_example' # String |
|
1280
|
-
related_resource = 'categories' # String |
|
1281
1270
|
opts = {
|
1282
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1271
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
1283
1272
|
}
|
1284
1273
|
|
1285
1274
|
begin
|
1286
|
-
# Get Catalog Item Relationships
|
1287
|
-
result = api_instance.
|
1275
|
+
# Get Catalog Item Relationships Categories
|
1276
|
+
result = api_instance.get_catalog_item_relationships_categories(id, opts)
|
1288
1277
|
p result
|
1289
1278
|
rescue KlaviyoAPI::ApiError => e
|
1290
|
-
puts "Error when calling CatalogsApi->
|
1279
|
+
puts "Error when calling CatalogsApi->get_catalog_item_relationships_categories: #{e}"
|
1291
1280
|
end
|
1292
1281
|
```
|
1293
1282
|
|
1294
|
-
#### Using the
|
1283
|
+
#### Using the get_catalog_item_relationships_categories_with_http_info variant
|
1295
1284
|
|
1296
1285
|
This returns an Array which contains the response data, status code and headers.
|
1297
1286
|
|
1298
|
-
> <Array(Hash<String, Object>, Integer, Hash)>
|
1287
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_catalog_item_relationships_categories_with_http_info(id, opts)
|
1299
1288
|
|
1300
1289
|
```ruby
|
1301
1290
|
begin
|
1302
|
-
# Get Catalog Item Relationships
|
1303
|
-
data, status_code, headers = api_instance.
|
1291
|
+
# Get Catalog Item Relationships Categories
|
1292
|
+
data, status_code, headers = api_instance.get_catalog_item_relationships_categories_with_http_info(id, opts)
|
1304
1293
|
p status_code # => 2xx
|
1305
1294
|
p headers # => { ... }
|
1306
1295
|
p data # => Hash<String, Object>
|
1307
1296
|
rescue KlaviyoAPI::ApiError => e
|
1308
|
-
puts "Error when calling CatalogsApi->
|
1297
|
+
puts "Error when calling CatalogsApi->get_catalog_item_relationships_categories_with_http_info: #{e}"
|
1309
1298
|
end
|
1310
1299
|
```
|
1311
1300
|
|
@@ -1314,8 +1303,7 @@ end
|
|
1314
1303
|
| Name | Type | Description | Notes |
|
1315
1304
|
| ---- | ---- | ----------- | ----- |
|
1316
1305
|
| **id** | **String** | | |
|
1317
|
-
| **
|
1318
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
|
1306
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
1319
1307
|
|
1320
1308
|
### Return type
|
1321
1309
|
|
@@ -1353,12 +1341,12 @@ KlaviyoAPI.configure do |config|
|
|
1353
1341
|
end
|
1354
1342
|
|
1355
1343
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1356
|
-
item_id = '
|
1344
|
+
item_id = '$custom:::$default:::SAMPLE-DATA-ITEM-1' # String | The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
1357
1345
|
opts = {
|
1358
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1359
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1360
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1361
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1346
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1347
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1348
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
1349
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
1362
1350
|
}
|
1363
1351
|
|
1364
1352
|
begin
|
@@ -1392,11 +1380,11 @@ end
|
|
1392
1380
|
|
1393
1381
|
| Name | Type | Description | Notes |
|
1394
1382
|
| ---- | ---- | ----------- | ----- |
|
1395
|
-
| **item_id** | **String** | The catalog item ID is a compound ID (string), with format: `
|
1396
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1397
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1398
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1399
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1383
|
+
| **item_id** | **String** | The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
1384
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1385
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` | [optional] |
|
1386
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
1387
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
|
1400
1388
|
|
1401
1389
|
### Return type
|
1402
1390
|
|
@@ -1435,12 +1423,12 @@ end
|
|
1435
1423
|
|
1436
1424
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1437
1425
|
opts = {
|
1438
|
-
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1439
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1440
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1441
|
-
include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1442
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1443
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1426
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1427
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1428
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1429
|
+
include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
1430
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
1431
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
1444
1432
|
}
|
1445
1433
|
|
1446
1434
|
begin
|
@@ -1474,12 +1462,12 @@ end
|
|
1474
1462
|
|
1475
1463
|
| Name | Type | Description | Notes |
|
1476
1464
|
| ---- | ---- | ----------- | ----- |
|
1477
|
-
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1478
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1479
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1480
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1481
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1482
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1465
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1466
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1467
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals` | [optional] |
|
1468
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
|
1469
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
1470
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
|
1483
1471
|
|
1484
1472
|
### Return type
|
1485
1473
|
|
@@ -1517,9 +1505,9 @@ KlaviyoAPI.configure do |config|
|
|
1517
1505
|
end
|
1518
1506
|
|
1519
1507
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1520
|
-
id = '
|
1508
|
+
id = '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM' # String | The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
1521
1509
|
opts = {
|
1522
|
-
fields_catalog_variant: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1510
|
+
fields_catalog_variant: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1523
1511
|
}
|
1524
1512
|
|
1525
1513
|
begin
|
@@ -1553,8 +1541,8 @@ end
|
|
1553
1541
|
|
1554
1542
|
| Name | Type | Description | Notes |
|
1555
1543
|
| ---- | ---- | ----------- | ----- |
|
1556
|
-
| **id** | **String** | The catalog variant ID is a compound ID (string), with format: `
|
1557
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1544
|
+
| **id** | **String** | The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
1545
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1558
1546
|
|
1559
1547
|
### Return type
|
1560
1548
|
|
@@ -1593,10 +1581,10 @@ end
|
|
1593
1581
|
|
1594
1582
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1595
1583
|
opts = {
|
1596
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1597
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1598
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1599
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1584
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1585
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1586
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
1587
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
1600
1588
|
}
|
1601
1589
|
|
1602
1590
|
begin
|
@@ -1630,10 +1618,10 @@ end
|
|
1630
1618
|
|
1631
1619
|
| Name | Type | Description | Notes |
|
1632
1620
|
| ---- | ---- | ----------- | ----- |
|
1633
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1634
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1635
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1636
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1621
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1622
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals` | [optional] |
|
1623
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
1624
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
|
1637
1625
|
|
1638
1626
|
### Return type
|
1639
1627
|
|
@@ -1655,7 +1643,7 @@ end
|
|
1655
1643
|
|
1656
1644
|
Get Create Categories Job
|
1657
1645
|
|
1658
|
-
Get a catalog category bulk create job with the given job ID.
|
1646
|
+
Get a catalog category bulk create job with the given job ID. An `include` parameter 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
1647
|
|
1660
1648
|
### Examples
|
1661
1649
|
|
@@ -1671,11 +1659,11 @@ KlaviyoAPI.configure do |config|
|
|
1671
1659
|
end
|
1672
1660
|
|
1673
1661
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1674
|
-
job_id = '
|
1662
|
+
job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
|
1675
1663
|
opts = {
|
1676
|
-
fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1677
|
-
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1678
|
-
include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1664
|
+
fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1665
|
+
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1666
|
+
include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
1679
1667
|
}
|
1680
1668
|
|
1681
1669
|
begin
|
@@ -1709,10 +1697,10 @@ end
|
|
1709
1697
|
|
1710
1698
|
| Name | Type | Description | Notes |
|
1711
1699
|
| ---- | ---- | ----------- | ----- |
|
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/v2023-
|
1714
|
-
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1715
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1700
|
+
| **job_id** | **String** | ID of the job to retrieve. | |
|
1701
|
+
| **fields_catalog_category_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1702
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1703
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
|
1716
1704
|
|
1717
1705
|
### Return type
|
1718
1706
|
|
@@ -1751,9 +1739,9 @@ end
|
|
1751
1739
|
|
1752
1740
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1753
1741
|
opts = {
|
1754
|
-
fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1755
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1756
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1742
|
+
fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1743
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1744
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
1757
1745
|
}
|
1758
1746
|
|
1759
1747
|
begin
|
@@ -1787,9 +1775,9 @@ end
|
|
1787
1775
|
|
1788
1776
|
| Name | Type | Description | Notes |
|
1789
1777
|
| ---- | ---- | ----------- | ----- |
|
1790
|
-
| **fields_catalog_category_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1791
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1792
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1778
|
+
| **fields_catalog_category_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1779
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
1780
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
1793
1781
|
|
1794
1782
|
### Return type
|
1795
1783
|
|
@@ -1811,7 +1799,7 @@ end
|
|
1811
1799
|
|
1812
1800
|
Get Create Items Job
|
1813
1801
|
|
1814
|
-
Get a catalog item bulk create job with the given job ID.
|
1802
|
+
Get a catalog item bulk create job with the given job ID. An `include` parameter 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
1803
|
|
1816
1804
|
### Examples
|
1817
1805
|
|
@@ -1827,11 +1815,11 @@ KlaviyoAPI.configure do |config|
|
|
1827
1815
|
end
|
1828
1816
|
|
1829
1817
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1830
|
-
job_id = '
|
1818
|
+
job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
|
1831
1819
|
opts = {
|
1832
|
-
fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1833
|
-
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1834
|
-
include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1820
|
+
fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1821
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1822
|
+
include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
1835
1823
|
}
|
1836
1824
|
|
1837
1825
|
begin
|
@@ -1865,10 +1853,10 @@ end
|
|
1865
1853
|
|
1866
1854
|
| Name | Type | Description | Notes |
|
1867
1855
|
| ---- | ---- | ----------- | ----- |
|
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/v2023-
|
1870
|
-
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1871
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1856
|
+
| **job_id** | **String** | ID of the job to retrieve. | |
|
1857
|
+
| **fields_catalog_item_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1858
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1859
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
|
1872
1860
|
|
1873
1861
|
### Return type
|
1874
1862
|
|
@@ -1907,9 +1895,9 @@ end
|
|
1907
1895
|
|
1908
1896
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1909
1897
|
opts = {
|
1910
|
-
fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1911
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1912
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1898
|
+
fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1899
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1900
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
1913
1901
|
}
|
1914
1902
|
|
1915
1903
|
begin
|
@@ -1943,9 +1931,9 @@ end
|
|
1943
1931
|
|
1944
1932
|
| Name | Type | Description | Notes |
|
1945
1933
|
| ---- | ---- | ----------- | ----- |
|
1946
|
-
| **fields_catalog_item_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1947
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1948
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1934
|
+
| **fields_catalog_item_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1935
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
1936
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
1949
1937
|
|
1950
1938
|
### Return type
|
1951
1939
|
|
@@ -1967,7 +1955,7 @@ end
|
|
1967
1955
|
|
1968
1956
|
Get Create Variants Job
|
1969
1957
|
|
1970
|
-
Get a catalog variant bulk create job with the given job ID.
|
1958
|
+
Get a catalog variant bulk create job with the given job ID. An `include` parameter 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
1959
|
|
1972
1960
|
### Examples
|
1973
1961
|
|
@@ -1983,11 +1971,11 @@ KlaviyoAPI.configure do |config|
|
|
1983
1971
|
end
|
1984
1972
|
|
1985
1973
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
1986
|
-
job_id = '
|
1974
|
+
job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
|
1987
1975
|
opts = {
|
1988
|
-
fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1989
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1990
|
-
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1976
|
+
fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1977
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1978
|
+
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
1991
1979
|
}
|
1992
1980
|
|
1993
1981
|
begin
|
@@ -2021,10 +2009,10 @@ end
|
|
2021
2009
|
|
2022
2010
|
| Name | Type | Description | Notes |
|
2023
2011
|
| ---- | ---- | ----------- | ----- |
|
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/v2023-
|
2026
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2027
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2012
|
+
| **job_id** | **String** | ID of the job to retrieve. | |
|
2013
|
+
| **fields_catalog_variant_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2014
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2015
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
|
2028
2016
|
|
2029
2017
|
### Return type
|
2030
2018
|
|
@@ -2063,9 +2051,9 @@ end
|
|
2063
2051
|
|
2064
2052
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2065
2053
|
opts = {
|
2066
|
-
fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2067
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2068
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2054
|
+
fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2055
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2056
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
2069
2057
|
}
|
2070
2058
|
|
2071
2059
|
begin
|
@@ -2099,9 +2087,9 @@ end
|
|
2099
2087
|
|
2100
2088
|
| Name | Type | Description | Notes |
|
2101
2089
|
| ---- | ---- | ----------- | ----- |
|
2102
|
-
| **fields_catalog_variant_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2103
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2104
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2090
|
+
| **fields_catalog_variant_bulk_create_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2091
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
2092
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
2105
2093
|
|
2106
2094
|
### Return type
|
2107
2095
|
|
@@ -2139,9 +2127,9 @@ KlaviyoAPI.configure do |config|
|
|
2139
2127
|
end
|
2140
2128
|
|
2141
2129
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2142
|
-
job_id = '
|
2130
|
+
job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
|
2143
2131
|
opts = {
|
2144
|
-
fields_catalog_category_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2132
|
+
fields_catalog_category_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2145
2133
|
}
|
2146
2134
|
|
2147
2135
|
begin
|
@@ -2175,8 +2163,8 @@ end
|
|
2175
2163
|
|
2176
2164
|
| Name | Type | Description | Notes |
|
2177
2165
|
| ---- | ---- | ----------- | ----- |
|
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/v2023-
|
2166
|
+
| **job_id** | **String** | ID of the job to retrieve. | |
|
2167
|
+
| **fields_catalog_category_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2180
2168
|
|
2181
2169
|
### Return type
|
2182
2170
|
|
@@ -2215,9 +2203,9 @@ end
|
|
2215
2203
|
|
2216
2204
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2217
2205
|
opts = {
|
2218
|
-
fields_catalog_category_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2219
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2220
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2206
|
+
fields_catalog_category_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2207
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2208
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
2221
2209
|
}
|
2222
2210
|
|
2223
2211
|
begin
|
@@ -2251,9 +2239,9 @@ end
|
|
2251
2239
|
|
2252
2240
|
| Name | Type | Description | Notes |
|
2253
2241
|
| ---- | ---- | ----------- | ----- |
|
2254
|
-
| **fields_catalog_category_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2255
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2256
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2242
|
+
| **fields_catalog_category_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2243
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
2244
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
2257
2245
|
|
2258
2246
|
### Return type
|
2259
2247
|
|
@@ -2291,9 +2279,9 @@ KlaviyoAPI.configure do |config|
|
|
2291
2279
|
end
|
2292
2280
|
|
2293
2281
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2294
|
-
job_id = '
|
2282
|
+
job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
|
2295
2283
|
opts = {
|
2296
|
-
fields_catalog_item_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2284
|
+
fields_catalog_item_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2297
2285
|
}
|
2298
2286
|
|
2299
2287
|
begin
|
@@ -2327,8 +2315,8 @@ end
|
|
2327
2315
|
|
2328
2316
|
| Name | Type | Description | Notes |
|
2329
2317
|
| ---- | ---- | ----------- | ----- |
|
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/v2023-
|
2318
|
+
| **job_id** | **String** | ID of the job to retrieve. | |
|
2319
|
+
| **fields_catalog_item_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2332
2320
|
|
2333
2321
|
### Return type
|
2334
2322
|
|
@@ -2367,9 +2355,9 @@ end
|
|
2367
2355
|
|
2368
2356
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2369
2357
|
opts = {
|
2370
|
-
fields_catalog_item_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2371
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2372
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2358
|
+
fields_catalog_item_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2359
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2360
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
2373
2361
|
}
|
2374
2362
|
|
2375
2363
|
begin
|
@@ -2403,9 +2391,9 @@ end
|
|
2403
2391
|
|
2404
2392
|
| Name | Type | Description | Notes |
|
2405
2393
|
| ---- | ---- | ----------- | ----- |
|
2406
|
-
| **fields_catalog_item_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2407
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2408
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2394
|
+
| **fields_catalog_item_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2395
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
2396
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
2409
2397
|
|
2410
2398
|
### Return type
|
2411
2399
|
|
@@ -2443,9 +2431,9 @@ KlaviyoAPI.configure do |config|
|
|
2443
2431
|
end
|
2444
2432
|
|
2445
2433
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2446
|
-
job_id = '
|
2434
|
+
job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
|
2447
2435
|
opts = {
|
2448
|
-
fields_catalog_variant_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2436
|
+
fields_catalog_variant_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2449
2437
|
}
|
2450
2438
|
|
2451
2439
|
begin
|
@@ -2479,8 +2467,8 @@ end
|
|
2479
2467
|
|
2480
2468
|
| Name | Type | Description | Notes |
|
2481
2469
|
| ---- | ---- | ----------- | ----- |
|
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/v2023-
|
2470
|
+
| **job_id** | **String** | ID of the job to retrieve. | |
|
2471
|
+
| **fields_catalog_variant_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2484
2472
|
|
2485
2473
|
### Return type
|
2486
2474
|
|
@@ -2519,9 +2507,9 @@ end
|
|
2519
2507
|
|
2520
2508
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2521
2509
|
opts = {
|
2522
|
-
fields_catalog_variant_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2523
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2524
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2510
|
+
fields_catalog_variant_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2511
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2512
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
2525
2513
|
}
|
2526
2514
|
|
2527
2515
|
begin
|
@@ -2555,9 +2543,9 @@ end
|
|
2555
2543
|
|
2556
2544
|
| Name | Type | Description | Notes |
|
2557
2545
|
| ---- | ---- | ----------- | ----- |
|
2558
|
-
| **fields_catalog_variant_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2559
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2560
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2546
|
+
| **fields_catalog_variant_bulk_delete_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2547
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
2548
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
2561
2549
|
|
2562
2550
|
### Return type
|
2563
2551
|
|
@@ -2579,7 +2567,7 @@ end
|
|
2579
2567
|
|
2580
2568
|
Get Update Categories Job
|
2581
2569
|
|
2582
|
-
Get a catalog category bulk update job with the given job ID.
|
2570
|
+
Get a catalog category bulk update job with the given job ID. An `include` parameter 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
2571
|
|
2584
2572
|
### Examples
|
2585
2573
|
|
@@ -2595,11 +2583,11 @@ KlaviyoAPI.configure do |config|
|
|
2595
2583
|
end
|
2596
2584
|
|
2597
2585
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2598
|
-
job_id = '
|
2586
|
+
job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
|
2599
2587
|
opts = {
|
2600
|
-
fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2601
|
-
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2602
|
-
include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2588
|
+
fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2589
|
+
fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2590
|
+
include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
2603
2591
|
}
|
2604
2592
|
|
2605
2593
|
begin
|
@@ -2633,10 +2621,10 @@ end
|
|
2633
2621
|
|
2634
2622
|
| Name | Type | Description | Notes |
|
2635
2623
|
| ---- | ---- | ----------- | ----- |
|
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/v2023-
|
2638
|
-
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2639
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2624
|
+
| **job_id** | **String** | ID of the job to retrieve. | |
|
2625
|
+
| **fields_catalog_category_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2626
|
+
| **fields_catalog_category** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2627
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
|
2640
2628
|
|
2641
2629
|
### Return type
|
2642
2630
|
|
@@ -2675,9 +2663,9 @@ end
|
|
2675
2663
|
|
2676
2664
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2677
2665
|
opts = {
|
2678
|
-
fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2679
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2680
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2666
|
+
fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2667
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2668
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
2681
2669
|
}
|
2682
2670
|
|
2683
2671
|
begin
|
@@ -2711,9 +2699,9 @@ end
|
|
2711
2699
|
|
2712
2700
|
| Name | Type | Description | Notes |
|
2713
2701
|
| ---- | ---- | ----------- | ----- |
|
2714
|
-
| **fields_catalog_category_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2715
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2716
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2702
|
+
| **fields_catalog_category_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2703
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
2704
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
2717
2705
|
|
2718
2706
|
### Return type
|
2719
2707
|
|
@@ -2735,7 +2723,7 @@ end
|
|
2735
2723
|
|
2736
2724
|
Get Update Items Job
|
2737
2725
|
|
2738
|
-
Get a catalog item bulk update job with the given job ID.
|
2726
|
+
Get a catalog item bulk update job with the given job ID. An `include` parameter 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
2727
|
|
2740
2728
|
### Examples
|
2741
2729
|
|
@@ -2751,11 +2739,11 @@ KlaviyoAPI.configure do |config|
|
|
2751
2739
|
end
|
2752
2740
|
|
2753
2741
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2754
|
-
job_id = '
|
2742
|
+
job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
|
2755
2743
|
opts = {
|
2756
|
-
fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2757
|
-
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2758
|
-
include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2744
|
+
fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2745
|
+
fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2746
|
+
include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
2759
2747
|
}
|
2760
2748
|
|
2761
2749
|
begin
|
@@ -2789,10 +2777,10 @@ end
|
|
2789
2777
|
|
2790
2778
|
| Name | Type | Description | Notes |
|
2791
2779
|
| ---- | ---- | ----------- | ----- |
|
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/v2023-
|
2794
|
-
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2795
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2780
|
+
| **job_id** | **String** | ID of the job to retrieve. | |
|
2781
|
+
| **fields_catalog_item_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2782
|
+
| **fields_catalog_item** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2783
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
|
2796
2784
|
|
2797
2785
|
### Return type
|
2798
2786
|
|
@@ -2831,9 +2819,9 @@ end
|
|
2831
2819
|
|
2832
2820
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2833
2821
|
opts = {
|
2834
|
-
fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2835
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2836
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2822
|
+
fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2823
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2824
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
2837
2825
|
}
|
2838
2826
|
|
2839
2827
|
begin
|
@@ -2867,9 +2855,9 @@ end
|
|
2867
2855
|
|
2868
2856
|
| Name | Type | Description | Notes |
|
2869
2857
|
| ---- | ---- | ----------- | ----- |
|
2870
|
-
| **fields_catalog_item_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2871
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2872
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2858
|
+
| **fields_catalog_item_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2859
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
2860
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
2873
2861
|
|
2874
2862
|
### Return type
|
2875
2863
|
|
@@ -2891,7 +2879,7 @@ end
|
|
2891
2879
|
|
2892
2880
|
Get Update Variants Job
|
2893
2881
|
|
2894
|
-
Get a catalog variate bulk update job with the given job ID.
|
2882
|
+
Get a catalog variate bulk update job with the given job ID. An `include` parameter 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
2883
|
|
2896
2884
|
### Examples
|
2897
2885
|
|
@@ -2907,11 +2895,11 @@ KlaviyoAPI.configure do |config|
|
|
2907
2895
|
end
|
2908
2896
|
|
2909
2897
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2910
|
-
job_id = '
|
2898
|
+
job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
|
2911
2899
|
opts = {
|
2912
|
-
fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2913
|
-
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2914
|
-
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2900
|
+
fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2901
|
+
fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2902
|
+
include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
2915
2903
|
}
|
2916
2904
|
|
2917
2905
|
begin
|
@@ -2945,10 +2933,10 @@ end
|
|
2945
2933
|
|
2946
2934
|
| Name | Type | Description | Notes |
|
2947
2935
|
| ---- | ---- | ----------- | ----- |
|
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/v2023-
|
2950
|
-
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2951
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2936
|
+
| **job_id** | **String** | ID of the job to retrieve. | |
|
2937
|
+
| **fields_catalog_variant_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2938
|
+
| **fields_catalog_variant** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
2939
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
|
2952
2940
|
|
2953
2941
|
### Return type
|
2954
2942
|
|
@@ -2987,9 +2975,9 @@ end
|
|
2987
2975
|
|
2988
2976
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
2989
2977
|
opts = {
|
2990
|
-
fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2991
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2992
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
2978
|
+
fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
2979
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2980
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
2993
2981
|
}
|
2994
2982
|
|
2995
2983
|
begin
|
@@ -3023,9 +3011,9 @@ end
|
|
3023
3011
|
|
3024
3012
|
| Name | Type | Description | Notes |
|
3025
3013
|
| ---- | ---- | ----------- | ----- |
|
3026
|
-
| **fields_catalog_variant_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
3027
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
3028
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
3014
|
+
| **fields_catalog_variant_bulk_update_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
3015
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals` | [optional] |
|
3016
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
3029
3017
|
|
3030
3018
|
### Return type
|
3031
3019
|
|
@@ -3047,7 +3035,7 @@ end
|
|
3047
3035
|
|
3048
3036
|
Spawn Create Categories Job
|
3049
3037
|
|
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`
|
3038
|
+
Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3051
3039
|
|
3052
3040
|
### Examples
|
3053
3041
|
|
@@ -3063,7 +3051,7 @@ KlaviyoAPI.configure do |config|
|
|
3063
3051
|
end
|
3064
3052
|
|
3065
3053
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3066
|
-
catalog_category_create_job_create_query = KlaviyoAPI::CatalogCategoryCreateJobCreateQuery.new({data: KlaviyoAPI::
|
3054
|
+
catalog_category_create_job_create_query = KlaviyoAPI::CatalogCategoryCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryBulkCreateJobEnum::CATALOG_CATEGORY_BULK_CREATE_JOB, attributes: KlaviyoAPI::CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.new({categories: [KlaviyoAPI::CatalogCategoryCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, attributes: KlaviyoAPI::CatalogCategoryCreateQueryResourceObjectAttributes.new({external_id: 'SAMPLE-DATA-CATEGORY-APPAREL', name: 'Sample Data Category Apparel'})})]})})}) # CatalogCategoryCreateJobCreateQuery |
|
3067
3055
|
|
3068
3056
|
begin
|
3069
3057
|
# Spawn Create Categories Job
|
@@ -3118,7 +3106,7 @@ end
|
|
3118
3106
|
|
3119
3107
|
Spawn Create Items Job
|
3120
3108
|
|
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`
|
3109
|
+
Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3122
3110
|
|
3123
3111
|
### Examples
|
3124
3112
|
|
@@ -3134,7 +3122,7 @@ KlaviyoAPI.configure do |config|
|
|
3134
3122
|
end
|
3135
3123
|
|
3136
3124
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3137
|
-
catalog_item_create_job_create_query = KlaviyoAPI::CatalogItemCreateJobCreateQuery.new({data: KlaviyoAPI::
|
3125
|
+
catalog_item_create_job_create_query = KlaviyoAPI::CatalogItemCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogItemCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemBulkCreateJobEnum::CATALOG_ITEM_BULK_CREATE_JOB, attributes: KlaviyoAPI::CatalogItemCreateJobCreateQueryResourceObjectAttributes.new({items: [KlaviyoAPI::CatalogItemCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, attributes: KlaviyoAPI::CatalogItemCreateQueryResourceObjectAttributes.new({external_id: 'SAMPLE-DATA-ITEM-1', title: 'Ocean Blue Shirt (Sample)', description: 'Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.', url: 'https://via.placeholder.com/150'})})]})})}) # CatalogItemCreateJobCreateQuery |
|
3138
3126
|
|
3139
3127
|
begin
|
3140
3128
|
# Spawn Create Items Job
|
@@ -3189,7 +3177,7 @@ end
|
|
3189
3177
|
|
3190
3178
|
Spawn Create Variants Job
|
3191
3179
|
|
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`
|
3180
|
+
Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3193
3181
|
|
3194
3182
|
### Examples
|
3195
3183
|
|
@@ -3205,7 +3193,7 @@ KlaviyoAPI.configure do |config|
|
|
3205
3193
|
end
|
3206
3194
|
|
3207
3195
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3208
|
-
catalog_variant_create_job_create_query = KlaviyoAPI::CatalogVariantCreateJobCreateQuery.new({data: KlaviyoAPI::
|
3196
|
+
catalog_variant_create_job_create_query = KlaviyoAPI::CatalogVariantCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantBulkCreateJobEnum::CATALOG_VARIANT_BULK_CREATE_JOB, attributes: KlaviyoAPI::CatalogVariantCreateJobCreateQueryResourceObjectAttributes.new({variants: [KlaviyoAPI::CatalogVariantCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantEnum::CATALOG_VARIANT, attributes: KlaviyoAPI::CatalogVariantCreateQueryResourceObjectAttributes.new({external_id: 'SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM', title: 'Ocean Blue Shirt (Sample) Variant Medium', description: 'Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.', sku: 'OBS-MD', inventory_quantity: 25, price: 42, url: 'https://via.placeholder.com/150'})})]})})}) # CatalogVariantCreateJobCreateQuery |
|
3209
3197
|
|
3210
3198
|
begin
|
3211
3199
|
# Spawn Create Variants Job
|
@@ -3260,7 +3248,7 @@ end
|
|
3260
3248
|
|
3261
3249
|
Spawn Delete Categories Job
|
3262
3250
|
|
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`
|
3251
|
+
Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3264
3252
|
|
3265
3253
|
### Examples
|
3266
3254
|
|
@@ -3276,7 +3264,7 @@ KlaviyoAPI.configure do |config|
|
|
3276
3264
|
end
|
3277
3265
|
|
3278
3266
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3279
|
-
catalog_category_delete_job_create_query = KlaviyoAPI::CatalogCategoryDeleteJobCreateQuery.new({data: KlaviyoAPI::
|
3267
|
+
catalog_category_delete_job_create_query = KlaviyoAPI::CatalogCategoryDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryDeleteJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryBulkDeleteJobEnum::CATALOG_CATEGORY_BULK_DELETE_JOB, attributes: KlaviyoAPI::CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.new({categories: [KlaviyoAPI::CatalogCategoryDeleteQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'})]})})}) # CatalogCategoryDeleteJobCreateQuery |
|
3280
3268
|
|
3281
3269
|
begin
|
3282
3270
|
# Spawn Delete Categories Job
|
@@ -3331,7 +3319,7 @@ end
|
|
3331
3319
|
|
3332
3320
|
Spawn Delete Items Job
|
3333
3321
|
|
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`
|
3322
|
+
Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3335
3323
|
|
3336
3324
|
### Examples
|
3337
3325
|
|
@@ -3347,7 +3335,7 @@ KlaviyoAPI.configure do |config|
|
|
3347
3335
|
end
|
3348
3336
|
|
3349
3337
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3350
|
-
catalog_item_delete_job_create_query = KlaviyoAPI::CatalogItemDeleteJobCreateQuery.new({data: KlaviyoAPI::
|
3338
|
+
catalog_item_delete_job_create_query = KlaviyoAPI::CatalogItemDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogItemDeleteJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemBulkDeleteJobEnum::CATALOG_ITEM_BULK_DELETE_JOB, attributes: KlaviyoAPI::CatalogItemDeleteJobCreateQueryResourceObjectAttributes.new({items: [KlaviyoAPI::CatalogItemDeleteQueryResourceObject.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1'})]})})}) # CatalogItemDeleteJobCreateQuery |
|
3351
3339
|
|
3352
3340
|
begin
|
3353
3341
|
# Spawn Delete Items Job
|
@@ -3402,7 +3390,7 @@ end
|
|
3402
3390
|
|
3403
3391
|
Spawn Delete Variants Job
|
3404
3392
|
|
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`
|
3393
|
+
Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3406
3394
|
|
3407
3395
|
### Examples
|
3408
3396
|
|
@@ -3418,7 +3406,7 @@ KlaviyoAPI.configure do |config|
|
|
3418
3406
|
end
|
3419
3407
|
|
3420
3408
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3421
|
-
catalog_variant_delete_job_create_query = KlaviyoAPI::CatalogVariantDeleteJobCreateQuery.new({data: KlaviyoAPI::
|
3409
|
+
catalog_variant_delete_job_create_query = KlaviyoAPI::CatalogVariantDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantDeleteJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantBulkDeleteJobEnum::CATALOG_VARIANT_BULK_DELETE_JOB, attributes: KlaviyoAPI::CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.new({variants: [KlaviyoAPI::CatalogVariantDeleteQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantEnum::CATALOG_VARIANT, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM'})]})})}) # CatalogVariantDeleteJobCreateQuery |
|
3422
3410
|
|
3423
3411
|
begin
|
3424
3412
|
# Spawn Delete Variants Job
|
@@ -3473,7 +3461,7 @@ end
|
|
3473
3461
|
|
3474
3462
|
Spawn Update Categories Job
|
3475
3463
|
|
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`
|
3464
|
+
Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3477
3465
|
|
3478
3466
|
### Examples
|
3479
3467
|
|
@@ -3489,7 +3477,7 @@ KlaviyoAPI.configure do |config|
|
|
3489
3477
|
end
|
3490
3478
|
|
3491
3479
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3492
|
-
catalog_category_update_job_create_query = KlaviyoAPI::CatalogCategoryUpdateJobCreateQuery.new({data: KlaviyoAPI::
|
3480
|
+
catalog_category_update_job_create_query = KlaviyoAPI::CatalogCategoryUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryUpdateJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryBulkUpdateJobEnum::CATALOG_CATEGORY_BULK_UPDATE_JOB, attributes: KlaviyoAPI::CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.new({categories: [KlaviyoAPI::CatalogCategoryUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL', attributes: KlaviyoAPI::CatalogCategoryUpdateQueryResourceObjectAttributes.new})]})})}) # CatalogCategoryUpdateJobCreateQuery |
|
3493
3481
|
|
3494
3482
|
begin
|
3495
3483
|
# Spawn Update Categories Job
|
@@ -3544,7 +3532,7 @@ end
|
|
3544
3532
|
|
3545
3533
|
Spawn Update Items Job
|
3546
3534
|
|
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`
|
3535
|
+
Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3548
3536
|
|
3549
3537
|
### Examples
|
3550
3538
|
|
@@ -3560,7 +3548,7 @@ KlaviyoAPI.configure do |config|
|
|
3560
3548
|
end
|
3561
3549
|
|
3562
3550
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3563
|
-
catalog_item_update_job_create_query = KlaviyoAPI::CatalogItemUpdateJobCreateQuery.new({data: KlaviyoAPI::
|
3551
|
+
catalog_item_update_job_create_query = KlaviyoAPI::CatalogItemUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogItemUpdateJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemBulkUpdateJobEnum::CATALOG_ITEM_BULK_UPDATE_JOB, attributes: KlaviyoAPI::CatalogItemUpdateJobCreateQueryResourceObjectAttributes.new({items: [KlaviyoAPI::CatalogItemUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1', attributes: KlaviyoAPI::CatalogItemUpdateQueryResourceObjectAttributes.new})]})})}) # CatalogItemUpdateJobCreateQuery |
|
3564
3552
|
|
3565
3553
|
begin
|
3566
3554
|
# Spawn Update Items Job
|
@@ -3615,7 +3603,7 @@ end
|
|
3615
3603
|
|
3616
3604
|
Spawn Update Variants Job
|
3617
3605
|
|
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`
|
3606
|
+
Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3619
3607
|
|
3620
3608
|
### Examples
|
3621
3609
|
|
@@ -3631,7 +3619,7 @@ KlaviyoAPI.configure do |config|
|
|
3631
3619
|
end
|
3632
3620
|
|
3633
3621
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3634
|
-
catalog_variant_update_job_create_query = KlaviyoAPI::CatalogVariantUpdateJobCreateQuery.new({data: KlaviyoAPI::
|
3622
|
+
catalog_variant_update_job_create_query = KlaviyoAPI::CatalogVariantUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantUpdateJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantBulkUpdateJobEnum::CATALOG_VARIANT_BULK_UPDATE_JOB, attributes: KlaviyoAPI::CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.new({variants: [KlaviyoAPI::CatalogVariantUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantEnum::CATALOG_VARIANT, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM', attributes: KlaviyoAPI::CatalogVariantUpdateQueryResourceObjectAttributes.new})]})})}) # CatalogVariantUpdateJobCreateQuery |
|
3635
3623
|
|
3636
3624
|
begin
|
3637
3625
|
# Spawn Update Variants Job
|
@@ -3702,8 +3690,8 @@ KlaviyoAPI.configure do |config|
|
|
3702
3690
|
end
|
3703
3691
|
|
3704
3692
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3705
|
-
id = '
|
3706
|
-
catalog_category_update_query = KlaviyoAPI::CatalogCategoryUpdateQuery.new({data: KlaviyoAPI::
|
3693
|
+
id = '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL' # String | The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3694
|
+
catalog_category_update_query = KlaviyoAPI::CatalogCategoryUpdateQuery.new({data: KlaviyoAPI::CatalogCategoryUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL', attributes: KlaviyoAPI::CatalogCategoryUpdateQueryResourceObjectAttributes.new})}) # CatalogCategoryUpdateQuery |
|
3707
3695
|
|
3708
3696
|
begin
|
3709
3697
|
# Update Catalog Category
|
@@ -3736,7 +3724,7 @@ end
|
|
3736
3724
|
|
3737
3725
|
| Name | Type | Description | Notes |
|
3738
3726
|
| ---- | ---- | ----------- | ----- |
|
3739
|
-
| **id** | **String** | The catalog category ID is a compound ID (string), with format: `
|
3727
|
+
| **id** | **String** | The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
3740
3728
|
| **catalog_category_update_query** | [**CatalogCategoryUpdateQuery**](CatalogCategoryUpdateQuery.md) | | |
|
3741
3729
|
|
3742
3730
|
### Return type
|
@@ -3753,11 +3741,11 @@ end
|
|
3753
3741
|
- **Accept**: application/json
|
3754
3742
|
|
3755
3743
|
|
3756
|
-
##
|
3744
|
+
## update_catalog_category_relationships_items
|
3757
3745
|
|
3758
|
-
>
|
3746
|
+
> update_catalog_category_relationships_items(id, catalog_category_item_op)
|
3759
3747
|
|
3760
|
-
Update Catalog Category Relationships
|
3748
|
+
Update Catalog Category Relationships Items
|
3761
3749
|
|
3762
3750
|
Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
|
3763
3751
|
|
@@ -3776,32 +3764,31 @@ end
|
|
3776
3764
|
|
3777
3765
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3778
3766
|
id = 'id_example' # String |
|
3779
|
-
|
3780
|
-
catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
|
3767
|
+
catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
|
3781
3768
|
|
3782
3769
|
begin
|
3783
|
-
# Update Catalog Category Relationships
|
3784
|
-
api_instance.
|
3770
|
+
# Update Catalog Category Relationships Items
|
3771
|
+
api_instance.update_catalog_category_relationships_items(id, catalog_category_item_op)
|
3785
3772
|
rescue KlaviyoAPI::ApiError => e
|
3786
|
-
puts "Error when calling CatalogsApi->
|
3773
|
+
puts "Error when calling CatalogsApi->update_catalog_category_relationships_items: #{e}"
|
3787
3774
|
end
|
3788
3775
|
```
|
3789
3776
|
|
3790
|
-
#### Using the
|
3777
|
+
#### Using the update_catalog_category_relationships_items_with_http_info variant
|
3791
3778
|
|
3792
3779
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
3793
3780
|
|
3794
|
-
> <Array(nil, Integer, Hash)>
|
3781
|
+
> <Array(nil, Integer, Hash)> update_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
|
3795
3782
|
|
3796
3783
|
```ruby
|
3797
3784
|
begin
|
3798
|
-
# Update Catalog Category Relationships
|
3799
|
-
data, status_code, headers = api_instance.
|
3785
|
+
# Update Catalog Category Relationships Items
|
3786
|
+
data, status_code, headers = api_instance.update_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
|
3800
3787
|
p status_code # => 2xx
|
3801
3788
|
p headers # => { ... }
|
3802
3789
|
p data # => nil
|
3803
3790
|
rescue KlaviyoAPI::ApiError => e
|
3804
|
-
puts "Error when calling CatalogsApi->
|
3791
|
+
puts "Error when calling CatalogsApi->update_catalog_category_relationships_items_with_http_info: #{e}"
|
3805
3792
|
end
|
3806
3793
|
```
|
3807
3794
|
|
@@ -3810,7 +3797,6 @@ end
|
|
3810
3797
|
| Name | Type | Description | Notes |
|
3811
3798
|
| ---- | ---- | ----------- | ----- |
|
3812
3799
|
| **id** | **String** | | |
|
3813
|
-
| **related_resource** | **String** | | |
|
3814
3800
|
| **catalog_category_item_op** | [**CatalogCategoryItemOp**](CatalogCategoryItemOp.md) | | |
|
3815
3801
|
|
3816
3802
|
### Return type
|
@@ -3849,8 +3835,8 @@ KlaviyoAPI.configure do |config|
|
|
3849
3835
|
end
|
3850
3836
|
|
3851
3837
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3852
|
-
id = '
|
3853
|
-
catalog_item_update_query = KlaviyoAPI::CatalogItemUpdateQuery.new({data: KlaviyoAPI::
|
3838
|
+
id = '$custom:::$default:::SAMPLE-DATA-ITEM-1' # String | The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3839
|
+
catalog_item_update_query = KlaviyoAPI::CatalogItemUpdateQuery.new({data: KlaviyoAPI::CatalogItemUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1', attributes: KlaviyoAPI::CatalogItemUpdateQueryResourceObjectAttributes.new})}) # CatalogItemUpdateQuery |
|
3854
3840
|
|
3855
3841
|
begin
|
3856
3842
|
# Update Catalog Item
|
@@ -3883,7 +3869,7 @@ end
|
|
3883
3869
|
|
3884
3870
|
| Name | Type | Description | Notes |
|
3885
3871
|
| ---- | ---- | ----------- | ----- |
|
3886
|
-
| **id** | **String** | The catalog item ID is a compound ID (string), with format: `
|
3872
|
+
| **id** | **String** | The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
3887
3873
|
| **catalog_item_update_query** | [**CatalogItemUpdateQuery**](CatalogItemUpdateQuery.md) | | |
|
3888
3874
|
|
3889
3875
|
### Return type
|
@@ -3900,11 +3886,11 @@ end
|
|
3900
3886
|
- **Accept**: application/json
|
3901
3887
|
|
3902
3888
|
|
3903
|
-
##
|
3889
|
+
## update_catalog_item_relationships_categories
|
3904
3890
|
|
3905
|
-
>
|
3891
|
+
> update_catalog_item_relationships_categories(id, catalog_item_category_op)
|
3906
3892
|
|
3907
|
-
Update Catalog Item Relationships
|
3893
|
+
Update Catalog Item Relationships Categories
|
3908
3894
|
|
3909
3895
|
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
3896
|
|
@@ -3923,32 +3909,31 @@ end
|
|
3923
3909
|
|
3924
3910
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3925
3911
|
id = 'id_example' # String |
|
3926
|
-
|
3927
|
-
catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
|
3912
|
+
catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
|
3928
3913
|
|
3929
3914
|
begin
|
3930
|
-
# Update Catalog Item Relationships
|
3931
|
-
api_instance.
|
3915
|
+
# Update Catalog Item Relationships Categories
|
3916
|
+
api_instance.update_catalog_item_relationships_categories(id, catalog_item_category_op)
|
3932
3917
|
rescue KlaviyoAPI::ApiError => e
|
3933
|
-
puts "Error when calling CatalogsApi->
|
3918
|
+
puts "Error when calling CatalogsApi->update_catalog_item_relationships_categories: #{e}"
|
3934
3919
|
end
|
3935
3920
|
```
|
3936
3921
|
|
3937
|
-
#### Using the
|
3922
|
+
#### Using the update_catalog_item_relationships_categories_with_http_info variant
|
3938
3923
|
|
3939
3924
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
3940
3925
|
|
3941
|
-
> <Array(nil, Integer, Hash)>
|
3926
|
+
> <Array(nil, Integer, Hash)> update_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
|
3942
3927
|
|
3943
3928
|
```ruby
|
3944
3929
|
begin
|
3945
|
-
# Update Catalog Item Relationships
|
3946
|
-
data, status_code, headers = api_instance.
|
3930
|
+
# Update Catalog Item Relationships Categories
|
3931
|
+
data, status_code, headers = api_instance.update_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
|
3947
3932
|
p status_code # => 2xx
|
3948
3933
|
p headers # => { ... }
|
3949
3934
|
p data # => nil
|
3950
3935
|
rescue KlaviyoAPI::ApiError => e
|
3951
|
-
puts "Error when calling CatalogsApi->
|
3936
|
+
puts "Error when calling CatalogsApi->update_catalog_item_relationships_categories_with_http_info: #{e}"
|
3952
3937
|
end
|
3953
3938
|
```
|
3954
3939
|
|
@@ -3957,7 +3942,6 @@ end
|
|
3957
3942
|
| Name | Type | Description | Notes |
|
3958
3943
|
| ---- | ---- | ----------- | ----- |
|
3959
3944
|
| **id** | **String** | | |
|
3960
|
-
| **related_resource** | **String** | | |
|
3961
3945
|
| **catalog_item_category_op** | [**CatalogItemCategoryOp**](CatalogItemCategoryOp.md) | | |
|
3962
3946
|
|
3963
3947
|
### Return type
|
@@ -3996,8 +3980,8 @@ KlaviyoAPI.configure do |config|
|
|
3996
3980
|
end
|
3997
3981
|
|
3998
3982
|
api_instance = KlaviyoAPI::CatalogsApi.new
|
3999
|
-
id = '
|
4000
|
-
catalog_variant_update_query = KlaviyoAPI::CatalogVariantUpdateQuery.new({data: KlaviyoAPI::
|
3983
|
+
id = '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM' # String | The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3984
|
+
catalog_variant_update_query = KlaviyoAPI::CatalogVariantUpdateQuery.new({data: KlaviyoAPI::CatalogVariantUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantEnum::CATALOG_VARIANT, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM', attributes: KlaviyoAPI::CatalogVariantUpdateQueryResourceObjectAttributes.new})}) # CatalogVariantUpdateQuery |
|
4001
3985
|
|
4002
3986
|
begin
|
4003
3987
|
# Update Catalog Variant
|
@@ -4030,7 +4014,7 @@ end
|
|
4030
4014
|
|
4031
4015
|
| Name | Type | Description | Notes |
|
4032
4016
|
| ---- | ---- | ----------- | ----- |
|
4033
|
-
| **id** | **String** | The catalog variant ID is a compound ID (string), with format: `
|
4017
|
+
| **id** | **String** | The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
|
4034
4018
|
| **catalog_variant_update_query** | [**CatalogVariantUpdateQuery**](CatalogVariantUpdateQuery.md) | | |
|
4035
4019
|
|
4036
4020
|
### Return type
|