klaviyo-api-sdk 1.2.0 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +220 -61
- data/docs/CampaignCloneQuery.md +1 -1
- data/docs/CampaignCloneQueryResourceObject.md +20 -0
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +20 -0
- data/docs/CampaignCreateQuery.md +1 -1
- data/docs/CampaignCreateQueryResourceObject.md +20 -0
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +28 -0
- data/docs/CampaignEnum.md +15 -0
- data/docs/CampaignMessageAssignTemplateQuery.md +1 -1
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +20 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +20 -0
- data/docs/CampaignMessageEnum.md +15 -0
- data/docs/CampaignMessagePartialUpdateQuery.md +1 -1
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +20 -0
- data/docs/CampaignPartialUpdateQuery.md +1 -1
- data/docs/CampaignPartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +26 -0
- data/docs/CampaignRecipientEstimationEnum.md +15 -0
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +1 -1
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignRecipientEstimationJobEnum.md +15 -0
- data/docs/CampaignSendJobCreateQuery.md +1 -1
- data/docs/CampaignSendJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignSendJobEnum.md +15 -0
- data/docs/CampaignSendJobPartialUpdateQuery.md +1 -1
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignsApi.md +25 -27
- data/docs/CatalogCategoryBulkCreateJobEnum.md +15 -0
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogCategoryCreateJobCreateQuery.md +1 -1
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryCreateQuery.md +1 -1
- data/docs/CatalogCategoryCreateQueryResourceObject.md +22 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +24 -0
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +1 -1
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryEnum.md +15 -0
- data/docs/CatalogCategoryItemOp.md +1 -1
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +1 -1
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryUpdateQuery.md +1 -1
- data/docs/CatalogCategoryUpdateQueryResourceObject.md +24 -0
- data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemBulkCreateJobEnum.md +15 -0
- data/docs/CatalogItemBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogItemBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogItemCategoryOp.md +1 -1
- data/docs/CatalogItemCreateJobCreateQuery.md +1 -1
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemCreateQuery.md +1 -1
- data/docs/CatalogItemCreateQueryResourceObject.md +22 -0
- data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +40 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +18 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQuery.md +1 -1
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogItemEnum.md +15 -0
- data/docs/CatalogItemUpdateJobCreateQuery.md +1 -1
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemUpdateQuery.md +1 -1
- data/docs/CatalogItemUpdateQueryResourceObject.md +24 -0
- data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +34 -0
- data/docs/CatalogVariantBulkCreateJobEnum.md +15 -0
- data/docs/CatalogVariantBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogVariantBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogVariantCreateJobCreateQuery.md +1 -1
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantCreateQuery.md +1 -1
- data/docs/CatalogVariantCreateQueryResourceObject.md +22 -0
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +46 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItems.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQuery.md +1 -1
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogVariantEnum.md +15 -0
- data/docs/CatalogVariantUpdateJobCreateQuery.md +1 -1
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantUpdateQuery.md +1 -1
- data/docs/CatalogVariantUpdateQueryResourceObject.md +22 -0
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +40 -0
- data/docs/CatalogsApi.md +141 -157
- data/docs/ClientApi.md +3 -3
- data/docs/CollectionLinks.md +26 -0
- data/docs/DataPrivacyApi.md +1 -1
- data/docs/DataPrivacyCreateDeletionJobQuery.md +1 -1
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +20 -0
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +22 -0
- data/docs/DataPrivacyDeletionJobEnum.md +15 -0
- data/docs/EmailChannel.md +18 -0
- data/docs/EmailMarketing.md +32 -0
- data/docs/EmailMarketingListSuppression.md +22 -0
- data/docs/EmailMarketingSuppression.md +20 -0
- data/docs/EventCreateQuery.md +1 -1
- data/docs/EventCreateQueryResourceObject.md +20 -0
- data/docs/EventCreateQueryResourceObjectAttributes.md +28 -0
- data/docs/EventEnum.md +15 -0
- data/docs/EventsApi.md +90 -18
- data/docs/FlowActionEnum.md +15 -0
- data/docs/FlowEnum.md +15 -0
- data/docs/FlowMessageEnum.md +15 -0
- data/docs/FlowUpdateQuery.md +1 -1
- data/docs/FlowUpdateQueryResourceObject.md +22 -0
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/FlowsApi.md +190 -46
- data/docs/ListCreateQuery.md +1 -1
- data/docs/ListCreateQueryResourceObject.md +20 -0
- data/docs/ListCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/ListEnum.md +15 -0
- data/docs/ListPartialUpdateQuery.md +1 -1
- data/docs/ListPartialUpdateQueryResourceObject.md +22 -0
- data/docs/ListsApi.md +108 -38
- data/docs/MetricAggregateEnum.md +15 -0
- data/docs/MetricAggregateQuery.md +1 -1
- data/docs/MetricAggregateQueryResourceObject.md +20 -0
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +36 -0
- data/docs/MetricEnum.md +15 -0
- data/docs/MetricsApi.md +1 -1
- data/docs/ObjectLinks.md +18 -0
- data/docs/OnsiteProfileCreateQuery.md +1 -1
- data/docs/OnsiteProfileCreateQueryResourceObject.md +22 -0
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +38 -0
- data/docs/OnsiteSubscriptionCreateQuery.md +1 -1
- data/docs/OnsiteSubscriptionCreateQueryResourceObject.md +20 -0
- data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md +26 -0
- data/docs/PredictiveAnalytics.md +34 -0
- data/docs/ProfileAggregateEnum.md +15 -0
- data/docs/ProfileCreateQuery.md +1 -1
- data/docs/ProfileCreateQueryResourceObject.md +20 -0
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +36 -0
- data/docs/ProfileEnum.md +15 -0
- data/docs/ProfilePartialUpdateQuery.md +1 -1
- data/docs/ProfilePartialUpdateQueryResourceObject.md +22 -0
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileUnsubscriptionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileUnsuppressionBulkCreateJobEnum.md +15 -0
- data/docs/ProfilesApi.md +121 -37
- data/docs/SMSChannel.md +18 -0
- data/docs/SMSMarketing.md +24 -0
- data/docs/SegmentEnum.md +15 -0
- data/docs/SegmentPartialUpdateQuery.md +1 -1
- data/docs/SegmentPartialUpdateQueryResourceObject.md +22 -0
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/SegmentsApi.md +90 -16
- data/docs/SubscriptionCreateJobCreateQuery.md +1 -1
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +22 -0
- data/docs/SubscriptionEnum.md +15 -0
- data/docs/Subscriptions.md +20 -0
- data/docs/SuppressionCreateJobCreateQuery.md +1 -1
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/TagCampaignOp.md +18 -0
- data/docs/TagCampaignOpDataInner.md +20 -0
- data/docs/TagCreateQuery.md +1 -1
- data/docs/TagCreateQueryResourceObject.md +20 -0
- data/docs/TagCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagEnum.md +15 -0
- data/docs/TagFlowOp.md +18 -0
- data/docs/TagFlowOpDataInner.md +20 -0
- data/docs/TagGroupCreateQuery.md +1 -1
- data/docs/TagGroupCreateQueryResourceObject.md +20 -0
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagGroupEnum.md +15 -0
- data/docs/TagGroupUpdateQuery.md +1 -1
- data/docs/TagGroupUpdateQueryResourceObject.md +22 -0
- data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagListOp.md +18 -0
- data/docs/TagListOpDataInner.md +20 -0
- data/docs/TagUpdateQuery.md +1 -1
- data/docs/TagUpdateQueryResourceObject.md +22 -0
- data/docs/TagUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/TagsApi.md +881 -163
- data/docs/TemplateCloneQuery.md +1 -1
- data/docs/TemplateCloneQueryResourceObject.md +20 -0
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +22 -0
- data/docs/TemplateCreateQuery.md +1 -1
- data/docs/TemplateCreateQueryResourceObject.md +20 -0
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +32 -0
- data/docs/TemplateEnum.md +15 -0
- data/docs/TemplateRenderQuery.md +1 -1
- data/docs/TemplateRenderQueryResourceObject.md +20 -0
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +22 -0
- data/docs/TemplateUpdateQuery.md +1 -1
- data/docs/TemplateUpdateQueryResourceObject.md +22 -0
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +30 -0
- data/docs/TemplatesApi.md +5 -5
- data/docs/TestApiAnalyticsSampleEnum.md +15 -0
- data/docs/TestListEnum.md +15 -0
- data/docs/UnsubscriptionCreateJobCreateQuery.md +1 -1
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.md +22 -0
- data/docs/UnsuppressionCreateJobCreateQuery.md +1 -1
- data/docs/UnsuppressionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/UnsuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/klaviyo-api-sdk.gemspec +1 -1
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +14 -20
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +110 -198
- data/lib/klaviyo-api-sdk/api/events_api.rb +87 -26
- data/lib/klaviyo-api-sdk/api/flows_api.rb +172 -65
- data/lib/klaviyo-api-sdk/api/lists_api.rb +99 -57
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +121 -36
- data/lib/klaviyo-api-sdk/api/segments_api.rb +85 -21
- data/lib/klaviyo-api-sdk/api/tags_api.rb +788 -116
- data/lib/klaviyo-api-sdk/api/templates_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +291 -0
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +256 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +296 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +262 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +220 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +390 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +262 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +302 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +447 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_items.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_items_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +366 -0
- data/lib/klaviyo-api-sdk/models/collection_links.rb +260 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/email_channel.rb +219 -0
- data/lib/klaviyo-api-sdk/models/email_marketing.rb +298 -0
- data/lib/klaviyo-api-sdk/models/email_marketing_list_suppression.rb +255 -0
- data/lib/klaviyo-api-sdk/models/email_marketing_suppression.rb +240 -0
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object_attributes.rb +284 -0
- data/lib/klaviyo-api-sdk/models/event_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_action_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/list_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +388 -0
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/object_links.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +318 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object_attributes.rb +265 -0
- data/lib/klaviyo-api-sdk/models/predictive_analytics.rb +300 -0
- data/lib/klaviyo-api-sdk/models/profile_aggregate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +309 -0
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/sms_channel.rb +219 -0
- data/lib/klaviyo-api-sdk/models/sms_marketing.rb +270 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/subscription_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/subscriptions.rb +228 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +234 -0
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +236 -0
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +247 -0
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/test_api_analytics_sample_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/test_list_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object_attributes.rb +244 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk.rb +153 -123
- data/spec/api/campaigns_api_spec.rb +5 -34
- data/spec/api/catalogs_api_spec.rb +162 -170
- data/spec/api/client_api_spec.rb +3 -3
- data/spec/api/data_privacy_api_spec.rb +1 -1
- data/spec/api/events_api_spec.rb +33 -21
- data/spec/api/flows_api_spec.rb +76 -49
- data/spec/api/lists_api_spec.rb +38 -27
- data/spec/api/metrics_api_spec.rb +8 -8
- data/spec/api/profiles_api_spec.rb +41 -25
- data/spec/api/segments_api_spec.rb +30 -17
- data/spec/api/tags_api_spec.rb +155 -33
- data/spec/api/templates_api_spec.rb +12 -14
- data/spec/models/audiences_sub_object_spec.rb +1 -1
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/campaign_clone_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_clone_query_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +64 -0
- data/spec/models/campaign_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_create_query_spec.rb +1 -1
- data/spec/models/campaign_enum_spec.rb +28 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_spec.rb +1 -1
- data/spec/models/campaign_message_enum_spec.rb +28 -0
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_message_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +58 -0
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_enum_spec.rb +28 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +28 -0
- data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_send_job_create_query_spec.rb +1 -1
- data/spec/models/campaign_send_job_enum_spec.rb +28 -0
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +56 -0
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_category_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_enum_spec.rb +28 -0
- data/spec/models/catalog_category_item_op_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +52 -0
- data/spec/models/catalog_category_update_query_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_category_op_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +44 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_item_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_enum_spec.rb +28 -0
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +82 -0
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +52 -0
- data/spec/models/catalog_item_update_query_spec.rb +1 -1
- data/spec/models/catalog_job_error_payload_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +126 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_data_inner_spec.rb +44 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_variant_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_variant_update_query_spec.rb +1 -1
- data/spec/models/collection_links_spec.rb +58 -0
- data/spec/models/content_sub_object_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +40 -0
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +1 -1
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +28 -0
- data/spec/models/email_channel_spec.rb +34 -0
- data/spec/models/email_marketing_list_suppression_spec.rb +46 -0
- data/spec/models/email_marketing_spec.rb +76 -0
- data/spec/models/email_marketing_suppression_spec.rb +40 -0
- data/spec/models/email_message_content_spec.rb +1 -1
- data/spec/models/email_tracking_options_spec.rb +1 -1
- data/spec/models/error_source_spec.rb +1 -1
- data/spec/models/event_create_query_resource_object_attributes_spec.rb +64 -0
- data/spec/models/event_create_query_resource_object_spec.rb +40 -0
- data/spec/models/event_create_query_spec.rb +1 -1
- data/spec/models/event_enum_spec.rb +28 -0
- data/spec/models/flow_action_enum_spec.rb +28 -0
- data/spec/models/flow_enum_spec.rb +28 -0
- data/spec/models/flow_message_enum_spec.rb +28 -0
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/flow_update_query_resource_object_spec.rb +46 -0
- data/spec/models/flow_update_query_spec.rb +1 -1
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/list_create_query_resource_object_spec.rb +40 -0
- data/spec/models/list_create_query_spec.rb +1 -1
- data/spec/models/list_enum_spec.rb +28 -0
- data/spec/models/list_members_add_query_data_inner_spec.rb +1 -1
- data/spec/models/list_members_add_query_spec.rb +1 -1
- data/spec/models/list_members_delete_query_spec.rb +1 -1
- data/spec/models/list_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/list_partial_update_query_spec.rb +1 -1
- data/spec/models/metric_aggregate_enum_spec.rb +28 -0
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +40 -0
- data/spec/models/metric_aggregate_query_spec.rb +1 -1
- data/spec/models/metric_aggregate_row_dto_spec.rb +1 -1
- data/spec/models/metric_create_query_spec.rb +1 -1
- data/spec/models/metric_enum_spec.rb +28 -0
- data/spec/models/object_links_spec.rb +34 -0
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +94 -0
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +46 -0
- data/spec/models/onsite_profile_create_query_spec.rb +1 -1
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +4 -4
- data/spec/models/onsite_profile_meta_spec.rb +1 -1
- data/spec/models/onsite_subscription_create_query_resource_object_attributes_spec.rb +58 -0
- data/spec/models/onsite_subscription_create_query_resource_object_spec.rb +40 -0
- data/spec/models/onsite_subscription_create_query_spec.rb +1 -1
- data/spec/models/predictive_analytics_spec.rb +82 -0
- data/spec/models/profile_aggregate_enum_spec.rb +28 -0
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +88 -0
- data/spec/models/profile_create_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_create_query_spec.rb +1 -1
- data/spec/models/profile_enum_spec.rb +28 -0
- data/spec/models/profile_location_latitude_spec.rb +1 -1
- data/spec/models/profile_location_spec.rb +1 -1
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/profile_partial_update_query_spec.rb +1 -1
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_unsubscription_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_unsuppression_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/segment_enum_spec.rb +28 -0
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/segment_partial_update_query_spec.rb +1 -1
- data/spec/models/send_options_spec.rb +1 -1
- data/spec/models/send_options_sub_object_spec.rb +1 -7
- data/spec/models/send_strategy_sub_object_spec.rb +7 -1
- data/spec/models/send_time_sub_object_spec.rb +1 -1
- data/spec/models/sms_channel_spec.rb +34 -0
- data/spec/models/sms_marketing_spec.rb +52 -0
- data/spec/models/sms_message_content_spec.rb +1 -1
- data/spec/models/sms_render_options_spec.rb +1 -1
- data/spec/models/sms_tracking_options_spec.rb +1 -1
- data/spec/models/static_schedule_options_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_spec.rb +1 -1
- data/spec/models/subscription_enum_spec.rb +28 -0
- data/spec/models/subscription_spec.rb +13 -1
- data/spec/models/subscriptions_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_spec.rb +1 -1
- data/spec/models/suppression_spec.rb +1 -1
- data/spec/models/tag_campaign_op_data_inner_spec.rb +44 -0
- data/spec/models/tag_campaign_op_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_create_query_resource_object_spec.rb +40 -0
- data/spec/models/tag_create_query_spec.rb +1 -1
- data/spec/models/tag_enum_spec.rb +28 -0
- data/spec/models/tag_flow_op_data_inner_spec.rb +44 -0
- data/spec/models/tag_flow_op_spec.rb +34 -0
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_group_create_query_resource_object_spec.rb +40 -0
- data/spec/models/tag_group_create_query_spec.rb +1 -1
- data/spec/models/tag_group_enum_spec.rb +28 -0
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_group_update_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_group_update_query_spec.rb +1 -1
- data/spec/models/tag_list_op_data_inner_spec.rb +44 -0
- data/spec/models/tag_list_op_spec.rb +34 -0
- data/spec/models/tag_segment_op_data_inner_spec.rb +1 -1
- data/spec/models/tag_segment_op_spec.rb +1 -1
- data/spec/models/tag_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/tag_update_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_update_query_spec.rb +1 -1
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/template_clone_query_resource_object_spec.rb +40 -0
- data/spec/models/template_clone_query_spec.rb +1 -1
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +58 -0
- data/spec/models/template_create_query_resource_object_spec.rb +40 -0
- data/spec/models/template_create_query_spec.rb +1 -1
- data/spec/models/template_enum_spec.rb +28 -0
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/template_render_query_resource_object_spec.rb +40 -0
- data/spec/models/template_render_query_spec.rb +1 -1
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +52 -0
- data/spec/models/template_update_query_resource_object_spec.rb +46 -0
- data/spec/models/template_update_query_spec.rb +1 -1
- data/spec/models/test_api_analytics_sample_enum_spec.rb +28 -0
- data/spec/models/test_list_enum_spec.rb +28 -0
- data/spec/models/throttled_schedule_options_spec.rb +1 -1
- data/spec/models/tracking_options_sub_object_spec.rb +1 -1
- data/spec/models/unsubscription_create_job_create_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/unsubscription_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/unsubscription_create_job_create_query_spec.rb +1 -1
- data/spec/models/unsuppression_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/unsuppression_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/unsuppression_create_job_create_query_spec.rb +1 -1
- data/spec/models/utm_param_info_spec.rb +1 -1
- data/spec/models/utm_params_sub_object_spec.rb +1 -1
- metadata +466 -394
- data/CHANGELOG.md +0 -41
- data/docs/CampaignCloneQueryAsSubResource.md +0 -20
- data/docs/CampaignCloneQueryAsSubResourceAttributes.md +0 -20
- data/docs/CampaignCreateQueryAsSubResource.md +0 -20
- data/docs/CampaignCreateQueryAsSubResourceAttributes.md +0 -28
- data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +0 -20
- data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +0 -20
- data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +0 -22
- data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +0 -20
- data/docs/CampaignPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +0 -26
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +0 -20
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CampaignSendJobCreateQueryAsSubResource.md +0 -20
- data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CampaignTagOp.md +0 -18
- data/docs/CampaignTagOpDataInner.md +0 -20
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryCreateQueryAsSubResource.md +0 -22
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +0 -24
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +0 -24
- data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemCreateQueryAsSubResource.md +0 -22
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +0 -40
- data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md +0 -18
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md +0 -18
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemDeleteQueryAsSubResource.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemUpdateQueryAsSubResource.md +0 -24
- data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +0 -34
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogVariantCreateQueryAsSubResource.md +0 -22
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +0 -46
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md +0 -18
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md +0 -18
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +0 -22
- data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +0 -38
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +0 -20
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +0 -22
- data/docs/EventCreateQueryAsSubResource.md +0 -20
- data/docs/EventCreateQueryAsSubResourceAttributes.md +0 -28
- data/docs/FlowUpdateQueryAsSubResource.md +0 -22
- data/docs/FlowUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/GetCatalogItems4XXResponse.md +0 -18
- data/docs/GetCatalogItems4XXResponseErrorsInner.md +0 -26
- data/docs/GetCatalogItems4XXResponseErrorsInnerSource.md +0 -20
- data/docs/IncludedCategories.md +0 -24
- data/docs/IncludedCategoriesAttributes.md +0 -22
- data/docs/IncludedFlowAction.md +0 -24
- data/docs/IncludedFlowActions.md +0 -24
- data/docs/IncludedFlowActionsAttributes.md +0 -32
- data/docs/IncludedFlowActionsAttributesTrackingOptions.md +0 -49
- data/docs/IncludedFlowMessages.md +0 -24
- data/docs/IncludedFlowMessagesAttributes.md +0 -26
- data/docs/IncludedFlowMessagesAttributesContent.md +0 -49
- data/docs/IncludedFlows.md +0 -24
- data/docs/IncludedFlowsAttributes.md +0 -28
- data/docs/IncludedItems.md +0 -24
- data/docs/IncludedItemsAttributes.md +0 -40
- data/docs/IncludedLists.md +0 -24
- data/docs/IncludedListsAttributes.md +0 -22
- data/docs/IncludedMetrics.md +0 -24
- data/docs/IncludedMetricsAttributes.md +0 -24
- data/docs/IncludedProfiles.md +0 -24
- data/docs/IncludedProfilesAttributes.md +0 -44
- data/docs/IncludedSegments.md +0 -24
- data/docs/IncludedSegmentsAttributes.md +0 -22
- data/docs/IncludedTags.md +0 -24
- data/docs/IncludedVariants.md +0 -24
- data/docs/IncludedVariantsAttributes.md +0 -46
- data/docs/IncludedVariantsLinks.md +0 -18
- data/docs/ListCreateQueryAsSubResource.md +0 -20
- data/docs/ListCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/ListPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/MetricAggregateQueryAsSubResource.md +0 -20
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +0 -36
- data/docs/OnsiteProfileCreateQueryAsSubResource.md +0 -22
- data/docs/OnsiteSubscriptionCreateQueryAsSubResource.md +0 -20
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +0 -26
- data/docs/ProfileCreateQueryAsSubResource.md +0 -20
- data/docs/ProfileCreateQueryAsSubResourceAttributes.md +0 -38
- data/docs/ProfilePartialUpdateQueryAsSubResource.md +0 -22
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/SubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
- data/docs/SuppressionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/TagCreateQueryAsSubResource.md +0 -20
- data/docs/TagCreateQueryAsSubResourceAttributes.md +0 -20
- data/docs/TagGroupCreateQueryAsSubResource.md +0 -20
- data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +0 -20
- data/docs/TagGroupUpdateQueryAsSubResource.md +0 -22
- data/docs/TagGroupUpdateQueryAsSubResourceAttributes.md +0 -20
- data/docs/TagUpdateQueryAsSubResource.md +0 -22
- data/docs/TagUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/TemplateCloneQueryAsSubResource.md +0 -20
- data/docs/TemplateCloneQueryAsSubResourceAttributes.md +0 -22
- data/docs/TemplateCreateQueryAsSubResource.md +0 -20
- data/docs/TemplateCreateQueryAsSubResourceAttributes.md +0 -32
- data/docs/TemplateRenderQueryAsSubResource.md +0 -20
- data/docs/TemplateRenderQueryAsSubResourceAttributes.md +0 -22
- data/docs/TemplateUpdateQueryAsSubResource.md +0 -22
- data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +0 -30
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/V2TemplateRenderQueryAsSubResource.md +0 -18
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +0 -235
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +0 -291
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +0 -229
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +0 -256
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb +0 -225
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +0 -225
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +0 -225
- data/lib/klaviyo-api-sdk/models/campaign_tag_op.rb +0 -226
- data/lib/klaviyo-api-sdk/models/campaign_tag_op_data_inner.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +0 -296
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +0 -273
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +0 -296
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +0 -220
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +0 -390
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +0 -219
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +0 -273
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +0 -296
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +0 -302
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +0 -447
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +0 -219
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +0 -273
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +0 -356
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +0 -284
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +0 -224
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +0 -226
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +0 -275
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +0 -228
- data/lib/klaviyo-api-sdk/models/included_categories.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +0 -282
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +0 -105
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +0 -270
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +0 -105
- data/lib/klaviyo-api-sdk/models/included_flows.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +0 -264
- data/lib/klaviyo-api-sdk/models/included_items.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +0 -332
- data/lib/klaviyo-api-sdk/models/included_lists.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +0 -250
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +0 -348
- data/lib/klaviyo-api-sdk/models/included_segments.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/included_tags.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_variants.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +0 -396
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +0 -224
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +0 -225
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +0 -388
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +0 -265
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +0 -318
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource_attributes.rb +0 -224
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +0 -252
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +0 -235
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +0 -234
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource_attributes.rb +0 -236
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +0 -225
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +0 -247
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +0 -252
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +0 -252
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +0 -244
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +0 -221
- data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +0 -64
- data/spec/models/campaign_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +0 -58
- data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/campaign_tag_op_data_inner_spec.rb +0 -44
- data/spec/models/campaign_tag_op_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +0 -56
- data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +0 -56
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +0 -98
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +0 -76
- data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +0 -56
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +0 -126
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +0 -98
- data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +0 -64
- data/spec/models/event_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/flow_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +0 -40
- data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +0 -58
- data/spec/models/get_catalog_items4_xx_response_spec.rb +0 -34
- data/spec/models/included_categories_attributes_spec.rb +0 -46
- data/spec/models/included_categories_spec.rb +0 -56
- data/spec/models/included_flow_action_spec.rb +0 -56
- data/spec/models/included_flow_actions_attributes_spec.rb +0 -76
- data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +0 -31
- data/spec/models/included_flow_actions_spec.rb +0 -56
- data/spec/models/included_flow_messages_attributes_content_spec.rb +0 -31
- data/spec/models/included_flow_messages_attributes_spec.rb +0 -58
- data/spec/models/included_flow_messages_spec.rb +0 -56
- data/spec/models/included_flows_attributes_spec.rb +0 -64
- data/spec/models/included_flows_spec.rb +0 -56
- data/spec/models/included_items_attributes_spec.rb +0 -94
- data/spec/models/included_items_spec.rb +0 -56
- data/spec/models/included_lists_attributes_spec.rb +0 -46
- data/spec/models/included_lists_spec.rb +0 -56
- data/spec/models/included_metrics_attributes_spec.rb +0 -52
- data/spec/models/included_metrics_spec.rb +0 -56
- data/spec/models/included_profiles_attributes_spec.rb +0 -112
- data/spec/models/included_profiles_spec.rb +0 -56
- data/spec/models/included_segments_attributes_spec.rb +0 -46
- data/spec/models/included_segments_spec.rb +0 -56
- data/spec/models/included_tags_spec.rb +0 -56
- data/spec/models/included_variants_attributes_spec.rb +0 -122
- data/spec/models/included_variants_links_spec.rb +0 -34
- data/spec/models/included_variants_spec.rb +0 -56
- data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/list_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +0 -104
- data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +0 -58
- data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +0 -94
- data/spec/models/profile_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/tag_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/tag_group_update_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/tag_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/template_clone_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +0 -58
- data/spec/models/template_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/template_render_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +0 -52
- data/spec/models/template_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +0 -34
data/docs/ListsApi.md
CHANGED
@@ -5,12 +5,13 @@ All URIs are relative to *https://a.klaviyo.com*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**create_list**](ListsApi.md#create_list) | **POST** /api/lists/ | Create List |
|
8
|
-
| [**create_list_relationships**](ListsApi.md#create_list_relationships) | **POST** /api/lists/{id}/relationships/
|
8
|
+
| [**create_list_relationships**](ListsApi.md#create_list_relationships) | **POST** /api/lists/{id}/relationships/profiles/ | Add Profile To List |
|
9
9
|
| [**delete_list**](ListsApi.md#delete_list) | **DELETE** /api/lists/{id}/ | Delete List |
|
10
|
-
| [**delete_list_relationships**](ListsApi.md#delete_list_relationships) | **DELETE** /api/lists/{id}/relationships/
|
10
|
+
| [**delete_list_relationships**](ListsApi.md#delete_list_relationships) | **DELETE** /api/lists/{id}/relationships/profiles/ | Remove Profile From List |
|
11
11
|
| [**get_list**](ListsApi.md#get_list) | **GET** /api/lists/{id}/ | Get List |
|
12
12
|
| [**get_list_profiles**](ListsApi.md#get_list_profiles) | **GET** /api/lists/{list_id}/profiles/ | Get List Profiles |
|
13
|
-
| [**
|
13
|
+
| [**get_list_relationships_profiles**](ListsApi.md#get_list_relationships_profiles) | **GET** /api/lists/{id}/relationships/profiles/ | Get List Relationships Profiles |
|
14
|
+
| [**get_list_relationships_tags**](ListsApi.md#get_list_relationships_tags) | **GET** /api/lists/{id}/relationships/tags/ | Get List Relationships Tags |
|
14
15
|
| [**get_list_tags**](ListsApi.md#get_list_tags) | **GET** /api/lists/{list_id}/tags/ | Get List Tags |
|
15
16
|
| [**get_lists**](ListsApi.md#get_lists) | **GET** /api/lists/ | Get Lists |
|
16
17
|
| [**update_list**](ListsApi.md#update_list) | **PATCH** /api/lists/{id}/ | Update List |
|
@@ -38,7 +39,7 @@ KlaviyoAPI.configure do |config|
|
|
38
39
|
end
|
39
40
|
|
40
41
|
api_instance = KlaviyoAPI::ListsApi.new
|
41
|
-
list_create_query = KlaviyoAPI::ListCreateQuery.new({data: KlaviyoAPI::
|
42
|
+
list_create_query = KlaviyoAPI::ListCreateQuery.new({data: KlaviyoAPI::ListCreateQueryResourceObject.new({type: KlaviyoAPI::ListEnum::LIST, attributes: KlaviyoAPI::ListCreateQueryResourceObjectAttributes.new({name: 'Newsletter'})})}) # ListCreateQuery |
|
42
43
|
|
43
44
|
begin
|
44
45
|
# Create List
|
@@ -89,9 +90,9 @@ end
|
|
89
90
|
|
90
91
|
## create_list_relationships
|
91
92
|
|
92
|
-
> create_list_relationships(id,
|
93
|
+
> create_list_relationships(id, list_members_add_query)
|
93
94
|
|
94
|
-
Add Profile
|
95
|
+
Add Profile To List
|
95
96
|
|
96
97
|
Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
|
97
98
|
|
@@ -110,12 +111,11 @@ end
|
|
110
111
|
|
111
112
|
api_instance = KlaviyoAPI::ListsApi.new
|
112
113
|
id = 'id_example' # String |
|
113
|
-
related_resource = 'profiles' # String |
|
114
114
|
list_members_add_query = KlaviyoAPI::ListMembersAddQuery.new({data: [KlaviyoAPI::ListMembersAddQueryDataInner.new({type: 'profile', id: 'id_example'})]}) # ListMembersAddQuery |
|
115
115
|
|
116
116
|
begin
|
117
|
-
# Add Profile
|
118
|
-
api_instance.create_list_relationships(id,
|
117
|
+
# Add Profile To List
|
118
|
+
api_instance.create_list_relationships(id, list_members_add_query)
|
119
119
|
rescue KlaviyoAPI::ApiError => e
|
120
120
|
puts "Error when calling ListsApi->create_list_relationships: #{e}"
|
121
121
|
end
|
@@ -125,12 +125,12 @@ end
|
|
125
125
|
|
126
126
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
127
127
|
|
128
|
-
> <Array(nil, Integer, Hash)> create_list_relationships_with_http_info(id,
|
128
|
+
> <Array(nil, Integer, Hash)> create_list_relationships_with_http_info(id, list_members_add_query)
|
129
129
|
|
130
130
|
```ruby
|
131
131
|
begin
|
132
|
-
# Add Profile
|
133
|
-
data, status_code, headers = api_instance.create_list_relationships_with_http_info(id,
|
132
|
+
# Add Profile To List
|
133
|
+
data, status_code, headers = api_instance.create_list_relationships_with_http_info(id, list_members_add_query)
|
134
134
|
p status_code # => 2xx
|
135
135
|
p headers # => { ... }
|
136
136
|
p data # => nil
|
@@ -144,7 +144,6 @@ end
|
|
144
144
|
| Name | Type | Description | Notes |
|
145
145
|
| ---- | ---- | ----------- | ----- |
|
146
146
|
| **id** | **String** | | |
|
147
|
-
| **related_resource** | **String** | | |
|
148
147
|
| **list_members_add_query** | [**ListMembersAddQuery**](ListMembersAddQuery.md) | | |
|
149
148
|
|
150
149
|
### Return type
|
@@ -233,11 +232,11 @@ nil (empty response body)
|
|
233
232
|
|
234
233
|
## delete_list_relationships
|
235
234
|
|
236
|
-
> delete_list_relationships(id,
|
235
|
+
> delete_list_relationships(id, list_members_delete_query)
|
237
236
|
|
238
|
-
Remove Profile
|
237
|
+
Remove Profile From List
|
239
238
|
|
240
|
-
Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
|
239
|
+
Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
|
241
240
|
|
242
241
|
### Examples
|
243
242
|
|
@@ -254,12 +253,11 @@ end
|
|
254
253
|
|
255
254
|
api_instance = KlaviyoAPI::ListsApi.new
|
256
255
|
id = 'id_example' # String |
|
257
|
-
related_resource = 'profiles' # String |
|
258
256
|
list_members_delete_query = KlaviyoAPI::ListMembersDeleteQuery.new({data: [KlaviyoAPI::ListMembersAddQueryDataInner.new({type: 'profile', id: 'id_example'})]}) # ListMembersDeleteQuery |
|
259
257
|
|
260
258
|
begin
|
261
|
-
# Remove Profile
|
262
|
-
api_instance.delete_list_relationships(id,
|
259
|
+
# Remove Profile From List
|
260
|
+
api_instance.delete_list_relationships(id, list_members_delete_query)
|
263
261
|
rescue KlaviyoAPI::ApiError => e
|
264
262
|
puts "Error when calling ListsApi->delete_list_relationships: #{e}"
|
265
263
|
end
|
@@ -269,12 +267,12 @@ end
|
|
269
267
|
|
270
268
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
271
269
|
|
272
|
-
> <Array(nil, Integer, Hash)> delete_list_relationships_with_http_info(id,
|
270
|
+
> <Array(nil, Integer, Hash)> delete_list_relationships_with_http_info(id, list_members_delete_query)
|
273
271
|
|
274
272
|
```ruby
|
275
273
|
begin
|
276
|
-
# Remove Profile
|
277
|
-
data, status_code, headers = api_instance.delete_list_relationships_with_http_info(id,
|
274
|
+
# Remove Profile From List
|
275
|
+
data, status_code, headers = api_instance.delete_list_relationships_with_http_info(id, list_members_delete_query)
|
278
276
|
p status_code # => 2xx
|
279
277
|
p headers # => { ... }
|
280
278
|
p data # => nil
|
@@ -288,7 +286,6 @@ end
|
|
288
286
|
| Name | Type | Description | Notes |
|
289
287
|
| ---- | ---- | ----------- | ----- |
|
290
288
|
| **id** | **String** | | |
|
291
|
-
| **related_resource** | **String** | | |
|
292
289
|
| **list_members_delete_query** | [**ListMembersDeleteQuery**](ListMembersDeleteQuery.md) | | |
|
293
290
|
|
294
291
|
### Return type
|
@@ -404,9 +401,11 @@ end
|
|
404
401
|
api_instance = KlaviyoAPI::ListsApi.new
|
405
402
|
list_id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
406
403
|
opts = {
|
404
|
+
additional_fields_profile: ['predictive_analytics'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
407
405
|
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
408
406
|
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
|
409
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
407
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
408
|
+
page_size: 56 # Integer | The number of results to return per page. Default = 20. Max = 100
|
410
409
|
}
|
411
410
|
|
412
411
|
begin
|
@@ -441,9 +440,11 @@ end
|
|
441
440
|
| Name | Type | Description | Notes |
|
442
441
|
| ---- | ---- | ----------- | ----- |
|
443
442
|
| **list_id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
443
|
+
| **additional_fields_profile** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'predictive_analytics' | [optional] |
|
444
444
|
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
445
445
|
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals` | [optional] |
|
446
446
|
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
447
|
+
| **page_size** | **Integer** | The number of results to return per page. Default = 20. Max = 100 | [optional] |
|
447
448
|
|
448
449
|
### Return type
|
449
450
|
|
@@ -459,11 +460,11 @@ end
|
|
459
460
|
- **Accept**: application/json
|
460
461
|
|
461
462
|
|
462
|
-
##
|
463
|
+
## get_list_relationships_profiles
|
463
464
|
|
464
|
-
> Hash<String, Object>
|
465
|
+
> Hash<String, Object> get_list_relationships_profiles(id, opts)
|
465
466
|
|
466
|
-
Get List Relationships
|
467
|
+
Get List Relationships Profiles
|
467
468
|
|
468
469
|
Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID. You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read` `Profiles Read`
|
469
470
|
|
@@ -482,35 +483,34 @@ end
|
|
482
483
|
|
483
484
|
api_instance = KlaviyoAPI::ListsApi.new
|
484
485
|
id = 'id_example' # String |
|
485
|
-
related_resource = 'profiles' # String |
|
486
486
|
opts = {
|
487
487
|
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
488
488
|
}
|
489
489
|
|
490
490
|
begin
|
491
|
-
# Get List Relationships
|
492
|
-
result = api_instance.
|
491
|
+
# Get List Relationships Profiles
|
492
|
+
result = api_instance.get_list_relationships_profiles(id, opts)
|
493
493
|
p result
|
494
494
|
rescue KlaviyoAPI::ApiError => e
|
495
|
-
puts "Error when calling ListsApi->
|
495
|
+
puts "Error when calling ListsApi->get_list_relationships_profiles: #{e}"
|
496
496
|
end
|
497
497
|
```
|
498
498
|
|
499
|
-
#### Using the
|
499
|
+
#### Using the get_list_relationships_profiles_with_http_info variant
|
500
500
|
|
501
501
|
This returns an Array which contains the response data, status code and headers.
|
502
502
|
|
503
|
-
> <Array(Hash<String, Object>, Integer, Hash)>
|
503
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_list_relationships_profiles_with_http_info(id, opts)
|
504
504
|
|
505
505
|
```ruby
|
506
506
|
begin
|
507
|
-
# Get List Relationships
|
508
|
-
data, status_code, headers = api_instance.
|
507
|
+
# Get List Relationships Profiles
|
508
|
+
data, status_code, headers = api_instance.get_list_relationships_profiles_with_http_info(id, opts)
|
509
509
|
p status_code # => 2xx
|
510
510
|
p headers # => { ... }
|
511
511
|
p data # => Hash<String, Object>
|
512
512
|
rescue KlaviyoAPI::ApiError => e
|
513
|
-
puts "Error when calling ListsApi->
|
513
|
+
puts "Error when calling ListsApi->get_list_relationships_profiles_with_http_info: #{e}"
|
514
514
|
end
|
515
515
|
```
|
516
516
|
|
@@ -519,7 +519,6 @@ end
|
|
519
519
|
| Name | Type | Description | Notes |
|
520
520
|
| ---- | ---- | ----------- | ----- |
|
521
521
|
| **id** | **String** | | |
|
522
|
-
| **related_resource** | **String** | | |
|
523
522
|
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
524
523
|
|
525
524
|
### Return type
|
@@ -536,6 +535,77 @@ end
|
|
536
535
|
- **Accept**: application/json
|
537
536
|
|
538
537
|
|
538
|
+
## get_list_relationships_tags
|
539
|
+
|
540
|
+
> Hash<String, Object> get_list_relationships_tags(id)
|
541
|
+
|
542
|
+
Get List Relationships Tags
|
543
|
+
|
544
|
+
Returns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `List Read` `Tags Read`
|
545
|
+
|
546
|
+
### Examples
|
547
|
+
|
548
|
+
```ruby
|
549
|
+
require 'time'
|
550
|
+
require 'klaviyo-api-sdk'
|
551
|
+
# setup authorization
|
552
|
+
KlaviyoAPI.configure do |config|
|
553
|
+
# Configure API key authorization: Klaviyo-API-Key
|
554
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
555
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
556
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
557
|
+
end
|
558
|
+
|
559
|
+
api_instance = KlaviyoAPI::ListsApi.new
|
560
|
+
id = 'id_example' # String |
|
561
|
+
|
562
|
+
begin
|
563
|
+
# Get List Relationships Tags
|
564
|
+
result = api_instance.get_list_relationships_tags(id)
|
565
|
+
p result
|
566
|
+
rescue KlaviyoAPI::ApiError => e
|
567
|
+
puts "Error when calling ListsApi->get_list_relationships_tags: #{e}"
|
568
|
+
end
|
569
|
+
```
|
570
|
+
|
571
|
+
#### Using the get_list_relationships_tags_with_http_info variant
|
572
|
+
|
573
|
+
This returns an Array which contains the response data, status code and headers.
|
574
|
+
|
575
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_list_relationships_tags_with_http_info(id)
|
576
|
+
|
577
|
+
```ruby
|
578
|
+
begin
|
579
|
+
# Get List Relationships Tags
|
580
|
+
data, status_code, headers = api_instance.get_list_relationships_tags_with_http_info(id)
|
581
|
+
p status_code # => 2xx
|
582
|
+
p headers # => { ... }
|
583
|
+
p data # => Hash<String, Object>
|
584
|
+
rescue KlaviyoAPI::ApiError => e
|
585
|
+
puts "Error when calling ListsApi->get_list_relationships_tags_with_http_info: #{e}"
|
586
|
+
end
|
587
|
+
```
|
588
|
+
|
589
|
+
### Parameters
|
590
|
+
|
591
|
+
| Name | Type | Description | Notes |
|
592
|
+
| ---- | ---- | ----------- | ----- |
|
593
|
+
| **id** | **String** | | |
|
594
|
+
|
595
|
+
### Return type
|
596
|
+
|
597
|
+
**Hash<String, Object>**
|
598
|
+
|
599
|
+
### Authorization
|
600
|
+
|
601
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
602
|
+
|
603
|
+
### HTTP request headers
|
604
|
+
|
605
|
+
- **Content-Type**: Not defined
|
606
|
+
- **Accept**: application/json
|
607
|
+
|
608
|
+
|
539
609
|
## get_list_tags
|
540
610
|
|
541
611
|
> Hash<String, Object> get_list_tags(list_id, opts)
|
@@ -711,7 +781,7 @@ end
|
|
711
781
|
|
712
782
|
api_instance = KlaviyoAPI::ListsApi.new
|
713
783
|
id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
714
|
-
list_partial_update_query = KlaviyoAPI::ListPartialUpdateQuery.new({data: KlaviyoAPI::
|
784
|
+
list_partial_update_query = KlaviyoAPI::ListPartialUpdateQuery.new({data: KlaviyoAPI::ListPartialUpdateQueryResourceObject.new({type: KlaviyoAPI::ListEnum::LIST, id: 'Y6nRLr', attributes: KlaviyoAPI::ListCreateQueryResourceObjectAttributes.new({name: 'Newsletter'})})}) # ListPartialUpdateQuery |
|
715
785
|
|
716
786
|
begin
|
717
787
|
# Update List
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# KlaviyoAPI::MetricAggregateEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'klaviyo-api-sdk'
|
12
|
+
|
13
|
+
instance = KlaviyoAPI::MetricAggregateEnum.new()
|
14
|
+
```
|
15
|
+
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**
|
7
|
+
| **data** | [**MetricAggregateQueryResourceObject**](MetricAggregateQueryResourceObject.md) | | |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# KlaviyoAPI::MetricAggregateQueryResourceObject
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**MetricAggregateEnum**](MetricAggregateEnum.md) | | |
|
8
|
+
| **attributes** | [**MetricAggregateQueryResourceObjectAttributes**](MetricAggregateQueryResourceObjectAttributes.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'klaviyo-api-sdk'
|
14
|
+
|
15
|
+
instance = KlaviyoAPI::MetricAggregateQueryResourceObject.new(
|
16
|
+
type: null,
|
17
|
+
attributes: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# KlaviyoAPI::MetricAggregateQueryResourceObjectAttributes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **metric_id** | **String** | The metric ID used in the aggregation. | |
|
8
|
+
| **page_cursor** | **String** | Optional pagination cursor to iterate over large result sets | [optional] |
|
9
|
+
| **measurements** | **Array<String>** | Measurement key, e.g. `unique`, `sum_value`, `count` | |
|
10
|
+
| **interval** | **String** | Aggregation interval, e.g. \"hour\", \"day\", \"week\", \"month\" | |
|
11
|
+
| **page_size** | **Integer** | Alter the maximum number of returned rows in a single page of aggregation results | [optional][default to 500] |
|
12
|
+
| **by** | **Array<String>** | Optional attribute(s) used for partitioning by the aggregation function | [optional] |
|
13
|
+
| **return_fields** | **Array<String>** | Provide fields to limit the returned data | [optional] |
|
14
|
+
| **filter** | **Array<String>** | List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). These filters follow a similar format to those in `GET` requests, the primary difference is that this endpoint asks for a list. The time range can be filtered by providing a `greater-or-equal` and a `less-than` filter on the `datetime` field. | |
|
15
|
+
| **timezone** | **String** | The timezone used for processing the query, e.g. `'America/New_York'`. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones). While most are supported, a few notable exceptions are `Factory`, `Europe/Kyiv` and `Pacific/Kanton`. This field is case-sensitive. | [optional][default to 'UTC'] |
|
16
|
+
| **sort** | **String** | Provide a sort key (e.g. -$message) | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'klaviyo-api-sdk'
|
22
|
+
|
23
|
+
instance = KlaviyoAPI::MetricAggregateQueryResourceObjectAttributes.new(
|
24
|
+
metric_id: 0rG4eQ,
|
25
|
+
page_cursor: null,
|
26
|
+
measurements: count,
|
27
|
+
interval: day,
|
28
|
+
page_size: 500,
|
29
|
+
by: $message,
|
30
|
+
return_fields: null,
|
31
|
+
filter: ["greater-or-equal(datetime,2022-12-01T00:00:00)","less-than(datetime,2022-12-08T00:00:00"],
|
32
|
+
timezone: America/New_York,
|
33
|
+
sort: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
data/docs/MetricEnum.md
ADDED
data/docs/MetricsApi.md
CHANGED
@@ -183,7 +183,7 @@ KlaviyoAPI.configure do |config|
|
|
183
183
|
end
|
184
184
|
|
185
185
|
api_instance = KlaviyoAPI::MetricsApi.new
|
186
|
-
metric_aggregate_query = KlaviyoAPI::MetricAggregateQuery.new({data: KlaviyoAPI::
|
186
|
+
metric_aggregate_query = KlaviyoAPI::MetricAggregateQuery.new({data: KlaviyoAPI::MetricAggregateQueryResourceObject.new({type: KlaviyoAPI::MetricAggregateEnum::METRIC_AGGREGATE, attributes: KlaviyoAPI::MetricAggregateQueryResourceObjectAttributes.new({metric_id: '0rG4eQ', measurements: count, interval: 'day', filter: ["greater-or-equal(datetime, 2022-12-01T00: 00: 00)", "less-than(datetime, 2022-12-08T00: 00: 00"]})})}) # MetricAggregateQuery | Retrieve Metric Aggregations
|
187
187
|
|
188
188
|
begin
|
189
189
|
# Query Metric Aggregates
|
data/docs/ObjectLinks.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# KlaviyoAPI::ObjectLinks
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_self** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'klaviyo-api-sdk'
|
13
|
+
|
14
|
+
instance = KlaviyoAPI::ObjectLinks.new(
|
15
|
+
_self: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**
|
7
|
+
| **data** | [**OnsiteProfileCreateQueryResourceObject**](OnsiteProfileCreateQueryResourceObject.md) | | |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# KlaviyoAPI::OnsiteProfileCreateQueryResourceObject
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**ProfileEnum**](ProfileEnum.md) | | |
|
8
|
+
| **attributes** | [**OnsiteProfileCreateQueryResourceObjectAttributes**](OnsiteProfileCreateQueryResourceObjectAttributes.md) | | |
|
9
|
+
| **meta** | [**OnsiteProfileMeta**](OnsiteProfileMeta.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'klaviyo-api-sdk'
|
15
|
+
|
16
|
+
instance = KlaviyoAPI::OnsiteProfileCreateQueryResourceObject.new(
|
17
|
+
type: null,
|
18
|
+
attributes: null,
|
19
|
+
meta: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# KlaviyoAPI::OnsiteProfileCreateQueryResourceObjectAttributes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **email** | **String** | Individual's email address | [optional] |
|
8
|
+
| **phone_number** | **String** | Individual's phone number in E.164 format | [optional] |
|
9
|
+
| **external_id** | **String** | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system. | [optional] |
|
10
|
+
| **anonymous_id** | **String** | | [optional] |
|
11
|
+
| **first_name** | **String** | Individual's first name | [optional] |
|
12
|
+
| **last_name** | **String** | Individual's last name | [optional] |
|
13
|
+
| **organization** | **String** | Name of the company or organization within the company for whom the individual works | [optional] |
|
14
|
+
| **title** | **String** | Individual's job title | [optional] |
|
15
|
+
| **image** | **String** | URL pointing to the location of a profile image | [optional] |
|
16
|
+
| **location** | [**ProfileLocation**](ProfileLocation.md) | | [optional] |
|
17
|
+
| **properties** | **Object** | An object containing key/value pairs for any custom properties assigned to this profile | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'klaviyo-api-sdk'
|
23
|
+
|
24
|
+
instance = KlaviyoAPI::OnsiteProfileCreateQueryResourceObjectAttributes.new(
|
25
|
+
email: sarah.mason@klaviyo-demo.com,
|
26
|
+
phone_number: +15005550006,
|
27
|
+
external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
|
28
|
+
anonymous_id: null,
|
29
|
+
first_name: Sarah,
|
30
|
+
last_name: Mason,
|
31
|
+
organization: Klaviyo,
|
32
|
+
title: Engineer,
|
33
|
+
image: https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg,
|
34
|
+
location: null,
|
35
|
+
properties: {"pseudonym":"Dr. Octopus"}
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**
|
7
|
+
| **data** | [**OnsiteSubscriptionCreateQueryResourceObject**](OnsiteSubscriptionCreateQueryResourceObject.md) | | |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# KlaviyoAPI::OnsiteSubscriptionCreateQueryResourceObject
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**SubscriptionEnum**](SubscriptionEnum.md) | | |
|
8
|
+
| **attributes** | [**OnsiteSubscriptionCreateQueryResourceObjectAttributes**](OnsiteSubscriptionCreateQueryResourceObjectAttributes.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'klaviyo-api-sdk'
|
14
|
+
|
15
|
+
instance = KlaviyoAPI::OnsiteSubscriptionCreateQueryResourceObject.new(
|
16
|
+
type: null,
|
17
|
+
attributes: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# KlaviyoAPI::OnsiteSubscriptionCreateQueryResourceObjectAttributes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **list_id** | **String** | The list ID to add the newly subscribed profile to. | |
|
8
|
+
| **custom_source** | **String** | A custom method detail or source to store on the consent records for this subscription. | [optional] |
|
9
|
+
| **email** | **String** | Email address to create subscription and email consent record for. | [optional] |
|
10
|
+
| **phone_number** | **String** | Phone number to create subscription and SMS consent record for, in E.164 format. | [optional] |
|
11
|
+
| **properties** | **Object** | Profile properties to set on the newly subscribed profile. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'klaviyo-api-sdk'
|
17
|
+
|
18
|
+
instance = KlaviyoAPI::OnsiteSubscriptionCreateQueryResourceObjectAttributes.new(
|
19
|
+
list_id: Y6nRLr,
|
20
|
+
custom_source: Homepage footer signup form,
|
21
|
+
email: matt.kemp@klaviyo-demo.com,
|
22
|
+
phone_number: +15005550006,
|
23
|
+
properties: {"first_name":"Matt","last_name":"Kemp","favorite_color":"Blue"}
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# KlaviyoAPI::PredictiveAnalytics
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **historic_clv** | **Float** | Total value of all historically placed orders | [optional] |
|
8
|
+
| **predicted_clv** | **Float** | Predicted value of all placed orders in the next 365 days | [optional] |
|
9
|
+
| **total_clv** | **Float** | Sum of historic and predicted CLV | [optional] |
|
10
|
+
| **historic_number_of_orders** | **Integer** | Number of already placed orders | [optional] |
|
11
|
+
| **predicted_number_of_orders** | **Float** | Predicted number of placed orders in the next 365 days | [optional] |
|
12
|
+
| **average_days_between_orders** | **Float** | Average number of days between orders (None if only one order has been placed) | [optional] |
|
13
|
+
| **average_order_value** | **Float** | Average value of placed orders | [optional] |
|
14
|
+
| **churn_probability** | **Float** | Probability the customer has churned | [optional] |
|
15
|
+
| **expected_date_of_next_order** | **Time** | Expected date of next order, as calculated at the time of their most recent order | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'klaviyo-api-sdk'
|
21
|
+
|
22
|
+
instance = KlaviyoAPI::PredictiveAnalytics.new(
|
23
|
+
historic_clv: 93.87,
|
24
|
+
predicted_clv: 27.24,
|
25
|
+
total_clv: 121.11,
|
26
|
+
historic_number_of_orders: 2,
|
27
|
+
predicted_number_of_orders: 0.54,
|
28
|
+
average_days_between_orders: 189,
|
29
|
+
average_order_value: 46.94,
|
30
|
+
churn_probability: 0.89,
|
31
|
+
expected_date_of_next_order: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# KlaviyoAPI::ProfileAggregateEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'klaviyo-api-sdk'
|
12
|
+
|
13
|
+
instance = KlaviyoAPI::ProfileAggregateEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/ProfileCreateQuery.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**
|
7
|
+
| **data** | [**ProfileCreateQueryResourceObject**](ProfileCreateQueryResourceObject.md) | | |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# KlaviyoAPI::ProfileCreateQueryResourceObject
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**ProfileEnum**](ProfileEnum.md) | | |
|
8
|
+
| **attributes** | [**ProfileCreateQueryResourceObjectAttributes**](ProfileCreateQueryResourceObjectAttributes.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'klaviyo-api-sdk'
|
14
|
+
|
15
|
+
instance = KlaviyoAPI::ProfileCreateQueryResourceObject.new(
|
16
|
+
type: null,
|
17
|
+
attributes: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|