klaviyo-api-sdk 1.1.0 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +507 -170
- data/docs/CampaignCloneQuery.md +1 -1
- data/docs/CampaignCloneQueryResourceObject.md +20 -0
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +20 -0
- data/docs/CampaignCreateQuery.md +1 -1
- data/docs/CampaignCreateQueryResourceObject.md +20 -0
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +28 -0
- data/docs/CampaignEnum.md +15 -0
- data/docs/CampaignMessageAssignTemplateQuery.md +1 -1
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +20 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +20 -0
- data/docs/CampaignMessageEnum.md +15 -0
- data/docs/CampaignMessagePartialUpdateQuery.md +1 -1
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +20 -0
- data/docs/CampaignPartialUpdateQuery.md +1 -1
- data/docs/CampaignPartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +26 -0
- data/docs/CampaignRecipientEstimationEnum.md +15 -0
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignRecipientEstimationJobEnum.md +15 -0
- data/docs/CampaignSendJobCreateQuery.md +1 -1
- data/docs/CampaignSendJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignSendJobEnum.md +15 -0
- data/docs/CampaignSendJobPartialUpdateQuery.md +1 -1
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignsApi.md +1275 -0
- data/docs/CatalogCategoryBulkCreateJobEnum.md +15 -0
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogCategoryCreateJobCreateQuery.md +1 -1
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryCreateQuery.md +1 -1
- data/docs/CatalogCategoryCreateQueryResourceObject.md +22 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +24 -0
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +1 -1
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryEnum.md +15 -0
- data/docs/CatalogCategoryItemOp.md +1 -1
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +1 -1
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryUpdateQuery.md +1 -1
- data/docs/CatalogCategoryUpdateQueryResourceObject.md +24 -0
- data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemBulkCreateJobEnum.md +15 -0
- data/docs/CatalogItemBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogItemBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogItemCategoryOp.md +1 -1
- data/docs/CatalogItemCreateJobCreateQuery.md +1 -1
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemCreateQuery.md +1 -1
- data/docs/CatalogItemCreateQueryResourceObject.md +22 -0
- data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +40 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +18 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQuery.md +1 -1
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogItemEnum.md +15 -0
- data/docs/CatalogItemUpdateJobCreateQuery.md +1 -1
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemUpdateQuery.md +1 -1
- data/docs/CatalogItemUpdateQueryResourceObject.md +24 -0
- data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +34 -0
- data/docs/CatalogJobErrorPayload.md +8 -8
- data/docs/CatalogVariantBulkCreateJobEnum.md +15 -0
- data/docs/CatalogVariantBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogVariantBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogVariantCreateJobCreateQuery.md +1 -1
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantCreateQuery.md +1 -1
- data/docs/CatalogVariantCreateQueryResourceObject.md +22 -0
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +46 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItems.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQuery.md +1 -1
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogVariantEnum.md +15 -0
- data/docs/CatalogVariantUpdateJobCreateQuery.md +1 -1
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantUpdateQuery.md +1 -1
- data/docs/CatalogVariantUpdateQueryResourceObject.md +22 -0
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +40 -0
- data/docs/CatalogsApi.md +340 -356
- data/docs/ClientApi.md +3 -3
- data/docs/CollectionLinks.md +26 -0
- data/docs/DataPrivacyApi.md +1 -1
- data/docs/DataPrivacyCreateDeletionJobQuery.md +1 -1
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +20 -0
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +22 -0
- data/docs/DataPrivacyDeletionJobEnum.md +15 -0
- data/docs/EmailChannel.md +18 -0
- data/docs/EmailMarketing.md +32 -0
- data/docs/EmailMarketingListSuppression.md +22 -0
- data/docs/EmailMarketingSuppression.md +20 -0
- data/docs/ErrorSource.md +1 -1
- data/docs/EventCreateQuery.md +1 -1
- data/docs/EventCreateQueryResourceObject.md +20 -0
- data/docs/EventCreateQueryResourceObjectAttributes.md +28 -0
- data/docs/EventEnum.md +15 -0
- data/docs/EventsApi.md +114 -42
- data/docs/FlowActionEnum.md +15 -0
- data/docs/FlowEnum.md +15 -0
- data/docs/FlowMessageEnum.md +15 -0
- data/docs/FlowUpdateQuery.md +1 -1
- data/docs/FlowUpdateQueryResourceObject.md +22 -0
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/FlowsApi.md +254 -102
- data/docs/GetCampaigns4XXResponse.md +18 -0
- data/docs/GetCampaigns4XXResponseErrorsInner.md +26 -0
- data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +20 -0
- data/docs/ListCreateQuery.md +1 -1
- data/docs/ListCreateQueryResourceObject.md +20 -0
- data/docs/ListCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/ListEnum.md +15 -0
- data/docs/ListPartialUpdateQuery.md +1 -1
- data/docs/ListPartialUpdateQueryResourceObject.md +22 -0
- data/docs/ListsApi.md +135 -65
- data/docs/MetricAggregateEnum.md +15 -0
- data/docs/MetricAggregateQuery.md +1 -1
- data/docs/MetricAggregateQueryResourceObject.md +20 -0
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +36 -0
- data/docs/MetricEnum.md +15 -0
- data/docs/MetricsApi.md +10 -10
- data/docs/ObjectLinks.md +18 -0
- data/docs/OnsiteProfileCreateQuery.md +1 -1
- data/docs/OnsiteProfileCreateQueryResourceObject.md +22 -0
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +38 -0
- data/docs/OnsiteProfileMetaIdentifiers.md +10 -10
- data/docs/OnsiteSubscriptionCreateQuery.md +1 -1
- data/docs/OnsiteSubscriptionCreateQueryResourceObject.md +20 -0
- data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md +26 -0
- data/docs/PredictiveAnalytics.md +34 -0
- data/docs/ProfileAggregateEnum.md +15 -0
- data/docs/ProfileCreateQuery.md +1 -1
- data/docs/ProfileCreateQueryResourceObject.md +20 -0
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +36 -0
- data/docs/ProfileEnum.md +15 -0
- data/docs/ProfileLocation.md +15 -15
- data/docs/ProfileLocationLongitude.md +49 -0
- data/docs/ProfilePartialUpdateQuery.md +1 -1
- data/docs/ProfilePartialUpdateQueryResourceObject.md +22 -0
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileUnsubscriptionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileUnsuppressionBulkCreateJobEnum.md +15 -0
- data/docs/ProfilesApi.md +140 -56
- data/docs/SMSChannel.md +18 -0
- data/docs/SMSMarketing.md +24 -0
- data/docs/STOScheduleOptions.md +18 -0
- data/docs/SegmentEnum.md +15 -0
- data/docs/SegmentPartialUpdateQuery.md +1 -1
- data/docs/SegmentPartialUpdateQueryResourceObject.md +22 -0
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/SegmentsApi.md +107 -33
- data/docs/SendOptionsSubObject.md +1 -3
- data/docs/SendStrategySubObject.md +4 -2
- data/docs/Subscription.md +8 -4
- data/docs/SubscriptionChannels.md +20 -0
- data/docs/SubscriptionCreateJobCreateQuery.md +1 -1
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +22 -0
- data/docs/SubscriptionEnum.md +15 -0
- data/docs/Subscriptions.md +20 -0
- data/docs/Suppression.md +1 -1
- data/docs/SuppressionCreateJobCreateQuery.md +1 -1
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/TagCampaignOp.md +18 -0
- data/docs/TagCampaignOpDataInner.md +20 -0
- data/docs/TagCreateQuery.md +1 -1
- data/docs/TagCreateQueryResourceObject.md +20 -0
- data/docs/TagCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagEnum.md +15 -0
- data/docs/TagFlowOp.md +18 -0
- data/docs/TagFlowOpDataInner.md +20 -0
- data/docs/TagGroupCreateQuery.md +1 -1
- data/docs/TagGroupCreateQueryResourceObject.md +20 -0
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagGroupEnum.md +15 -0
- data/docs/TagGroupUpdateQuery.md +1 -1
- data/docs/TagGroupUpdateQueryResourceObject.md +22 -0
- data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagListOp.md +18 -0
- data/docs/TagListOpDataInner.md +20 -0
- data/docs/TagUpdateQuery.md +1 -1
- data/docs/TagUpdateQueryResourceObject.md +22 -0
- data/docs/TagUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/TagsApi.md +894 -176
- data/docs/TemplateCloneQuery.md +1 -1
- data/docs/TemplateCloneQueryResourceObject.md +20 -0
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +22 -0
- data/docs/TemplateCreateQuery.md +1 -1
- data/docs/TemplateCreateQueryResourceObject.md +20 -0
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +32 -0
- data/docs/TemplateEnum.md +15 -0
- data/docs/TemplateRenderQuery.md +1 -1
- data/docs/TemplateRenderQueryResourceObject.md +20 -0
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +22 -0
- data/docs/TemplateUpdateQuery.md +1 -1
- data/docs/TemplateUpdateQueryResourceObject.md +22 -0
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +30 -0
- data/docs/TemplatesApi.md +15 -15
- data/docs/TestApiAnalyticsSampleEnum.md +15 -0
- data/docs/TestListEnum.md +15 -0
- data/docs/ThrottledScheduleOptions.md +1 -1
- data/docs/UnsubscriptionCreateJobCreateQuery.md +1 -1
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.md +22 -0
- data/docs/UnsuppressionCreateJobCreateQuery.md +1 -1
- data/docs/UnsuppressionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/UnsuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +1269 -0
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +385 -473
- data/lib/klaviyo-api-sdk/api/client_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/events_api.rb +118 -57
- data/lib/klaviyo-api-sdk/api/flows_api.rb +256 -137
- data/lib/klaviyo-api-sdk/api/lists_api.rb +138 -96
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +153 -68
- data/lib/klaviyo-api-sdk/api/segments_api.rb +110 -46
- data/lib/klaviyo-api-sdk/api/tags_api.rb +831 -159
- data/lib/klaviyo-api-sdk/api/templates_api.rb +20 -20
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +291 -0
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +256 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +296 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +262 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +220 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +390 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +262 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +302 -0
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +5 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +447 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_items.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_items_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +366 -0
- data/lib/klaviyo-api-sdk/models/collection_links.rb +260 -0
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/email_channel.rb +219 -0
- data/lib/klaviyo-api-sdk/models/email_marketing.rb +298 -0
- data/lib/klaviyo-api-sdk/models/email_marketing_list_suppression.rb +255 -0
- data/lib/klaviyo-api-sdk/models/email_marketing_suppression.rb +240 -0
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/error_source.rb +2 -1
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object_attributes.rb +284 -0
- data/lib/klaviyo-api-sdk/models/event_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_action_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response.rb +226 -0
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner.rb +275 -0
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner_source.rb +228 -0
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/list_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +388 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/object_links.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +318 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +16 -11
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object_attributes.rb +265 -0
- data/lib/klaviyo-api-sdk/models/predictive_analytics.rb +300 -0
- data/lib/klaviyo-api-sdk/models/profile_aggregate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +309 -0
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_location.rb +9 -2
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/send_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +5 -15
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +15 -6
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_channel.rb +219 -0
- data/lib/klaviyo-api-sdk/models/sms_marketing.rb +270 -0
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +225 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +26 -5
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/subscription_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/subscriptions.rb +228 -0
- data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +234 -0
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +236 -0
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.rb +225 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +247 -0
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +252 -0
- data/lib/klaviyo-api-sdk/models/test_api_analytics_sample_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/test_list_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object_attributes.rb +244 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object_attributes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +1 -1
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +162 -123
- data/spec/api/campaigns_api_spec.rb +255 -0
- data/spec/api/catalogs_api_spec.rb +162 -170
- data/spec/api/client_api_spec.rb +3 -3
- data/spec/api/data_privacy_api_spec.rb +1 -1
- data/spec/api/events_api_spec.rb +33 -21
- data/spec/api/flows_api_spec.rb +76 -49
- data/spec/api/lists_api_spec.rb +38 -27
- data/spec/api/metrics_api_spec.rb +8 -8
- data/spec/api/profiles_api_spec.rb +41 -25
- data/spec/api/segments_api_spec.rb +30 -17
- data/spec/api/tags_api_spec.rb +155 -33
- data/spec/api/templates_api_spec.rb +12 -14
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/audiences_sub_object_spec.rb +1 -1
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/campaign_clone_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_clone_query_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +64 -0
- data/spec/models/campaign_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_create_query_spec.rb +1 -1
- data/spec/models/campaign_enum_spec.rb +28 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_spec.rb +1 -1
- data/spec/models/campaign_message_enum_spec.rb +28 -0
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_message_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +58 -0
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_enum_spec.rb +28 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +28 -0
- data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_send_job_create_query_spec.rb +1 -1
- data/spec/models/campaign_send_job_enum_spec.rb +28 -0
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +56 -0
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_category_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_enum_spec.rb +28 -0
- data/spec/models/catalog_category_item_op_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +52 -0
- data/spec/models/catalog_category_update_query_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_category_op_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +44 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_item_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_enum_spec.rb +28 -0
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +82 -0
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +52 -0
- data/spec/models/catalog_item_update_query_spec.rb +1 -1
- data/spec/models/catalog_job_error_payload_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +126 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_data_inner_spec.rb +44 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_variant_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_variant_update_query_spec.rb +1 -1
- data/spec/models/collection_links_spec.rb +58 -0
- data/spec/models/content_sub_object_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +40 -0
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +1 -1
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +28 -0
- data/spec/models/email_channel_spec.rb +34 -0
- data/spec/models/email_marketing_list_suppression_spec.rb +46 -0
- data/spec/models/email_marketing_spec.rb +76 -0
- data/spec/models/email_marketing_suppression_spec.rb +40 -0
- data/spec/models/email_message_content_spec.rb +1 -1
- data/spec/models/email_tracking_options_spec.rb +1 -1
- data/spec/models/error_source_spec.rb +1 -1
- data/spec/models/event_create_query_resource_object_attributes_spec.rb +64 -0
- data/spec/models/event_create_query_resource_object_spec.rb +40 -0
- data/spec/models/event_create_query_spec.rb +1 -1
- data/spec/models/event_enum_spec.rb +28 -0
- data/spec/models/flow_action_enum_spec.rb +28 -0
- data/spec/models/flow_enum_spec.rb +28 -0
- data/spec/models/flow_message_enum_spec.rb +28 -0
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/flow_update_query_resource_object_spec.rb +46 -0
- data/spec/models/flow_update_query_spec.rb +1 -1
- data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +40 -0
- data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +58 -0
- data/spec/models/get_campaigns4_xx_response_spec.rb +34 -0
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/list_create_query_resource_object_spec.rb +40 -0
- data/spec/models/list_create_query_spec.rb +1 -1
- data/spec/models/list_enum_spec.rb +28 -0
- data/spec/models/list_members_add_query_data_inner_spec.rb +1 -1
- data/spec/models/list_members_add_query_spec.rb +1 -1
- data/spec/models/list_members_delete_query_spec.rb +1 -1
- data/spec/models/list_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/list_partial_update_query_spec.rb +1 -1
- data/spec/models/metric_aggregate_enum_spec.rb +28 -0
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +40 -0
- data/spec/models/metric_aggregate_query_spec.rb +1 -1
- data/spec/models/metric_aggregate_row_dto_spec.rb +1 -1
- data/spec/models/metric_create_query_spec.rb +1 -1
- data/spec/models/metric_enum_spec.rb +28 -0
- data/spec/models/object_links_spec.rb +34 -0
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +94 -0
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +46 -0
- data/spec/models/onsite_profile_create_query_spec.rb +1 -1
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +4 -4
- data/spec/models/onsite_profile_meta_spec.rb +1 -1
- data/spec/models/onsite_subscription_create_query_resource_object_attributes_spec.rb +58 -0
- data/spec/models/onsite_subscription_create_query_resource_object_spec.rb +40 -0
- data/spec/models/onsite_subscription_create_query_spec.rb +1 -1
- data/spec/models/predictive_analytics_spec.rb +82 -0
- data/spec/models/profile_aggregate_enum_spec.rb +28 -0
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +88 -0
- data/spec/models/profile_create_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_create_query_spec.rb +1 -1
- data/spec/models/profile_enum_spec.rb +28 -0
- data/spec/models/profile_location_latitude_spec.rb +1 -1
- data/spec/models/profile_location_longitude_spec.rb +31 -0
- data/spec/models/profile_location_spec.rb +1 -1
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/profile_partial_update_query_spec.rb +1 -1
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_unsubscription_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_unsuppression_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/segment_enum_spec.rb +28 -0
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/segment_partial_update_query_spec.rb +1 -1
- data/spec/models/send_options_spec.rb +1 -1
- data/spec/models/send_options_sub_object_spec.rb +1 -7
- data/spec/models/send_strategy_sub_object_spec.rb +7 -1
- data/spec/models/send_time_sub_object_spec.rb +1 -1
- data/spec/models/sms_channel_spec.rb +34 -0
- data/spec/models/sms_marketing_spec.rb +52 -0
- data/spec/models/sms_message_content_spec.rb +1 -1
- data/spec/models/sms_render_options_spec.rb +1 -1
- data/spec/models/sms_tracking_options_spec.rb +1 -1
- data/spec/models/static_schedule_options_spec.rb +1 -1
- data/spec/models/sto_schedule_options_spec.rb +34 -0
- data/spec/models/subscription_channels_spec.rb +48 -0
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_spec.rb +1 -1
- data/spec/models/subscription_enum_spec.rb +28 -0
- data/spec/models/subscription_spec.rb +13 -1
- data/spec/models/subscriptions_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_spec.rb +1 -1
- data/spec/models/suppression_spec.rb +1 -1
- data/spec/models/tag_campaign_op_data_inner_spec.rb +44 -0
- data/spec/models/tag_campaign_op_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_create_query_resource_object_spec.rb +40 -0
- data/spec/models/tag_create_query_spec.rb +1 -1
- data/spec/models/tag_enum_spec.rb +28 -0
- data/spec/models/tag_flow_op_data_inner_spec.rb +44 -0
- data/spec/models/tag_flow_op_spec.rb +34 -0
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_group_create_query_resource_object_spec.rb +40 -0
- data/spec/models/tag_group_create_query_spec.rb +1 -1
- data/spec/models/tag_group_enum_spec.rb +28 -0
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_group_update_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_group_update_query_spec.rb +1 -1
- data/spec/models/tag_list_op_data_inner_spec.rb +44 -0
- data/spec/models/tag_list_op_spec.rb +34 -0
- data/spec/models/tag_segment_op_data_inner_spec.rb +1 -1
- data/spec/models/tag_segment_op_spec.rb +1 -1
- data/spec/models/tag_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/tag_update_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_update_query_spec.rb +1 -1
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/template_clone_query_resource_object_spec.rb +40 -0
- data/spec/models/template_clone_query_spec.rb +1 -1
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +58 -0
- data/spec/models/template_create_query_resource_object_spec.rb +40 -0
- data/spec/models/template_create_query_spec.rb +1 -1
- data/spec/models/template_enum_spec.rb +28 -0
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/template_render_query_resource_object_spec.rb +40 -0
- data/spec/models/template_render_query_spec.rb +1 -1
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +52 -0
- data/spec/models/template_update_query_resource_object_spec.rb +46 -0
- data/spec/models/template_update_query_spec.rb +1 -1
- data/spec/models/test_api_analytics_sample_enum_spec.rb +28 -0
- data/spec/models/test_list_enum_spec.rb +28 -0
- data/spec/models/throttled_schedule_options_spec.rb +1 -1
- data/spec/models/tracking_options_sub_object_spec.rb +1 -1
- data/spec/models/unsubscription_create_job_create_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/unsubscription_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/unsubscription_create_job_create_query_spec.rb +1 -1
- data/spec/models/unsuppression_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/unsuppression_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/unsuppression_create_job_create_query_spec.rb +1 -1
- data/spec/models/utm_param_info_spec.rb +1 -1
- data/spec/models/utm_params_sub_object_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +487 -370
- data/CHANGELOG.md +0 -31
- data/docs/CampaignCloneQueryAsSubResource.md +0 -20
- data/docs/CampaignCloneQueryAsSubResourceAttributes.md +0 -20
- data/docs/CampaignCreateQueryAsSubResource.md +0 -20
- data/docs/CampaignCreateQueryAsSubResourceAttributes.md +0 -28
- data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +0 -20
- data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +0 -20
- data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +0 -22
- data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +0 -20
- data/docs/CampaignPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +0 -26
- data/docs/CampaignSendJobCreateQueryAsSubResource.md +0 -20
- data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryCreateQueryAsSubResource.md +0 -22
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +0 -24
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +0 -24
- data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemCreateQueryAsSubResource.md +0 -22
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +0 -38
- data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md +0 -18
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md +0 -18
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemDeleteQueryAsSubResource.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogItemUpdateQueryAsSubResource.md +0 -24
- data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +0 -32
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogVariantCreateQueryAsSubResource.md +0 -22
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +0 -46
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md +0 -18
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md +0 -18
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +0 -22
- data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +0 -38
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +0 -20
- data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +0 -22
- data/docs/EventCreateQueryAsSubResource.md +0 -20
- data/docs/EventCreateQueryAsSubResourceAttributes.md +0 -28
- data/docs/FlowUpdateQueryAsSubResource.md +0 -22
- data/docs/FlowUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/GetCatalogItems4XXResponse.md +0 -18
- data/docs/GetCatalogItems4XXResponseErrorsInner.md +0 -26
- data/docs/GetCatalogItems4XXResponseErrorsInnerSource.md +0 -20
- data/docs/IncludedCategories.md +0 -24
- data/docs/IncludedCategoriesAttributes.md +0 -22
- data/docs/IncludedFlowAction.md +0 -24
- data/docs/IncludedFlowActions.md +0 -24
- data/docs/IncludedFlowActionsAttributes.md +0 -32
- data/docs/IncludedFlowActionsAttributesTrackingOptions.md +0 -49
- data/docs/IncludedFlowMessages.md +0 -24
- data/docs/IncludedFlowMessagesAttributes.md +0 -26
- data/docs/IncludedFlowMessagesAttributesContent.md +0 -49
- data/docs/IncludedFlows.md +0 -24
- data/docs/IncludedFlowsAttributes.md +0 -28
- data/docs/IncludedItems.md +0 -24
- data/docs/IncludedItemsAttributes.md +0 -38
- data/docs/IncludedLists.md +0 -24
- data/docs/IncludedListsAttributes.md +0 -22
- data/docs/IncludedMetrics.md +0 -24
- data/docs/IncludedMetricsAttributes.md +0 -24
- data/docs/IncludedProfiles.md +0 -24
- data/docs/IncludedProfilesAttributes.md +0 -44
- data/docs/IncludedSegments.md +0 -24
- data/docs/IncludedVariants.md +0 -24
- data/docs/IncludedVariantsAttributes.md +0 -46
- data/docs/IncludedVariantsLinks.md +0 -18
- data/docs/ListCreateQueryAsSubResource.md +0 -20
- data/docs/ListCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/ListPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/MetricAggregateQueryAsSubResource.md +0 -20
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +0 -36
- data/docs/OnsiteProfileCreateQueryAsSubResource.md +0 -22
- data/docs/OnsiteSubscriptionCreateQueryAsSubResource.md +0 -20
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +0 -26
- data/docs/ProfileCreateQueryAsSubResource.md +0 -20
- data/docs/ProfileCreateQueryAsSubResourceAttributes.md +0 -38
- data/docs/ProfilePartialUpdateQueryAsSubResource.md +0 -22
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +0 -22
- data/docs/SubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
- data/docs/SuppressionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/TagCreateQueryAsSubResource.md +0 -20
- data/docs/TagCreateQueryAsSubResourceAttributes.md +0 -20
- data/docs/TagGroupCreateQueryAsSubResource.md +0 -20
- data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +0 -20
- data/docs/TagGroupUpdateQueryAsSubResource.md +0 -22
- data/docs/TagGroupUpdateQueryAsSubResourceAttributes.md +0 -20
- data/docs/TagUpdateQueryAsSubResource.md +0 -22
- data/docs/TagUpdateQueryAsSubResourceAttributes.md +0 -18
- data/docs/TemplateCloneQueryAsSubResource.md +0 -22
- data/docs/TemplateCloneQueryAsSubResourceAttributes.md +0 -22
- data/docs/TemplateCreateQueryAsSubResource.md +0 -20
- data/docs/TemplateCreateQueryAsSubResourceAttributes.md +0 -32
- data/docs/TemplateRenderQueryAsSubResource.md +0 -20
- data/docs/TemplateRenderQueryAsSubResourceAttributes.md +0 -22
- data/docs/TemplateUpdateQueryAsSubResource.md +0 -22
- data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +0 -30
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +0 -20
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
- data/docs/V2TemplateRenderQueryAsSubResource.md +0 -18
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +0 -235
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +0 -291
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +0 -229
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +0 -256
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +0 -225
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +0 -225
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +0 -293
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +0 -273
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +0 -296
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +0 -219
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +0 -370
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +0 -219
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +0 -273
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +0 -296
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +0 -284
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +0 -439
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +0 -219
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +0 -273
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +0 -226
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +0 -346
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +0 -240
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +0 -284
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +0 -224
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +0 -226
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +0 -275
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +0 -228
- data/lib/klaviyo-api-sdk/models/included_categories.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +0 -237
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +0 -282
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +0 -105
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +0 -270
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +0 -105
- data/lib/klaviyo-api-sdk/models/included_flows.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +0 -264
- data/lib/klaviyo-api-sdk/models/included_items.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +0 -311
- data/lib/klaviyo-api-sdk/models/included_lists.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +0 -237
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +0 -301
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +0 -250
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +0 -336
- data/lib/klaviyo-api-sdk/models/included_segments.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_variants.rb +0 -300
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +0 -382
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +0 -224
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +0 -224
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +0 -386
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +0 -281
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +0 -265
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +0 -309
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +0 -286
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +0 -252
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +0 -235
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +0 -234
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource_attributes.rb +0 -236
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +0 -225
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +0 -283
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +0 -247
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +0 -252
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +0 -287
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +0 -252
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +0 -244
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +0 -272
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +0 -227
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +0 -221
- data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +0 -64
- data/spec/models/campaign_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +0 -58
- data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +0 -56
- data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +0 -56
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +0 -98
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +0 -76
- data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +0 -56
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +0 -126
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +0 -98
- data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +0 -64
- data/spec/models/event_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/flow_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +0 -40
- data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +0 -58
- data/spec/models/get_catalog_items4_xx_response_spec.rb +0 -34
- data/spec/models/included_categories_attributes_spec.rb +0 -46
- data/spec/models/included_categories_spec.rb +0 -56
- data/spec/models/included_flow_action_spec.rb +0 -56
- data/spec/models/included_flow_actions_attributes_spec.rb +0 -76
- data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +0 -31
- data/spec/models/included_flow_actions_spec.rb +0 -56
- data/spec/models/included_flow_messages_attributes_content_spec.rb +0 -31
- data/spec/models/included_flow_messages_attributes_spec.rb +0 -58
- data/spec/models/included_flow_messages_spec.rb +0 -56
- data/spec/models/included_flows_attributes_spec.rb +0 -64
- data/spec/models/included_flows_spec.rb +0 -56
- data/spec/models/included_items_attributes_spec.rb +0 -94
- data/spec/models/included_items_spec.rb +0 -56
- data/spec/models/included_lists_attributes_spec.rb +0 -46
- data/spec/models/included_lists_spec.rb +0 -56
- data/spec/models/included_metrics_attributes_spec.rb +0 -52
- data/spec/models/included_metrics_spec.rb +0 -56
- data/spec/models/included_profiles_attributes_spec.rb +0 -112
- data/spec/models/included_profiles_spec.rb +0 -56
- data/spec/models/included_segments_spec.rb +0 -56
- data/spec/models/included_variants_attributes_spec.rb +0 -122
- data/spec/models/included_variants_links_spec.rb +0 -34
- data/spec/models/included_variants_spec.rb +0 -56
- data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/list_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +0 -104
- data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +0 -58
- data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +0 -94
- data/spec/models/profile_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/tag_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/tag_group_update_query_as_sub_resource_attributes_spec.rb +0 -40
- data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/tag_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/template_clone_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +0 -58
- data/spec/models/template_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/template_render_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +0 -52
- data/spec/models/template_update_query_as_sub_resource_spec.rb +0 -50
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
- data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +0 -34
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2023-
|
6
|
+
The version of the OpenAPI document: 2023-02-22
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -23,6 +23,7 @@ module KlaviyoAPI
|
|
23
23
|
# Create a new profile. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Write`
|
24
24
|
# @param profile_create_query [ProfileCreateQuery]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
26
27
|
# @return [Hash<String, Object>]
|
27
28
|
def create_profile(profile_create_query, opts = {})
|
28
29
|
data, _status_code, _headers = create_profile_with_http_info(profile_create_query, opts)
|
@@ -33,6 +34,7 @@ module KlaviyoAPI
|
|
33
34
|
# Create a new profile. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Write`
|
34
35
|
# @param profile_create_query [ProfileCreateQuery]
|
35
36
|
# @param [Hash] opts the optional parameters
|
37
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
36
38
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
37
39
|
def create_profile_with_http_info(profile_create_query, opts = {})
|
38
40
|
if @api_client.config.debugging
|
@@ -42,16 +44,21 @@ module KlaviyoAPI
|
|
42
44
|
if @api_client.config.client_side_validation && profile_create_query.nil?
|
43
45
|
fail ArgumentError, "Missing the required parameter 'profile_create_query' when calling ProfilesApi.create_profile"
|
44
46
|
end
|
47
|
+
allowable_values = ["predictive_analytics"]
|
48
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
49
|
+
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
50
|
+
end
|
45
51
|
# resource path
|
46
52
|
local_var_path = '/api/profiles/'
|
47
53
|
|
48
54
|
# query parameters
|
49
55
|
query_params = opts[:query_params] || {}
|
56
|
+
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
50
57
|
|
51
58
|
# header parameters
|
52
59
|
header_params = opts[:header_params] || {}
|
53
60
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
61
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
55
62
|
# HTTP header 'Accept' (if needed)
|
56
63
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
64
|
# HTTP header 'Content-Type'
|
@@ -90,13 +97,14 @@ module KlaviyoAPI
|
|
90
97
|
end
|
91
98
|
|
92
99
|
# Get Profile
|
93
|
-
# Get the profile with the given profile ID. Include parameters can be provided to get the following related resource data: `lists` memberships, `segments` memberships\"<br><br>*Rate limits*:<br>Burst: `
|
100
|
+
# Get the profile with the given profile ID. Include parameters can be provided to get the following related resource data: `lists` memberships, `segments` memberships\"<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Read`
|
94
101
|
# @param id [String]
|
95
102
|
# @param [Hash] opts the optional parameters
|
96
|
-
# @option opts [Array<String>] :
|
97
|
-
# @option opts [Array<String>] :
|
98
|
-
# @option opts [Array<String>] :
|
99
|
-
# @option opts [Array<String>] :
|
103
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
104
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
105
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
106
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
107
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
100
108
|
# @return [Hash<String, Object>]
|
101
109
|
def get_profile(id, opts = {})
|
102
110
|
data, _status_code, _headers = get_profile_with_http_info(id, opts)
|
@@ -104,13 +112,14 @@ module KlaviyoAPI
|
|
104
112
|
end
|
105
113
|
|
106
114
|
# Get Profile
|
107
|
-
# Get the profile with the given profile ID. Include parameters can be provided to get the following related resource data: `lists` memberships, `segments` memberships\"<br><br>*Rate limits*:<br>Burst: `
|
115
|
+
# Get the profile with the given profile ID. Include parameters can be provided to get the following related resource data: `lists` memberships, `segments` memberships\"<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Read`
|
108
116
|
# @param id [String]
|
109
117
|
# @param [Hash] opts the optional parameters
|
110
|
-
# @option opts [Array<String>] :
|
111
|
-
# @option opts [Array<String>] :
|
112
|
-
# @option opts [Array<String>] :
|
113
|
-
# @option opts [Array<String>] :
|
118
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
119
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
120
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
121
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
122
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
|
114
123
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
115
124
|
def get_profile_with_http_info(id, opts = {})
|
116
125
|
if @api_client.config.debugging
|
@@ -120,11 +129,15 @@ module KlaviyoAPI
|
|
120
129
|
if @api_client.config.client_side_validation && id.nil?
|
121
130
|
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile"
|
122
131
|
end
|
132
|
+
allowable_values = ["predictive_analytics"]
|
133
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
134
|
+
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
135
|
+
end
|
123
136
|
allowable_values = ["name", "created", "updated"]
|
124
137
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
125
138
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
126
139
|
end
|
127
|
-
allowable_values = ["email", "phone_number", "external_id", "
|
140
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.suppressions.reason", "subscriptions.email.marketing.suppressions.timestamp", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.list_suppressions.list_id", "subscriptions.email.marketing.list_suppressions.reason", "subscriptions.email.marketing.list_suppressions.timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
128
141
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
129
142
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
130
143
|
end
|
@@ -141,6 +154,7 @@ module KlaviyoAPI
|
|
141
154
|
|
142
155
|
# query parameters
|
143
156
|
query_params = opts[:query_params] || {}
|
157
|
+
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
144
158
|
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
145
159
|
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
146
160
|
query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
|
@@ -149,7 +163,7 @@ module KlaviyoAPI
|
|
149
163
|
# header parameters
|
150
164
|
header_params = opts[:header_params] || {}
|
151
165
|
# klaviyo api revision
|
152
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
166
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
153
167
|
# HTTP header 'Accept' (if needed)
|
154
168
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
155
169
|
|
@@ -186,7 +200,7 @@ module KlaviyoAPI
|
|
186
200
|
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `List Read` `Profiles Read`
|
187
201
|
# @param profile_id [String]
|
188
202
|
# @param [Hash] opts the optional parameters
|
189
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
203
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
190
204
|
# @return [Hash<String, Object>]
|
191
205
|
def get_profile_lists(profile_id, opts = {})
|
192
206
|
data, _status_code, _headers = get_profile_lists_with_http_info(profile_id, opts)
|
@@ -197,7 +211,7 @@ module KlaviyoAPI
|
|
197
211
|
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `List Read` `Profiles Read`
|
198
212
|
# @param profile_id [String]
|
199
213
|
# @param [Hash] opts the optional parameters
|
200
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
214
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
201
215
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
202
216
|
def get_profile_lists_with_http_info(profile_id, opts = {})
|
203
217
|
if @api_client.config.debugging
|
@@ -221,7 +235,7 @@ module KlaviyoAPI
|
|
221
235
|
# header parameters
|
222
236
|
header_params = opts[:header_params] || {}
|
223
237
|
# klaviyo api revision
|
224
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
238
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
225
239
|
# HTTP header 'Accept' (if needed)
|
226
240
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
227
241
|
|
@@ -254,42 +268,96 @@ module KlaviyoAPI
|
|
254
268
|
return data, status_code, headers
|
255
269
|
end
|
256
270
|
|
257
|
-
# Get Profile Relationships
|
258
|
-
# Get list
|
271
|
+
# Get Profile Relationships Lists
|
272
|
+
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `List Read` `Profiles Read`
|
259
273
|
# @param id [String]
|
260
|
-
# @param related_resource [String]
|
261
274
|
# @param [Hash] opts the optional parameters
|
262
275
|
# @return [Hash<String, Object>]
|
263
|
-
def
|
264
|
-
data, _status_code, _headers =
|
276
|
+
def get_profile_relationships_lists(id, opts = {})
|
277
|
+
data, _status_code, _headers = get_profile_relationships_lists_with_http_info(id, opts)
|
265
278
|
data
|
266
279
|
end
|
267
280
|
|
268
|
-
# Get Profile Relationships
|
269
|
-
# Get list
|
281
|
+
# Get Profile Relationships Lists
|
282
|
+
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `List Read` `Profiles Read`
|
270
283
|
# @param id [String]
|
271
|
-
# @param related_resource [String]
|
272
284
|
# @param [Hash] opts the optional parameters
|
273
285
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
274
|
-
def
|
286
|
+
def get_profile_relationships_lists_with_http_info(id, opts = {})
|
275
287
|
if @api_client.config.debugging
|
276
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
288
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_relationships_lists ...'
|
277
289
|
end
|
278
290
|
# verify the required parameter 'id' is set
|
279
291
|
if @api_client.config.client_side_validation && id.nil?
|
280
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.
|
292
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_relationships_lists"
|
281
293
|
end
|
282
|
-
#
|
283
|
-
|
284
|
-
|
294
|
+
# resource path
|
295
|
+
local_var_path = '/api/profiles/{id}/relationships/lists/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
296
|
+
|
297
|
+
# query parameters
|
298
|
+
query_params = opts[:query_params] || {}
|
299
|
+
|
300
|
+
# header parameters
|
301
|
+
header_params = opts[:header_params] || {}
|
302
|
+
# klaviyo api revision
|
303
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
304
|
+
# HTTP header 'Accept' (if needed)
|
305
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
306
|
+
|
307
|
+
# form parameters
|
308
|
+
form_params = opts[:form_params] || {}
|
309
|
+
|
310
|
+
# http body (model)
|
311
|
+
post_body = opts[:debug_body]
|
312
|
+
|
313
|
+
# return_type
|
314
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
315
|
+
|
316
|
+
# auth_names
|
317
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
318
|
+
|
319
|
+
new_options = opts.merge(
|
320
|
+
:operation => :"ProfilesApi.get_profile_relationships_lists",
|
321
|
+
:header_params => header_params,
|
322
|
+
:query_params => query_params,
|
323
|
+
:form_params => form_params,
|
324
|
+
:body => post_body,
|
325
|
+
:auth_names => auth_names,
|
326
|
+
:return_type => return_type
|
327
|
+
)
|
328
|
+
|
329
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
330
|
+
if @api_client.config.debugging
|
331
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_profile_relationships_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
285
332
|
end
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
333
|
+
return data, status_code, headers
|
334
|
+
end
|
335
|
+
|
336
|
+
# Get Profile Relationships Segments
|
337
|
+
# Get segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read` `Segments Read`
|
338
|
+
# @param id [String]
|
339
|
+
# @param [Hash] opts the optional parameters
|
340
|
+
# @return [Hash<String, Object>]
|
341
|
+
def get_profile_relationships_segments(id, opts = {})
|
342
|
+
data, _status_code, _headers = get_profile_relationships_segments_with_http_info(id, opts)
|
343
|
+
data
|
344
|
+
end
|
345
|
+
|
346
|
+
# Get Profile Relationships Segments
|
347
|
+
# Get segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read` `Segments Read`
|
348
|
+
# @param id [String]
|
349
|
+
# @param [Hash] opts the optional parameters
|
350
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
351
|
+
def get_profile_relationships_segments_with_http_info(id, opts = {})
|
352
|
+
if @api_client.config.debugging
|
353
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_relationships_segments ...'
|
354
|
+
end
|
355
|
+
# verify the required parameter 'id' is set
|
356
|
+
if @api_client.config.client_side_validation && id.nil?
|
357
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_relationships_segments"
|
290
358
|
end
|
291
359
|
# resource path
|
292
|
-
local_var_path = '/api/profiles/{id}/relationships/
|
360
|
+
local_var_path = '/api/profiles/{id}/relationships/segments/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
293
361
|
|
294
362
|
# query parameters
|
295
363
|
query_params = opts[:query_params] || {}
|
@@ -297,7 +365,7 @@ module KlaviyoAPI
|
|
297
365
|
# header parameters
|
298
366
|
header_params = opts[:header_params] || {}
|
299
367
|
# klaviyo api revision
|
300
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
368
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
301
369
|
# HTTP header 'Accept' (if needed)
|
302
370
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
303
371
|
|
@@ -314,7 +382,7 @@ module KlaviyoAPI
|
|
314
382
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
315
383
|
|
316
384
|
new_options = opts.merge(
|
317
|
-
:operation => :"ProfilesApi.
|
385
|
+
:operation => :"ProfilesApi.get_profile_relationships_segments",
|
318
386
|
:header_params => header_params,
|
319
387
|
:query_params => query_params,
|
320
388
|
:form_params => form_params,
|
@@ -325,7 +393,7 @@ module KlaviyoAPI
|
|
325
393
|
|
326
394
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
327
395
|
if @api_client.config.debugging
|
328
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
396
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_profile_relationships_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
329
397
|
end
|
330
398
|
return data, status_code, headers
|
331
399
|
end
|
@@ -334,7 +402,7 @@ module KlaviyoAPI
|
|
334
402
|
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read` `Segments Read`
|
335
403
|
# @param profile_id [String]
|
336
404
|
# @param [Hash] opts the optional parameters
|
337
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
405
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
338
406
|
# @return [Hash<String, Object>]
|
339
407
|
def get_profile_segments(profile_id, opts = {})
|
340
408
|
data, _status_code, _headers = get_profile_segments_with_http_info(profile_id, opts)
|
@@ -345,7 +413,7 @@ module KlaviyoAPI
|
|
345
413
|
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read` `Segments Read`
|
346
414
|
# @param profile_id [String]
|
347
415
|
# @param [Hash] opts the optional parameters
|
348
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
416
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
349
417
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
350
418
|
def get_profile_segments_with_http_info(profile_id, opts = {})
|
351
419
|
if @api_client.config.debugging
|
@@ -369,7 +437,7 @@ module KlaviyoAPI
|
|
369
437
|
# header parameters
|
370
438
|
header_params = opts[:header_params] || {}
|
371
439
|
# klaviyo api revision
|
372
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
440
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
373
441
|
# HTTP header 'Accept' (if needed)
|
374
442
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
375
443
|
|
@@ -403,12 +471,14 @@ module KlaviyoAPI
|
|
403
471
|
end
|
404
472
|
|
405
473
|
# Get Profiles
|
406
|
-
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `email` 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: `
|
474
|
+
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email` 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:** `Profiles Read`
|
407
475
|
# @param [Hash] opts the optional parameters
|
408
|
-
# @option opts [Array<String>] :
|
409
|
-
# @option opts [String] :
|
410
|
-
# @option opts [String] :
|
411
|
-
# @option opts [String] :
|
476
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
477
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
478
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`
|
479
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
480
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
481
|
+
# @option opts [Integer] :page_size The number of results to return per page. Default = 20. Max = 100
|
412
482
|
# @return [Hash<String, Object>]
|
413
483
|
def get_profiles(opts = {})
|
414
484
|
data, _status_code, _headers = get_profiles_with_http_info(opts)
|
@@ -416,22 +486,28 @@ module KlaviyoAPI
|
|
416
486
|
end
|
417
487
|
|
418
488
|
# Get Profiles
|
419
|
-
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `email` 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: `
|
489
|
+
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email` 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:** `Profiles Read`
|
420
490
|
# @param [Hash] opts the optional parameters
|
421
|
-
# @option opts [Array<String>] :
|
422
|
-
# @option opts [String] :
|
423
|
-
# @option opts [String] :
|
424
|
-
# @option opts [String] :
|
491
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
492
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
493
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`
|
494
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
495
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
496
|
+
# @option opts [Integer] :page_size The number of results to return per page. Default = 20. Max = 100
|
425
497
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
426
498
|
def get_profiles_with_http_info(opts = {})
|
427
499
|
if @api_client.config.debugging
|
428
500
|
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_profiles ...'
|
429
501
|
end
|
430
|
-
allowable_values = ["
|
502
|
+
allowable_values = ["predictive_analytics"]
|
503
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
504
|
+
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
505
|
+
end
|
506
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.suppressions.reason", "subscriptions.email.marketing.suppressions.timestamp", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.list_suppressions.list_id", "subscriptions.email.marketing.list_suppressions.reason", "subscriptions.email.marketing.list_suppressions.timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
431
507
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
432
508
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
433
509
|
end
|
434
|
-
allowable_values = ["created", "-created", "email", "-email", "id", "-id"]
|
510
|
+
allowable_values = ["created", "-created", "email", "-email", "id", "-id", "updated", "-updated"]
|
435
511
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
436
512
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
437
513
|
end
|
@@ -440,15 +516,17 @@ module KlaviyoAPI
|
|
440
516
|
|
441
517
|
# query parameters
|
442
518
|
query_params = opts[:query_params] || {}
|
519
|
+
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
443
520
|
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
444
521
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
445
522
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
446
523
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
524
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
447
525
|
|
448
526
|
# header parameters
|
449
527
|
header_params = opts[:header_params] || {}
|
450
528
|
# klaviyo api revision
|
451
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
529
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
452
530
|
# HTTP header 'Accept' (if needed)
|
453
531
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
454
532
|
|
@@ -482,7 +560,7 @@ module KlaviyoAPI
|
|
482
560
|
end
|
483
561
|
|
484
562
|
# Subscribe Profiles
|
485
|
-
# Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). Maximum number of profile can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `List Write` `Profiles Write` `Subscriptions Write`
|
563
|
+
# Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about suppressed profiles in [this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profile can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `List Write` `Profiles Write` `Subscriptions Write`
|
486
564
|
# @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
|
487
565
|
# @param [Hash] opts the optional parameters
|
488
566
|
# @return [nil]
|
@@ -492,7 +570,7 @@ module KlaviyoAPI
|
|
492
570
|
end
|
493
571
|
|
494
572
|
# Subscribe Profiles
|
495
|
-
# Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). Maximum number of profile can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `List Write` `Profiles Write` `Subscriptions Write`
|
573
|
+
# Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about suppressed profiles in [this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profile can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `List Write` `Profiles Write` `Subscriptions Write`
|
496
574
|
# @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
|
497
575
|
# @param [Hash] opts the optional parameters
|
498
576
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -513,7 +591,7 @@ module KlaviyoAPI
|
|
513
591
|
# header parameters
|
514
592
|
header_params = opts[:header_params] || {}
|
515
593
|
# klaviyo api revision
|
516
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
594
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
517
595
|
# HTTP header 'Accept' (if needed)
|
518
596
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
519
597
|
# HTTP header 'Content-Type'
|
@@ -552,7 +630,7 @@ module KlaviyoAPI
|
|
552
630
|
end
|
553
631
|
|
554
632
|
# Suppress Profiles
|
555
|
-
# Manually suppress one or more profiles. Manually suppressed profiles
|
633
|
+
# Manually suppress one or more profiles. Such profiles will have `USER_SUPPRESSED` as their suppression reason. Manually suppressed profiles _will not_ receive email marketing. Learn more about suppressed profiles [in this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Not supported for SMS marketing. Maximum number of profile can be submitted for suppression: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Write` `Subscriptions Write`
|
556
634
|
# @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
|
557
635
|
# @param [Hash] opts the optional parameters
|
558
636
|
# @return [nil]
|
@@ -562,7 +640,7 @@ module KlaviyoAPI
|
|
562
640
|
end
|
563
641
|
|
564
642
|
# Suppress Profiles
|
565
|
-
# Manually suppress one or more profiles. Manually suppressed profiles
|
643
|
+
# Manually suppress one or more profiles. Such profiles will have `USER_SUPPRESSED` as their suppression reason. Manually suppressed profiles _will not_ receive email marketing. Learn more about suppressed profiles [in this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Not supported for SMS marketing. Maximum number of profile can be submitted for suppression: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Write` `Subscriptions Write`
|
566
644
|
# @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
|
567
645
|
# @param [Hash] opts the optional parameters
|
568
646
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -583,7 +661,7 @@ module KlaviyoAPI
|
|
583
661
|
# header parameters
|
584
662
|
header_params = opts[:header_params] || {}
|
585
663
|
# klaviyo api revision
|
586
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
664
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
587
665
|
# HTTP header 'Accept' (if needed)
|
588
666
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
589
667
|
# HTTP header 'Content-Type'
|
@@ -653,7 +731,7 @@ module KlaviyoAPI
|
|
653
731
|
# header parameters
|
654
732
|
header_params = opts[:header_params] || {}
|
655
733
|
# klaviyo api revision
|
656
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
734
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
657
735
|
# HTTP header 'Accept' (if needed)
|
658
736
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
659
737
|
# HTTP header 'Content-Type'
|
@@ -692,7 +770,7 @@ module KlaviyoAPI
|
|
692
770
|
end
|
693
771
|
|
694
772
|
# Unsuppress Profiles
|
695
|
-
# Unsuppress one or more profiles
|
773
|
+
# Unsuppress one or more profiles, this will remove any Manual Suppressions (USER_SUPPRESSED) on these profiles. A profile may receive email marketing after a manual suppression is removed so long as they have not revoked consent, i.e. unsubscribed. Not supported for SMS marketing. Only manual suppressions (USER_SUPPRESSED) will be removed. `UNSUBSCRIBE` and `SPAM_REPORT` suppressions are removed whenever a [profile resubscribes](https://developers.klaviyo.com/en/reference/subscribe_profiles). `INVALID_EMAIL` and `HARD_BOUNCE` suppressions cannot be removed by the API. Maximum number of profile can be submitted for unsuppression: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Subscriptions Write`
|
696
774
|
# @param unsuppression_create_job_create_query [UnsuppressionCreateJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
|
697
775
|
# @param [Hash] opts the optional parameters
|
698
776
|
# @return [nil]
|
@@ -702,7 +780,7 @@ module KlaviyoAPI
|
|
702
780
|
end
|
703
781
|
|
704
782
|
# Unsuppress Profiles
|
705
|
-
# Unsuppress one or more profiles
|
783
|
+
# Unsuppress one or more profiles, this will remove any Manual Suppressions (USER_SUPPRESSED) on these profiles. A profile may receive email marketing after a manual suppression is removed so long as they have not revoked consent, i.e. unsubscribed. Not supported for SMS marketing. Only manual suppressions (USER_SUPPRESSED) will be removed. `UNSUBSCRIBE` and `SPAM_REPORT` suppressions are removed whenever a [profile resubscribes](https://developers.klaviyo.com/en/reference/subscribe_profiles). `INVALID_EMAIL` and `HARD_BOUNCE` suppressions cannot be removed by the API. Maximum number of profile can be submitted for unsuppression: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Subscriptions Write`
|
706
784
|
# @param unsuppression_create_job_create_query [UnsuppressionCreateJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
|
707
785
|
# @param [Hash] opts the optional parameters
|
708
786
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -723,7 +801,7 @@ module KlaviyoAPI
|
|
723
801
|
# header parameters
|
724
802
|
header_params = opts[:header_params] || {}
|
725
803
|
# klaviyo api revision
|
726
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
804
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
727
805
|
# HTTP header 'Accept' (if needed)
|
728
806
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
729
807
|
# HTTP header 'Content-Type'
|
@@ -763,9 +841,10 @@ module KlaviyoAPI
|
|
763
841
|
|
764
842
|
# Update Profile
|
765
843
|
# Update the profile with the given profile ID. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Write`
|
766
|
-
# @param id [String]
|
844
|
+
# @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
|
767
845
|
# @param profile_partial_update_query [ProfilePartialUpdateQuery]
|
768
846
|
# @param [Hash] opts the optional parameters
|
847
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
769
848
|
# @return [Hash<String, Object>]
|
770
849
|
def update_profile(id, profile_partial_update_query, opts = {})
|
771
850
|
data, _status_code, _headers = update_profile_with_http_info(id, profile_partial_update_query, opts)
|
@@ -774,9 +853,10 @@ module KlaviyoAPI
|
|
774
853
|
|
775
854
|
# Update Profile
|
776
855
|
# Update the profile with the given profile ID. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Write`
|
777
|
-
# @param id [String]
|
856
|
+
# @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
|
778
857
|
# @param profile_partial_update_query [ProfilePartialUpdateQuery]
|
779
858
|
# @param [Hash] opts the optional parameters
|
859
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
780
860
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
781
861
|
def update_profile_with_http_info(id, profile_partial_update_query, opts = {})
|
782
862
|
if @api_client.config.debugging
|
@@ -790,16 +870,21 @@ module KlaviyoAPI
|
|
790
870
|
if @api_client.config.client_side_validation && profile_partial_update_query.nil?
|
791
871
|
fail ArgumentError, "Missing the required parameter 'profile_partial_update_query' when calling ProfilesApi.update_profile"
|
792
872
|
end
|
873
|
+
allowable_values = ["predictive_analytics"]
|
874
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
875
|
+
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
876
|
+
end
|
793
877
|
# resource path
|
794
878
|
local_var_path = '/api/profiles/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
795
879
|
|
796
880
|
# query parameters
|
797
881
|
query_params = opts[:query_params] || {}
|
882
|
+
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
798
883
|
|
799
884
|
# header parameters
|
800
885
|
header_params = opts[:header_params] || {}
|
801
886
|
# klaviyo api revision
|
802
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
887
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
|
803
888
|
# HTTP header 'Accept' (if needed)
|
804
889
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
805
890
|
# HTTP header 'Content-Type'
|