klaviyo-api-sdk 5.1.0 → 7.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 +267 -209
- data/docs/AccountsApi.md +4 -4
- data/docs/BaseEventCreateQueryResourceObject.md +20 -0
- data/docs/BaseEventCreateQueryResourceObjectAttributes.md +28 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +1 -1
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationships.md +1 -1
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate.md +1 -1
- data/docs/CampaignValuesReportEnum.md +15 -0
- data/docs/CampaignValuesRequestDTO.md +18 -0
- data/docs/CampaignValuesRequestDTOResourceObject.md +20 -0
- data/docs/CampaignValuesRequestDTOResourceObjectAttributes.md +24 -0
- data/docs/CampaignValuesRequestDTOResourceObjectAttributesTimeframe.md +49 -0
- data/docs/CampaignsApi.md +51 -51
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItems.md +1 -1
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +1 -1
- data/docs/CatalogVariantCreateQueryResourceObject.md +1 -1
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +1 -1
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItem.md +1 -1
- data/docs/CatalogsApi.md +178 -178
- data/docs/CouponCodeCreateQueryResourceObject.md +1 -1
- data/docs/CouponCodeCreateQueryResourceObjectRelationships.md +1 -1
- data/docs/CouponCodeCreateQueryResourceObjectRelationshipsCoupon.md +1 -1
- data/docs/CouponsApi.md +47 -47
- data/docs/CustomTimeframe.md +20 -0
- data/docs/EventBulkCreateEnum.md +15 -0
- data/docs/EventBulkCreateJobEnum.md +15 -0
- data/docs/EventCreateQueryV2ResourceObjectAttributes.md +4 -2
- data/docs/EventCreateQueryV2ResourceObjectAttributesProfile.md +1 -1
- data/docs/EventProfileCreateQueryResourceObject.md +22 -0
- data/docs/EventProfileCreateQueryResourceObjectAttributes.md +42 -0
- data/docs/EventsApi.md +98 -27
- data/docs/EventsBulkCreateJob.md +18 -0
- data/docs/EventsBulkCreateJobResourceObject.md +20 -0
- data/docs/EventsBulkCreateJobResourceObjectAttributes.md +18 -0
- data/docs/EventsBulkCreateJobResourceObjectAttributesEventsBulkCreate.md +18 -0
- data/docs/EventsBulkCreateQueryResourceObject.md +20 -0
- data/docs/EventsBulkCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/EventsBulkCreateQueryResourceObjectAttributesEvents.md +18 -0
- data/docs/EventsBulkCreateQueryResourceObjectAttributesProfile.md +18 -0
- data/docs/FlowSeriesReportEnum.md +15 -0
- data/docs/FlowSeriesRequestDTO.md +18 -0
- data/docs/FlowSeriesRequestDTOResourceObject.md +20 -0
- data/docs/FlowSeriesRequestDTOResourceObjectAttributes.md +26 -0
- data/docs/FlowValuesReportEnum.md +15 -0
- data/docs/FlowValuesRequestDTO.md +18 -0
- data/docs/FlowValuesRequestDTOResourceObject.md +20 -0
- data/docs/FlowValuesRequestDTOResourceObjectAttributes.md +24 -0
- data/docs/FlowsApi.md +70 -70
- data/docs/ImagesApi.md +10 -10
- data/docs/ListsApi.md +34 -34
- data/docs/MarketingSubscriptionParameters.md +3 -1
- data/docs/MetricsApi.md +8 -8
- data/docs/OnsiteProfileCreateQueryResourceObject.md +1 -1
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +4 -4
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +3 -3
- data/docs/ProfileIdentifierDTOResourceObjectAttributes.md +1 -1
- data/docs/ProfileImportJobCreateQueryResourceObjectRelationshipsLists.md +1 -1
- data/docs/ProfileMergeQueryResourceObject.md +1 -1
- data/docs/ProfileMergeQueryResourceObjectRelationships.md +1 -1
- data/docs/ProfileMergeQueryResourceObjectRelationshipsProfiles.md +1 -1
- data/docs/ProfilePartialUpdateQueryResourceObjectAttributes.md +3 -3
- data/docs/ProfileSubscriptionCreateQueryResourceObjectAttributes.md +4 -2
- data/docs/ProfileSubscriptionDeleteQueryResourceObjectAttributes.md +1 -1
- data/docs/ProfileSuppressionCreateQueryResourceObjectAttributes.md +1 -1
- data/docs/ProfileSuppressionDeleteQueryResourceObjectAttributes.md +1 -1
- data/docs/ProfileUpsertQuery.md +18 -0
- data/docs/ProfileUpsertQueryResourceObject.md +4 -2
- data/docs/ProfileUpsertQueryResourceObjectAttributes.md +5 -7
- data/docs/ProfilesApi.md +134 -62
- data/docs/PushProfileUpsertQueryResourceObject.md +22 -0
- data/docs/PushProfileUpsertQueryResourceObjectAttributes.md +42 -0
- data/docs/PushTokenCreateQueryResourceObjectAttributesProfile.md +1 -1
- data/docs/ReportingApi.md +235 -0
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +4 -2
- data/docs/SegmentsApi.md +35 -35
- data/docs/ServerBISSubscriptionCreateQueryResourceObject.md +1 -1
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md +1 -1
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant.md +1 -1
- data/docs/StaticScheduleOptions.md +1 -1
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.md +1 -1
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsList.md +1 -1
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +3 -1
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +1 -1
- data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationships.md +20 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationshipsList.md +18 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationshipsSegment.md +18 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationshipsSegmentData.md +20 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObject.md +3 -1
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributes.md +1 -1
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationships.md +20 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationshipsList.md +18 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationshipsSegment.md +18 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationshipsSegmentData.md +20 -0
- data/docs/TagCreateQueryResourceObjectRelationshipsTagGroup.md +1 -1
- data/docs/TagsApi.md +32 -32
- data/docs/TemplatesApi.md +11 -11
- data/docs/Timeframe.md +18 -0
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +9 -9
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +78 -78
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +239 -239
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +64 -64
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/events_api.rb +106 -36
- data/lib/klaviyo-api-sdk/api/flows_api.rb +88 -88
- data/lib/klaviyo-api-sdk/api/images_api.rb +16 -16
- data/lib/klaviyo-api-sdk/api/lists_api.rb +50 -50
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +163 -93
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +241 -0
- data/lib/klaviyo-api-sdk/api/segments_api.rb +46 -46
- data/lib/klaviyo-api-sdk/api/tags_api.rb +59 -59
- 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 +3 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +283 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +1 -6
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -6
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -6
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +4 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +289 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +1 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +9 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +10 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +1 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +9 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +13 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +1 -6
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +1 -6
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -6
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +238 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +2 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +13 -1
- data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +8 -1
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +2 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +5 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +17 -3
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +2 -2
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +249 -0
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +348 -0
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +224 -0
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +226 -0
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +238 -0
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +226 -0
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +316 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +289 -0
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +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 +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/marketing_subscription_parameters.rb +16 -5
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +6 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +2 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +12 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +10 -1
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +2 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +5 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -6
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +11 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -6
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -6
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -6
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +4 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +11 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +2 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +19 -6
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +4 -2
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +6 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +6 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +15 -5
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +16 -14
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +249 -0
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +349 -0
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +2 -2
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +5 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +16 -10
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -6
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -6
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -6
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +2 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +2 -1
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +3 -1
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +3 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -6
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -6
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +14 -5
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +2 -6
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +228 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +219 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +219 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +14 -5
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +2 -6
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +228 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +219 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +219 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -6
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +4 -1
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/timeframe.rb +259 -0
- 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 +44 -1
- data/spec/api/accounts_api_spec.rb +3 -3
- data/spec/api/campaigns_api_spec.rb +26 -26
- data/spec/api/catalogs_api_spec.rb +93 -93
- data/spec/api/coupons_api_spec.rb +24 -24
- data/spec/api/data_privacy_api_spec.rb +1 -1
- data/spec/api/events_api_spec.rb +26 -14
- data/spec/api/flows_api_spec.rb +36 -36
- data/spec/api/images_api_spec.rb +6 -6
- data/spec/api/lists_api_spec.rb +19 -19
- data/spec/api/metrics_api_spec.rb +5 -5
- data/spec/api/profiles_api_spec.rb +45 -33
- data/spec/api/reporting_api_spec.rb +74 -0
- data/spec/api/segments_api_spec.rb +19 -19
- data/spec/api/tags_api_spec.rb +17 -17
- data/spec/api/templates_api_spec.rb +7 -7
- 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/back_in_stock_subscription_enum_spec.rb +1 -1
- data/spec/models/base_event_create_query_resource_object_attributes_spec.rb +64 -0
- data/spec/models/base_event_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_clone_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_clone_query_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_create_query_spec.rb +1 -1
- data/spec/models/campaign_enum_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_spec.rb +1 -1
- data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +1 -1
- data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_message_create_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_message_enum_spec.rb +1 -1
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_message_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +1 -1
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_send_job_create_query_spec.rb +1 -1
- data/spec/models/campaign_send_job_enum_spec.rb +1 -1
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_values_report_enum_spec.rb +28 -0
- data/spec/models/campaign_values_request_dto_resource_object_attributes_spec.rb +56 -0
- data/spec/models/campaign_values_request_dto_resource_object_attributes_timeframe_spec.rb +31 -0
- data/spec/models/campaign_values_request_dto_resource_object_spec.rb +40 -0
- data/spec/models/campaign_values_request_dto_spec.rb +34 -0
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_data_inner_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_enum_spec.rb +1 -1
- data/spec/models/catalog_category_item_op_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +1 -1
- data/spec/models/catalog_item_category_op_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_enum_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_spec.rb +1 -1
- data/spec/models/coupon_code_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes_spec.rb +1 -1
- data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_code_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_code_create_job_create_query_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_data_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_spec.rb +1 -1
- data/spec/models/coupon_code_enum_spec.rb +1 -1
- data/spec/models/coupon_code_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_code_update_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_code_update_query_spec.rb +1 -1
- data/spec/models/coupon_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_create_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_create_query_spec.rb +1 -1
- data/spec/models/coupon_enum_spec.rb +1 -1
- data/spec/models/coupon_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_update_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_update_query_spec.rb +1 -1
- data/spec/models/custom_timeframe_spec.rb +40 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +1 -1
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +1 -1
- data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/data_privacy_profile_query_resource_object_spec.rb +1 -1
- data/spec/models/device_metadata_spec.rb +1 -1
- data/spec/models/email_content_sub_object_spec.rb +1 -1
- data/spec/models/email_send_options_sub_object_spec.rb +1 -1
- data/spec/models/email_subscription_parameters_spec.rb +1 -1
- data/spec/models/email_tracking_options_sub_object_spec.rb +1 -1
- data/spec/models/event_bulk_create_enum_spec.rb +28 -0
- data/spec/models/event_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/event_create_query_v2_resource_object_attributes_metric_spec.rb +1 -1
- data/spec/models/event_create_query_v2_resource_object_attributes_profile_spec.rb +1 -1
- data/spec/models/event_create_query_v2_resource_object_attributes_spec.rb +7 -1
- data/spec/models/event_create_query_v2_resource_object_spec.rb +1 -1
- data/spec/models/event_create_query_v2_spec.rb +1 -1
- data/spec/models/event_enum_spec.rb +1 -1
- data/spec/models/event_profile_create_query_resource_object_attributes_spec.rb +106 -0
- data/spec/models/event_profile_create_query_resource_object_spec.rb +46 -0
- data/spec/models/events_bulk_create_job_resource_object_attributes_events_bulk_create_spec.rb +34 -0
- data/spec/models/events_bulk_create_job_resource_object_attributes_spec.rb +34 -0
- data/spec/models/events_bulk_create_job_resource_object_spec.rb +40 -0
- data/spec/models/events_bulk_create_job_spec.rb +34 -0
- data/spec/models/events_bulk_create_query_resource_object_attributes_events_spec.rb +34 -0
- data/spec/models/events_bulk_create_query_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/events_bulk_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/events_bulk_create_query_resource_object_spec.rb +40 -0
- data/spec/models/flow_enum_spec.rb +1 -1
- data/spec/models/flow_series_report_enum_spec.rb +28 -0
- data/spec/models/flow_series_request_dto_resource_object_attributes_spec.rb +66 -0
- data/spec/models/flow_series_request_dto_resource_object_spec.rb +40 -0
- data/spec/models/flow_series_request_dto_spec.rb +34 -0
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/flow_update_query_resource_object_spec.rb +1 -1
- data/spec/models/flow_update_query_spec.rb +1 -1
- data/spec/models/flow_values_report_enum_spec.rb +28 -0
- data/spec/models/flow_values_request_dto_resource_object_attributes_spec.rb +56 -0
- data/spec/models/flow_values_request_dto_resource_object_spec.rb +40 -0
- data/spec/models/flow_values_request_dto_spec.rb +34 -0
- data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +1 -1
- data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +1 -1
- data/spec/models/get_accounts4_xx_response_spec.rb +1 -1
- data/spec/models/image_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/image_create_query_resource_object_spec.rb +1 -1
- data/spec/models/image_create_query_spec.rb +1 -1
- data/spec/models/image_enum_spec.rb +1 -1
- data/spec/models/image_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/image_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/image_partial_update_query_spec.rb +1 -1
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/list_create_query_resource_object_spec.rb +1 -1
- data/spec/models/list_create_query_spec.rb +1 -1
- data/spec/models/list_enum_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/list_partial_update_query_spec.rb +1 -1
- data/spec/models/marketing_subscription_parameters_spec.rb +7 -1
- data/spec/models/metric_aggregate_enum_spec.rb +1 -1
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +1 -1
- data/spec/models/metric_aggregate_query_spec.rb +1 -1
- data/spec/models/metric_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/metric_create_query_resource_object_spec.rb +1 -1
- data/spec/models/metric_enum_spec.rb +1 -1
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +1 -1
- data/spec/models/onsite_profile_meta_spec.rb +1 -1
- data/spec/models/profile_bulk_import_job_enum_spec.rb +1 -1
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_create_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_create_query_spec.rb +1 -1
- data/spec/models/profile_enum_spec.rb +1 -1
- data/spec/models/profile_identifier_dto_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_identifier_dto_resource_object_spec.rb +1 -1
- data/spec/models/profile_import_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
- data/spec/models/profile_import_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner_spec.rb +1 -1
- data/spec/models/profile_import_job_create_query_resource_object_relationships_lists_spec.rb +1 -1
- data/spec/models/profile_import_job_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/profile_import_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_import_job_create_query_spec.rb +1 -1
- data/spec/models/profile_location_latitude_spec.rb +1 -1
- data/spec/models/profile_location_longitude_spec.rb +1 -1
- data/spec/models/profile_location_spec.rb +1 -1
- data/spec/models/profile_merge_enum_spec.rb +1 -1
- data/spec/models/profile_merge_query_resource_object_relationships_profiles_data_inner_spec.rb +1 -1
- data/spec/models/profile_merge_query_resource_object_relationships_profiles_spec.rb +1 -1
- data/spec/models/profile_merge_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/profile_merge_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_merge_query_spec.rb +1 -1
- data/spec/models/profile_meta_patch_properties_spec.rb +1 -1
- data/spec/models/profile_meta_patch_properties_unset_spec.rb +1 -1
- data/spec/models/profile_meta_spec.rb +1 -1
- data/spec/models/profile_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_partial_update_query_spec.rb +1 -1
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +7 -1
- data/spec/models/profile_subscription_create_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_subscription_delete_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_subscription_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/profile_suppression_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/profile_suppression_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_suppression_create_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_suppression_delete_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_suppression_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_upsert_query_resource_object_attributes_spec.rb +1 -7
- data/spec/models/profile_upsert_query_resource_object_spec.rb +7 -1
- data/spec/models/profile_upsert_query_spec.rb +34 -0
- data/spec/models/push_profile_upsert_query_resource_object_attributes_spec.rb +106 -0
- data/spec/models/push_profile_upsert_query_resource_object_spec.rb +46 -0
- data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +1 -1
- data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/push_token_create_query_resource_object_spec.rb +1 -1
- data/spec/models/push_token_create_query_spec.rb +1 -1
- data/spec/models/push_token_enum_spec.rb +1 -1
- data/spec/models/render_options_sub_object_spec.rb +1 -1
- data/spec/models/segment_enum_spec.rb +1 -1
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +7 -1
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/segment_partial_update_query_spec.rb +1 -1
- data/spec/models/send_strategy_sub_object_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_spec.rb +1 -1
- data/spec/models/sms_content_sub_object_create_spec.rb +1 -1
- data/spec/models/sms_send_options_sub_object_spec.rb +1 -1
- data/spec/models/sms_subscription_parameters_spec.rb +1 -1
- data/spec/models/sms_tracking_options_sub_object_spec.rb +1 -1
- data/spec/models/static_schedule_options_spec.rb +1 -1
- data/spec/models/sto_schedule_options_spec.rb +1 -1
- data/spec/models/subscription_channels_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_spec.rb +1 -1
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/suppression_create_job_create_query_resource_object_relationships_list_data_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_resource_object_relationships_list_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_resource_object_relationships_segment_data_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_resource_object_relationships_segment_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_resource_object_relationships_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +7 -1
- data/spec/models/suppression_create_job_create_query_spec.rb +1 -1
- data/spec/models/suppression_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
- data/spec/models/suppression_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/suppression_delete_job_create_query_resource_object_relationships_list_data_spec.rb +40 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_relationships_list_spec.rb +34 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_relationships_segment_data_spec.rb +40 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_relationships_segment_spec.rb +34 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_relationships_spec.rb +40 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_spec.rb +7 -1
- data/spec/models/suppression_delete_job_create_query_spec.rb +1 -1
- data/spec/models/tag_campaign_op_data_inner_spec.rb +1 -1
- data/spec/models/tag_campaign_op_spec.rb +1 -1
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/tag_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/tag_create_query_resource_object_relationships_tag_group_data_spec.rb +1 -1
- data/spec/models/tag_create_query_resource_object_relationships_tag_group_spec.rb +1 -1
- data/spec/models/tag_create_query_resource_object_spec.rb +1 -1
- data/spec/models/tag_create_query_spec.rb +1 -1
- data/spec/models/tag_enum_spec.rb +1 -1
- data/spec/models/tag_flow_op_data_inner_spec.rb +1 -1
- data/spec/models/tag_flow_op_spec.rb +1 -1
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/tag_group_create_query_resource_object_spec.rb +1 -1
- data/spec/models/tag_group_create_query_spec.rb +1 -1
- data/spec/models/tag_group_enum_spec.rb +1 -1
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/tag_group_update_query_resource_object_spec.rb +1 -1
- data/spec/models/tag_group_update_query_spec.rb +1 -1
- data/spec/models/tag_list_op_data_inner_spec.rb +1 -1
- data/spec/models/tag_list_op_spec.rb +1 -1
- 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_spec.rb +1 -1
- data/spec/models/tag_update_query_spec.rb +1 -1
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/template_clone_query_resource_object_spec.rb +1 -1
- data/spec/models/template_clone_query_spec.rb +1 -1
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/template_create_query_resource_object_spec.rb +1 -1
- data/spec/models/template_create_query_spec.rb +1 -1
- data/spec/models/template_enum_spec.rb +1 -1
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/template_render_query_resource_object_spec.rb +1 -1
- data/spec/models/template_render_query_spec.rb +1 -1
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/template_update_query_resource_object_spec.rb +1 -1
- data/spec/models/template_update_query_spec.rb +1 -1
- data/spec/models/throttled_schedule_options_spec.rb +1 -1
- data/spec/models/timeframe_spec.rb +38 -0
- data/spec/models/utm_params_sub_object_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +131 -2
@@ -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:
|
6
|
+
The version of the OpenAPI document: 2024-05-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -19,8 +19,78 @@ module KlaviyoAPI
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Create or Update Profile
|
23
|
+
# Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
24
|
+
# @param profile_upsert_query [ProfileUpsertQuery]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [Hash<String, Object>]
|
27
|
+
def create_or_update_profile(profile_upsert_query, opts = {})
|
28
|
+
data, _status_code, _headers = create_or_update_profile_with_http_info(profile_upsert_query, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Create or Update Profile
|
33
|
+
# Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
34
|
+
# @param profile_upsert_query [ProfileUpsertQuery]
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
37
|
+
def create_or_update_profile_with_http_info(profile_upsert_query, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.create_or_update_profile ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'profile_upsert_query' is set
|
42
|
+
if @api_client.config.client_side_validation && profile_upsert_query.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'profile_upsert_query' when calling ProfilesApi.create_or_update_profile"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/api/profile-import/'
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# klaviyo api revision
|
54
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
55
|
+
# HTTP header 'Accept' (if needed)
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
|
+
# HTTP header 'Content-Type'
|
58
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
59
|
+
if !content_type.nil?
|
60
|
+
header_params['Content-Type'] = content_type
|
61
|
+
end
|
62
|
+
|
63
|
+
# form parameters
|
64
|
+
form_params = opts[:form_params] || {}
|
65
|
+
|
66
|
+
# http body (model)
|
67
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_upsert_query)
|
68
|
+
|
69
|
+
# return_type
|
70
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
71
|
+
|
72
|
+
# auth_names
|
73
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
74
|
+
|
75
|
+
new_options = opts.merge(
|
76
|
+
:operation => :"ProfilesApi.create_or_update_profile",
|
77
|
+
:header_params => header_params,
|
78
|
+
:query_params => query_params,
|
79
|
+
:form_params => form_params,
|
80
|
+
:body => post_body,
|
81
|
+
:auth_names => auth_names,
|
82
|
+
:return_type => return_type
|
83
|
+
)
|
84
|
+
|
85
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
86
|
+
if @api_client.config.debugging
|
87
|
+
@api_client.config.logger.debug "API called: ProfilesApi#create_or_update_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
88
|
+
end
|
89
|
+
return data, status_code, headers
|
90
|
+
end
|
91
|
+
|
22
92
|
# Create Profile
|
23
|
-
# Create a new profile
|
93
|
+
# Create a new profile.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
24
94
|
# @param profile_create_query [ProfileCreateQuery]
|
25
95
|
# @param [Hash] opts the optional parameters
|
26
96
|
# @return [Hash<String, Object>]
|
@@ -30,7 +100,7 @@ module KlaviyoAPI
|
|
30
100
|
end
|
31
101
|
|
32
102
|
# Create Profile
|
33
|
-
# Create a new profile
|
103
|
+
# Create a new profile.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
34
104
|
# @param profile_create_query [ProfileCreateQuery]
|
35
105
|
# @param [Hash] opts the optional parameters
|
36
106
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -51,7 +121,7 @@ module KlaviyoAPI
|
|
51
121
|
# header parameters
|
52
122
|
header_params = opts[:header_params] || {}
|
53
123
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
124
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
55
125
|
# HTTP header 'Accept' (if needed)
|
56
126
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
127
|
# HTTP header 'Content-Type'
|
@@ -121,7 +191,7 @@ module KlaviyoAPI
|
|
121
191
|
# header parameters
|
122
192
|
header_params = opts[:header_params] || {}
|
123
193
|
# klaviyo api revision
|
124
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
194
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
125
195
|
# HTTP header 'Accept' (if needed)
|
126
196
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
127
197
|
# HTTP header 'Content-Type'
|
@@ -163,9 +233,9 @@ module KlaviyoAPI
|
|
163
233
|
# Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
164
234
|
# @param job_id [String] ID of the job to retrieve.
|
165
235
|
# @param [Hash] opts the optional parameters
|
166
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
167
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/
|
168
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
236
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
237
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
238
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
|
169
239
|
# @return [Hash<String, Object>]
|
170
240
|
def get_bulk_profile_import_job(job_id, opts = {})
|
171
241
|
data, _status_code, _headers = get_bulk_profile_import_job_with_http_info(job_id, opts)
|
@@ -176,9 +246,9 @@ module KlaviyoAPI
|
|
176
246
|
# Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
177
247
|
# @param job_id [String] ID of the job to retrieve.
|
178
248
|
# @param [Hash] opts the optional parameters
|
179
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
180
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/
|
181
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
249
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
250
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
251
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
|
182
252
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
183
253
|
def get_bulk_profile_import_job_with_http_info(job_id, opts = {})
|
184
254
|
if @api_client.config.debugging
|
@@ -188,7 +258,7 @@ module KlaviyoAPI
|
|
188
258
|
if @api_client.config.client_side_validation && job_id.nil?
|
189
259
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_profile_import_job"
|
190
260
|
end
|
191
|
-
allowable_values = ["name", "created", "updated"]
|
261
|
+
allowable_values = ["name", "created", "updated", "opt_in_process"]
|
192
262
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
193
263
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
194
264
|
end
|
@@ -212,7 +282,7 @@ module KlaviyoAPI
|
|
212
282
|
# header parameters
|
213
283
|
header_params = opts[:header_params] || {}
|
214
284
|
# klaviyo api revision
|
215
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
285
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
216
286
|
# HTTP header 'Accept' (if needed)
|
217
287
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
218
288
|
|
@@ -245,12 +315,12 @@ module KlaviyoAPI
|
|
245
315
|
return data, status_code, headers
|
246
316
|
end
|
247
317
|
|
248
|
-
# Get Bulk Profile Import Job
|
318
|
+
# Get Bulk Profile Import Job Errors
|
249
319
|
# Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
250
320
|
# @param id [String]
|
251
321
|
# @param [Hash] opts the optional parameters
|
252
|
-
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/
|
253
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
322
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
323
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
|
254
324
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
255
325
|
# @return [Hash<String, Object>]
|
256
326
|
def get_bulk_profile_import_job_import_errors(id, opts = {})
|
@@ -258,12 +328,12 @@ module KlaviyoAPI
|
|
258
328
|
data
|
259
329
|
end
|
260
330
|
|
261
|
-
# Get Bulk Profile Import Job
|
331
|
+
# Get Bulk Profile Import Job Errors
|
262
332
|
# Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
263
333
|
# @param id [String]
|
264
334
|
# @param [Hash] opts the optional parameters
|
265
|
-
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/
|
266
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
335
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
336
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
|
267
337
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
268
338
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
269
339
|
def get_bulk_profile_import_job_import_errors_with_http_info(id, opts = {})
|
@@ -298,7 +368,7 @@ module KlaviyoAPI
|
|
298
368
|
# header parameters
|
299
369
|
header_params = opts[:header_params] || {}
|
300
370
|
# klaviyo api revision
|
301
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
371
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
302
372
|
# HTTP header 'Accept' (if needed)
|
303
373
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
304
374
|
|
@@ -335,7 +405,7 @@ module KlaviyoAPI
|
|
335
405
|
# Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
336
406
|
# @param id [String]
|
337
407
|
# @param [Hash] opts the optional parameters
|
338
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
408
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
339
409
|
# @return [Hash<String, Object>]
|
340
410
|
def get_bulk_profile_import_job_lists(id, opts = {})
|
341
411
|
data, _status_code, _headers = get_bulk_profile_import_job_lists_with_http_info(id, opts)
|
@@ -346,7 +416,7 @@ module KlaviyoAPI
|
|
346
416
|
# Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
347
417
|
# @param id [String]
|
348
418
|
# @param [Hash] opts the optional parameters
|
349
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
419
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
350
420
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
351
421
|
def get_bulk_profile_import_job_lists_with_http_info(id, opts = {})
|
352
422
|
if @api_client.config.debugging
|
@@ -356,7 +426,7 @@ module KlaviyoAPI
|
|
356
426
|
if @api_client.config.client_side_validation && id.nil?
|
357
427
|
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_lists"
|
358
428
|
end
|
359
|
-
allowable_values = ["name", "created", "updated"]
|
429
|
+
allowable_values = ["name", "created", "updated", "opt_in_process"]
|
360
430
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
361
431
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
362
432
|
end
|
@@ -370,7 +440,7 @@ module KlaviyoAPI
|
|
370
440
|
# header parameters
|
371
441
|
header_params = opts[:header_params] || {}
|
372
442
|
# klaviyo api revision
|
373
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
443
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
374
444
|
# HTTP header 'Accept' (if needed)
|
375
445
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
376
446
|
|
@@ -408,8 +478,8 @@ module KlaviyoAPI
|
|
408
478
|
# @param id [String]
|
409
479
|
# @param [Hash] opts the optional parameters
|
410
480
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
411
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
412
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
481
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
482
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
|
413
483
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
414
484
|
# @return [Hash<String, Object>]
|
415
485
|
def get_bulk_profile_import_job_profiles(id, opts = {})
|
@@ -422,8 +492,8 @@ module KlaviyoAPI
|
|
422
492
|
# @param id [String]
|
423
493
|
# @param [Hash] opts the optional parameters
|
424
494
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
425
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
426
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
495
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
496
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
|
427
497
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
428
498
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
429
499
|
def get_bulk_profile_import_job_profiles_with_http_info(id, opts = {})
|
@@ -463,7 +533,7 @@ module KlaviyoAPI
|
|
463
533
|
# header parameters
|
464
534
|
header_params = opts[:header_params] || {}
|
465
535
|
# klaviyo api revision
|
466
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
536
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
467
537
|
# HTTP header 'Accept' (if needed)
|
468
538
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
469
539
|
|
@@ -528,7 +598,7 @@ module KlaviyoAPI
|
|
528
598
|
# header parameters
|
529
599
|
header_params = opts[:header_params] || {}
|
530
600
|
# klaviyo api revision
|
531
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
601
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
532
602
|
# HTTP header 'Accept' (if needed)
|
533
603
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
534
604
|
|
@@ -565,7 +635,7 @@ module KlaviyoAPI
|
|
565
635
|
# Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
566
636
|
# @param id [String]
|
567
637
|
# @param [Hash] opts the optional parameters
|
568
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
638
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
|
569
639
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
570
640
|
# @return [Hash<String, Object>]
|
571
641
|
def get_bulk_profile_import_job_relationships_profiles(id, opts = {})
|
@@ -577,7 +647,7 @@ module KlaviyoAPI
|
|
577
647
|
# Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
578
648
|
# @param id [String]
|
579
649
|
# @param [Hash] opts the optional parameters
|
580
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
650
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
|
581
651
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
582
652
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
583
653
|
def get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts = {})
|
@@ -607,7 +677,7 @@ module KlaviyoAPI
|
|
607
677
|
# header parameters
|
608
678
|
header_params = opts[:header_params] || {}
|
609
679
|
# klaviyo api revision
|
610
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
680
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
611
681
|
# HTTP header 'Accept' (if needed)
|
612
682
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
613
683
|
|
@@ -643,11 +713,11 @@ module KlaviyoAPI
|
|
643
713
|
# Get Bulk Profile Import Jobs
|
644
714
|
# Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
645
715
|
# @param [Hash] opts the optional parameters
|
646
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/
|
647
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
648
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
716
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
717
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
718
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
|
649
719
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
650
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
720
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
|
651
721
|
# @return [Hash<String, Object>]
|
652
722
|
def get_bulk_profile_import_jobs(opts = {})
|
653
723
|
data, _status_code, _headers = get_bulk_profile_import_jobs_with_http_info(opts)
|
@@ -657,11 +727,11 @@ module KlaviyoAPI
|
|
657
727
|
# Get Bulk Profile Import Jobs
|
658
728
|
# Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
659
729
|
# @param [Hash] opts the optional parameters
|
660
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/
|
661
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
662
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
730
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
731
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
732
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
|
663
733
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
664
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
734
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
|
665
735
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
666
736
|
def get_bulk_profile_import_jobs_with_http_info(opts = {})
|
667
737
|
if @api_client.config.debugging
|
@@ -697,7 +767,7 @@ module KlaviyoAPI
|
|
697
767
|
# header parameters
|
698
768
|
header_params = opts[:header_params] || {}
|
699
769
|
# klaviyo api revision
|
700
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
770
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
701
771
|
# HTTP header 'Accept' (if needed)
|
702
772
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
703
773
|
|
@@ -735,10 +805,10 @@ module KlaviyoAPI
|
|
735
805
|
# @param id [String]
|
736
806
|
# @param [Hash] opts the optional parameters
|
737
807
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
738
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
739
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
740
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/
|
741
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
808
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
809
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
810
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
811
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
|
742
812
|
# @return [Hash<String, Object>]
|
743
813
|
def get_profile(id, opts = {})
|
744
814
|
data, _status_code, _headers = get_profile_with_http_info(id, opts)
|
@@ -750,10 +820,10 @@ module KlaviyoAPI
|
|
750
820
|
# @param id [String]
|
751
821
|
# @param [Hash] opts the optional parameters
|
752
822
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
753
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
754
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
755
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/
|
756
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
823
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
824
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
825
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
826
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
|
757
827
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
758
828
|
def get_profile_with_http_info(id, opts = {})
|
759
829
|
if @api_client.config.debugging
|
@@ -767,7 +837,7 @@ module KlaviyoAPI
|
|
767
837
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
768
838
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
769
839
|
end
|
770
|
-
allowable_values = ["name", "created", "updated"]
|
840
|
+
allowable_values = ["name", "created", "updated", "opt_in_process"]
|
771
841
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
772
842
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
773
843
|
end
|
@@ -775,7 +845,7 @@ module KlaviyoAPI
|
|
775
845
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
776
846
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
777
847
|
end
|
778
|
-
allowable_values = ["name", "created", "updated"]
|
848
|
+
allowable_values = ["name", "created", "updated", "is_active", "is_processing", "is_starred"]
|
779
849
|
if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
|
780
850
|
fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
|
781
851
|
end
|
@@ -797,7 +867,7 @@ module KlaviyoAPI
|
|
797
867
|
# header parameters
|
798
868
|
header_params = opts[:header_params] || {}
|
799
869
|
# klaviyo api revision
|
800
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
870
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
801
871
|
# HTTP header 'Accept' (if needed)
|
802
872
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
803
873
|
|
@@ -834,7 +904,7 @@ module KlaviyoAPI
|
|
834
904
|
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
|
835
905
|
# @param id [String]
|
836
906
|
# @param [Hash] opts the optional parameters
|
837
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
907
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
838
908
|
# @return [Hash<String, Object>]
|
839
909
|
def get_profile_lists(id, opts = {})
|
840
910
|
data, _status_code, _headers = get_profile_lists_with_http_info(id, opts)
|
@@ -845,7 +915,7 @@ module KlaviyoAPI
|
|
845
915
|
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
|
846
916
|
# @param id [String]
|
847
917
|
# @param [Hash] opts the optional parameters
|
848
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
918
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
849
919
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
850
920
|
def get_profile_lists_with_http_info(id, opts = {})
|
851
921
|
if @api_client.config.debugging
|
@@ -855,7 +925,7 @@ module KlaviyoAPI
|
|
855
925
|
if @api_client.config.client_side_validation && id.nil?
|
856
926
|
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_lists"
|
857
927
|
end
|
858
|
-
allowable_values = ["name", "created", "updated"]
|
928
|
+
allowable_values = ["name", "created", "updated", "opt_in_process"]
|
859
929
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
860
930
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
861
931
|
end
|
@@ -869,7 +939,7 @@ module KlaviyoAPI
|
|
869
939
|
# header parameters
|
870
940
|
header_params = opts[:header_params] || {}
|
871
941
|
# klaviyo api revision
|
872
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
942
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
873
943
|
# HTTP header 'Accept' (if needed)
|
874
944
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
875
945
|
|
@@ -934,7 +1004,7 @@ module KlaviyoAPI
|
|
934
1004
|
# header parameters
|
935
1005
|
header_params = opts[:header_params] || {}
|
936
1006
|
# klaviyo api revision
|
937
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
1007
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
938
1008
|
# HTTP header 'Accept' (if needed)
|
939
1009
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
940
1010
|
|
@@ -999,7 +1069,7 @@ module KlaviyoAPI
|
|
999
1069
|
# header parameters
|
1000
1070
|
header_params = opts[:header_params] || {}
|
1001
1071
|
# klaviyo api revision
|
1002
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
1072
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
1003
1073
|
# HTTP header 'Accept' (if needed)
|
1004
1074
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1005
1075
|
|
@@ -1036,7 +1106,7 @@ module KlaviyoAPI
|
|
1036
1106
|
# 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`
|
1037
1107
|
# @param id [String]
|
1038
1108
|
# @param [Hash] opts the optional parameters
|
1039
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/
|
1109
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
1040
1110
|
# @return [Hash<String, Object>]
|
1041
1111
|
def get_profile_segments(id, opts = {})
|
1042
1112
|
data, _status_code, _headers = get_profile_segments_with_http_info(id, opts)
|
@@ -1047,7 +1117,7 @@ module KlaviyoAPI
|
|
1047
1117
|
# 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`
|
1048
1118
|
# @param id [String]
|
1049
1119
|
# @param [Hash] opts the optional parameters
|
1050
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/
|
1120
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
1051
1121
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1052
1122
|
def get_profile_segments_with_http_info(id, opts = {})
|
1053
1123
|
if @api_client.config.debugging
|
@@ -1057,7 +1127,7 @@ module KlaviyoAPI
|
|
1057
1127
|
if @api_client.config.client_side_validation && id.nil?
|
1058
1128
|
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_segments"
|
1059
1129
|
end
|
1060
|
-
allowable_values = ["name", "created", "updated"]
|
1130
|
+
allowable_values = ["name", "created", "updated", "is_active", "is_processing", "is_starred"]
|
1061
1131
|
if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
|
1062
1132
|
fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
|
1063
1133
|
end
|
@@ -1071,7 +1141,7 @@ module KlaviyoAPI
|
|
1071
1141
|
# header parameters
|
1072
1142
|
header_params = opts[:header_params] || {}
|
1073
1143
|
# klaviyo api revision
|
1074
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
1144
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
1075
1145
|
# HTTP header 'Accept' (if needed)
|
1076
1146
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1077
1147
|
|
@@ -1105,14 +1175,14 @@ module KlaviyoAPI
|
|
1105
1175
|
end
|
1106
1176
|
|
1107
1177
|
# Get Profiles
|
1108
|
-
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/
|
1178
|
+
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-05-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1109
1179
|
# @param [Hash] opts the optional parameters
|
1110
1180
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1111
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
1112
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1113
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1181
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
1182
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/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`<br>`subscriptions.email.marketing.suppression.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`<br>`subscriptions.email.marketing.suppression.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.list_id` : `equals`<br>`subscriptions.email.marketing.list_suppressions.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`
|
1183
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
|
1114
1184
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1115
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
1185
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
|
1116
1186
|
# @return [Hash<String, Object>]
|
1117
1187
|
def get_profiles(opts = {})
|
1118
1188
|
data, _status_code, _headers = get_profiles_with_http_info(opts)
|
@@ -1120,14 +1190,14 @@ module KlaviyoAPI
|
|
1120
1190
|
end
|
1121
1191
|
|
1122
1192
|
# Get Profiles
|
1123
|
-
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/
|
1193
|
+
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-05-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1124
1194
|
# @param [Hash] opts the optional parameters
|
1125
1195
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1126
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
1127
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1128
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1196
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
|
1197
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/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`<br>`subscriptions.email.marketing.suppression.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`<br>`subscriptions.email.marketing.suppression.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.list_id` : `equals`<br>`subscriptions.email.marketing.list_suppressions.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`
|
1198
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
|
1129
1199
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1130
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
1200
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
|
1131
1201
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1132
1202
|
def get_profiles_with_http_info(opts = {})
|
1133
1203
|
if @api_client.config.debugging
|
@@ -1168,7 +1238,7 @@ module KlaviyoAPI
|
|
1168
1238
|
# header parameters
|
1169
1239
|
header_params = opts[:header_params] || {}
|
1170
1240
|
# klaviyo api revision
|
1171
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
1241
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
1172
1242
|
# HTTP header 'Accept' (if needed)
|
1173
1243
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1174
1244
|
|
@@ -1233,7 +1303,7 @@ module KlaviyoAPI
|
|
1233
1303
|
# header parameters
|
1234
1304
|
header_params = opts[:header_params] || {}
|
1235
1305
|
# klaviyo api revision
|
1236
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
1306
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
1237
1307
|
# HTTP header 'Accept' (if needed)
|
1238
1308
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1239
1309
|
# HTTP header 'Content-Type'
|
@@ -1272,7 +1342,7 @@ module KlaviyoAPI
|
|
1272
1342
|
end
|
1273
1343
|
|
1274
1344
|
# Spawn Bulk Profile Import Job
|
1275
|
-
#
|
1345
|
+
# Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
|
1276
1346
|
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
1277
1347
|
# @param [Hash] opts the optional parameters
|
1278
1348
|
# @return [Hash<String, Object>]
|
@@ -1282,7 +1352,7 @@ module KlaviyoAPI
|
|
1282
1352
|
end
|
1283
1353
|
|
1284
1354
|
# Spawn Bulk Profile Import Job
|
1285
|
-
#
|
1355
|
+
# Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
|
1286
1356
|
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
1287
1357
|
# @param [Hash] opts the optional parameters
|
1288
1358
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -1303,7 +1373,7 @@ module KlaviyoAPI
|
|
1303
1373
|
# header parameters
|
1304
1374
|
header_params = opts[:header_params] || {}
|
1305
1375
|
# klaviyo api revision
|
1306
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
1376
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
1307
1377
|
# HTTP header 'Accept' (if needed)
|
1308
1378
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1309
1379
|
# HTTP header 'Content-Type'
|
@@ -1342,7 +1412,7 @@ module KlaviyoAPI
|
|
1342
1412
|
end
|
1343
1413
|
|
1344
1414
|
# Subscribe Profiles
|
1345
|
-
# 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
|
1415
|
+
# Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided 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. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). 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](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
1346
1416
|
# @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.
|
1347
1417
|
# @param [Hash] opts the optional parameters
|
1348
1418
|
# @return [nil]
|
@@ -1352,7 +1422,7 @@ module KlaviyoAPI
|
|
1352
1422
|
end
|
1353
1423
|
|
1354
1424
|
# Subscribe Profiles
|
1355
|
-
# 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
|
1425
|
+
# Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided 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. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). 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](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
1356
1426
|
# @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.
|
1357
1427
|
# @param [Hash] opts the optional parameters
|
1358
1428
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -1373,7 +1443,7 @@ module KlaviyoAPI
|
|
1373
1443
|
# header parameters
|
1374
1444
|
header_params = opts[:header_params] || {}
|
1375
1445
|
# klaviyo api revision
|
1376
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
1446
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
1377
1447
|
# HTTP header 'Accept' (if needed)
|
1378
1448
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1379
1449
|
# HTTP header 'Content-Type'
|
@@ -1412,7 +1482,7 @@ module KlaviyoAPI
|
|
1412
1482
|
end
|
1413
1483
|
|
1414
1484
|
# Suppress Profiles
|
1415
|
-
# Manually suppress
|
1485
|
+
# Manually suppress profiles using their email address, or by specifying a segment or list ID to suppress all current members. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `subscriptions:write`
|
1416
1486
|
# @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.
|
1417
1487
|
# @param [Hash] opts the optional parameters
|
1418
1488
|
# @return [nil]
|
@@ -1422,7 +1492,7 @@ module KlaviyoAPI
|
|
1422
1492
|
end
|
1423
1493
|
|
1424
1494
|
# Suppress Profiles
|
1425
|
-
# Manually suppress
|
1495
|
+
# Manually suppress profiles using their email address, or by specifying a segment or list ID to suppress all current members. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `subscriptions:write`
|
1426
1496
|
# @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.
|
1427
1497
|
# @param [Hash] opts the optional parameters
|
1428
1498
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -1443,7 +1513,7 @@ module KlaviyoAPI
|
|
1443
1513
|
# header parameters
|
1444
1514
|
header_params = opts[:header_params] || {}
|
1445
1515
|
# klaviyo api revision
|
1446
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
1516
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
1447
1517
|
# HTTP header 'Accept' (if needed)
|
1448
1518
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1449
1519
|
# HTTP header 'Content-Type'
|
@@ -1482,7 +1552,7 @@ module KlaviyoAPI
|
|
1482
1552
|
end
|
1483
1553
|
|
1484
1554
|
# Unsubscribe Profiles
|
1485
|
-
# Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
1555
|
+
# Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
1486
1556
|
# @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
|
1487
1557
|
# @param [Hash] opts the optional parameters
|
1488
1558
|
# @return [nil]
|
@@ -1492,7 +1562,7 @@ module KlaviyoAPI
|
|
1492
1562
|
end
|
1493
1563
|
|
1494
1564
|
# Unsubscribe Profiles
|
1495
|
-
# Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
1565
|
+
# Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
1496
1566
|
# @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
|
1497
1567
|
# @param [Hash] opts the optional parameters
|
1498
1568
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -1513,7 +1583,7 @@ module KlaviyoAPI
|
|
1513
1583
|
# header parameters
|
1514
1584
|
header_params = opts[:header_params] || {}
|
1515
1585
|
# klaviyo api revision
|
1516
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
1586
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
1517
1587
|
# HTTP header 'Accept' (if needed)
|
1518
1588
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1519
1589
|
# HTTP header 'Content-Type'
|
@@ -1552,7 +1622,7 @@ module KlaviyoAPI
|
|
1552
1622
|
end
|
1553
1623
|
|
1554
1624
|
# Unsuppress Profiles
|
1555
|
-
#
|
1625
|
+
# Manually unsuppress profiles using their email address, or by specifying a segment or list ID to unsuppress all current members. This only removes suppressions with reason `USER_SUPPRESSED`, leaving unsubscribed profiles and profiles suppressed with reason `INVALID_EMAIL` or `HARD_BOUNCE` unchanged. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:write`
|
1556
1626
|
# @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] 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.
|
1557
1627
|
# @param [Hash] opts the optional parameters
|
1558
1628
|
# @return [nil]
|
@@ -1562,7 +1632,7 @@ module KlaviyoAPI
|
|
1562
1632
|
end
|
1563
1633
|
|
1564
1634
|
# Unsuppress Profiles
|
1565
|
-
#
|
1635
|
+
# Manually unsuppress profiles using their email address, or by specifying a segment or list ID to unsuppress all current members. This only removes suppressions with reason `USER_SUPPRESSED`, leaving unsubscribed profiles and profiles suppressed with reason `INVALID_EMAIL` or `HARD_BOUNCE` unchanged. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:write`
|
1566
1636
|
# @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] 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.
|
1567
1637
|
# @param [Hash] opts the optional parameters
|
1568
1638
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -1583,7 +1653,7 @@ module KlaviyoAPI
|
|
1583
1653
|
# header parameters
|
1584
1654
|
header_params = opts[:header_params] || {}
|
1585
1655
|
# klaviyo api revision
|
1586
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
1656
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
1587
1657
|
# HTTP header 'Accept' (if needed)
|
1588
1658
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1589
1659
|
# HTTP header 'Content-Type'
|
@@ -1622,7 +1692,7 @@ module KlaviyoAPI
|
|
1622
1692
|
end
|
1623
1693
|
|
1624
1694
|
# Update Profile
|
1625
|
-
# Update the profile with the given profile ID
|
1695
|
+
# Update the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
1626
1696
|
# @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
|
1627
1697
|
# @param profile_partial_update_query [ProfilePartialUpdateQuery]
|
1628
1698
|
# @param [Hash] opts the optional parameters
|
@@ -1633,7 +1703,7 @@ module KlaviyoAPI
|
|
1633
1703
|
end
|
1634
1704
|
|
1635
1705
|
# Update Profile
|
1636
|
-
# Update the profile with the given profile ID
|
1706
|
+
# Update the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
1637
1707
|
# @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
|
1638
1708
|
# @param profile_partial_update_query [ProfilePartialUpdateQuery]
|
1639
1709
|
# @param [Hash] opts the optional parameters
|
@@ -1659,7 +1729,7 @@ module KlaviyoAPI
|
|
1659
1729
|
# header parameters
|
1660
1730
|
header_params = opts[:header_params] || {}
|
1661
1731
|
# klaviyo api revision
|
1662
|
-
header_params['revision'] = ENV['API_REVISION'] || "
|
1732
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
|
1663
1733
|
# HTTP header 'Accept' (if needed)
|
1664
1734
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1665
1735
|
# HTTP header 'Content-Type'
|