klaviyo-api-sdk 3.0.0 → 4.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +9 -0
- data/README.md +273 -173
- data/Rakefile +10 -0
- data/docs/AccountsApi.md +157 -0
- data/docs/AudiencesSubObject.md +20 -0
- data/docs/BackInStockSubscriptionEnum.md +15 -0
- data/docs/CampaignCloneQuery.md +18 -0
- data/docs/CampaignCloneQueryResourceObject.md +20 -0
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +20 -0
- data/docs/CampaignCreateQuery.md +18 -0
- data/docs/CampaignCreateQueryResourceObject.md +20 -0
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +28 -0
- data/docs/CampaignCreateQueryResourceObjectAttributesCampaignMessages.md +18 -0
- data/docs/CampaignCreateQueryResourceObjectAttributesSendOptions.md +49 -0
- data/docs/CampaignCreateQueryResourceObjectAttributesTrackingOptions.md +49 -0
- data/docs/CampaignEnum.md +15 -0
- data/docs/CampaignMessageAssignTemplateQuery.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +22 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationships.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplateData.md +20 -0
- data/docs/CampaignMessageCreateQueryResourceObject.md +20 -0
- data/docs/CampaignMessageCreateQueryResourceObjectAttributes.md +24 -0
- data/docs/CampaignMessageCreateQueryResourceObjectAttributesContent.md +49 -0
- data/docs/CampaignMessageEnum.md +15 -0
- data/docs/CampaignMessagePartialUpdateQuery.md +18 -0
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +22 -0
- data/docs/CampaignPartialUpdateQuery.md +18 -0
- data/docs/CampaignPartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +26 -0
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignRecipientEstimationJobEnum.md +15 -0
- data/docs/CampaignSendJobCreateQuery.md +18 -0
- data/docs/CampaignSendJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignSendJobEnum.md +15 -0
- data/docs/CampaignSendJobPartialUpdateQuery.md +18 -0
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignsApi.md +1735 -0
- data/docs/CatalogCategoryBulkCreateJobEnum.md +15 -0
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogCategoryCreateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributesCategories.md +18 -0
- data/docs/CatalogCategoryCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateQueryResourceObject.md +22 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +24 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItems.md +18 -0
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributesCategories.md +18 -0
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryEnum.md +15 -0
- data/docs/CatalogCategoryItemOp.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributesCategories.md +18 -0
- data/docs/CatalogCategoryUpdateQuery.md +18 -0
- 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 +18 -0
- data/docs/CatalogItemCreateJobCreateQuery.md +18 -0
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributesItems.md +18 -0
- data/docs/CatalogItemCreateQuery.md +18 -0
- 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 +18 -0
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributesItems.md +18 -0
- data/docs/CatalogItemDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogItemEnum.md +15 -0
- data/docs/CatalogItemUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributesItems.md +18 -0
- data/docs/CatalogItemUpdateQuery.md +18 -0
- 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 +18 -0
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributesVariants.md +18 -0
- data/docs/CatalogVariantCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObject.md +22 -0
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +46 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItem.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemData.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributesVariants.md +18 -0
- data/docs/CatalogVariantDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogVariantEnum.md +15 -0
- data/docs/CatalogVariantUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributesVariants.md +18 -0
- data/docs/CatalogVariantUpdateQuery.md +18 -0
- data/docs/CatalogVariantUpdateQueryResourceObject.md +22 -0
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +40 -0
- data/docs/CatalogsApi.md +4103 -0
- data/docs/DataPrivacyApi.md +78 -0
- data/docs/DataPrivacyCreateDeletionJobQuery.md +18 -0
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +20 -0
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +18 -0
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributesProfile.md +18 -0
- data/docs/DataPrivacyDeletionJobEnum.md +15 -0
- data/docs/DataPrivacyProfileQueryResourceObject.md +22 -0
- data/docs/DataPrivacyProfileQueryResourceObjectAttributes.md +20 -0
- data/docs/DeviceMetadata.md +40 -0
- data/docs/EmailContentSubObject.md +30 -0
- data/docs/EmailSendOptionsSubObject.md +18 -0
- data/docs/EmailTrackingOptionsSubObject.md +24 -0
- data/docs/EventCreateQueryV2.md +18 -0
- data/docs/EventCreateQueryV2ResourceObject.md +20 -0
- data/docs/EventCreateQueryV2ResourceObjectAttributes.md +28 -0
- data/docs/EventCreateQueryV2ResourceObjectAttributesMetric.md +18 -0
- data/docs/EventCreateQueryV2ResourceObjectAttributesProfile.md +18 -0
- data/docs/EventEnum.md +15 -0
- data/docs/EventsApi.md +544 -0
- data/docs/FlowEnum.md +15 -0
- data/docs/FlowUpdateQuery.md +18 -0
- data/docs/FlowUpdateQueryResourceObject.md +22 -0
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/FlowsApi.md +1335 -0
- data/docs/GetAccounts4XXResponse.md +18 -0
- data/docs/GetAccounts4XXResponseErrorsInner.md +26 -0
- data/docs/GetAccounts4XXResponseErrorsInnerSource.md +20 -0
- data/docs/ListCreateQuery.md +18 -0
- data/docs/ListCreateQueryResourceObject.md +20 -0
- data/docs/ListCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/ListEnum.md +15 -0
- data/docs/ListMembersAddQuery.md +18 -0
- data/docs/ListMembersAddQueryDataInner.md +20 -0
- data/docs/ListMembersDeleteQuery.md +18 -0
- data/docs/ListPartialUpdateQuery.md +18 -0
- data/docs/ListPartialUpdateQueryResourceObject.md +22 -0
- data/docs/ListsApi.md +842 -0
- data/docs/MetricAggregateEnum.md +15 -0
- data/docs/MetricAggregateQuery.md +18 -0
- data/docs/MetricAggregateQueryResourceObject.md +20 -0
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +36 -0
- data/docs/MetricCreateQueryResourceObject.md +20 -0
- data/docs/MetricCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/MetricEnum.md +15 -0
- data/docs/MetricsApi.md +233 -0
- data/docs/OnsiteProfileCreateQueryResourceObject.md +24 -0
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +38 -0
- data/docs/OnsiteProfileMeta.md +18 -0
- data/docs/ProfileCreateQuery.md +18 -0
- data/docs/ProfileCreateQueryResourceObject.md +20 -0
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +36 -0
- data/docs/ProfileEnum.md +15 -0
- data/docs/ProfileIdentifierDTOResourceObject.md +22 -0
- data/docs/ProfileIdentifierDTOResourceObjectAttributes.md +24 -0
- data/docs/ProfileLocation.md +34 -0
- data/docs/ProfileLocationLatitude.md +49 -0
- data/docs/ProfileLocationLongitude.md +49 -0
- data/docs/ProfileMeta.md +18 -0
- data/docs/ProfileMetaPatchProperties.md +22 -0
- data/docs/ProfileMetaPatchPropertiesUnset.md +49 -0
- data/docs/ProfilePartialUpdateQuery.md +18 -0
- data/docs/ProfilePartialUpdateQueryResourceObject.md +24 -0
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileSubscriptionBulkDeleteJobEnum.md +15 -0
- data/docs/ProfileSubscriptionCreateQueryResourceObject.md +22 -0
- data/docs/ProfileSubscriptionCreateQueryResourceObjectAttributes.md +22 -0
- data/docs/ProfileSubscriptionDeleteQueryResourceObject.md +20 -0
- data/docs/ProfileSubscriptionDeleteQueryResourceObjectAttributes.md +20 -0
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileSuppressionBulkDeleteJobEnum.md +15 -0
- data/docs/ProfileSuppressionCreateQueryResourceObject.md +20 -0
- data/docs/ProfileSuppressionCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/ProfileSuppressionDeleteQueryResourceObject.md +20 -0
- data/docs/ProfileSuppressionDeleteQueryResourceObjectAttributes.md +18 -0
- data/docs/ProfileUpsertQueryResourceObject.md +22 -0
- data/docs/ProfileUpsertQueryResourceObjectAttributes.md +40 -0
- data/docs/ProfilesApi.md +972 -0
- data/docs/PushTokenCreateQuery.md +18 -0
- data/docs/PushTokenCreateQueryResourceObject.md +20 -0
- data/docs/PushTokenCreateQueryResourceObjectAttributes.md +30 -0
- data/docs/PushTokenCreateQueryResourceObjectAttributesProfile.md +18 -0
- data/docs/PushTokenEnum.md +15 -0
- data/docs/RenderOptionsSubObject.md +24 -0
- data/docs/SMSContentSubObjectCreate.md +18 -0
- data/docs/SMSSendOptionsSubObject.md +18 -0
- data/docs/SMSTrackingOptionsSubObject.md +20 -0
- data/docs/STOScheduleOptions.md +18 -0
- data/docs/SegmentEnum.md +15 -0
- data/docs/SegmentPartialUpdateQuery.md +18 -0
- data/docs/SegmentPartialUpdateQueryResourceObject.md +22 -0
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/SegmentsApi.md +553 -0
- data/docs/SendStrategySubObject.md +24 -0
- data/docs/ServerBISSubscriptionCreateQuery.md +18 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObject.md +22 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributesProfile.md +18 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant.md +18 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariantData.md +20 -0
- data/docs/StaticScheduleOptions.md +22 -0
- data/docs/SubscriptionChannels.md +20 -0
- data/docs/SubscriptionCreateJobCreateQuery.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +22 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
- data/docs/SubscriptionDeleteJobCreateQuery.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObject.md +22 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/SuppressionCreateJobCreateQuery.md +18 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/SuppressionDeleteJobCreateQuery.md +18 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/TagCampaignOp.md +18 -0
- data/docs/TagCampaignOpDataInner.md +20 -0
- data/docs/TagCreateQuery.md +18 -0
- data/docs/TagCreateQueryResourceObject.md +22 -0
- data/docs/TagCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/TagCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/TagCreateQueryResourceObjectRelationshipsTagGroup.md +18 -0
- data/docs/TagCreateQueryResourceObjectRelationshipsTagGroupData.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 +18 -0
- data/docs/TagGroupCreateQueryResourceObject.md +20 -0
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagGroupEnum.md +15 -0
- data/docs/TagGroupUpdateQuery.md +18 -0
- 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/TagSegmentOp.md +18 -0
- data/docs/TagSegmentOpDataInner.md +20 -0
- data/docs/TagUpdateQuery.md +18 -0
- data/docs/TagUpdateQueryResourceObject.md +22 -0
- data/docs/TagsApi.md +1929 -0
- data/docs/TemplateCloneQuery.md +18 -0
- data/docs/TemplateCloneQueryResourceObject.md +20 -0
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +20 -0
- data/docs/TemplateCreateQuery.md +18 -0
- data/docs/TemplateCreateQueryResourceObject.md +20 -0
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +30 -0
- data/docs/TemplateEnum.md +15 -0
- data/docs/TemplateRenderQuery.md +18 -0
- data/docs/TemplateRenderQueryResourceObject.md +20 -0
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +20 -0
- data/docs/TemplateUpdateQuery.md +18 -0
- data/docs/TemplateUpdateQueryResourceObject.md +22 -0
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +28 -0
- data/docs/TemplatesApi.md +524 -0
- data/docs/ThrottledScheduleOptions.md +20 -0
- data/docs/UTMParamsSubObject.md +20 -0
- data/git_push.sh +57 -0
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +9 -9
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +528 -57
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +376 -306
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +96 -96
- data/lib/klaviyo-api-sdk/api/flows_api.rb +258 -103
- data/lib/klaviyo-api-sdk/api/lists_api.rb +79 -44
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +141 -71
- data/lib/klaviyo-api-sdk/api/segments_api.rb +71 -36
- data/lib/klaviyo-api-sdk/api/tags_api.rb +121 -93
- data/lib/klaviyo-api-sdk/api/templates_api.rb +31 -31
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{profile_unsuppression_bulk_create_job_enum.rb → back_in_stock_subscription_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +32 -38
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +227 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- 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 +22 -13
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +5 -20
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object.rb → campaign_message_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +253 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +19 -10
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.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 +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +19 -17
- data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships.rb → catalog_category_create_query_resource_object_relationships.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships_items.rb → catalog_category_create_query_resource_object_relationships_items.rb} +5 -5
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.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 +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.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 +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +73 -71
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +238 -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 +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.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 +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +43 -43
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.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 +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +117 -115
- 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_item.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +238 -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 +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.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 +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +58 -58
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +13 -29
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +388 -0
- data/lib/klaviyo-api-sdk/models/{content_sub_object.rb → email_content_sub_object.rb} +50 -40
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +220 -0
- data/lib/klaviyo-api-sdk/models/{tracking_options_sub_object.rb → email_tracking_options_sub_object.rb} +15 -15
- data/lib/klaviyo-api-sdk/models/{event_create_query.rb → event_create_query_v2.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object.rb → event_create_query_v2_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object_attributes.rb → event_create_query_v2_resource_object_attributes.rb} +44 -45
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response.rb → get_accounts4_xx_response.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response_errors_inner.rb → get_accounts4_xx_response_errors_inner.rb} +40 -40
- data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response_errors_inner_source.rb → get_accounts4_xx_response_errors_inner_source.rb} +17 -17
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +2 -36
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +65 -68
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object.rb → metric_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{metric_create_query.rb → metric_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{profile_unsubscription_bulk_create_job_enum.rb → metric_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +257 -0
- data/lib/klaviyo-api-sdk/models/{profile_partial_update_query_resource_object_attributes.rb → onsite_profile_create_query_resource_object_attributes.rb} +48 -48
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +219 -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 +19 -19
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +39 -39
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +249 -0
- data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +219 -0
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +239 -0
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +106 -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 +28 -19
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/{subscription.rb → profile_subscription_create_query_resource_object_attributes.rb} +18 -28
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{suppression.rb → profile_suppression_create_query_resource_object_attributes.rb} +5 -10
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +220 -0
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +328 -0
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query.rb → push_token_create_query.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships_items_data_inner.rb → push_token_create_query_resource_object_attributes.rb} +131 -31
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +225 -0
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query.rb → server_bis_subscription_create_query.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/{catalog_item_category_op_data_inner.rb → server_bis_subscription_create_query_resource_object_attributes.rb} +23 -37
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +224 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +220 -0
- data/lib/klaviyo-api-sdk/models/{send_options_sub_object.rb → sms_send_options_sub_object.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object_attributes.rb → sms_tracking_options_sub_object.rb} +23 -18
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
- 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 +22 -13
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +11 -29
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +227 -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 +19 -19
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +11 -14
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{tag_update_query_resource_object_attributes.rb → suppression_delete_job_create_query_resource_object_attributes.rb} +14 -15
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +2 -36
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +22 -13
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +2 -12
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +2 -36
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +2 -36
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +2 -36
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +2 -14
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +25 -37
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +3 -15
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -28
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +96 -27
- data/spec/api/accounts_api_spec.rb +60 -0
- data/spec/api/campaigns_api_spec.rb +338 -0
- data/spec/api/catalogs_api_spec.rb +763 -0
- data/spec/api/data_privacy_api_spec.rb +47 -0
- data/spec/api/events_api_spec.rb +132 -0
- data/spec/api/flows_api_spec.rb +279 -0
- data/spec/api/lists_api_spec.rb +185 -0
- data/spec/api/metrics_api_spec.rb +74 -0
- data/spec/api/profiles_api_spec.rb +204 -0
- data/spec/api/segments_api_spec.rb +135 -0
- data/spec/api/tags_api_spec.rb +371 -0
- data/spec/api/templates_api_spec.rb +124 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/audiences_sub_object_spec.rb +40 -0
- data/spec/models/back_in_stock_subscription_enum_spec.rb +28 -0
- 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 +34 -0
- data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +34 -0
- data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +31 -0
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +64 -0
- data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +31 -0
- data/spec/models/campaign_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_create_query_spec.rb +34 -0
- data/spec/models/campaign_enum_spec.rb +28 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +34 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_message_assign_template_query_spec.rb +34 -0
- data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +31 -0
- data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +52 -0
- data/spec/models/campaign_message_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_message_enum_spec.rb +28 -0
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +46 -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 +34 -0
- 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 +34 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +28 -0
- data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_send_job_create_query_spec.rb +34 -0
- 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 +34 -0
- 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_categories_spec.rb +34 -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 +34 -0
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +56 -0
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +34 -0
- data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_category_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
- 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 +34 -0
- 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 +34 -0
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
- 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 +34 -0
- 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 +34 -0
- 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 +34 -0
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +34 -0
- 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 +34 -0
- 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 +40 -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 +34 -0
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +34 -0
- 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 +34 -0
- 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_items_spec.rb +34 -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 +34 -0
- 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 +34 -0
- 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_attributes_variants_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 +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +126 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +40 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_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 +34 -0
- 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_attributes_variants_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 +34 -0
- 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_attributes_variants_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 +34 -0
- 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 +34 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +34 -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 +34 -0
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +28 -0
- data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/data_privacy_profile_query_resource_object_spec.rb +46 -0
- data/spec/models/device_metadata_spec.rb +112 -0
- data/spec/models/email_content_sub_object_spec.rb +70 -0
- data/spec/models/email_send_options_sub_object_spec.rb +34 -0
- data/spec/models/email_tracking_options_sub_object_spec.rb +52 -0
- data/spec/models/event_create_query_v2_resource_object_attributes_metric_spec.rb +34 -0
- data/spec/models/event_create_query_v2_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/event_create_query_v2_resource_object_attributes_spec.rb +64 -0
- data/spec/models/event_create_query_v2_resource_object_spec.rb +40 -0
- data/spec/models/event_create_query_v2_spec.rb +34 -0
- data/spec/models/event_enum_spec.rb +28 -0
- data/spec/models/flow_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 +34 -0
- data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +40 -0
- data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +58 -0
- data/spec/models/get_accounts4_xx_response_spec.rb +34 -0
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/list_create_query_resource_object_spec.rb +40 -0
- data/spec/models/list_create_query_spec.rb +34 -0
- data/spec/models/list_enum_spec.rb +28 -0
- data/spec/models/list_members_add_query_data_inner_spec.rb +40 -0
- data/spec/models/list_members_add_query_spec.rb +34 -0
- data/spec/models/list_members_delete_query_spec.rb +34 -0
- data/spec/models/list_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/list_partial_update_query_spec.rb +34 -0
- 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 +34 -0
- data/spec/models/metric_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/metric_create_query_resource_object_spec.rb +40 -0
- data/spec/models/metric_enum_spec.rb +28 -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 +52 -0
- data/spec/models/onsite_profile_meta_spec.rb +34 -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 +34 -0
- data/spec/models/profile_enum_spec.rb +28 -0
- data/spec/models/profile_identifier_dto_resource_object_attributes_spec.rb +52 -0
- data/spec/models/profile_identifier_dto_resource_object_spec.rb +46 -0
- data/spec/models/profile_location_latitude_spec.rb +31 -0
- data/spec/models/profile_location_longitude_spec.rb +31 -0
- data/spec/models/profile_location_spec.rb +82 -0
- data/spec/models/profile_meta_patch_properties_spec.rb +46 -0
- data/spec/models/profile_meta_patch_properties_unset_spec.rb +31 -0
- data/spec/models/profile_meta_spec.rb +34 -0
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +52 -0
- data/spec/models/profile_partial_update_query_spec.rb +34 -0
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/profile_subscription_create_query_resource_object_spec.rb +46 -0
- data/spec/models/profile_subscription_delete_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/profile_subscription_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_suppression_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/profile_suppression_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/profile_suppression_create_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_suppression_delete_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/profile_suppression_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_upsert_query_resource_object_attributes_spec.rb +100 -0
- data/spec/models/profile_upsert_query_resource_object_spec.rb +46 -0
- data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +86 -0
- data/spec/models/push_token_create_query_resource_object_spec.rb +40 -0
- data/spec/models/push_token_create_query_spec.rb +34 -0
- data/spec/models/push_token_enum_spec.rb +28 -0
- data/spec/models/render_options_sub_object_spec.rb +52 -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 +34 -0
- data/spec/models/send_strategy_sub_object_spec.rb +52 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +44 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +40 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +34 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +46 -0
- data/spec/models/server_bis_subscription_create_query_spec.rb +34 -0
- data/spec/models/sms_content_sub_object_create_spec.rb +34 -0
- data/spec/models/sms_send_options_sub_object_spec.rb +34 -0
- data/spec/models/sms_tracking_options_sub_object_spec.rb +40 -0
- data/spec/models/static_schedule_options_spec.rb +46 -0
- data/spec/models/sto_schedule_options_spec.rb +34 -0
- data/spec/models/subscription_channels_spec.rb +48 -0
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +34 -0
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_spec.rb +46 -0
- data/spec/models/subscription_delete_job_create_query_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +34 -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 +34 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/suppression_delete_job_create_query_spec.rb +34 -0
- data/spec/models/tag_campaign_op_data_inner_spec.rb +40 -0
- data/spec/models/tag_campaign_op_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_relationships_tag_group_data_spec.rb +40 -0
- data/spec/models/tag_create_query_resource_object_relationships_tag_group_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_create_query_spec.rb +34 -0
- data/spec/models/tag_enum_spec.rb +28 -0
- data/spec/models/tag_flow_op_data_inner_spec.rb +40 -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 +34 -0
- 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 +34 -0
- data/spec/models/tag_list_op_data_inner_spec.rb +40 -0
- data/spec/models/tag_list_op_spec.rb +34 -0
- data/spec/models/tag_segment_op_data_inner_spec.rb +40 -0
- data/spec/models/tag_segment_op_spec.rb +34 -0
- data/spec/models/tag_update_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_update_query_spec.rb +34 -0
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/template_clone_query_resource_object_spec.rb +40 -0
- data/spec/models/template_clone_query_spec.rb +34 -0
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +52 -0
- data/spec/models/template_create_query_resource_object_spec.rb +40 -0
- data/spec/models/template_create_query_spec.rb +34 -0
- data/spec/models/template_enum_spec.rb +28 -0
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/template_render_query_resource_object_spec.rb +40 -0
- data/spec/models/template_render_query_spec.rb +34 -0
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/template_update_query_resource_object_spec.rb +46 -0
- data/spec/models/template_update_query_spec.rb +34 -0
- data/spec/models/throttled_schedule_options_spec.rb +40 -0
- data/spec/models/utm_params_sub_object_spec.rb +40 -0
- data/spec/spec_helper.rb +111 -0
- metadata +674 -33
- data/CHANGELOG.md +0 -65
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object_attributes.rb +0 -244
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2023-
|
6
|
+
The version of the OpenAPI document: 2023-08-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -20,7 +20,7 @@ module KlaviyoAPI
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Create Tag
|
23
|
-
# Create a tag. An account cannot have more than **500** unique tags.
|
23
|
+
# Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If the `tag_group_id` is not specified, the tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
24
24
|
# @param tag_create_query [TagCreateQuery]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [Hash<String, Object>]
|
@@ -30,7 +30,7 @@ module KlaviyoAPI
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Create Tag
|
33
|
-
# Create a tag. An account cannot have more than **500** unique tags.
|
33
|
+
# Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If the `tag_group_id` is not specified, the tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
34
34
|
# @param tag_create_query [TagCreateQuery]
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -51,7 +51,7 @@ module KlaviyoAPI
|
|
51
51
|
# header parameters
|
52
52
|
header_params = opts[:header_params] || {}
|
53
53
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
54
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
55
55
|
# HTTP header 'Accept' (if needed)
|
56
56
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
57
|
# HTTP header 'Content-Type'
|
@@ -90,7 +90,7 @@ module KlaviyoAPI
|
|
90
90
|
end
|
91
91
|
|
92
92
|
# Create Tag Group
|
93
|
-
# Create a tag group. An account cannot have more than **50** unique tag groups.
|
93
|
+
# Create a tag group. An account cannot have more than **50** unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
94
94
|
# @param tag_group_create_query [TagGroupCreateQuery]
|
95
95
|
# @param [Hash] opts the optional parameters
|
96
96
|
# @return [Hash<String, Object>]
|
@@ -100,7 +100,7 @@ module KlaviyoAPI
|
|
100
100
|
end
|
101
101
|
|
102
102
|
# Create Tag Group
|
103
|
-
# Create a tag group. An account cannot have more than **50** unique tag groups.
|
103
|
+
# Create a tag group. An account cannot have more than **50** unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
104
104
|
# @param tag_group_create_query [TagGroupCreateQuery]
|
105
105
|
# @param [Hash] opts the optional parameters
|
106
106
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -121,7 +121,7 @@ module KlaviyoAPI
|
|
121
121
|
# header parameters
|
122
122
|
header_params = opts[:header_params] || {}
|
123
123
|
# klaviyo api revision
|
124
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
124
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
125
125
|
# HTTP header 'Accept' (if needed)
|
126
126
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
127
127
|
# HTTP header 'Content-Type'
|
@@ -160,7 +160,7 @@ module KlaviyoAPI
|
|
160
160
|
end
|
161
161
|
|
162
162
|
# Create Tag Relationships Campaigns
|
163
|
-
# Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags.
|
163
|
+
# 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`
|
164
164
|
# @param id [String]
|
165
165
|
# @param tag_campaign_op [TagCampaignOp]
|
166
166
|
# @param [Hash] opts the optional parameters
|
@@ -171,7 +171,7 @@ module KlaviyoAPI
|
|
171
171
|
end
|
172
172
|
|
173
173
|
# Create Tag Relationships Campaigns
|
174
|
-
# Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags.
|
174
|
+
# 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`
|
175
175
|
# @param id [String]
|
176
176
|
# @param tag_campaign_op [TagCampaignOp]
|
177
177
|
# @param [Hash] opts the optional parameters
|
@@ -197,7 +197,7 @@ module KlaviyoAPI
|
|
197
197
|
# header parameters
|
198
198
|
header_params = opts[:header_params] || {}
|
199
199
|
# klaviyo api revision
|
200
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
200
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
201
201
|
# HTTP header 'Accept' (if needed)
|
202
202
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
203
203
|
# HTTP header 'Content-Type'
|
@@ -236,7 +236,7 @@ module KlaviyoAPI
|
|
236
236
|
end
|
237
237
|
|
238
238
|
# Create Tag Relationships Flows
|
239
|
-
# Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags.
|
239
|
+
# 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`
|
240
240
|
# @param id [String]
|
241
241
|
# @param tag_flow_op [TagFlowOp]
|
242
242
|
# @param [Hash] opts the optional parameters
|
@@ -247,7 +247,7 @@ module KlaviyoAPI
|
|
247
247
|
end
|
248
248
|
|
249
249
|
# Create Tag Relationships Flows
|
250
|
-
# Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags.
|
250
|
+
# 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`
|
251
251
|
# @param id [String]
|
252
252
|
# @param tag_flow_op [TagFlowOp]
|
253
253
|
# @param [Hash] opts the optional parameters
|
@@ -273,7 +273,7 @@ module KlaviyoAPI
|
|
273
273
|
# header parameters
|
274
274
|
header_params = opts[:header_params] || {}
|
275
275
|
# klaviyo api revision
|
276
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
276
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
277
277
|
# HTTP header 'Accept' (if needed)
|
278
278
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
279
279
|
# HTTP header 'Content-Type'
|
@@ -312,7 +312,7 @@ module KlaviyoAPI
|
|
312
312
|
end
|
313
313
|
|
314
314
|
# Create Tag Relationships Lists
|
315
|
-
# Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags.
|
315
|
+
# 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`
|
316
316
|
# @param id [String]
|
317
317
|
# @param tag_list_op [TagListOp]
|
318
318
|
# @param [Hash] opts the optional parameters
|
@@ -323,7 +323,7 @@ module KlaviyoAPI
|
|
323
323
|
end
|
324
324
|
|
325
325
|
# Create Tag Relationships Lists
|
326
|
-
# Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags.
|
326
|
+
# 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`
|
327
327
|
# @param id [String]
|
328
328
|
# @param tag_list_op [TagListOp]
|
329
329
|
# @param [Hash] opts the optional parameters
|
@@ -349,7 +349,7 @@ module KlaviyoAPI
|
|
349
349
|
# header parameters
|
350
350
|
header_params = opts[:header_params] || {}
|
351
351
|
# klaviyo api revision
|
352
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
352
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
353
353
|
# HTTP header 'Accept' (if needed)
|
354
354
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
355
355
|
# HTTP header 'Content-Type'
|
@@ -388,7 +388,7 @@ module KlaviyoAPI
|
|
388
388
|
end
|
389
389
|
|
390
390
|
# Create Tag Relationships Segments
|
391
|
-
# Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags.
|
391
|
+
# 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`
|
392
392
|
# @param id [String]
|
393
393
|
# @param tag_segment_op [TagSegmentOp]
|
394
394
|
# @param [Hash] opts the optional parameters
|
@@ -399,7 +399,7 @@ module KlaviyoAPI
|
|
399
399
|
end
|
400
400
|
|
401
401
|
# Create Tag Relationships Segments
|
402
|
-
# Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags.
|
402
|
+
# 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`
|
403
403
|
# @param id [String]
|
404
404
|
# @param tag_segment_op [TagSegmentOp]
|
405
405
|
# @param [Hash] opts the optional parameters
|
@@ -425,7 +425,7 @@ module KlaviyoAPI
|
|
425
425
|
# header parameters
|
426
426
|
header_params = opts[:header_params] || {}
|
427
427
|
# klaviyo api revision
|
428
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
428
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
429
429
|
# HTTP header 'Accept' (if needed)
|
430
430
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
431
431
|
# HTTP header 'Content-Type'
|
@@ -467,17 +467,17 @@ module KlaviyoAPI
|
|
467
467
|
# 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`
|
468
468
|
# @param id [String] The Tag ID
|
469
469
|
# @param [Hash] opts the optional parameters
|
470
|
-
# @return [
|
470
|
+
# @return [nil]
|
471
471
|
def delete_tag(id, opts = {})
|
472
|
-
|
473
|
-
|
472
|
+
delete_tag_with_http_info(id, opts)
|
473
|
+
nil
|
474
474
|
end
|
475
475
|
|
476
476
|
# Delete Tag
|
477
477
|
# 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`
|
478
478
|
# @param id [String] The Tag ID
|
479
479
|
# @param [Hash] opts the optional parameters
|
480
|
-
# @return [Array<(
|
480
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
481
481
|
def delete_tag_with_http_info(id, opts = {})
|
482
482
|
if @api_client.config.debugging
|
483
483
|
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag ...'
|
@@ -495,7 +495,7 @@ module KlaviyoAPI
|
|
495
495
|
# header parameters
|
496
496
|
header_params = opts[:header_params] || {}
|
497
497
|
# klaviyo api revision
|
498
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
498
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
499
499
|
# HTTP header 'Accept' (if needed)
|
500
500
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
501
501
|
|
@@ -506,7 +506,7 @@ module KlaviyoAPI
|
|
506
506
|
post_body = opts[:debug_body]
|
507
507
|
|
508
508
|
# return_type
|
509
|
-
return_type = opts[:debug_return_type]
|
509
|
+
return_type = opts[:debug_return_type]
|
510
510
|
|
511
511
|
# auth_names
|
512
512
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
@@ -529,7 +529,7 @@ module KlaviyoAPI
|
|
529
529
|
end
|
530
530
|
|
531
531
|
# Delete Tag Group
|
532
|
-
# Delete the tag group with the given tag group ID.
|
532
|
+
# 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`
|
533
533
|
# @param id [String] The Tag Group ID
|
534
534
|
# @param [Hash] opts the optional parameters
|
535
535
|
# @return [Hash<String, Object>]
|
@@ -539,7 +539,7 @@ module KlaviyoAPI
|
|
539
539
|
end
|
540
540
|
|
541
541
|
# Delete Tag Group
|
542
|
-
# Delete the tag group with the given tag group ID.
|
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
543
|
# @param id [String] The Tag Group ID
|
544
544
|
# @param [Hash] opts the optional parameters
|
545
545
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -560,7 +560,7 @@ module KlaviyoAPI
|
|
560
560
|
# header parameters
|
561
561
|
header_params = opts[:header_params] || {}
|
562
562
|
# klaviyo api revision
|
563
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
563
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
564
564
|
# HTTP header 'Accept' (if needed)
|
565
565
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
566
566
|
|
@@ -594,7 +594,7 @@ module KlaviyoAPI
|
|
594
594
|
end
|
595
595
|
|
596
596
|
# Delete Tag Relationships Campaigns
|
597
|
-
# Remove a tag's association with one or more campaigns.
|
597
|
+
# 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`
|
598
598
|
# @param id [String]
|
599
599
|
# @param tag_campaign_op [TagCampaignOp]
|
600
600
|
# @param [Hash] opts the optional parameters
|
@@ -605,7 +605,7 @@ module KlaviyoAPI
|
|
605
605
|
end
|
606
606
|
|
607
607
|
# Delete Tag Relationships Campaigns
|
608
|
-
# Remove a tag's association with one or more campaigns.
|
608
|
+
# 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`
|
609
609
|
# @param id [String]
|
610
610
|
# @param tag_campaign_op [TagCampaignOp]
|
611
611
|
# @param [Hash] opts the optional parameters
|
@@ -631,7 +631,7 @@ module KlaviyoAPI
|
|
631
631
|
# header parameters
|
632
632
|
header_params = opts[:header_params] || {}
|
633
633
|
# klaviyo api revision
|
634
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
634
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
635
635
|
# HTTP header 'Accept' (if needed)
|
636
636
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
637
637
|
# HTTP header 'Content-Type'
|
@@ -670,7 +670,7 @@ module KlaviyoAPI
|
|
670
670
|
end
|
671
671
|
|
672
672
|
# Delete Tag Relationships Flows
|
673
|
-
# Remove a tag's association with one or more flows.
|
673
|
+
# 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`
|
674
674
|
# @param id [String]
|
675
675
|
# @param tag_flow_op [TagFlowOp]
|
676
676
|
# @param [Hash] opts the optional parameters
|
@@ -681,7 +681,7 @@ module KlaviyoAPI
|
|
681
681
|
end
|
682
682
|
|
683
683
|
# Delete Tag Relationships Flows
|
684
|
-
# Remove a tag's association with one or more flows.
|
684
|
+
# 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`
|
685
685
|
# @param id [String]
|
686
686
|
# @param tag_flow_op [TagFlowOp]
|
687
687
|
# @param [Hash] opts the optional parameters
|
@@ -707,7 +707,7 @@ module KlaviyoAPI
|
|
707
707
|
# header parameters
|
708
708
|
header_params = opts[:header_params] || {}
|
709
709
|
# klaviyo api revision
|
710
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
710
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
711
711
|
# HTTP header 'Accept' (if needed)
|
712
712
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
713
713
|
# HTTP header 'Content-Type'
|
@@ -746,7 +746,7 @@ module KlaviyoAPI
|
|
746
746
|
end
|
747
747
|
|
748
748
|
# Delete Tag Relationships Lists
|
749
|
-
# Remove a tag's association with one or more lists.
|
749
|
+
# 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`
|
750
750
|
# @param id [String]
|
751
751
|
# @param tag_list_op [TagListOp]
|
752
752
|
# @param [Hash] opts the optional parameters
|
@@ -757,7 +757,7 @@ module KlaviyoAPI
|
|
757
757
|
end
|
758
758
|
|
759
759
|
# Delete Tag Relationships Lists
|
760
|
-
# Remove a tag's association with one or more lists.
|
760
|
+
# 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`
|
761
761
|
# @param id [String]
|
762
762
|
# @param tag_list_op [TagListOp]
|
763
763
|
# @param [Hash] opts the optional parameters
|
@@ -783,7 +783,7 @@ module KlaviyoAPI
|
|
783
783
|
# header parameters
|
784
784
|
header_params = opts[:header_params] || {}
|
785
785
|
# klaviyo api revision
|
786
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
786
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
787
787
|
# HTTP header 'Accept' (if needed)
|
788
788
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
789
789
|
# HTTP header 'Content-Type'
|
@@ -822,7 +822,7 @@ module KlaviyoAPI
|
|
822
822
|
end
|
823
823
|
|
824
824
|
# Delete Tag Relationships Segments
|
825
|
-
# Remove a tag's association with one or more segments.
|
825
|
+
# 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`
|
826
826
|
# @param id [String]
|
827
827
|
# @param tag_segment_op [TagSegmentOp]
|
828
828
|
# @param [Hash] opts the optional parameters
|
@@ -833,7 +833,7 @@ module KlaviyoAPI
|
|
833
833
|
end
|
834
834
|
|
835
835
|
# Delete Tag Relationships Segments
|
836
|
-
# Remove a tag's association with one or more segments.
|
836
|
+
# 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`
|
837
837
|
# @param id [String]
|
838
838
|
# @param tag_segment_op [TagSegmentOp]
|
839
839
|
# @param [Hash] opts the optional parameters
|
@@ -859,7 +859,7 @@ module KlaviyoAPI
|
|
859
859
|
# header parameters
|
860
860
|
header_params = opts[:header_params] || {}
|
861
861
|
# klaviyo api revision
|
862
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
862
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
863
863
|
# HTTP header 'Accept' (if needed)
|
864
864
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
865
865
|
# HTTP header 'Content-Type'
|
@@ -901,7 +901,9 @@ module KlaviyoAPI
|
|
901
901
|
# Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
902
902
|
# @param id [String] The Tag ID
|
903
903
|
# @param [Hash] opts the optional parameters
|
904
|
-
# @option opts [Array<String>] :
|
904
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
905
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
906
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
|
905
907
|
# @return [Hash<String, Object>]
|
906
908
|
def get_tag(id, opts = {})
|
907
909
|
data, _status_code, _headers = get_tag_with_http_info(id, opts)
|
@@ -912,7 +914,9 @@ module KlaviyoAPI
|
|
912
914
|
# Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
913
915
|
# @param id [String] The Tag ID
|
914
916
|
# @param [Hash] opts the optional parameters
|
915
|
-
# @option opts [Array<String>] :
|
917
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
918
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
919
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
|
916
920
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
917
921
|
def get_tag_with_http_info(id, opts = {})
|
918
922
|
if @api_client.config.debugging
|
@@ -922,21 +926,31 @@ module KlaviyoAPI
|
|
922
926
|
if @api_client.config.client_side_validation && id.nil?
|
923
927
|
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag"
|
924
928
|
end
|
929
|
+
allowable_values = ["name", "exclusive", "default"]
|
930
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
931
|
+
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
932
|
+
end
|
925
933
|
allowable_values = ["name"]
|
926
934
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
927
935
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
928
936
|
end
|
937
|
+
allowable_values = ["tag-group"]
|
938
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
939
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
940
|
+
end
|
929
941
|
# resource path
|
930
942
|
local_var_path = '/api/tags/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
931
943
|
|
932
944
|
# query parameters
|
933
945
|
query_params = opts[:query_params] || {}
|
946
|
+
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
934
947
|
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
948
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
935
949
|
|
936
950
|
# header parameters
|
937
951
|
header_params = opts[:header_params] || {}
|
938
952
|
# klaviyo api revision
|
939
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
953
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
940
954
|
# HTTP header 'Accept' (if needed)
|
941
955
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
942
956
|
|
@@ -973,7 +987,7 @@ module KlaviyoAPI
|
|
973
987
|
# 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`
|
974
988
|
# @param id [String] The Tag Group ID
|
975
989
|
# @param [Hash] opts the optional parameters
|
976
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
990
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
977
991
|
# @return [Hash<String, Object>]
|
978
992
|
def get_tag_group(id, opts = {})
|
979
993
|
data, _status_code, _headers = get_tag_group_with_http_info(id, opts)
|
@@ -984,7 +998,7 @@ module KlaviyoAPI
|
|
984
998
|
# 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`
|
985
999
|
# @param id [String] The Tag Group ID
|
986
1000
|
# @param [Hash] opts the optional parameters
|
987
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1001
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
988
1002
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
989
1003
|
def get_tag_group_with_http_info(id, opts = {})
|
990
1004
|
if @api_client.config.debugging
|
@@ -1008,7 +1022,7 @@ module KlaviyoAPI
|
|
1008
1022
|
# header parameters
|
1009
1023
|
header_params = opts[:header_params] || {}
|
1010
1024
|
# klaviyo api revision
|
1011
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1025
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1012
1026
|
# HTTP header 'Accept' (if needed)
|
1013
1027
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1014
1028
|
|
@@ -1073,7 +1087,7 @@ module KlaviyoAPI
|
|
1073
1087
|
# header parameters
|
1074
1088
|
header_params = opts[:header_params] || {}
|
1075
1089
|
# klaviyo api revision
|
1076
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1090
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1077
1091
|
# HTTP header 'Accept' (if needed)
|
1078
1092
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1079
1093
|
|
@@ -1110,7 +1124,7 @@ module KlaviyoAPI
|
|
1110
1124
|
# Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1111
1125
|
# @param id [String]
|
1112
1126
|
# @param [Hash] opts the optional parameters
|
1113
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
1127
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
1114
1128
|
# @return [Hash<String, Object>]
|
1115
1129
|
def get_tag_group_tags(id, opts = {})
|
1116
1130
|
data, _status_code, _headers = get_tag_group_tags_with_http_info(id, opts)
|
@@ -1121,7 +1135,7 @@ module KlaviyoAPI
|
|
1121
1135
|
# Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1122
1136
|
# @param id [String]
|
1123
1137
|
# @param [Hash] opts the optional parameters
|
1124
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
1138
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
1125
1139
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1126
1140
|
def get_tag_group_tags_with_http_info(id, opts = {})
|
1127
1141
|
if @api_client.config.debugging
|
@@ -1145,7 +1159,7 @@ module KlaviyoAPI
|
|
1145
1159
|
# header parameters
|
1146
1160
|
header_params = opts[:header_params] || {}
|
1147
1161
|
# klaviyo api revision
|
1148
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1162
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1149
1163
|
# HTTP header 'Accept' (if needed)
|
1150
1164
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1151
1165
|
|
@@ -1179,12 +1193,12 @@ module KlaviyoAPI
|
|
1179
1193
|
end
|
1180
1194
|
|
1181
1195
|
# Get Tag Groups
|
1182
|
-
# List all tag groups in an account. Every account has one default tag group.
|
1196
|
+
# 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`
|
1183
1197
|
# @param [Hash] opts the optional parameters
|
1184
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1185
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1186
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1187
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1198
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
1199
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
1200
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
|
1201
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
1188
1202
|
# @return [Hash<String, Object>]
|
1189
1203
|
def get_tag_groups(opts = {})
|
1190
1204
|
data, _status_code, _headers = get_tag_groups_with_http_info(opts)
|
@@ -1192,12 +1206,12 @@ module KlaviyoAPI
|
|
1192
1206
|
end
|
1193
1207
|
|
1194
1208
|
# Get Tag Groups
|
1195
|
-
# List all tag groups in an account. Every account has one default tag group.
|
1209
|
+
# 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`
|
1196
1210
|
# @param [Hash] opts the optional parameters
|
1197
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1198
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1199
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1200
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1211
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
1212
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
1213
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
|
1214
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
1201
1215
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1202
1216
|
def get_tag_groups_with_http_info(opts = {})
|
1203
1217
|
if @api_client.config.debugging
|
@@ -1224,7 +1238,7 @@ module KlaviyoAPI
|
|
1224
1238
|
# header parameters
|
1225
1239
|
header_params = opts[:header_params] || {}
|
1226
1240
|
# klaviyo api revision
|
1227
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1241
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1228
1242
|
# HTTP header 'Accept' (if needed)
|
1229
1243
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1230
1244
|
|
@@ -1289,7 +1303,7 @@ module KlaviyoAPI
|
|
1289
1303
|
# header parameters
|
1290
1304
|
header_params = opts[:header_params] || {}
|
1291
1305
|
# klaviyo api revision
|
1292
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1306
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1293
1307
|
# HTTP header 'Accept' (if needed)
|
1294
1308
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1295
1309
|
|
@@ -1354,7 +1368,7 @@ module KlaviyoAPI
|
|
1354
1368
|
# header parameters
|
1355
1369
|
header_params = opts[:header_params] || {}
|
1356
1370
|
# klaviyo api revision
|
1357
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1371
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1358
1372
|
# HTTP header 'Accept' (if needed)
|
1359
1373
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1360
1374
|
|
@@ -1419,7 +1433,7 @@ module KlaviyoAPI
|
|
1419
1433
|
# header parameters
|
1420
1434
|
header_params = opts[:header_params] || {}
|
1421
1435
|
# klaviyo api revision
|
1422
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1436
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1423
1437
|
# HTTP header 'Accept' (if needed)
|
1424
1438
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1425
1439
|
|
@@ -1484,7 +1498,7 @@ module KlaviyoAPI
|
|
1484
1498
|
# header parameters
|
1485
1499
|
header_params = opts[:header_params] || {}
|
1486
1500
|
# klaviyo api revision
|
1487
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1501
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1488
1502
|
# HTTP header 'Accept' (if needed)
|
1489
1503
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1490
1504
|
|
@@ -1518,7 +1532,7 @@ module KlaviyoAPI
|
|
1518
1532
|
end
|
1519
1533
|
|
1520
1534
|
# Get Tag Relationships Tag Group
|
1521
|
-
# Returns the
|
1535
|
+
# Returns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1522
1536
|
# @param id [String]
|
1523
1537
|
# @param [Hash] opts the optional parameters
|
1524
1538
|
# @return [Hash<String, Object>]
|
@@ -1528,7 +1542,7 @@ module KlaviyoAPI
|
|
1528
1542
|
end
|
1529
1543
|
|
1530
1544
|
# Get Tag Relationships Tag Group
|
1531
|
-
# Returns the
|
1545
|
+
# Returns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1532
1546
|
# @param id [String]
|
1533
1547
|
# @param [Hash] opts the optional parameters
|
1534
1548
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -1549,7 +1563,7 @@ module KlaviyoAPI
|
|
1549
1563
|
# header parameters
|
1550
1564
|
header_params = opts[:header_params] || {}
|
1551
1565
|
# klaviyo api revision
|
1552
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1566
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1553
1567
|
# HTTP header 'Accept' (if needed)
|
1554
1568
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1555
1569
|
|
@@ -1586,7 +1600,7 @@ module KlaviyoAPI
|
|
1586
1600
|
# Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1587
1601
|
# @param id [String]
|
1588
1602
|
# @param [Hash] opts the optional parameters
|
1589
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1603
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
1590
1604
|
# @return [Hash<String, Object>]
|
1591
1605
|
def get_tag_tag_group(id, opts = {})
|
1592
1606
|
data, _status_code, _headers = get_tag_tag_group_with_http_info(id, opts)
|
@@ -1597,7 +1611,7 @@ module KlaviyoAPI
|
|
1597
1611
|
# Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1598
1612
|
# @param id [String]
|
1599
1613
|
# @param [Hash] opts the optional parameters
|
1600
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-
|
1614
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
1601
1615
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1602
1616
|
def get_tag_tag_group_with_http_info(id, opts = {})
|
1603
1617
|
if @api_client.config.debugging
|
@@ -1621,7 +1635,7 @@ module KlaviyoAPI
|
|
1621
1635
|
# header parameters
|
1622
1636
|
header_params = opts[:header_params] || {}
|
1623
1637
|
# klaviyo api revision
|
1624
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1638
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1625
1639
|
# HTTP header 'Accept' (if needed)
|
1626
1640
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1627
1641
|
|
@@ -1655,12 +1669,14 @@ module KlaviyoAPI
|
|
1655
1669
|
end
|
1656
1670
|
|
1657
1671
|
# Get Tags
|
1658
|
-
# List all tags in an account.
|
1672
|
+
# List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags 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`
|
1659
1673
|
# @param [Hash] opts the optional parameters
|
1660
|
-
# @option opts [Array<String>] :
|
1661
|
-
# @option opts [String] :
|
1662
|
-
# @option opts [String] :
|
1663
|
-
# @option opts [String] :
|
1674
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
1675
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
1676
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
1677
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
|
1678
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
|
1679
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
1664
1680
|
# @return [Hash<String, Object>]
|
1665
1681
|
def get_tags(opts = {})
|
1666
1682
|
data, _status_code, _headers = get_tags_with_http_info(opts)
|
@@ -1668,21 +1684,31 @@ module KlaviyoAPI
|
|
1668
1684
|
end
|
1669
1685
|
|
1670
1686
|
# Get Tags
|
1671
|
-
# List all tags in an account.
|
1687
|
+
# List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags 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`
|
1672
1688
|
# @param [Hash] opts the optional parameters
|
1673
|
-
# @option opts [Array<String>] :
|
1674
|
-
# @option opts [String] :
|
1675
|
-
# @option opts [String] :
|
1676
|
-
# @option opts [String] :
|
1689
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
1690
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
1691
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
1692
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
|
1693
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
|
1694
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
1677
1695
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1678
1696
|
def get_tags_with_http_info(opts = {})
|
1679
1697
|
if @api_client.config.debugging
|
1680
1698
|
@api_client.config.logger.debug 'Calling API: TagsApi.get_tags ...'
|
1681
1699
|
end
|
1700
|
+
allowable_values = ["name", "exclusive", "default"]
|
1701
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
1702
|
+
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
1703
|
+
end
|
1682
1704
|
allowable_values = ["name"]
|
1683
1705
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
1684
1706
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1685
1707
|
end
|
1708
|
+
allowable_values = ["tag-group"]
|
1709
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1710
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1711
|
+
end
|
1686
1712
|
allowable_values = ["id", "-id", "name", "-name"]
|
1687
1713
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1688
1714
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
@@ -1692,15 +1718,17 @@ module KlaviyoAPI
|
|
1692
1718
|
|
1693
1719
|
# query parameters
|
1694
1720
|
query_params = opts[:query_params] || {}
|
1721
|
+
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
1695
1722
|
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1696
1723
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1724
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1697
1725
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1698
1726
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1699
1727
|
|
1700
1728
|
# header parameters
|
1701
1729
|
header_params = opts[:header_params] || {}
|
1702
1730
|
# klaviyo api revision
|
1703
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1731
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1704
1732
|
# HTTP header 'Accept' (if needed)
|
1705
1733
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1706
1734
|
|
@@ -1734,22 +1762,22 @@ module KlaviyoAPI
|
|
1734
1762
|
end
|
1735
1763
|
|
1736
1764
|
# Update Tag
|
1737
|
-
# Update the tag with the given tag ID.
|
1765
|
+
# Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
1738
1766
|
# @param id [String] The Tag ID
|
1739
1767
|
# @param tag_update_query [TagUpdateQuery]
|
1740
1768
|
# @param [Hash] opts the optional parameters
|
1741
|
-
# @return [
|
1769
|
+
# @return [nil]
|
1742
1770
|
def update_tag(id, tag_update_query, opts = {})
|
1743
|
-
|
1744
|
-
|
1771
|
+
update_tag_with_http_info(id, tag_update_query, opts)
|
1772
|
+
nil
|
1745
1773
|
end
|
1746
1774
|
|
1747
1775
|
# Update Tag
|
1748
|
-
# Update the tag with the given tag ID.
|
1776
|
+
# Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
1749
1777
|
# @param id [String] The Tag ID
|
1750
1778
|
# @param tag_update_query [TagUpdateQuery]
|
1751
1779
|
# @param [Hash] opts the optional parameters
|
1752
|
-
# @return [Array<(
|
1780
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1753
1781
|
def update_tag_with_http_info(id, tag_update_query, opts = {})
|
1754
1782
|
if @api_client.config.debugging
|
1755
1783
|
@api_client.config.logger.debug 'Calling API: TagsApi.update_tag ...'
|
@@ -1771,7 +1799,7 @@ module KlaviyoAPI
|
|
1771
1799
|
# header parameters
|
1772
1800
|
header_params = opts[:header_params] || {}
|
1773
1801
|
# klaviyo api revision
|
1774
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1802
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1775
1803
|
# HTTP header 'Accept' (if needed)
|
1776
1804
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1777
1805
|
# HTTP header 'Content-Type'
|
@@ -1787,7 +1815,7 @@ module KlaviyoAPI
|
|
1787
1815
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_update_query)
|
1788
1816
|
|
1789
1817
|
# return_type
|
1790
|
-
return_type = opts[:debug_return_type]
|
1818
|
+
return_type = opts[:debug_return_type]
|
1791
1819
|
|
1792
1820
|
# auth_names
|
1793
1821
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
@@ -1810,7 +1838,7 @@ module KlaviyoAPI
|
|
1810
1838
|
end
|
1811
1839
|
|
1812
1840
|
# Update Tag Group
|
1813
|
-
# Update the tag group with the given tag group ID.
|
1841
|
+
# Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
1814
1842
|
# @param id [String] The Tag Group ID
|
1815
1843
|
# @param tag_group_update_query [TagGroupUpdateQuery]
|
1816
1844
|
# @param [Hash] opts the optional parameters
|
@@ -1821,7 +1849,7 @@ module KlaviyoAPI
|
|
1821
1849
|
end
|
1822
1850
|
|
1823
1851
|
# Update Tag Group
|
1824
|
-
# Update the tag group with the given tag group ID.
|
1852
|
+
# Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
1825
1853
|
# @param id [String] The Tag Group ID
|
1826
1854
|
# @param tag_group_update_query [TagGroupUpdateQuery]
|
1827
1855
|
# @param [Hash] opts the optional parameters
|
@@ -1847,7 +1875,7 @@ module KlaviyoAPI
|
|
1847
1875
|
# header parameters
|
1848
1876
|
header_params = opts[:header_params] || {}
|
1849
1877
|
# klaviyo api revision
|
1850
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1878
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
1851
1879
|
# HTTP header 'Accept' (if needed)
|
1852
1880
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1853
1881
|
# HTTP header 'Content-Type'
|