klaviyo-api-sdk 1.2.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 +220 -61
- 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 +1 -1
- 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 +25 -27
- 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/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 +141 -157
- 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/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 +90 -18
- 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 +190 -46
- 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 +108 -38
- 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 +1 -1
- 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/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/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 +121 -37
- data/docs/SMSChannel.md +18 -0
- data/docs/SMSMarketing.md +24 -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 +90 -16
- 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/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 +881 -163
- 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 +5 -5
- data/docs/TestApiAnalyticsSampleEnum.md +15 -0
- data/docs/TestListEnum.md +15 -0
- 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 +1 -1
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +14 -20
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +110 -198
- data/lib/klaviyo-api-sdk/api/events_api.rb +87 -26
- data/lib/klaviyo-api-sdk/api/flows_api.rb +172 -65
- data/lib/klaviyo-api-sdk/api/lists_api.rb +99 -57
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +121 -36
- data/lib/klaviyo-api-sdk/api/segments_api.rb +85 -21
- data/lib/klaviyo-api-sdk/api/tags_api.rb +788 -116
- data/lib/klaviyo-api-sdk/api/templates_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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_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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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/data_privacy_create_deletion_job_query.rb +1 -1
- 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/event_create_query.rb +1 -1
- 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 +1 -1
- 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/list_create_query.rb +1 -1
- 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_partial_update_query.rb +1 -1
- 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 +1 -1
- 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_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 +1 -1
- 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_subscription_create_query.rb +1 -1
- 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 +1 -1
- 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_partial_update_query.rb +1 -1
- 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 +1 -1
- 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/sms_channel.rb +219 -0
- data/lib/klaviyo-api-sdk/models/sms_marketing.rb +270 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_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_create_job_create_query.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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_update_query.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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/unsubscription_create_job_create_query.rb +1 -1
- 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 +1 -1
- 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.rb +153 -123
- data/spec/api/campaigns_api_spec.rb +5 -34
- 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/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_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/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_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/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
- metadata +466 -394
- data/CHANGELOG.md +0 -41
- 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/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +0 -20
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +0 -18
- 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/CampaignTagOp.md +0 -18
- data/docs/CampaignTagOpDataInner.md +0 -20
- 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 -40
- 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 -34
- 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 -40
- 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/IncludedSegmentsAttributes.md +0 -22
- data/docs/IncludedTags.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/SegmentPartialUpdateQueryAsSubResourceAttributes.md +0 -18
- 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 -20
- 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_recipient_estimation_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb +0 -225
- 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/campaign_tag_op.rb +0 -226
- data/lib/klaviyo-api-sdk/models/campaign_tag_op_data_inner.rb +0 -272
- 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 -227
- 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 -296
- 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 -227
- 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 -227
- 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 -220
- 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 -227
- 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 -390
- 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 -227
- 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 -227
- 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 -302
- 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 -227
- 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 -447
- 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 -227
- 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 -227
- 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 -356
- 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 -240
- 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 -301
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +0 -332
- data/lib/klaviyo-api-sdk/models/included_lists.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +0 -240
- 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 -301
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +0 -348
- data/lib/klaviyo-api-sdk/models/included_segments.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/included_tags.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_variants.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +0 -396
- 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 -225
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +0 -287
- 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 -388
- 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 -318
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource_attributes.rb +0 -224
- 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 -272
- 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_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +0 -44
- 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/campaign_tag_op_data_inner_spec.rb +0 -44
- data/spec/models/campaign_tag_op_spec.rb +0 -34
- 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_attributes_spec.rb +0 -46
- data/spec/models/included_segments_spec.rb +0 -56
- data/spec/models/included_tags_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_attributes_spec.rb +0 -34
- 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/TagsApi.md
CHANGED
@@ -6,16 +6,26 @@ All URIs are relative to *https://a.klaviyo.com*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**create_tag**](TagsApi.md#create_tag) | **POST** /api/tags/ | Create Tag |
|
8
8
|
| [**create_tag_group**](TagsApi.md#create_tag_group) | **POST** /api/tag-groups/ | Create Tag Group |
|
9
|
-
| [**
|
9
|
+
| [**create_tag_relationships_campaigns**](TagsApi.md#create_tag_relationships_campaigns) | **POST** /api/tags/{id}/relationships/campaigns/ | Create Tag Relationships Campaigns |
|
10
|
+
| [**create_tag_relationships_flows**](TagsApi.md#create_tag_relationships_flows) | **POST** /api/tags/{id}/relationships/flows/ | Create Tag Relationships Flows |
|
11
|
+
| [**create_tag_relationships_lists**](TagsApi.md#create_tag_relationships_lists) | **POST** /api/tags/{id}/relationships/lists/ | Create Tag Relationships Lists |
|
12
|
+
| [**create_tag_relationships_segments**](TagsApi.md#create_tag_relationships_segments) | **POST** /api/tags/{id}/relationships/segments/ | Create Tag Relationships Segments |
|
10
13
|
| [**delete_tag**](TagsApi.md#delete_tag) | **DELETE** /api/tags/{id}/ | Delete Tag |
|
11
14
|
| [**delete_tag_group**](TagsApi.md#delete_tag_group) | **DELETE** /api/tag-groups/{id}/ | Delete Tag Group |
|
12
|
-
| [**
|
15
|
+
| [**delete_tag_relationships_campaigns**](TagsApi.md#delete_tag_relationships_campaigns) | **DELETE** /api/tags/{id}/relationships/campaigns/ | Delete Tag Relationships Campaigns |
|
16
|
+
| [**delete_tag_relationships_flows**](TagsApi.md#delete_tag_relationships_flows) | **DELETE** /api/tags/{id}/relationships/flows/ | Delete Tag Relationships Flows |
|
17
|
+
| [**delete_tag_relationships_lists**](TagsApi.md#delete_tag_relationships_lists) | **DELETE** /api/tags/{id}/relationships/lists/ | Delete Tag Relationships Lists |
|
18
|
+
| [**delete_tag_relationships_segments**](TagsApi.md#delete_tag_relationships_segments) | **DELETE** /api/tags/{id}/relationships/segments/ | Delete Tag Relationships Segments |
|
13
19
|
| [**get_tag**](TagsApi.md#get_tag) | **GET** /api/tags/{id}/ | Get Tag |
|
14
20
|
| [**get_tag_group**](TagsApi.md#get_tag_group) | **GET** /api/tag-groups/{id}/ | Get Tag Group |
|
15
|
-
| [**
|
21
|
+
| [**get_tag_group_relationships_tags**](TagsApi.md#get_tag_group_relationships_tags) | **GET** /api/tag-groups/{id}/relationships/tags/ | Get Tag Group Relationships Tags |
|
16
22
|
| [**get_tag_group_tags**](TagsApi.md#get_tag_group_tags) | **GET** /api/tag-groups/{id}/tags/ | Get Tag Group Tags |
|
17
23
|
| [**get_tag_groups**](TagsApi.md#get_tag_groups) | **GET** /api/tag-groups/ | Get Tag Groups |
|
18
|
-
| [**
|
24
|
+
| [**get_tag_relationships_campaigns**](TagsApi.md#get_tag_relationships_campaigns) | **GET** /api/tags/{id}/relationships/campaigns/ | Get Tag Relationships Campaigns |
|
25
|
+
| [**get_tag_relationships_flows**](TagsApi.md#get_tag_relationships_flows) | **GET** /api/tags/{id}/relationships/flows/ | Get Tag Relationships Flows |
|
26
|
+
| [**get_tag_relationships_lists**](TagsApi.md#get_tag_relationships_lists) | **GET** /api/tags/{id}/relationships/lists/ | Get Tag Relationships Lists |
|
27
|
+
| [**get_tag_relationships_segments**](TagsApi.md#get_tag_relationships_segments) | **GET** /api/tags/{id}/relationships/segments/ | Get Tag Relationships Segments |
|
28
|
+
| [**get_tag_relationships_tag_group**](TagsApi.md#get_tag_relationships_tag_group) | **GET** /api/tags/{id}/relationships/tag-group/ | Get Tag Relationships Tag Group |
|
19
29
|
| [**get_tag_tag_group**](TagsApi.md#get_tag_tag_group) | **GET** /api/tags/{id}/tag-group/ | Get Tag Tag Group |
|
20
30
|
| [**get_tags**](TagsApi.md#get_tags) | **GET** /api/tags/ | Get Tags |
|
21
31
|
| [**update_tag**](TagsApi.md#update_tag) | **PATCH** /api/tags/{id}/ | Update Tag |
|
@@ -44,7 +54,7 @@ KlaviyoAPI.configure do |config|
|
|
44
54
|
end
|
45
55
|
|
46
56
|
api_instance = KlaviyoAPI::TagsApi.new
|
47
|
-
tag_create_query = KlaviyoAPI::TagCreateQuery.new({data: KlaviyoAPI::
|
57
|
+
tag_create_query = KlaviyoAPI::TagCreateQuery.new({data: KlaviyoAPI::TagCreateQueryResourceObject.new({type: KlaviyoAPI::TagEnum::TAG, attributes: KlaviyoAPI::TagCreateQueryResourceObjectAttributes.new({name: 'My Tag'})})}) # TagCreateQuery |
|
48
58
|
|
49
59
|
begin
|
50
60
|
# Create Tag
|
@@ -115,7 +125,7 @@ KlaviyoAPI.configure do |config|
|
|
115
125
|
end
|
116
126
|
|
117
127
|
api_instance = KlaviyoAPI::TagsApi.new
|
118
|
-
tag_group_create_query = KlaviyoAPI::TagGroupCreateQuery.new({data: KlaviyoAPI::
|
128
|
+
tag_group_create_query = KlaviyoAPI::TagGroupCreateQuery.new({data: KlaviyoAPI::TagGroupCreateQueryResourceObject.new({type: KlaviyoAPI::TagGroupEnum::TAG_GROUP, attributes: KlaviyoAPI::TagGroupCreateQueryResourceObjectAttributes.new({name: 'My Tag Group'})})}) # TagGroupCreateQuery |
|
119
129
|
|
120
130
|
begin
|
121
131
|
# Create Tag Group
|
@@ -164,13 +174,659 @@ end
|
|
164
174
|
- **Accept**: application/json
|
165
175
|
|
166
176
|
|
167
|
-
##
|
177
|
+
## create_tag_relationships_campaigns
|
168
178
|
|
169
|
-
>
|
179
|
+
> create_tag_relationships_campaigns(id, tag_campaign_op)
|
170
180
|
|
171
|
-
Create Tag Relationships
|
181
|
+
Create Tag Relationships Campaigns
|
172
182
|
|
173
|
-
Associate a tag with
|
183
|
+
Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Campaigns Write` `Tags Write`
|
184
|
+
|
185
|
+
### Examples
|
186
|
+
|
187
|
+
```ruby
|
188
|
+
require 'time'
|
189
|
+
require 'klaviyo-api-sdk'
|
190
|
+
# setup authorization
|
191
|
+
KlaviyoAPI.configure do |config|
|
192
|
+
# Configure API key authorization: Klaviyo-API-Key
|
193
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
194
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
195
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
196
|
+
end
|
197
|
+
|
198
|
+
api_instance = KlaviyoAPI::TagsApi.new
|
199
|
+
id = 'id_example' # String |
|
200
|
+
tag_campaign_op = KlaviyoAPI::TagCampaignOp.new({data: [KlaviyoAPI::TagCampaignOpDataInner.new({type: 'campaign', id: 'id_example'})]}) # TagCampaignOp |
|
201
|
+
|
202
|
+
begin
|
203
|
+
# Create Tag Relationships Campaigns
|
204
|
+
api_instance.create_tag_relationships_campaigns(id, tag_campaign_op)
|
205
|
+
rescue KlaviyoAPI::ApiError => e
|
206
|
+
puts "Error when calling TagsApi->create_tag_relationships_campaigns: #{e}"
|
207
|
+
end
|
208
|
+
```
|
209
|
+
|
210
|
+
#### Using the create_tag_relationships_campaigns_with_http_info variant
|
211
|
+
|
212
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
213
|
+
|
214
|
+
> <Array(nil, Integer, Hash)> create_tag_relationships_campaigns_with_http_info(id, tag_campaign_op)
|
215
|
+
|
216
|
+
```ruby
|
217
|
+
begin
|
218
|
+
# Create Tag Relationships Campaigns
|
219
|
+
data, status_code, headers = api_instance.create_tag_relationships_campaigns_with_http_info(id, tag_campaign_op)
|
220
|
+
p status_code # => 2xx
|
221
|
+
p headers # => { ... }
|
222
|
+
p data # => nil
|
223
|
+
rescue KlaviyoAPI::ApiError => e
|
224
|
+
puts "Error when calling TagsApi->create_tag_relationships_campaigns_with_http_info: #{e}"
|
225
|
+
end
|
226
|
+
```
|
227
|
+
|
228
|
+
### Parameters
|
229
|
+
|
230
|
+
| Name | Type | Description | Notes |
|
231
|
+
| ---- | ---- | ----------- | ----- |
|
232
|
+
| **id** | **String** | | |
|
233
|
+
| **tag_campaign_op** | [**TagCampaignOp**](TagCampaignOp.md) | | |
|
234
|
+
|
235
|
+
### Return type
|
236
|
+
|
237
|
+
nil (empty response body)
|
238
|
+
|
239
|
+
### Authorization
|
240
|
+
|
241
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
242
|
+
|
243
|
+
### HTTP request headers
|
244
|
+
|
245
|
+
- **Content-Type**: application/json
|
246
|
+
- **Accept**: application/json
|
247
|
+
|
248
|
+
|
249
|
+
## create_tag_relationships_flows
|
250
|
+
|
251
|
+
> create_tag_relationships_flows(id, tag_flow_op)
|
252
|
+
|
253
|
+
Create Tag Relationships Flows
|
254
|
+
|
255
|
+
Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Write` `Tags Write`
|
256
|
+
|
257
|
+
### Examples
|
258
|
+
|
259
|
+
```ruby
|
260
|
+
require 'time'
|
261
|
+
require 'klaviyo-api-sdk'
|
262
|
+
# setup authorization
|
263
|
+
KlaviyoAPI.configure do |config|
|
264
|
+
# Configure API key authorization: Klaviyo-API-Key
|
265
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
266
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
267
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
268
|
+
end
|
269
|
+
|
270
|
+
api_instance = KlaviyoAPI::TagsApi.new
|
271
|
+
id = 'id_example' # String |
|
272
|
+
tag_flow_op = KlaviyoAPI::TagFlowOp.new({data: [KlaviyoAPI::TagFlowOpDataInner.new({type: 'flow', id: 'id_example'})]}) # TagFlowOp |
|
273
|
+
|
274
|
+
begin
|
275
|
+
# Create Tag Relationships Flows
|
276
|
+
api_instance.create_tag_relationships_flows(id, tag_flow_op)
|
277
|
+
rescue KlaviyoAPI::ApiError => e
|
278
|
+
puts "Error when calling TagsApi->create_tag_relationships_flows: #{e}"
|
279
|
+
end
|
280
|
+
```
|
281
|
+
|
282
|
+
#### Using the create_tag_relationships_flows_with_http_info variant
|
283
|
+
|
284
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
285
|
+
|
286
|
+
> <Array(nil, Integer, Hash)> create_tag_relationships_flows_with_http_info(id, tag_flow_op)
|
287
|
+
|
288
|
+
```ruby
|
289
|
+
begin
|
290
|
+
# Create Tag Relationships Flows
|
291
|
+
data, status_code, headers = api_instance.create_tag_relationships_flows_with_http_info(id, tag_flow_op)
|
292
|
+
p status_code # => 2xx
|
293
|
+
p headers # => { ... }
|
294
|
+
p data # => nil
|
295
|
+
rescue KlaviyoAPI::ApiError => e
|
296
|
+
puts "Error when calling TagsApi->create_tag_relationships_flows_with_http_info: #{e}"
|
297
|
+
end
|
298
|
+
```
|
299
|
+
|
300
|
+
### Parameters
|
301
|
+
|
302
|
+
| Name | Type | Description | Notes |
|
303
|
+
| ---- | ---- | ----------- | ----- |
|
304
|
+
| **id** | **String** | | |
|
305
|
+
| **tag_flow_op** | [**TagFlowOp**](TagFlowOp.md) | | |
|
306
|
+
|
307
|
+
### Return type
|
308
|
+
|
309
|
+
nil (empty response body)
|
310
|
+
|
311
|
+
### Authorization
|
312
|
+
|
313
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
314
|
+
|
315
|
+
### HTTP request headers
|
316
|
+
|
317
|
+
- **Content-Type**: application/json
|
318
|
+
- **Accept**: application/json
|
319
|
+
|
320
|
+
|
321
|
+
## create_tag_relationships_lists
|
322
|
+
|
323
|
+
> create_tag_relationships_lists(id, tag_list_op)
|
324
|
+
|
325
|
+
Create Tag Relationships Lists
|
326
|
+
|
327
|
+
Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `List Write` `Tags Write`
|
328
|
+
|
329
|
+
### Examples
|
330
|
+
|
331
|
+
```ruby
|
332
|
+
require 'time'
|
333
|
+
require 'klaviyo-api-sdk'
|
334
|
+
# setup authorization
|
335
|
+
KlaviyoAPI.configure do |config|
|
336
|
+
# Configure API key authorization: Klaviyo-API-Key
|
337
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
338
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
339
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
340
|
+
end
|
341
|
+
|
342
|
+
api_instance = KlaviyoAPI::TagsApi.new
|
343
|
+
id = 'id_example' # String |
|
344
|
+
tag_list_op = KlaviyoAPI::TagListOp.new({data: [KlaviyoAPI::TagListOpDataInner.new({type: 'list', id: 'id_example'})]}) # TagListOp |
|
345
|
+
|
346
|
+
begin
|
347
|
+
# Create Tag Relationships Lists
|
348
|
+
api_instance.create_tag_relationships_lists(id, tag_list_op)
|
349
|
+
rescue KlaviyoAPI::ApiError => e
|
350
|
+
puts "Error when calling TagsApi->create_tag_relationships_lists: #{e}"
|
351
|
+
end
|
352
|
+
```
|
353
|
+
|
354
|
+
#### Using the create_tag_relationships_lists_with_http_info variant
|
355
|
+
|
356
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
357
|
+
|
358
|
+
> <Array(nil, Integer, Hash)> create_tag_relationships_lists_with_http_info(id, tag_list_op)
|
359
|
+
|
360
|
+
```ruby
|
361
|
+
begin
|
362
|
+
# Create Tag Relationships Lists
|
363
|
+
data, status_code, headers = api_instance.create_tag_relationships_lists_with_http_info(id, tag_list_op)
|
364
|
+
p status_code # => 2xx
|
365
|
+
p headers # => { ... }
|
366
|
+
p data # => nil
|
367
|
+
rescue KlaviyoAPI::ApiError => e
|
368
|
+
puts "Error when calling TagsApi->create_tag_relationships_lists_with_http_info: #{e}"
|
369
|
+
end
|
370
|
+
```
|
371
|
+
|
372
|
+
### Parameters
|
373
|
+
|
374
|
+
| Name | Type | Description | Notes |
|
375
|
+
| ---- | ---- | ----------- | ----- |
|
376
|
+
| **id** | **String** | | |
|
377
|
+
| **tag_list_op** | [**TagListOp**](TagListOp.md) | | |
|
378
|
+
|
379
|
+
### Return type
|
380
|
+
|
381
|
+
nil (empty response body)
|
382
|
+
|
383
|
+
### Authorization
|
384
|
+
|
385
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
386
|
+
|
387
|
+
### HTTP request headers
|
388
|
+
|
389
|
+
- **Content-Type**: application/json
|
390
|
+
- **Accept**: application/json
|
391
|
+
|
392
|
+
|
393
|
+
## create_tag_relationships_segments
|
394
|
+
|
395
|
+
> create_tag_relationships_segments(id, tag_segment_op)
|
396
|
+
|
397
|
+
Create Tag Relationships Segments
|
398
|
+
|
399
|
+
Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Segments Write` `Tags Write`
|
400
|
+
|
401
|
+
### Examples
|
402
|
+
|
403
|
+
```ruby
|
404
|
+
require 'time'
|
405
|
+
require 'klaviyo-api-sdk'
|
406
|
+
# setup authorization
|
407
|
+
KlaviyoAPI.configure do |config|
|
408
|
+
# Configure API key authorization: Klaviyo-API-Key
|
409
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
410
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
411
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
412
|
+
end
|
413
|
+
|
414
|
+
api_instance = KlaviyoAPI::TagsApi.new
|
415
|
+
id = 'id_example' # String |
|
416
|
+
tag_segment_op = KlaviyoAPI::TagSegmentOp.new({data: [KlaviyoAPI::TagSegmentOpDataInner.new({type: 'segment', id: 'id_example'})]}) # TagSegmentOp |
|
417
|
+
|
418
|
+
begin
|
419
|
+
# Create Tag Relationships Segments
|
420
|
+
api_instance.create_tag_relationships_segments(id, tag_segment_op)
|
421
|
+
rescue KlaviyoAPI::ApiError => e
|
422
|
+
puts "Error when calling TagsApi->create_tag_relationships_segments: #{e}"
|
423
|
+
end
|
424
|
+
```
|
425
|
+
|
426
|
+
#### Using the create_tag_relationships_segments_with_http_info variant
|
427
|
+
|
428
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
429
|
+
|
430
|
+
> <Array(nil, Integer, Hash)> create_tag_relationships_segments_with_http_info(id, tag_segment_op)
|
431
|
+
|
432
|
+
```ruby
|
433
|
+
begin
|
434
|
+
# Create Tag Relationships Segments
|
435
|
+
data, status_code, headers = api_instance.create_tag_relationships_segments_with_http_info(id, tag_segment_op)
|
436
|
+
p status_code # => 2xx
|
437
|
+
p headers # => { ... }
|
438
|
+
p data # => nil
|
439
|
+
rescue KlaviyoAPI::ApiError => e
|
440
|
+
puts "Error when calling TagsApi->create_tag_relationships_segments_with_http_info: #{e}"
|
441
|
+
end
|
442
|
+
```
|
443
|
+
|
444
|
+
### Parameters
|
445
|
+
|
446
|
+
| Name | Type | Description | Notes |
|
447
|
+
| ---- | ---- | ----------- | ----- |
|
448
|
+
| **id** | **String** | | |
|
449
|
+
| **tag_segment_op** | [**TagSegmentOp**](TagSegmentOp.md) | | |
|
450
|
+
|
451
|
+
### Return type
|
452
|
+
|
453
|
+
nil (empty response body)
|
454
|
+
|
455
|
+
### Authorization
|
456
|
+
|
457
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
458
|
+
|
459
|
+
### HTTP request headers
|
460
|
+
|
461
|
+
- **Content-Type**: application/json
|
462
|
+
- **Accept**: application/json
|
463
|
+
|
464
|
+
|
465
|
+
## delete_tag
|
466
|
+
|
467
|
+
> Hash<String, Object> delete_tag(id)
|
468
|
+
|
469
|
+
Delete Tag
|
470
|
+
|
471
|
+
Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Tags Read` `Tags Write`
|
472
|
+
|
473
|
+
### Examples
|
474
|
+
|
475
|
+
```ruby
|
476
|
+
require 'time'
|
477
|
+
require 'klaviyo-api-sdk'
|
478
|
+
# setup authorization
|
479
|
+
KlaviyoAPI.configure do |config|
|
480
|
+
# Configure API key authorization: Klaviyo-API-Key
|
481
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
482
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
483
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
484
|
+
end
|
485
|
+
|
486
|
+
api_instance = KlaviyoAPI::TagsApi.new
|
487
|
+
id = 'abcd1234-ef56-gh78-ij90-abcdef123456' # String | The Tag ID
|
488
|
+
|
489
|
+
begin
|
490
|
+
# Delete Tag
|
491
|
+
result = api_instance.delete_tag(id)
|
492
|
+
p result
|
493
|
+
rescue KlaviyoAPI::ApiError => e
|
494
|
+
puts "Error when calling TagsApi->delete_tag: #{e}"
|
495
|
+
end
|
496
|
+
```
|
497
|
+
|
498
|
+
#### Using the delete_tag_with_http_info variant
|
499
|
+
|
500
|
+
This returns an Array which contains the response data, status code and headers.
|
501
|
+
|
502
|
+
> <Array(Hash<String, Object>, Integer, Hash)> delete_tag_with_http_info(id)
|
503
|
+
|
504
|
+
```ruby
|
505
|
+
begin
|
506
|
+
# Delete Tag
|
507
|
+
data, status_code, headers = api_instance.delete_tag_with_http_info(id)
|
508
|
+
p status_code # => 2xx
|
509
|
+
p headers # => { ... }
|
510
|
+
p data # => Hash<String, Object>
|
511
|
+
rescue KlaviyoAPI::ApiError => e
|
512
|
+
puts "Error when calling TagsApi->delete_tag_with_http_info: #{e}"
|
513
|
+
end
|
514
|
+
```
|
515
|
+
|
516
|
+
### Parameters
|
517
|
+
|
518
|
+
| Name | Type | Description | Notes |
|
519
|
+
| ---- | ---- | ----------- | ----- |
|
520
|
+
| **id** | **String** | The Tag ID | |
|
521
|
+
|
522
|
+
### Return type
|
523
|
+
|
524
|
+
**Hash<String, Object>**
|
525
|
+
|
526
|
+
### Authorization
|
527
|
+
|
528
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
529
|
+
|
530
|
+
### HTTP request headers
|
531
|
+
|
532
|
+
- **Content-Type**: Not defined
|
533
|
+
- **Accept**: application/json
|
534
|
+
|
535
|
+
|
536
|
+
## delete_tag_group
|
537
|
+
|
538
|
+
> Hash<String, Object> delete_tag_group(id)
|
539
|
+
|
540
|
+
Delete Tag Group
|
541
|
+
|
542
|
+
Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Tags Read` `Tags Write`
|
543
|
+
|
544
|
+
### Examples
|
545
|
+
|
546
|
+
```ruby
|
547
|
+
require 'time'
|
548
|
+
require 'klaviyo-api-sdk'
|
549
|
+
# setup authorization
|
550
|
+
KlaviyoAPI.configure do |config|
|
551
|
+
# Configure API key authorization: Klaviyo-API-Key
|
552
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
553
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
554
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
555
|
+
end
|
556
|
+
|
557
|
+
api_instance = KlaviyoAPI::TagsApi.new
|
558
|
+
id = 'zyxw9876-vu54-ts32-rq10-zyxwvu654321' # String | The Tag Group ID
|
559
|
+
|
560
|
+
begin
|
561
|
+
# Delete Tag Group
|
562
|
+
result = api_instance.delete_tag_group(id)
|
563
|
+
p result
|
564
|
+
rescue KlaviyoAPI::ApiError => e
|
565
|
+
puts "Error when calling TagsApi->delete_tag_group: #{e}"
|
566
|
+
end
|
567
|
+
```
|
568
|
+
|
569
|
+
#### Using the delete_tag_group_with_http_info variant
|
570
|
+
|
571
|
+
This returns an Array which contains the response data, status code and headers.
|
572
|
+
|
573
|
+
> <Array(Hash<String, Object>, Integer, Hash)> delete_tag_group_with_http_info(id)
|
574
|
+
|
575
|
+
```ruby
|
576
|
+
begin
|
577
|
+
# Delete Tag Group
|
578
|
+
data, status_code, headers = api_instance.delete_tag_group_with_http_info(id)
|
579
|
+
p status_code # => 2xx
|
580
|
+
p headers # => { ... }
|
581
|
+
p data # => Hash<String, Object>
|
582
|
+
rescue KlaviyoAPI::ApiError => e
|
583
|
+
puts "Error when calling TagsApi->delete_tag_group_with_http_info: #{e}"
|
584
|
+
end
|
585
|
+
```
|
586
|
+
|
587
|
+
### Parameters
|
588
|
+
|
589
|
+
| Name | Type | Description | Notes |
|
590
|
+
| ---- | ---- | ----------- | ----- |
|
591
|
+
| **id** | **String** | The Tag Group ID | |
|
592
|
+
|
593
|
+
### Return type
|
594
|
+
|
595
|
+
**Hash<String, Object>**
|
596
|
+
|
597
|
+
### Authorization
|
598
|
+
|
599
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
600
|
+
|
601
|
+
### HTTP request headers
|
602
|
+
|
603
|
+
- **Content-Type**: Not defined
|
604
|
+
- **Accept**: application/json
|
605
|
+
|
606
|
+
|
607
|
+
## delete_tag_relationships_campaigns
|
608
|
+
|
609
|
+
> delete_tag_relationships_campaigns(id, tag_campaign_op)
|
610
|
+
|
611
|
+
Delete Tag Relationships Campaigns
|
612
|
+
|
613
|
+
Remove a tag's association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Campaigns Write` `Tags Write`
|
614
|
+
|
615
|
+
### Examples
|
616
|
+
|
617
|
+
```ruby
|
618
|
+
require 'time'
|
619
|
+
require 'klaviyo-api-sdk'
|
620
|
+
# setup authorization
|
621
|
+
KlaviyoAPI.configure do |config|
|
622
|
+
# Configure API key authorization: Klaviyo-API-Key
|
623
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
624
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
625
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
626
|
+
end
|
627
|
+
|
628
|
+
api_instance = KlaviyoAPI::TagsApi.new
|
629
|
+
id = 'id_example' # String |
|
630
|
+
tag_campaign_op = KlaviyoAPI::TagCampaignOp.new({data: [KlaviyoAPI::TagCampaignOpDataInner.new({type: 'campaign', id: 'id_example'})]}) # TagCampaignOp |
|
631
|
+
|
632
|
+
begin
|
633
|
+
# Delete Tag Relationships Campaigns
|
634
|
+
api_instance.delete_tag_relationships_campaigns(id, tag_campaign_op)
|
635
|
+
rescue KlaviyoAPI::ApiError => e
|
636
|
+
puts "Error when calling TagsApi->delete_tag_relationships_campaigns: #{e}"
|
637
|
+
end
|
638
|
+
```
|
639
|
+
|
640
|
+
#### Using the delete_tag_relationships_campaigns_with_http_info variant
|
641
|
+
|
642
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
643
|
+
|
644
|
+
> <Array(nil, Integer, Hash)> delete_tag_relationships_campaigns_with_http_info(id, tag_campaign_op)
|
645
|
+
|
646
|
+
```ruby
|
647
|
+
begin
|
648
|
+
# Delete Tag Relationships Campaigns
|
649
|
+
data, status_code, headers = api_instance.delete_tag_relationships_campaigns_with_http_info(id, tag_campaign_op)
|
650
|
+
p status_code # => 2xx
|
651
|
+
p headers # => { ... }
|
652
|
+
p data # => nil
|
653
|
+
rescue KlaviyoAPI::ApiError => e
|
654
|
+
puts "Error when calling TagsApi->delete_tag_relationships_campaigns_with_http_info: #{e}"
|
655
|
+
end
|
656
|
+
```
|
657
|
+
|
658
|
+
### Parameters
|
659
|
+
|
660
|
+
| Name | Type | Description | Notes |
|
661
|
+
| ---- | ---- | ----------- | ----- |
|
662
|
+
| **id** | **String** | | |
|
663
|
+
| **tag_campaign_op** | [**TagCampaignOp**](TagCampaignOp.md) | | |
|
664
|
+
|
665
|
+
### Return type
|
666
|
+
|
667
|
+
nil (empty response body)
|
668
|
+
|
669
|
+
### Authorization
|
670
|
+
|
671
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
672
|
+
|
673
|
+
### HTTP request headers
|
674
|
+
|
675
|
+
- **Content-Type**: application/json
|
676
|
+
- **Accept**: application/json
|
677
|
+
|
678
|
+
|
679
|
+
## delete_tag_relationships_flows
|
680
|
+
|
681
|
+
> delete_tag_relationships_flows(id, tag_flow_op)
|
682
|
+
|
683
|
+
Delete Tag Relationships Flows
|
684
|
+
|
685
|
+
Remove a tag's association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Write` `Tags Write`
|
686
|
+
|
687
|
+
### Examples
|
688
|
+
|
689
|
+
```ruby
|
690
|
+
require 'time'
|
691
|
+
require 'klaviyo-api-sdk'
|
692
|
+
# setup authorization
|
693
|
+
KlaviyoAPI.configure do |config|
|
694
|
+
# Configure API key authorization: Klaviyo-API-Key
|
695
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
696
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
697
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
698
|
+
end
|
699
|
+
|
700
|
+
api_instance = KlaviyoAPI::TagsApi.new
|
701
|
+
id = 'id_example' # String |
|
702
|
+
tag_flow_op = KlaviyoAPI::TagFlowOp.new({data: [KlaviyoAPI::TagFlowOpDataInner.new({type: 'flow', id: 'id_example'})]}) # TagFlowOp |
|
703
|
+
|
704
|
+
begin
|
705
|
+
# Delete Tag Relationships Flows
|
706
|
+
api_instance.delete_tag_relationships_flows(id, tag_flow_op)
|
707
|
+
rescue KlaviyoAPI::ApiError => e
|
708
|
+
puts "Error when calling TagsApi->delete_tag_relationships_flows: #{e}"
|
709
|
+
end
|
710
|
+
```
|
711
|
+
|
712
|
+
#### Using the delete_tag_relationships_flows_with_http_info variant
|
713
|
+
|
714
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
715
|
+
|
716
|
+
> <Array(nil, Integer, Hash)> delete_tag_relationships_flows_with_http_info(id, tag_flow_op)
|
717
|
+
|
718
|
+
```ruby
|
719
|
+
begin
|
720
|
+
# Delete Tag Relationships Flows
|
721
|
+
data, status_code, headers = api_instance.delete_tag_relationships_flows_with_http_info(id, tag_flow_op)
|
722
|
+
p status_code # => 2xx
|
723
|
+
p headers # => { ... }
|
724
|
+
p data # => nil
|
725
|
+
rescue KlaviyoAPI::ApiError => e
|
726
|
+
puts "Error when calling TagsApi->delete_tag_relationships_flows_with_http_info: #{e}"
|
727
|
+
end
|
728
|
+
```
|
729
|
+
|
730
|
+
### Parameters
|
731
|
+
|
732
|
+
| Name | Type | Description | Notes |
|
733
|
+
| ---- | ---- | ----------- | ----- |
|
734
|
+
| **id** | **String** | | |
|
735
|
+
| **tag_flow_op** | [**TagFlowOp**](TagFlowOp.md) | | |
|
736
|
+
|
737
|
+
### Return type
|
738
|
+
|
739
|
+
nil (empty response body)
|
740
|
+
|
741
|
+
### Authorization
|
742
|
+
|
743
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
744
|
+
|
745
|
+
### HTTP request headers
|
746
|
+
|
747
|
+
- **Content-Type**: application/json
|
748
|
+
- **Accept**: application/json
|
749
|
+
|
750
|
+
|
751
|
+
## delete_tag_relationships_lists
|
752
|
+
|
753
|
+
> delete_tag_relationships_lists(id, tag_list_op)
|
754
|
+
|
755
|
+
Delete Tag Relationships Lists
|
756
|
+
|
757
|
+
Remove a tag's association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `List Write` `Tags Write`
|
758
|
+
|
759
|
+
### Examples
|
760
|
+
|
761
|
+
```ruby
|
762
|
+
require 'time'
|
763
|
+
require 'klaviyo-api-sdk'
|
764
|
+
# setup authorization
|
765
|
+
KlaviyoAPI.configure do |config|
|
766
|
+
# Configure API key authorization: Klaviyo-API-Key
|
767
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
768
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
769
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
770
|
+
end
|
771
|
+
|
772
|
+
api_instance = KlaviyoAPI::TagsApi.new
|
773
|
+
id = 'id_example' # String |
|
774
|
+
tag_list_op = KlaviyoAPI::TagListOp.new({data: [KlaviyoAPI::TagListOpDataInner.new({type: 'list', id: 'id_example'})]}) # TagListOp |
|
775
|
+
|
776
|
+
begin
|
777
|
+
# Delete Tag Relationships Lists
|
778
|
+
api_instance.delete_tag_relationships_lists(id, tag_list_op)
|
779
|
+
rescue KlaviyoAPI::ApiError => e
|
780
|
+
puts "Error when calling TagsApi->delete_tag_relationships_lists: #{e}"
|
781
|
+
end
|
782
|
+
```
|
783
|
+
|
784
|
+
#### Using the delete_tag_relationships_lists_with_http_info variant
|
785
|
+
|
786
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
787
|
+
|
788
|
+
> <Array(nil, Integer, Hash)> delete_tag_relationships_lists_with_http_info(id, tag_list_op)
|
789
|
+
|
790
|
+
```ruby
|
791
|
+
begin
|
792
|
+
# Delete Tag Relationships Lists
|
793
|
+
data, status_code, headers = api_instance.delete_tag_relationships_lists_with_http_info(id, tag_list_op)
|
794
|
+
p status_code # => 2xx
|
795
|
+
p headers # => { ... }
|
796
|
+
p data # => nil
|
797
|
+
rescue KlaviyoAPI::ApiError => e
|
798
|
+
puts "Error when calling TagsApi->delete_tag_relationships_lists_with_http_info: #{e}"
|
799
|
+
end
|
800
|
+
```
|
801
|
+
|
802
|
+
### Parameters
|
803
|
+
|
804
|
+
| Name | Type | Description | Notes |
|
805
|
+
| ---- | ---- | ----------- | ----- |
|
806
|
+
| **id** | **String** | | |
|
807
|
+
| **tag_list_op** | [**TagListOp**](TagListOp.md) | | |
|
808
|
+
|
809
|
+
### Return type
|
810
|
+
|
811
|
+
nil (empty response body)
|
812
|
+
|
813
|
+
### Authorization
|
814
|
+
|
815
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
816
|
+
|
817
|
+
### HTTP request headers
|
818
|
+
|
819
|
+
- **Content-Type**: application/json
|
820
|
+
- **Accept**: application/json
|
821
|
+
|
822
|
+
|
823
|
+
## delete_tag_relationships_segments
|
824
|
+
|
825
|
+
> delete_tag_relationships_segments(id, tag_segment_op)
|
826
|
+
|
827
|
+
Delete Tag Relationships Segments
|
828
|
+
|
829
|
+
Remove a tag's association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Segments Write` `Tags Write`
|
174
830
|
|
175
831
|
### Examples
|
176
832
|
|
@@ -187,32 +843,31 @@ end
|
|
187
843
|
|
188
844
|
api_instance = KlaviyoAPI::TagsApi.new
|
189
845
|
id = 'id_example' # String |
|
190
|
-
related_resource = 'flows' # String |
|
191
846
|
tag_segment_op = KlaviyoAPI::TagSegmentOp.new({data: [KlaviyoAPI::TagSegmentOpDataInner.new({type: 'segment', id: 'id_example'})]}) # TagSegmentOp |
|
192
847
|
|
193
848
|
begin
|
194
|
-
#
|
195
|
-
api_instance.
|
849
|
+
# Delete Tag Relationships Segments
|
850
|
+
api_instance.delete_tag_relationships_segments(id, tag_segment_op)
|
196
851
|
rescue KlaviyoAPI::ApiError => e
|
197
|
-
puts "Error when calling TagsApi->
|
852
|
+
puts "Error when calling TagsApi->delete_tag_relationships_segments: #{e}"
|
198
853
|
end
|
199
854
|
```
|
200
855
|
|
201
|
-
#### Using the
|
856
|
+
#### Using the delete_tag_relationships_segments_with_http_info variant
|
202
857
|
|
203
858
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
204
859
|
|
205
|
-
> <Array(nil, Integer, Hash)>
|
860
|
+
> <Array(nil, Integer, Hash)> delete_tag_relationships_segments_with_http_info(id, tag_segment_op)
|
206
861
|
|
207
862
|
```ruby
|
208
863
|
begin
|
209
|
-
#
|
210
|
-
data, status_code, headers = api_instance.
|
864
|
+
# Delete Tag Relationships Segments
|
865
|
+
data, status_code, headers = api_instance.delete_tag_relationships_segments_with_http_info(id, tag_segment_op)
|
211
866
|
p status_code # => 2xx
|
212
867
|
p headers # => { ... }
|
213
868
|
p data # => nil
|
214
869
|
rescue KlaviyoAPI::ApiError => e
|
215
|
-
puts "Error when calling TagsApi->
|
870
|
+
puts "Error when calling TagsApi->delete_tag_relationships_segments_with_http_info: #{e}"
|
216
871
|
end
|
217
872
|
```
|
218
873
|
|
@@ -221,7 +876,6 @@ end
|
|
221
876
|
| Name | Type | Description | Notes |
|
222
877
|
| ---- | ---- | ----------- | ----- |
|
223
878
|
| **id** | **String** | | |
|
224
|
-
| **related_resource** | **String** | | |
|
225
879
|
| **tag_segment_op** | [**TagSegmentOp**](TagSegmentOp.md) | | |
|
226
880
|
|
227
881
|
### Return type
|
@@ -238,13 +892,13 @@ nil (empty response body)
|
|
238
892
|
- **Accept**: application/json
|
239
893
|
|
240
894
|
|
241
|
-
##
|
895
|
+
## get_tag
|
242
896
|
|
243
|
-
> Hash<String, Object>
|
897
|
+
> Hash<String, Object> get_tag(id, opts)
|
244
898
|
|
245
|
-
|
899
|
+
Get Tag
|
246
900
|
|
247
|
-
|
901
|
+
Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Tags Read`
|
248
902
|
|
249
903
|
### Examples
|
250
904
|
|
@@ -261,31 +915,34 @@ end
|
|
261
915
|
|
262
916
|
api_instance = KlaviyoAPI::TagsApi.new
|
263
917
|
id = 'abcd1234-ef56-gh78-ij90-abcdef123456' # String | The Tag ID
|
918
|
+
opts = {
|
919
|
+
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
920
|
+
}
|
264
921
|
|
265
922
|
begin
|
266
|
-
#
|
267
|
-
result = api_instance.
|
923
|
+
# Get Tag
|
924
|
+
result = api_instance.get_tag(id, opts)
|
268
925
|
p result
|
269
926
|
rescue KlaviyoAPI::ApiError => e
|
270
|
-
puts "Error when calling TagsApi->
|
927
|
+
puts "Error when calling TagsApi->get_tag: #{e}"
|
271
928
|
end
|
272
929
|
```
|
273
930
|
|
274
|
-
#### Using the
|
931
|
+
#### Using the get_tag_with_http_info variant
|
275
932
|
|
276
933
|
This returns an Array which contains the response data, status code and headers.
|
277
934
|
|
278
|
-
> <Array(Hash<String, Object>, Integer, Hash)>
|
935
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_tag_with_http_info(id, opts)
|
279
936
|
|
280
937
|
```ruby
|
281
938
|
begin
|
282
|
-
#
|
283
|
-
data, status_code, headers = api_instance.
|
939
|
+
# Get Tag
|
940
|
+
data, status_code, headers = api_instance.get_tag_with_http_info(id, opts)
|
284
941
|
p status_code # => 2xx
|
285
942
|
p headers # => { ... }
|
286
943
|
p data # => Hash<String, Object>
|
287
944
|
rescue KlaviyoAPI::ApiError => e
|
288
|
-
puts "Error when calling TagsApi->
|
945
|
+
puts "Error when calling TagsApi->get_tag_with_http_info: #{e}"
|
289
946
|
end
|
290
947
|
```
|
291
948
|
|
@@ -294,6 +951,7 @@ end
|
|
294
951
|
| Name | Type | Description | Notes |
|
295
952
|
| ---- | ---- | ----------- | ----- |
|
296
953
|
| **id** | **String** | The Tag ID | |
|
954
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
297
955
|
|
298
956
|
### Return type
|
299
957
|
|
@@ -309,13 +967,13 @@ end
|
|
309
967
|
- **Accept**: application/json
|
310
968
|
|
311
969
|
|
312
|
-
##
|
970
|
+
## get_tag_group
|
313
971
|
|
314
|
-
> Hash<String, Object>
|
972
|
+
> Hash<String, Object> get_tag_group(id, opts)
|
315
973
|
|
316
|
-
|
974
|
+
Get Tag Group
|
317
975
|
|
318
|
-
|
976
|
+
Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Tags Read`
|
319
977
|
|
320
978
|
### Examples
|
321
979
|
|
@@ -332,31 +990,34 @@ end
|
|
332
990
|
|
333
991
|
api_instance = KlaviyoAPI::TagsApi.new
|
334
992
|
id = 'zyxw9876-vu54-ts32-rq10-zyxwvu654321' # String | The Tag Group ID
|
993
|
+
opts = {
|
994
|
+
fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
995
|
+
}
|
335
996
|
|
336
997
|
begin
|
337
|
-
#
|
338
|
-
result = api_instance.
|
998
|
+
# Get Tag Group
|
999
|
+
result = api_instance.get_tag_group(id, opts)
|
339
1000
|
p result
|
340
1001
|
rescue KlaviyoAPI::ApiError => e
|
341
|
-
puts "Error when calling TagsApi->
|
1002
|
+
puts "Error when calling TagsApi->get_tag_group: #{e}"
|
342
1003
|
end
|
343
1004
|
```
|
344
1005
|
|
345
|
-
#### Using the
|
1006
|
+
#### Using the get_tag_group_with_http_info variant
|
346
1007
|
|
347
1008
|
This returns an Array which contains the response data, status code and headers.
|
348
1009
|
|
349
|
-
> <Array(Hash<String, Object>, Integer, Hash)>
|
1010
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_tag_group_with_http_info(id, opts)
|
350
1011
|
|
351
1012
|
```ruby
|
352
1013
|
begin
|
353
|
-
#
|
354
|
-
data, status_code, headers = api_instance.
|
1014
|
+
# Get Tag Group
|
1015
|
+
data, status_code, headers = api_instance.get_tag_group_with_http_info(id, opts)
|
355
1016
|
p status_code # => 2xx
|
356
1017
|
p headers # => { ... }
|
357
1018
|
p data # => Hash<String, Object>
|
358
1019
|
rescue KlaviyoAPI::ApiError => e
|
359
|
-
puts "Error when calling TagsApi->
|
1020
|
+
puts "Error when calling TagsApi->get_tag_group_with_http_info: #{e}"
|
360
1021
|
end
|
361
1022
|
```
|
362
1023
|
|
@@ -365,6 +1026,7 @@ end
|
|
365
1026
|
| Name | Type | Description | Notes |
|
366
1027
|
| ---- | ---- | ----------- | ----- |
|
367
1028
|
| **id** | **String** | The Tag Group ID | |
|
1029
|
+
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
368
1030
|
|
369
1031
|
### Return type
|
370
1032
|
|
@@ -380,13 +1042,13 @@ end
|
|
380
1042
|
- **Accept**: application/json
|
381
1043
|
|
382
1044
|
|
383
|
-
##
|
1045
|
+
## get_tag_group_relationships_tags
|
384
1046
|
|
385
|
-
>
|
1047
|
+
> Hash<String, Object> get_tag_group_relationships_tags(id)
|
386
1048
|
|
387
|
-
|
1049
|
+
Get Tag Group Relationships Tags
|
388
1050
|
|
389
|
-
|
1051
|
+
Returns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Tags Read`
|
390
1052
|
|
391
1053
|
### Examples
|
392
1054
|
|
@@ -403,32 +1065,31 @@ end
|
|
403
1065
|
|
404
1066
|
api_instance = KlaviyoAPI::TagsApi.new
|
405
1067
|
id = 'id_example' # String |
|
406
|
-
related_resource = 'flows' # String |
|
407
|
-
tag_segment_op = KlaviyoAPI::TagSegmentOp.new({data: [KlaviyoAPI::TagSegmentOpDataInner.new({type: 'segment', id: 'id_example'})]}) # TagSegmentOp |
|
408
1068
|
|
409
1069
|
begin
|
410
|
-
#
|
411
|
-
api_instance.
|
1070
|
+
# Get Tag Group Relationships Tags
|
1071
|
+
result = api_instance.get_tag_group_relationships_tags(id)
|
1072
|
+
p result
|
412
1073
|
rescue KlaviyoAPI::ApiError => e
|
413
|
-
puts "Error when calling TagsApi->
|
1074
|
+
puts "Error when calling TagsApi->get_tag_group_relationships_tags: #{e}"
|
414
1075
|
end
|
415
1076
|
```
|
416
1077
|
|
417
|
-
#### Using the
|
1078
|
+
#### Using the get_tag_group_relationships_tags_with_http_info variant
|
418
1079
|
|
419
|
-
This returns an Array which contains the response data
|
1080
|
+
This returns an Array which contains the response data, status code and headers.
|
420
1081
|
|
421
|
-
> <Array(
|
1082
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_tag_group_relationships_tags_with_http_info(id)
|
422
1083
|
|
423
1084
|
```ruby
|
424
1085
|
begin
|
425
|
-
#
|
426
|
-
data, status_code, headers = api_instance.
|
1086
|
+
# Get Tag Group Relationships Tags
|
1087
|
+
data, status_code, headers = api_instance.get_tag_group_relationships_tags_with_http_info(id)
|
427
1088
|
p status_code # => 2xx
|
428
1089
|
p headers # => { ... }
|
429
|
-
p data # =>
|
1090
|
+
p data # => Hash<String, Object>
|
430
1091
|
rescue KlaviyoAPI::ApiError => e
|
431
|
-
puts "Error when calling TagsApi->
|
1092
|
+
puts "Error when calling TagsApi->get_tag_group_relationships_tags_with_http_info: #{e}"
|
432
1093
|
end
|
433
1094
|
```
|
434
1095
|
|
@@ -437,12 +1098,10 @@ end
|
|
437
1098
|
| Name | Type | Description | Notes |
|
438
1099
|
| ---- | ---- | ----------- | ----- |
|
439
1100
|
| **id** | **String** | | |
|
440
|
-
| **related_resource** | **String** | | |
|
441
|
-
| **tag_segment_op** | [**TagSegmentOp**](TagSegmentOp.md) | | |
|
442
1101
|
|
443
1102
|
### Return type
|
444
1103
|
|
445
|
-
|
1104
|
+
**Hash<String, Object>**
|
446
1105
|
|
447
1106
|
### Authorization
|
448
1107
|
|
@@ -450,17 +1109,17 @@ nil (empty response body)
|
|
450
1109
|
|
451
1110
|
### HTTP request headers
|
452
1111
|
|
453
|
-
- **Content-Type**:
|
1112
|
+
- **Content-Type**: Not defined
|
454
1113
|
- **Accept**: application/json
|
455
1114
|
|
456
1115
|
|
457
|
-
##
|
1116
|
+
## get_tag_group_tags
|
458
1117
|
|
459
|
-
> Hash<String, Object>
|
1118
|
+
> Hash<String, Object> get_tag_group_tags(id, opts)
|
460
1119
|
|
461
|
-
Get Tag
|
1120
|
+
Get Tag Group Tags
|
462
1121
|
|
463
|
-
|
1122
|
+
Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Tags Read`
|
464
1123
|
|
465
1124
|
### Examples
|
466
1125
|
|
@@ -476,35 +1135,35 @@ KlaviyoAPI.configure do |config|
|
|
476
1135
|
end
|
477
1136
|
|
478
1137
|
api_instance = KlaviyoAPI::TagsApi.new
|
479
|
-
id = '
|
1138
|
+
id = 'zyxw9876-vu54-ts32-rq10-zyxwvu654321' # String | The Tag Group ID
|
480
1139
|
opts = {
|
481
1140
|
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
482
1141
|
}
|
483
1142
|
|
484
1143
|
begin
|
485
|
-
# Get Tag
|
486
|
-
result = api_instance.
|
1144
|
+
# Get Tag Group Tags
|
1145
|
+
result = api_instance.get_tag_group_tags(id, opts)
|
487
1146
|
p result
|
488
1147
|
rescue KlaviyoAPI::ApiError => e
|
489
|
-
puts "Error when calling TagsApi->
|
1148
|
+
puts "Error when calling TagsApi->get_tag_group_tags: #{e}"
|
490
1149
|
end
|
491
1150
|
```
|
492
1151
|
|
493
|
-
#### Using the
|
1152
|
+
#### Using the get_tag_group_tags_with_http_info variant
|
494
1153
|
|
495
1154
|
This returns an Array which contains the response data, status code and headers.
|
496
1155
|
|
497
|
-
> <Array(Hash<String, Object>, Integer, Hash)>
|
1156
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_tag_group_tags_with_http_info(id, opts)
|
498
1157
|
|
499
1158
|
```ruby
|
500
1159
|
begin
|
501
|
-
# Get Tag
|
502
|
-
data, status_code, headers = api_instance.
|
1160
|
+
# Get Tag Group Tags
|
1161
|
+
data, status_code, headers = api_instance.get_tag_group_tags_with_http_info(id, opts)
|
503
1162
|
p status_code # => 2xx
|
504
1163
|
p headers # => { ... }
|
505
1164
|
p data # => Hash<String, Object>
|
506
1165
|
rescue KlaviyoAPI::ApiError => e
|
507
|
-
puts "Error when calling TagsApi->
|
1166
|
+
puts "Error when calling TagsApi->get_tag_group_tags_with_http_info: #{e}"
|
508
1167
|
end
|
509
1168
|
```
|
510
1169
|
|
@@ -512,7 +1171,7 @@ end
|
|
512
1171
|
|
513
1172
|
| Name | Type | Description | Notes |
|
514
1173
|
| ---- | ---- | ----------- | ----- |
|
515
|
-
| **id** | **String** | The Tag ID | |
|
1174
|
+
| **id** | **String** | The Tag Group ID | |
|
516
1175
|
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
517
1176
|
|
518
1177
|
### Return type
|
@@ -529,13 +1188,13 @@ end
|
|
529
1188
|
- **Accept**: application/json
|
530
1189
|
|
531
1190
|
|
532
|
-
##
|
1191
|
+
## get_tag_groups
|
533
1192
|
|
534
|
-
> Hash<String, Object>
|
1193
|
+
> Hash<String, Object> get_tag_groups(opts)
|
535
1194
|
|
536
|
-
Get Tag
|
1195
|
+
Get Tag Groups
|
537
1196
|
|
538
|
-
|
1197
|
+
List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Tags Read`
|
539
1198
|
|
540
1199
|
### Examples
|
541
1200
|
|
@@ -551,35 +1210,37 @@ KlaviyoAPI.configure do |config|
|
|
551
1210
|
end
|
552
1211
|
|
553
1212
|
api_instance = KlaviyoAPI::TagsApi.new
|
554
|
-
id = 'zyxw9876-vu54-ts32-rq10-zyxwvu654321' # String | The Tag Group ID
|
555
1213
|
opts = {
|
556
|
-
fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1214
|
+
fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1215
|
+
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>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
1216
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
1217
|
+
sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
557
1218
|
}
|
558
1219
|
|
559
1220
|
begin
|
560
|
-
# Get Tag
|
561
|
-
result = api_instance.
|
1221
|
+
# Get Tag Groups
|
1222
|
+
result = api_instance.get_tag_groups(opts)
|
562
1223
|
p result
|
563
1224
|
rescue KlaviyoAPI::ApiError => e
|
564
|
-
puts "Error when calling TagsApi->
|
1225
|
+
puts "Error when calling TagsApi->get_tag_groups: #{e}"
|
565
1226
|
end
|
566
1227
|
```
|
567
1228
|
|
568
|
-
#### Using the
|
1229
|
+
#### Using the get_tag_groups_with_http_info variant
|
569
1230
|
|
570
1231
|
This returns an Array which contains the response data, status code and headers.
|
571
1232
|
|
572
|
-
> <Array(Hash<String, Object>, Integer, Hash)>
|
1233
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_tag_groups_with_http_info(opts)
|
573
1234
|
|
574
1235
|
```ruby
|
575
1236
|
begin
|
576
|
-
# Get Tag
|
577
|
-
data, status_code, headers = api_instance.
|
1237
|
+
# Get Tag Groups
|
1238
|
+
data, status_code, headers = api_instance.get_tag_groups_with_http_info(opts)
|
578
1239
|
p status_code # => 2xx
|
579
1240
|
p headers # => { ... }
|
580
1241
|
p data # => Hash<String, Object>
|
581
1242
|
rescue KlaviyoAPI::ApiError => e
|
582
|
-
puts "Error when calling TagsApi->
|
1243
|
+
puts "Error when calling TagsApi->get_tag_groups_with_http_info: #{e}"
|
583
1244
|
end
|
584
1245
|
```
|
585
1246
|
|
@@ -587,8 +1248,10 @@ end
|
|
587
1248
|
|
588
1249
|
| Name | Type | Description | Notes |
|
589
1250
|
| ---- | ---- | ----------- | ----- |
|
590
|
-
| **id** | **String** | The Tag Group ID | |
|
591
1251
|
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1252
|
+
| **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>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals` | [optional] |
|
1253
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
1254
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
|
592
1255
|
|
593
1256
|
### Return type
|
594
1257
|
|
@@ -604,13 +1267,13 @@ end
|
|
604
1267
|
- **Accept**: application/json
|
605
1268
|
|
606
1269
|
|
607
|
-
##
|
1270
|
+
## get_tag_relationships_campaigns
|
608
1271
|
|
609
|
-
> Hash<String, Object>
|
1272
|
+
> Hash<String, Object> get_tag_relationships_campaigns(id)
|
610
1273
|
|
611
|
-
Get Tag
|
1274
|
+
Get Tag Relationships Campaigns
|
612
1275
|
|
613
|
-
|
1276
|
+
Returns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Campaigns Read` `Tags Read`
|
614
1277
|
|
615
1278
|
### Examples
|
616
1279
|
|
@@ -627,32 +1290,31 @@ end
|
|
627
1290
|
|
628
1291
|
api_instance = KlaviyoAPI::TagsApi.new
|
629
1292
|
id = 'id_example' # String |
|
630
|
-
related_resource = 'tags' # String |
|
631
1293
|
|
632
1294
|
begin
|
633
|
-
# Get Tag
|
634
|
-
result = api_instance.
|
1295
|
+
# Get Tag Relationships Campaigns
|
1296
|
+
result = api_instance.get_tag_relationships_campaigns(id)
|
635
1297
|
p result
|
636
1298
|
rescue KlaviyoAPI::ApiError => e
|
637
|
-
puts "Error when calling TagsApi->
|
1299
|
+
puts "Error when calling TagsApi->get_tag_relationships_campaigns: #{e}"
|
638
1300
|
end
|
639
1301
|
```
|
640
1302
|
|
641
|
-
#### Using the
|
1303
|
+
#### Using the get_tag_relationships_campaigns_with_http_info variant
|
642
1304
|
|
643
1305
|
This returns an Array which contains the response data, status code and headers.
|
644
1306
|
|
645
|
-
> <Array(Hash<String, Object>, Integer, Hash)>
|
1307
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_tag_relationships_campaigns_with_http_info(id)
|
646
1308
|
|
647
1309
|
```ruby
|
648
1310
|
begin
|
649
|
-
# Get Tag
|
650
|
-
data, status_code, headers = api_instance.
|
1311
|
+
# Get Tag Relationships Campaigns
|
1312
|
+
data, status_code, headers = api_instance.get_tag_relationships_campaigns_with_http_info(id)
|
651
1313
|
p status_code # => 2xx
|
652
1314
|
p headers # => { ... }
|
653
1315
|
p data # => Hash<String, Object>
|
654
1316
|
rescue KlaviyoAPI::ApiError => e
|
655
|
-
puts "Error when calling TagsApi->
|
1317
|
+
puts "Error when calling TagsApi->get_tag_relationships_campaigns_with_http_info: #{e}"
|
656
1318
|
end
|
657
1319
|
```
|
658
1320
|
|
@@ -661,7 +1323,6 @@ end
|
|
661
1323
|
| Name | Type | Description | Notes |
|
662
1324
|
| ---- | ---- | ----------- | ----- |
|
663
1325
|
| **id** | **String** | | |
|
664
|
-
| **related_resource** | **String** | | |
|
665
1326
|
|
666
1327
|
### Return type
|
667
1328
|
|
@@ -677,13 +1338,13 @@ end
|
|
677
1338
|
- **Accept**: application/json
|
678
1339
|
|
679
1340
|
|
680
|
-
##
|
1341
|
+
## get_tag_relationships_flows
|
681
1342
|
|
682
|
-
> Hash<String, Object>
|
1343
|
+
> Hash<String, Object> get_tag_relationships_flows(id)
|
683
1344
|
|
684
|
-
Get Tag
|
1345
|
+
Get Tag Relationships Flows
|
685
1346
|
|
686
|
-
|
1347
|
+
Returns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` `Tags Read`
|
687
1348
|
|
688
1349
|
### Examples
|
689
1350
|
|
@@ -699,35 +1360,32 @@ KlaviyoAPI.configure do |config|
|
|
699
1360
|
end
|
700
1361
|
|
701
1362
|
api_instance = KlaviyoAPI::TagsApi.new
|
702
|
-
id = '
|
703
|
-
opts = {
|
704
|
-
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
705
|
-
}
|
1363
|
+
id = 'id_example' # String |
|
706
1364
|
|
707
1365
|
begin
|
708
|
-
# Get Tag
|
709
|
-
result = api_instance.
|
1366
|
+
# Get Tag Relationships Flows
|
1367
|
+
result = api_instance.get_tag_relationships_flows(id)
|
710
1368
|
p result
|
711
1369
|
rescue KlaviyoAPI::ApiError => e
|
712
|
-
puts "Error when calling TagsApi->
|
1370
|
+
puts "Error when calling TagsApi->get_tag_relationships_flows: #{e}"
|
713
1371
|
end
|
714
1372
|
```
|
715
1373
|
|
716
|
-
#### Using the
|
1374
|
+
#### Using the get_tag_relationships_flows_with_http_info variant
|
717
1375
|
|
718
1376
|
This returns an Array which contains the response data, status code and headers.
|
719
1377
|
|
720
|
-
> <Array(Hash<String, Object>, Integer, Hash)>
|
1378
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_tag_relationships_flows_with_http_info(id)
|
721
1379
|
|
722
1380
|
```ruby
|
723
1381
|
begin
|
724
|
-
# Get Tag
|
725
|
-
data, status_code, headers = api_instance.
|
1382
|
+
# Get Tag Relationships Flows
|
1383
|
+
data, status_code, headers = api_instance.get_tag_relationships_flows_with_http_info(id)
|
726
1384
|
p status_code # => 2xx
|
727
1385
|
p headers # => { ... }
|
728
1386
|
p data # => Hash<String, Object>
|
729
1387
|
rescue KlaviyoAPI::ApiError => e
|
730
|
-
puts "Error when calling TagsApi->
|
1388
|
+
puts "Error when calling TagsApi->get_tag_relationships_flows_with_http_info: #{e}"
|
731
1389
|
end
|
732
1390
|
```
|
733
1391
|
|
@@ -735,8 +1393,7 @@ end
|
|
735
1393
|
|
736
1394
|
| Name | Type | Description | Notes |
|
737
1395
|
| ---- | ---- | ----------- | ----- |
|
738
|
-
| **id** | **String** |
|
739
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1396
|
+
| **id** | **String** | | |
|
740
1397
|
|
741
1398
|
### Return type
|
742
1399
|
|
@@ -752,13 +1409,13 @@ end
|
|
752
1409
|
- **Accept**: application/json
|
753
1410
|
|
754
1411
|
|
755
|
-
##
|
1412
|
+
## get_tag_relationships_lists
|
756
1413
|
|
757
|
-
> Hash<String, Object>
|
1414
|
+
> Hash<String, Object> get_tag_relationships_lists(id)
|
758
1415
|
|
759
|
-
Get Tag
|
1416
|
+
Get Tag Relationships Lists
|
760
1417
|
|
761
|
-
|
1418
|
+
Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `List Read` `Tags Read`
|
762
1419
|
|
763
1420
|
### Examples
|
764
1421
|
|
@@ -774,37 +1431,32 @@ KlaviyoAPI.configure do |config|
|
|
774
1431
|
end
|
775
1432
|
|
776
1433
|
api_instance = KlaviyoAPI::TagsApi.new
|
777
|
-
|
778
|
-
fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
779
|
-
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>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
780
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
781
|
-
sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
782
|
-
}
|
1434
|
+
id = 'id_example' # String |
|
783
1435
|
|
784
1436
|
begin
|
785
|
-
# Get Tag
|
786
|
-
result = api_instance.
|
1437
|
+
# Get Tag Relationships Lists
|
1438
|
+
result = api_instance.get_tag_relationships_lists(id)
|
787
1439
|
p result
|
788
1440
|
rescue KlaviyoAPI::ApiError => e
|
789
|
-
puts "Error when calling TagsApi->
|
1441
|
+
puts "Error when calling TagsApi->get_tag_relationships_lists: #{e}"
|
790
1442
|
end
|
791
1443
|
```
|
792
1444
|
|
793
|
-
#### Using the
|
1445
|
+
#### Using the get_tag_relationships_lists_with_http_info variant
|
794
1446
|
|
795
1447
|
This returns an Array which contains the response data, status code and headers.
|
796
1448
|
|
797
|
-
> <Array(Hash<String, Object>, Integer, Hash)>
|
1449
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_tag_relationships_lists_with_http_info(id)
|
798
1450
|
|
799
1451
|
```ruby
|
800
1452
|
begin
|
801
|
-
# Get Tag
|
802
|
-
data, status_code, headers = api_instance.
|
1453
|
+
# Get Tag Relationships Lists
|
1454
|
+
data, status_code, headers = api_instance.get_tag_relationships_lists_with_http_info(id)
|
803
1455
|
p status_code # => 2xx
|
804
1456
|
p headers # => { ... }
|
805
1457
|
p data # => Hash<String, Object>
|
806
1458
|
rescue KlaviyoAPI::ApiError => e
|
807
|
-
puts "Error when calling TagsApi->
|
1459
|
+
puts "Error when calling TagsApi->get_tag_relationships_lists_with_http_info: #{e}"
|
808
1460
|
end
|
809
1461
|
```
|
810
1462
|
|
@@ -812,10 +1464,78 @@ end
|
|
812
1464
|
|
813
1465
|
| Name | Type | Description | Notes |
|
814
1466
|
| ---- | ---- | ----------- | ----- |
|
815
|
-
| **
|
816
|
-
|
817
|
-
|
818
|
-
|
1467
|
+
| **id** | **String** | | |
|
1468
|
+
|
1469
|
+
### Return type
|
1470
|
+
|
1471
|
+
**Hash<String, Object>**
|
1472
|
+
|
1473
|
+
### Authorization
|
1474
|
+
|
1475
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1476
|
+
|
1477
|
+
### HTTP request headers
|
1478
|
+
|
1479
|
+
- **Content-Type**: Not defined
|
1480
|
+
- **Accept**: application/json
|
1481
|
+
|
1482
|
+
|
1483
|
+
## get_tag_relationships_segments
|
1484
|
+
|
1485
|
+
> Hash<String, Object> get_tag_relationships_segments(id)
|
1486
|
+
|
1487
|
+
Get Tag Relationships Segments
|
1488
|
+
|
1489
|
+
Returns the IDs of all segments associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Segments Read` `Tags Read`
|
1490
|
+
|
1491
|
+
### Examples
|
1492
|
+
|
1493
|
+
```ruby
|
1494
|
+
require 'time'
|
1495
|
+
require 'klaviyo-api-sdk'
|
1496
|
+
# setup authorization
|
1497
|
+
KlaviyoAPI.configure do |config|
|
1498
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1499
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1500
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1501
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1502
|
+
end
|
1503
|
+
|
1504
|
+
api_instance = KlaviyoAPI::TagsApi.new
|
1505
|
+
id = 'id_example' # String |
|
1506
|
+
|
1507
|
+
begin
|
1508
|
+
# Get Tag Relationships Segments
|
1509
|
+
result = api_instance.get_tag_relationships_segments(id)
|
1510
|
+
p result
|
1511
|
+
rescue KlaviyoAPI::ApiError => e
|
1512
|
+
puts "Error when calling TagsApi->get_tag_relationships_segments: #{e}"
|
1513
|
+
end
|
1514
|
+
```
|
1515
|
+
|
1516
|
+
#### Using the get_tag_relationships_segments_with_http_info variant
|
1517
|
+
|
1518
|
+
This returns an Array which contains the response data, status code and headers.
|
1519
|
+
|
1520
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_tag_relationships_segments_with_http_info(id)
|
1521
|
+
|
1522
|
+
```ruby
|
1523
|
+
begin
|
1524
|
+
# Get Tag Relationships Segments
|
1525
|
+
data, status_code, headers = api_instance.get_tag_relationships_segments_with_http_info(id)
|
1526
|
+
p status_code # => 2xx
|
1527
|
+
p headers # => { ... }
|
1528
|
+
p data # => Hash<String, Object>
|
1529
|
+
rescue KlaviyoAPI::ApiError => e
|
1530
|
+
puts "Error when calling TagsApi->get_tag_relationships_segments_with_http_info: #{e}"
|
1531
|
+
end
|
1532
|
+
```
|
1533
|
+
|
1534
|
+
### Parameters
|
1535
|
+
|
1536
|
+
| Name | Type | Description | Notes |
|
1537
|
+
| ---- | ---- | ----------- | ----- |
|
1538
|
+
| **id** | **String** | | |
|
819
1539
|
|
820
1540
|
### Return type
|
821
1541
|
|
@@ -831,13 +1551,13 @@ end
|
|
831
1551
|
- **Accept**: application/json
|
832
1552
|
|
833
1553
|
|
834
|
-
##
|
1554
|
+
## get_tag_relationships_tag_group
|
835
1555
|
|
836
|
-
> Hash<String, Object>
|
1556
|
+
> Hash<String, Object> get_tag_relationships_tag_group(id)
|
837
1557
|
|
838
|
-
Get Tag Relationships
|
1558
|
+
Get Tag Relationships Tag Group
|
839
1559
|
|
840
|
-
|
1560
|
+
Returns the ids of all tag groups related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Tags Read`
|
841
1561
|
|
842
1562
|
### Examples
|
843
1563
|
|
@@ -854,32 +1574,31 @@ end
|
|
854
1574
|
|
855
1575
|
api_instance = KlaviyoAPI::TagsApi.new
|
856
1576
|
id = 'id_example' # String |
|
857
|
-
related_resource = 'flows' # String |
|
858
1577
|
|
859
1578
|
begin
|
860
|
-
# Get Tag Relationships
|
861
|
-
result = api_instance.
|
1579
|
+
# Get Tag Relationships Tag Group
|
1580
|
+
result = api_instance.get_tag_relationships_tag_group(id)
|
862
1581
|
p result
|
863
1582
|
rescue KlaviyoAPI::ApiError => e
|
864
|
-
puts "Error when calling TagsApi->
|
1583
|
+
puts "Error when calling TagsApi->get_tag_relationships_tag_group: #{e}"
|
865
1584
|
end
|
866
1585
|
```
|
867
1586
|
|
868
|
-
#### Using the
|
1587
|
+
#### Using the get_tag_relationships_tag_group_with_http_info variant
|
869
1588
|
|
870
1589
|
This returns an Array which contains the response data, status code and headers.
|
871
1590
|
|
872
|
-
> <Array(Hash<String, Object>, Integer, Hash)>
|
1591
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_tag_relationships_tag_group_with_http_info(id)
|
873
1592
|
|
874
1593
|
```ruby
|
875
1594
|
begin
|
876
|
-
# Get Tag Relationships
|
877
|
-
data, status_code, headers = api_instance.
|
1595
|
+
# Get Tag Relationships Tag Group
|
1596
|
+
data, status_code, headers = api_instance.get_tag_relationships_tag_group_with_http_info(id)
|
878
1597
|
p status_code # => 2xx
|
879
1598
|
p headers # => { ... }
|
880
1599
|
p data # => Hash<String, Object>
|
881
1600
|
rescue KlaviyoAPI::ApiError => e
|
882
|
-
puts "Error when calling TagsApi->
|
1601
|
+
puts "Error when calling TagsApi->get_tag_relationships_tag_group_with_http_info: #{e}"
|
883
1602
|
end
|
884
1603
|
```
|
885
1604
|
|
@@ -888,7 +1607,6 @@ end
|
|
888
1607
|
| Name | Type | Description | Notes |
|
889
1608
|
| ---- | ---- | ----------- | ----- |
|
890
1609
|
| **id** | **String** | | |
|
891
|
-
| **related_resource** | **String** | | |
|
892
1610
|
|
893
1611
|
### Return type
|
894
1612
|
|
@@ -1081,7 +1799,7 @@ end
|
|
1081
1799
|
|
1082
1800
|
api_instance = KlaviyoAPI::TagsApi.new
|
1083
1801
|
id = 'abcd1234-ef56-gh78-ij90-abcdef123456' # String | The Tag ID
|
1084
|
-
tag_update_query = KlaviyoAPI::TagUpdateQuery.new({data: KlaviyoAPI::
|
1802
|
+
tag_update_query = KlaviyoAPI::TagUpdateQuery.new({data: KlaviyoAPI::TagUpdateQueryResourceObject.new({type: KlaviyoAPI::TagEnum::TAG, id: 'abcd1234-ef56-gh78-ij90-abcdef123456', attributes: KlaviyoAPI::TagUpdateQueryResourceObjectAttributes.new({name: 'My Tag'})})}) # TagUpdateQuery |
|
1085
1803
|
|
1086
1804
|
begin
|
1087
1805
|
# Update Tag
|
@@ -1154,7 +1872,7 @@ end
|
|
1154
1872
|
|
1155
1873
|
api_instance = KlaviyoAPI::TagsApi.new
|
1156
1874
|
id = 'zyxw9876-vu54-ts32-rq10-zyxwvu654321' # String | The Tag Group ID
|
1157
|
-
tag_group_update_query = KlaviyoAPI::TagGroupUpdateQuery.new({data: KlaviyoAPI::
|
1875
|
+
tag_group_update_query = KlaviyoAPI::TagGroupUpdateQuery.new({data: KlaviyoAPI::TagGroupUpdateQueryResourceObject.new({type: KlaviyoAPI::TagGroupEnum::TAG_GROUP, id: 'zyxw9876-vu54-ts32-rq10-zyxwvu654321', attributes: KlaviyoAPI::TagGroupUpdateQueryResourceObjectAttributes.new({name: 'My Tag Group'})})}) # TagGroupUpdateQuery |
|
1158
1876
|
|
1159
1877
|
begin
|
1160
1878
|
# Update Tag Group
|