klaviyo-api-sdk 4.2.0 → 5.1.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 +281 -201
- data/docs/AccountsApi.md +4 -4
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +1 -1
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +1 -1
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationships.md +1 -1
- data/docs/CampaignsApi.md +52 -52
- data/docs/CatalogVariantCreateQueryResourceObject.md +1 -1
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +1 -1
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +1 -1
- data/docs/CatalogsApi.md +181 -181
- data/docs/CouponCodeCreateQueryResourceObject.md +1 -1
- data/docs/CouponCodeCreateQueryResourceObjectRelationships.md +1 -1
- data/docs/CouponsApi.md +46 -34
- data/docs/EmailSubscriptionParameters.md +18 -0
- data/docs/EventsApi.md +30 -30
- data/docs/FlowsApi.md +73 -73
- data/docs/ImagesApi.md +12 -12
- data/docs/ListsApi.md +45 -45
- data/docs/MarketingSubscriptionParameters.md +18 -0
- data/docs/MetricsApi.md +8 -8
- data/docs/ProfileBulkImportJobEnum.md +15 -0
- data/docs/ProfileImportJobCreateQuery.md +18 -0
- data/docs/ProfileImportJobCreateQueryResourceObject.md +22 -0
- data/docs/ProfileImportJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/ProfileImportJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/ProfileImportJobCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/ProfileImportJobCreateQueryResourceObjectRelationshipsLists.md +18 -0
- data/docs/ProfileImportJobCreateQueryResourceObjectRelationshipsListsDataInner.md +20 -0
- data/docs/ProfileLocation.md +3 -1
- data/docs/ProfileMergeQueryResourceObject.md +1 -1
- data/docs/ProfileMergeQueryResourceObjectRelationships.md +1 -1
- data/docs/ProfileUpsertQueryResourceObjectAttributes.md +2 -0
- data/docs/ProfilesApi.md +655 -33
- data/docs/SMSSubscriptionParameters.md +18 -0
- data/docs/SegmentsApi.md +35 -35
- data/docs/ServerBISSubscriptionCreateQueryResourceObject.md +1 -1
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md +1 -1
- data/docs/SubscriptionChannels.md +4 -4
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsListData.md +1 -1
- data/docs/TagsApi.md +35 -35
- data/docs/TemplatesApi.md +14 -14
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +7 -7
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +74 -74
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +265 -265
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +94 -52
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/events_api.rb +44 -44
- data/lib/klaviyo-api-sdk/api/flows_api.rb +94 -94
- data/lib/klaviyo-api-sdk/api/images_api.rb +20 -20
- data/lib/klaviyo-api-sdk/api/lists_api.rb +70 -70
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +701 -60
- data/lib/klaviyo-api-sdk/api/segments_api.rb +46 -46
- data/lib/klaviyo-api-sdk/api/tags_api.rb +65 -65
- data/lib/klaviyo-api-sdk/api/templates_api.rb +26 -26
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -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 +1 -6
- 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 +6 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
- 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 +1 -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 +1 -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 +1 -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/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 +1 -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 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +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 +1 -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 -1
- 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 +1 -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 +6 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
- 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 +1 -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 +6 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
- 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 +1 -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 +1 -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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +224 -0
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- 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 +1 -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 +1 -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 +259 -0
- 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 +1 -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 +1 -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 +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +1 -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 +36 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +226 -0
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +239 -0
- data/lib/klaviyo-api-sdk/models/profile_location.rb +15 -5
- 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 +6 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
- 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 +1 -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 +1 -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 +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +1 -1
- 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 +1 -1
- 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 +1 -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 +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +12 -2
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -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 +1 -1
- 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 +6 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -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 +6 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +224 -0
- data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +5 -33
- 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 +1 -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 -1
- 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 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +2 -2
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- 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_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- 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 -1
- 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 +1 -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 +1 -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 +1 -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 +1 -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 +1 -1
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +12 -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 +96 -96
- data/spec/api/coupons_api_spec.rb +23 -17
- data/spec/api/data_privacy_api_spec.rb +1 -1
- data/spec/api/events_api_spec.rb +17 -17
- data/spec/api/flows_api_spec.rb +39 -39
- data/spec/api/images_api_spec.rb +8 -8
- data/spec/api/lists_api_spec.rb +29 -29
- data/spec/api/metrics_api_spec.rb +5 -5
- data/spec/api/profiles_api_spec.rb +134 -21
- data/spec/api/segments_api_spec.rb +19 -19
- data/spec/api/tags_api_spec.rb +20 -20
- data/spec/api/templates_api_spec.rb +10 -10
- 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/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/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/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 +34 -0
- data/spec/models/email_tracking_options_sub_object_spec.rb +1 -1
- 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 +1 -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/flow_enum_spec.rb +1 -1
- 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/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 +38 -0
- 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 +28 -0
- 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 +34 -0
- data/spec/models/profile_import_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner_spec.rb +40 -0
- data/spec/models/profile_import_job_create_query_resource_object_relationships_lists_spec.rb +34 -0
- data/spec/models/profile_import_job_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/profile_import_job_create_query_resource_object_spec.rb +46 -0
- data/spec/models/profile_import_job_create_query_spec.rb +34 -0
- 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 +7 -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 +1 -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 +7 -1
- data/spec/models/profile_upsert_query_resource_object_spec.rb +1 -1
- 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 +1 -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 +34 -0
- 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 -9
- 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_spec.rb +1 -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_spec.rb +1 -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/utm_params_sub_object_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +35 -2
data/docs/ProfilesApi.md
CHANGED
@@ -6,6 +6,13 @@ All URIs are relative to *https://a.klaviyo.com*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**create_profile**](ProfilesApi.md#create_profile) | **POST** /api/profiles/ | Create Profile |
|
8
8
|
| [**create_push_token**](ProfilesApi.md#create_push_token) | **POST** /api/push-tokens/ | Create or Update Push Token |
|
9
|
+
| [**get_bulk_profile_import_job**](ProfilesApi.md#get_bulk_profile_import_job) | **GET** /api/profile-bulk-import-jobs/{job_id}/ | Get Bulk Profile Import Job |
|
10
|
+
| [**get_bulk_profile_import_job_import_errors**](ProfilesApi.md#get_bulk_profile_import_job_import_errors) | **GET** /api/profile-bulk-import-jobs/{id}/import-errors/ | Get Bulk Profile Import Job Import Errors |
|
11
|
+
| [**get_bulk_profile_import_job_lists**](ProfilesApi.md#get_bulk_profile_import_job_lists) | **GET** /api/profile-bulk-import-jobs/{id}/lists/ | Get Bulk Profile Import Job Lists |
|
12
|
+
| [**get_bulk_profile_import_job_profiles**](ProfilesApi.md#get_bulk_profile_import_job_profiles) | **GET** /api/profile-bulk-import-jobs/{id}/profiles/ | Get Bulk Profile Import Job Profiles |
|
13
|
+
| [**get_bulk_profile_import_job_relationships_lists**](ProfilesApi.md#get_bulk_profile_import_job_relationships_lists) | **GET** /api/profile-bulk-import-jobs/{id}/relationships/lists/ | Get Bulk Profile Import Job Relationships Lists |
|
14
|
+
| [**get_bulk_profile_import_job_relationships_profiles**](ProfilesApi.md#get_bulk_profile_import_job_relationships_profiles) | **GET** /api/profile-bulk-import-jobs/{id}/relationships/profiles/ | Get Bulk Profile Import Job Relationships Profiles |
|
15
|
+
| [**get_bulk_profile_import_jobs**](ProfilesApi.md#get_bulk_profile_import_jobs) | **GET** /api/profile-bulk-import-jobs/ | Get Bulk Profile Import Jobs |
|
9
16
|
| [**get_profile**](ProfilesApi.md#get_profile) | **GET** /api/profiles/{id}/ | Get Profile |
|
10
17
|
| [**get_profile_lists**](ProfilesApi.md#get_profile_lists) | **GET** /api/profiles/{id}/lists/ | Get Profile Lists |
|
11
18
|
| [**get_profile_relationships_lists**](ProfilesApi.md#get_profile_relationships_lists) | **GET** /api/profiles/{id}/relationships/lists/ | Get Profile Relationships Lists |
|
@@ -13,6 +20,7 @@ All URIs are relative to *https://a.klaviyo.com*
|
|
13
20
|
| [**get_profile_segments**](ProfilesApi.md#get_profile_segments) | **GET** /api/profiles/{id}/segments/ | Get Profile Segments |
|
14
21
|
| [**get_profiles**](ProfilesApi.md#get_profiles) | **GET** /api/profiles/ | Get Profiles |
|
15
22
|
| [**merge_profiles**](ProfilesApi.md#merge_profiles) | **POST** /api/profile-merge/ | Merge Profiles |
|
23
|
+
| [**spawn_bulk_profile_import_job**](ProfilesApi.md#spawn_bulk_profile_import_job) | **POST** /api/profile-bulk-import-jobs/ | Spawn Bulk Profile Import Job |
|
16
24
|
| [**subscribe_profiles**](ProfilesApi.md#subscribe_profiles) | **POST** /api/profile-subscription-bulk-create-jobs/ | Subscribe Profiles |
|
17
25
|
| [**suppress_profiles**](ProfilesApi.md#suppress_profiles) | **POST** /api/profile-suppression-bulk-create-jobs/ | Suppress Profiles |
|
18
26
|
| [**unsubscribe_profiles**](ProfilesApi.md#unsubscribe_profiles) | **POST** /api/profile-subscription-bulk-delete-jobs/ | Unsubscribe Profiles |
|
@@ -161,13 +169,556 @@ nil (empty response body)
|
|
161
169
|
- **Accept**: application/json
|
162
170
|
|
163
171
|
|
172
|
+
## get_bulk_profile_import_job
|
173
|
+
|
174
|
+
> Hash<String, Object> get_bulk_profile_import_job(job_id, opts)
|
175
|
+
|
176
|
+
Get Bulk Profile Import Job
|
177
|
+
|
178
|
+
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`
|
179
|
+
|
180
|
+
### Examples
|
181
|
+
|
182
|
+
```ruby
|
183
|
+
require 'time'
|
184
|
+
require 'klaviyo-api-sdk'
|
185
|
+
# setup authorization
|
186
|
+
KlaviyoAPI.configure do |config|
|
187
|
+
# Configure API key authorization: Klaviyo-API-Key
|
188
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
189
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
190
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
191
|
+
end
|
192
|
+
|
193
|
+
api_instance = KlaviyoAPI::ProfilesApi.new
|
194
|
+
job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
|
195
|
+
opts = {
|
196
|
+
fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
197
|
+
fields_profile_bulk_import_job: ['status'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
198
|
+
include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
|
199
|
+
}
|
200
|
+
|
201
|
+
begin
|
202
|
+
# Get Bulk Profile Import Job
|
203
|
+
result = api_instance.get_bulk_profile_import_job(job_id, opts)
|
204
|
+
p result
|
205
|
+
rescue KlaviyoAPI::ApiError => e
|
206
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_job: #{e}"
|
207
|
+
end
|
208
|
+
```
|
209
|
+
|
210
|
+
#### Using the get_bulk_profile_import_job_with_http_info variant
|
211
|
+
|
212
|
+
This returns an Array which contains the response data, status code and headers.
|
213
|
+
|
214
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_bulk_profile_import_job_with_http_info(job_id, opts)
|
215
|
+
|
216
|
+
```ruby
|
217
|
+
begin
|
218
|
+
# Get Bulk Profile Import Job
|
219
|
+
data, status_code, headers = api_instance.get_bulk_profile_import_job_with_http_info(job_id, opts)
|
220
|
+
p status_code # => 2xx
|
221
|
+
p headers # => { ... }
|
222
|
+
p data # => Hash<String, Object>
|
223
|
+
rescue KlaviyoAPI::ApiError => e
|
224
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_job_with_http_info: #{e}"
|
225
|
+
end
|
226
|
+
```
|
227
|
+
|
228
|
+
### Parameters
|
229
|
+
|
230
|
+
| Name | Type | Description | Notes |
|
231
|
+
| ---- | ---- | ----------- | ----- |
|
232
|
+
| **job_id** | **String** | ID of the job to retrieve. | |
|
233
|
+
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
234
|
+
| **fields_profile_bulk_import_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
235
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] |
|
236
|
+
|
237
|
+
### Return type
|
238
|
+
|
239
|
+
**Hash<String, Object>**
|
240
|
+
|
241
|
+
### Authorization
|
242
|
+
|
243
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
244
|
+
|
245
|
+
### HTTP request headers
|
246
|
+
|
247
|
+
- **Content-Type**: Not defined
|
248
|
+
- **Accept**: application/json
|
249
|
+
|
250
|
+
|
251
|
+
## get_bulk_profile_import_job_import_errors
|
252
|
+
|
253
|
+
> Hash<String, Object> get_bulk_profile_import_job_import_errors(id, opts)
|
254
|
+
|
255
|
+
Get Bulk Profile Import Job Import Errors
|
256
|
+
|
257
|
+
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`
|
258
|
+
|
259
|
+
### Examples
|
260
|
+
|
261
|
+
```ruby
|
262
|
+
require 'time'
|
263
|
+
require 'klaviyo-api-sdk'
|
264
|
+
# setup authorization
|
265
|
+
KlaviyoAPI.configure do |config|
|
266
|
+
# Configure API key authorization: Klaviyo-API-Key
|
267
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
268
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
269
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
270
|
+
end
|
271
|
+
|
272
|
+
api_instance = KlaviyoAPI::ProfilesApi.new
|
273
|
+
id = 'id_example' # String |
|
274
|
+
opts = {
|
275
|
+
fields_import_error: ['code'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
276
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
277
|
+
page_size: 56 # Integer | Default: 20. Min: 1. Max: 100.
|
278
|
+
}
|
279
|
+
|
280
|
+
begin
|
281
|
+
# Get Bulk Profile Import Job Import Errors
|
282
|
+
result = api_instance.get_bulk_profile_import_job_import_errors(id, opts)
|
283
|
+
p result
|
284
|
+
rescue KlaviyoAPI::ApiError => e
|
285
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_job_import_errors: #{e}"
|
286
|
+
end
|
287
|
+
```
|
288
|
+
|
289
|
+
#### Using the get_bulk_profile_import_job_import_errors_with_http_info variant
|
290
|
+
|
291
|
+
This returns an Array which contains the response data, status code and headers.
|
292
|
+
|
293
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_bulk_profile_import_job_import_errors_with_http_info(id, opts)
|
294
|
+
|
295
|
+
```ruby
|
296
|
+
begin
|
297
|
+
# Get Bulk Profile Import Job Import Errors
|
298
|
+
data, status_code, headers = api_instance.get_bulk_profile_import_job_import_errors_with_http_info(id, opts)
|
299
|
+
p status_code # => 2xx
|
300
|
+
p headers # => { ... }
|
301
|
+
p data # => Hash<String, Object>
|
302
|
+
rescue KlaviyoAPI::ApiError => e
|
303
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_job_import_errors_with_http_info: #{e}"
|
304
|
+
end
|
305
|
+
```
|
306
|
+
|
307
|
+
### Parameters
|
308
|
+
|
309
|
+
| Name | Type | Description | Notes |
|
310
|
+
| ---- | ---- | ----------- | ----- |
|
311
|
+
| **id** | **String** | | |
|
312
|
+
| **fields_import_error** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
313
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
|
314
|
+
| **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
|
315
|
+
|
316
|
+
### Return type
|
317
|
+
|
318
|
+
**Hash<String, Object>**
|
319
|
+
|
320
|
+
### Authorization
|
321
|
+
|
322
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
323
|
+
|
324
|
+
### HTTP request headers
|
325
|
+
|
326
|
+
- **Content-Type**: Not defined
|
327
|
+
- **Accept**: application/json
|
328
|
+
|
329
|
+
|
330
|
+
## get_bulk_profile_import_job_lists
|
331
|
+
|
332
|
+
> Hash<String, Object> get_bulk_profile_import_job_lists(id, opts)
|
333
|
+
|
334
|
+
Get Bulk Profile Import Job Lists
|
335
|
+
|
336
|
+
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`
|
337
|
+
|
338
|
+
### Examples
|
339
|
+
|
340
|
+
```ruby
|
341
|
+
require 'time'
|
342
|
+
require 'klaviyo-api-sdk'
|
343
|
+
# setup authorization
|
344
|
+
KlaviyoAPI.configure do |config|
|
345
|
+
# Configure API key authorization: Klaviyo-API-Key
|
346
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
347
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
348
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
349
|
+
end
|
350
|
+
|
351
|
+
api_instance = KlaviyoAPI::ProfilesApi.new
|
352
|
+
id = 'id_example' # String |
|
353
|
+
opts = {
|
354
|
+
fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
355
|
+
}
|
356
|
+
|
357
|
+
begin
|
358
|
+
# Get Bulk Profile Import Job Lists
|
359
|
+
result = api_instance.get_bulk_profile_import_job_lists(id, opts)
|
360
|
+
p result
|
361
|
+
rescue KlaviyoAPI::ApiError => e
|
362
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_job_lists: #{e}"
|
363
|
+
end
|
364
|
+
```
|
365
|
+
|
366
|
+
#### Using the get_bulk_profile_import_job_lists_with_http_info variant
|
367
|
+
|
368
|
+
This returns an Array which contains the response data, status code and headers.
|
369
|
+
|
370
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_bulk_profile_import_job_lists_with_http_info(id, opts)
|
371
|
+
|
372
|
+
```ruby
|
373
|
+
begin
|
374
|
+
# Get Bulk Profile Import Job Lists
|
375
|
+
data, status_code, headers = api_instance.get_bulk_profile_import_job_lists_with_http_info(id, opts)
|
376
|
+
p status_code # => 2xx
|
377
|
+
p headers # => { ... }
|
378
|
+
p data # => Hash<String, Object>
|
379
|
+
rescue KlaviyoAPI::ApiError => e
|
380
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_job_lists_with_http_info: #{e}"
|
381
|
+
end
|
382
|
+
```
|
383
|
+
|
384
|
+
### Parameters
|
385
|
+
|
386
|
+
| Name | Type | Description | Notes |
|
387
|
+
| ---- | ---- | ----------- | ----- |
|
388
|
+
| **id** | **String** | | |
|
389
|
+
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
390
|
+
|
391
|
+
### Return type
|
392
|
+
|
393
|
+
**Hash<String, Object>**
|
394
|
+
|
395
|
+
### Authorization
|
396
|
+
|
397
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
398
|
+
|
399
|
+
### HTTP request headers
|
400
|
+
|
401
|
+
- **Content-Type**: Not defined
|
402
|
+
- **Accept**: application/json
|
403
|
+
|
404
|
+
|
405
|
+
## get_bulk_profile_import_job_profiles
|
406
|
+
|
407
|
+
> Hash<String, Object> get_bulk_profile_import_job_profiles(id, opts)
|
408
|
+
|
409
|
+
Get Bulk Profile Import Job Profiles
|
410
|
+
|
411
|
+
Get profiles 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`
|
412
|
+
|
413
|
+
### Examples
|
414
|
+
|
415
|
+
```ruby
|
416
|
+
require 'time'
|
417
|
+
require 'klaviyo-api-sdk'
|
418
|
+
# setup authorization
|
419
|
+
KlaviyoAPI.configure do |config|
|
420
|
+
# Configure API key authorization: Klaviyo-API-Key
|
421
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
422
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
423
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
424
|
+
end
|
425
|
+
|
426
|
+
api_instance = KlaviyoAPI::ProfilesApi.new
|
427
|
+
id = 'id_example' # String |
|
428
|
+
opts = {
|
429
|
+
additional_fields_profile: ['subscriptions'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
430
|
+
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
431
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
432
|
+
page_size: 56 # Integer | Default: 20. Min: 1. Max: 100.
|
433
|
+
}
|
434
|
+
|
435
|
+
begin
|
436
|
+
# Get Bulk Profile Import Job Profiles
|
437
|
+
result = api_instance.get_bulk_profile_import_job_profiles(id, opts)
|
438
|
+
p result
|
439
|
+
rescue KlaviyoAPI::ApiError => e
|
440
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_job_profiles: #{e}"
|
441
|
+
end
|
442
|
+
```
|
443
|
+
|
444
|
+
#### Using the get_bulk_profile_import_job_profiles_with_http_info variant
|
445
|
+
|
446
|
+
This returns an Array which contains the response data, status code and headers.
|
447
|
+
|
448
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_bulk_profile_import_job_profiles_with_http_info(id, opts)
|
449
|
+
|
450
|
+
```ruby
|
451
|
+
begin
|
452
|
+
# Get Bulk Profile Import Job Profiles
|
453
|
+
data, status_code, headers = api_instance.get_bulk_profile_import_job_profiles_with_http_info(id, opts)
|
454
|
+
p status_code # => 2xx
|
455
|
+
p headers # => { ... }
|
456
|
+
p data # => Hash<String, Object>
|
457
|
+
rescue KlaviyoAPI::ApiError => e
|
458
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_job_profiles_with_http_info: #{e}"
|
459
|
+
end
|
460
|
+
```
|
461
|
+
|
462
|
+
### Parameters
|
463
|
+
|
464
|
+
| Name | Type | Description | Notes |
|
465
|
+
| ---- | ---- | ----------- | ----- |
|
466
|
+
| **id** | **String** | | |
|
467
|
+
| **additional_fields_profile** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | [optional] |
|
468
|
+
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
469
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
|
470
|
+
| **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
|
471
|
+
|
472
|
+
### Return type
|
473
|
+
|
474
|
+
**Hash<String, Object>**
|
475
|
+
|
476
|
+
### Authorization
|
477
|
+
|
478
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
479
|
+
|
480
|
+
### HTTP request headers
|
481
|
+
|
482
|
+
- **Content-Type**: Not defined
|
483
|
+
- **Accept**: application/json
|
484
|
+
|
485
|
+
|
486
|
+
## get_bulk_profile_import_job_relationships_lists
|
487
|
+
|
488
|
+
> Hash<String, Object> get_bulk_profile_import_job_relationships_lists(id)
|
489
|
+
|
490
|
+
Get Bulk Profile Import Job Relationships Lists
|
491
|
+
|
492
|
+
Get list relationship 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`
|
493
|
+
|
494
|
+
### Examples
|
495
|
+
|
496
|
+
```ruby
|
497
|
+
require 'time'
|
498
|
+
require 'klaviyo-api-sdk'
|
499
|
+
# setup authorization
|
500
|
+
KlaviyoAPI.configure do |config|
|
501
|
+
# Configure API key authorization: Klaviyo-API-Key
|
502
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
503
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
504
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
505
|
+
end
|
506
|
+
|
507
|
+
api_instance = KlaviyoAPI::ProfilesApi.new
|
508
|
+
id = 'id_example' # String |
|
509
|
+
|
510
|
+
begin
|
511
|
+
# Get Bulk Profile Import Job Relationships Lists
|
512
|
+
result = api_instance.get_bulk_profile_import_job_relationships_lists(id)
|
513
|
+
p result
|
514
|
+
rescue KlaviyoAPI::ApiError => e
|
515
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_job_relationships_lists: #{e}"
|
516
|
+
end
|
517
|
+
```
|
518
|
+
|
519
|
+
#### Using the get_bulk_profile_import_job_relationships_lists_with_http_info variant
|
520
|
+
|
521
|
+
This returns an Array which contains the response data, status code and headers.
|
522
|
+
|
523
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_bulk_profile_import_job_relationships_lists_with_http_info(id)
|
524
|
+
|
525
|
+
```ruby
|
526
|
+
begin
|
527
|
+
# Get Bulk Profile Import Job Relationships Lists
|
528
|
+
data, status_code, headers = api_instance.get_bulk_profile_import_job_relationships_lists_with_http_info(id)
|
529
|
+
p status_code # => 2xx
|
530
|
+
p headers # => { ... }
|
531
|
+
p data # => Hash<String, Object>
|
532
|
+
rescue KlaviyoAPI::ApiError => e
|
533
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_job_relationships_lists_with_http_info: #{e}"
|
534
|
+
end
|
535
|
+
```
|
536
|
+
|
537
|
+
### Parameters
|
538
|
+
|
539
|
+
| Name | Type | Description | Notes |
|
540
|
+
| ---- | ---- | ----------- | ----- |
|
541
|
+
| **id** | **String** | | |
|
542
|
+
|
543
|
+
### Return type
|
544
|
+
|
545
|
+
**Hash<String, Object>**
|
546
|
+
|
547
|
+
### Authorization
|
548
|
+
|
549
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
550
|
+
|
551
|
+
### HTTP request headers
|
552
|
+
|
553
|
+
- **Content-Type**: Not defined
|
554
|
+
- **Accept**: application/json
|
555
|
+
|
556
|
+
|
557
|
+
## get_bulk_profile_import_job_relationships_profiles
|
558
|
+
|
559
|
+
> Hash<String, Object> get_bulk_profile_import_job_relationships_profiles(id, opts)
|
560
|
+
|
561
|
+
Get Bulk Profile Import Job Relationships Profiles
|
562
|
+
|
563
|
+
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`
|
564
|
+
|
565
|
+
### Examples
|
566
|
+
|
567
|
+
```ruby
|
568
|
+
require 'time'
|
569
|
+
require 'klaviyo-api-sdk'
|
570
|
+
# setup authorization
|
571
|
+
KlaviyoAPI.configure do |config|
|
572
|
+
# Configure API key authorization: Klaviyo-API-Key
|
573
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
574
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
575
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
576
|
+
end
|
577
|
+
|
578
|
+
api_instance = KlaviyoAPI::ProfilesApi.new
|
579
|
+
id = 'id_example' # String |
|
580
|
+
opts = {
|
581
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
582
|
+
page_size: 56 # Integer | Default: 20. Min: 1. Max: 100.
|
583
|
+
}
|
584
|
+
|
585
|
+
begin
|
586
|
+
# Get Bulk Profile Import Job Relationships Profiles
|
587
|
+
result = api_instance.get_bulk_profile_import_job_relationships_profiles(id, opts)
|
588
|
+
p result
|
589
|
+
rescue KlaviyoAPI::ApiError => e
|
590
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_job_relationships_profiles: #{e}"
|
591
|
+
end
|
592
|
+
```
|
593
|
+
|
594
|
+
#### Using the get_bulk_profile_import_job_relationships_profiles_with_http_info variant
|
595
|
+
|
596
|
+
This returns an Array which contains the response data, status code and headers.
|
597
|
+
|
598
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts)
|
599
|
+
|
600
|
+
```ruby
|
601
|
+
begin
|
602
|
+
# Get Bulk Profile Import Job Relationships Profiles
|
603
|
+
data, status_code, headers = api_instance.get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts)
|
604
|
+
p status_code # => 2xx
|
605
|
+
p headers # => { ... }
|
606
|
+
p data # => Hash<String, Object>
|
607
|
+
rescue KlaviyoAPI::ApiError => e
|
608
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_job_relationships_profiles_with_http_info: #{e}"
|
609
|
+
end
|
610
|
+
```
|
611
|
+
|
612
|
+
### Parameters
|
613
|
+
|
614
|
+
| Name | Type | Description | Notes |
|
615
|
+
| ---- | ---- | ----------- | ----- |
|
616
|
+
| **id** | **String** | | |
|
617
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
|
618
|
+
| **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
|
619
|
+
|
620
|
+
### Return type
|
621
|
+
|
622
|
+
**Hash<String, Object>**
|
623
|
+
|
624
|
+
### Authorization
|
625
|
+
|
626
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
627
|
+
|
628
|
+
### HTTP request headers
|
629
|
+
|
630
|
+
- **Content-Type**: Not defined
|
631
|
+
- **Accept**: application/json
|
632
|
+
|
633
|
+
|
634
|
+
## get_bulk_profile_import_jobs
|
635
|
+
|
636
|
+
> Hash<String, Object> get_bulk_profile_import_jobs(opts)
|
637
|
+
|
638
|
+
Get Bulk Profile Import Jobs
|
639
|
+
|
640
|
+
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`
|
641
|
+
|
642
|
+
### Examples
|
643
|
+
|
644
|
+
```ruby
|
645
|
+
require 'time'
|
646
|
+
require 'klaviyo-api-sdk'
|
647
|
+
# setup authorization
|
648
|
+
KlaviyoAPI.configure do |config|
|
649
|
+
# Configure API key authorization: Klaviyo-API-Key
|
650
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
651
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
652
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
653
|
+
end
|
654
|
+
|
655
|
+
api_instance = KlaviyoAPI::ProfilesApi.new
|
656
|
+
opts = {
|
657
|
+
fields_profile_bulk_import_job: ['status'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
658
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
659
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
660
|
+
page_size: 56, # Integer | Default: 20. Min: 1. Max: 100.
|
661
|
+
sort: 'created_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
|
662
|
+
}
|
663
|
+
|
664
|
+
begin
|
665
|
+
# Get Bulk Profile Import Jobs
|
666
|
+
result = api_instance.get_bulk_profile_import_jobs(opts)
|
667
|
+
p result
|
668
|
+
rescue KlaviyoAPI::ApiError => e
|
669
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_jobs: #{e}"
|
670
|
+
end
|
671
|
+
```
|
672
|
+
|
673
|
+
#### Using the get_bulk_profile_import_jobs_with_http_info variant
|
674
|
+
|
675
|
+
This returns an Array which contains the response data, status code and headers.
|
676
|
+
|
677
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_bulk_profile_import_jobs_with_http_info(opts)
|
678
|
+
|
679
|
+
```ruby
|
680
|
+
begin
|
681
|
+
# Get Bulk Profile Import Jobs
|
682
|
+
data, status_code, headers = api_instance.get_bulk_profile_import_jobs_with_http_info(opts)
|
683
|
+
p status_code # => 2xx
|
684
|
+
p headers # => { ... }
|
685
|
+
p data # => Hash<String, Object>
|
686
|
+
rescue KlaviyoAPI::ApiError => e
|
687
|
+
puts "Error when calling ProfilesApi->get_bulk_profile_import_jobs_with_http_info: #{e}"
|
688
|
+
end
|
689
|
+
```
|
690
|
+
|
691
|
+
### Parameters
|
692
|
+
|
693
|
+
| Name | Type | Description | Notes |
|
694
|
+
| ---- | ---- | ----------- | ----- |
|
695
|
+
| **fields_profile_bulk_import_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
696
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals` | [optional] |
|
697
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
|
698
|
+
| **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
|
699
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] |
|
700
|
+
|
701
|
+
### Return type
|
702
|
+
|
703
|
+
**Hash<String, Object>**
|
704
|
+
|
705
|
+
### Authorization
|
706
|
+
|
707
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
708
|
+
|
709
|
+
### HTTP request headers
|
710
|
+
|
711
|
+
- **Content-Type**: Not defined
|
712
|
+
- **Accept**: application/json
|
713
|
+
|
714
|
+
|
164
715
|
## get_profile
|
165
716
|
|
166
717
|
> Hash<String, Object> get_profile(id, opts)
|
167
718
|
|
168
719
|
Get Profile
|
169
720
|
|
170
|
-
Get the profile with the given profile ID
|
721
|
+
Get the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read`
|
171
722
|
|
172
723
|
### Examples
|
173
724
|
|
@@ -185,11 +736,11 @@ end
|
|
185
736
|
api_instance = KlaviyoAPI::ProfilesApi.new
|
186
737
|
id = 'id_example' # String |
|
187
738
|
opts = {
|
188
|
-
additional_fields_profile: ['
|
189
|
-
fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
190
|
-
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
191
|
-
fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
192
|
-
include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
739
|
+
additional_fields_profile: ['subscriptions'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
740
|
+
fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
741
|
+
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
742
|
+
fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
743
|
+
include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
|
193
744
|
}
|
194
745
|
|
195
746
|
begin
|
@@ -224,11 +775,11 @@ end
|
|
224
775
|
| Name | Type | Description | Notes |
|
225
776
|
| ---- | ---- | ----------- | ----- |
|
226
777
|
| **id** | **String** | | |
|
227
|
-
| **additional_fields_profile** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'predictive_analytics' | [optional] |
|
228
|
-
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
229
|
-
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
230
|
-
| **fields_segment** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
231
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
778
|
+
| **additional_fields_profile** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | [optional] |
|
779
|
+
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
780
|
+
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
781
|
+
| **fields_segment** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
782
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] |
|
232
783
|
|
233
784
|
### Return type
|
234
785
|
|
@@ -250,7 +801,7 @@ end
|
|
250
801
|
|
251
802
|
Get Profile Lists
|
252
803
|
|
253
|
-
Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
804
|
+
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`
|
254
805
|
|
255
806
|
### Examples
|
256
807
|
|
@@ -268,7 +819,7 @@ end
|
|
268
819
|
api_instance = KlaviyoAPI::ProfilesApi.new
|
269
820
|
id = 'id_example' # String |
|
270
821
|
opts = {
|
271
|
-
fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
822
|
+
fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
272
823
|
}
|
273
824
|
|
274
825
|
begin
|
@@ -303,7 +854,7 @@ end
|
|
303
854
|
| Name | Type | Description | Notes |
|
304
855
|
| ---- | ---- | ----------- | ----- |
|
305
856
|
| **id** | **String** | | |
|
306
|
-
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
857
|
+
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
307
858
|
|
308
859
|
### Return type
|
309
860
|
|
@@ -325,7 +876,7 @@ end
|
|
325
876
|
|
326
877
|
Get Profile Relationships Lists
|
327
878
|
|
328
|
-
Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
879
|
+
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`
|
329
880
|
|
330
881
|
### Examples
|
331
882
|
|
@@ -485,7 +1036,7 @@ end
|
|
485
1036
|
api_instance = KlaviyoAPI::ProfilesApi.new
|
486
1037
|
id = 'id_example' # String |
|
487
1038
|
opts = {
|
488
|
-
fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1039
|
+
fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
489
1040
|
}
|
490
1041
|
|
491
1042
|
begin
|
@@ -520,7 +1071,7 @@ end
|
|
520
1071
|
| Name | Type | Description | Notes |
|
521
1072
|
| ---- | ---- | ----------- | ----- |
|
522
1073
|
| **id** | **String** | | |
|
523
|
-
| **fields_segment** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1074
|
+
| **fields_segment** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
524
1075
|
|
525
1076
|
### Return type
|
526
1077
|
|
@@ -542,7 +1093,7 @@ end
|
|
542
1093
|
|
543
1094
|
Get Profiles
|
544
1095
|
|
545
|
-
Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`<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/v2023-
|
1096
|
+
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/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
546
1097
|
|
547
1098
|
### Examples
|
548
1099
|
|
@@ -559,12 +1110,12 @@ end
|
|
559
1110
|
|
560
1111
|
api_instance = KlaviyoAPI::ProfilesApi.new
|
561
1112
|
opts = {
|
562
|
-
additional_fields_profile: ['
|
563
|
-
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
564
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
565
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1113
|
+
additional_fields_profile: ['subscriptions'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1114
|
+
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
1115
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-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`
|
1116
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
566
1117
|
page_size: 56, # Integer | Default: 20. Min: 1. Max: 100.
|
567
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1118
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
|
568
1119
|
}
|
569
1120
|
|
570
1121
|
begin
|
@@ -598,12 +1149,12 @@ end
|
|
598
1149
|
|
599
1150
|
| Name | Type | Description | Notes |
|
600
1151
|
| ---- | ---- | ----------- | ----- |
|
601
|
-
| **additional_fields_profile** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'predictive_analytics' | [optional] |
|
602
|
-
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
603
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
604
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1152
|
+
| **additional_fields_profile** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | [optional] |
|
1153
|
+
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1154
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-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` | [optional] |
|
1155
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
|
605
1156
|
| **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
|
606
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1157
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] |
|
607
1158
|
|
608
1159
|
### Return type
|
609
1160
|
|
@@ -641,7 +1192,7 @@ KlaviyoAPI.configure do |config|
|
|
641
1192
|
end
|
642
1193
|
|
643
1194
|
api_instance = KlaviyoAPI::ProfilesApi.new
|
644
|
-
profile_merge_query = KlaviyoAPI::ProfileMergeQuery.new({data: KlaviyoAPI::ProfileMergeQueryResourceObject.new({type: KlaviyoAPI::ProfileMergeEnum::PROFILE_MERGE, id: '01GDDKASAP8TKDDA2GRZDSVP4H'})}) # ProfileMergeQuery |
|
1195
|
+
profile_merge_query = KlaviyoAPI::ProfileMergeQuery.new({data: KlaviyoAPI::ProfileMergeQueryResourceObject.new({type: KlaviyoAPI::ProfileMergeEnum::PROFILE_MERGE, id: '01GDDKASAP8TKDDA2GRZDSVP4H', relationships: KlaviyoAPI::ProfileMergeQueryResourceObjectRelationships.new({profiles: KlaviyoAPI::ProfileMergeQueryResourceObjectRelationshipsProfiles.new({data: [KlaviyoAPI::ProfileMergeQueryResourceObjectRelationshipsProfilesDataInner.new({type: KlaviyoAPI::ProfileEnum::PROFILE, id: '01GDDKASAP8TKDDA2GRZDSVP4I'})]})})})}) # ProfileMergeQuery |
|
645
1196
|
|
646
1197
|
begin
|
647
1198
|
# Merge Profiles
|
@@ -690,13 +1241,84 @@ end
|
|
690
1241
|
- **Accept**: application/json
|
691
1242
|
|
692
1243
|
|
1244
|
+
## spawn_bulk_profile_import_job
|
1245
|
+
|
1246
|
+
> Hash<String, Object> spawn_bulk_profile_import_job(profile_import_job_create_query)
|
1247
|
+
|
1248
|
+
Spawn Bulk Profile Import Job
|
1249
|
+
|
1250
|
+
*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
|
1251
|
+
|
1252
|
+
### Examples
|
1253
|
+
|
1254
|
+
```ruby
|
1255
|
+
require 'time'
|
1256
|
+
require 'klaviyo-api-sdk'
|
1257
|
+
# setup authorization
|
1258
|
+
KlaviyoAPI.configure do |config|
|
1259
|
+
# Configure API key authorization: Klaviyo-API-Key
|
1260
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
1261
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1262
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
1263
|
+
end
|
1264
|
+
|
1265
|
+
api_instance = KlaviyoAPI::ProfilesApi.new
|
1266
|
+
profile_import_job_create_query = KlaviyoAPI::ProfileImportJobCreateQuery.new({data: KlaviyoAPI::ProfileImportJobCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileBulkImportJobEnum::PROFILE_BULK_IMPORT_JOB, attributes: KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectAttributes.new({profiles: KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectAttributesProfiles.new({data: [KlaviyoAPI::ProfileUpsertQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileUpsertQueryResourceObjectAttributes.new})]})})})}) # ProfileImportJobCreateQuery |
|
1267
|
+
|
1268
|
+
begin
|
1269
|
+
# Spawn Bulk Profile Import Job
|
1270
|
+
result = api_instance.spawn_bulk_profile_import_job(profile_import_job_create_query)
|
1271
|
+
p result
|
1272
|
+
rescue KlaviyoAPI::ApiError => e
|
1273
|
+
puts "Error when calling ProfilesApi->spawn_bulk_profile_import_job: #{e}"
|
1274
|
+
end
|
1275
|
+
```
|
1276
|
+
|
1277
|
+
#### Using the spawn_bulk_profile_import_job_with_http_info variant
|
1278
|
+
|
1279
|
+
This returns an Array which contains the response data, status code and headers.
|
1280
|
+
|
1281
|
+
> <Array(Hash<String, Object>, Integer, Hash)> spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query)
|
1282
|
+
|
1283
|
+
```ruby
|
1284
|
+
begin
|
1285
|
+
# Spawn Bulk Profile Import Job
|
1286
|
+
data, status_code, headers = api_instance.spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query)
|
1287
|
+
p status_code # => 2xx
|
1288
|
+
p headers # => { ... }
|
1289
|
+
p data # => Hash<String, Object>
|
1290
|
+
rescue KlaviyoAPI::ApiError => e
|
1291
|
+
puts "Error when calling ProfilesApi->spawn_bulk_profile_import_job_with_http_info: #{e}"
|
1292
|
+
end
|
1293
|
+
```
|
1294
|
+
|
1295
|
+
### Parameters
|
1296
|
+
|
1297
|
+
| Name | Type | Description | Notes |
|
1298
|
+
| ---- | ---- | ----------- | ----- |
|
1299
|
+
| **profile_import_job_create_query** | [**ProfileImportJobCreateQuery**](ProfileImportJobCreateQuery.md) | | |
|
1300
|
+
|
1301
|
+
### Return type
|
1302
|
+
|
1303
|
+
**Hash<String, Object>**
|
1304
|
+
|
1305
|
+
### Authorization
|
1306
|
+
|
1307
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
1308
|
+
|
1309
|
+
### HTTP request headers
|
1310
|
+
|
1311
|
+
- **Content-Type**: application/json
|
1312
|
+
- **Accept**: application/json
|
1313
|
+
|
1314
|
+
|
693
1315
|
## subscribe_profiles
|
694
1316
|
|
695
1317
|
> subscribe_profiles(subscription_create_job_create_query)
|
696
1318
|
|
697
1319
|
Subscribe Profiles
|
698
1320
|
|
699
|
-
Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about suppressed profiles in [this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of
|
1321
|
+
Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about suppressed profiles in [this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of 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`
|
700
1322
|
|
701
1323
|
### Examples
|
702
1324
|
|
@@ -766,7 +1388,7 @@ nil (empty response body)
|
|
766
1388
|
|
767
1389
|
Suppress Profiles
|
768
1390
|
|
769
|
-
Manually suppress one or more profiles. Such profiles will have `USER_SUPPRESSED` as their suppression reason. Manually suppressed profiles _will not_ receive email marketing. Learn more about suppressed profiles
|
1391
|
+
Manually suppress one or more profiles. Such profiles will have `USER_SUPPRESSED` as their suppression reason. Manually suppressed profiles _will not_ receive email marketing. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Learn about [collecting consent and best practices](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Not supported for SMS marketing. Maximum number of profile can be submitted for suppression: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `subscriptions:write`
|
770
1392
|
|
771
1393
|
### Examples
|
772
1394
|
|
@@ -836,7 +1458,7 @@ nil (empty response body)
|
|
836
1458
|
|
837
1459
|
Unsubscribe Profiles
|
838
1460
|
|
839
|
-
Unsubscribe one or more profiles to email marketing, SMS marketing, or both. 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:** `
|
1461
|
+
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`
|
840
1462
|
|
841
1463
|
### Examples
|
842
1464
|
|
@@ -906,7 +1528,7 @@ nil (empty response body)
|
|
906
1528
|
|
907
1529
|
Unsuppress Profiles
|
908
1530
|
|
909
|
-
Unsuppress one or more profiles, this will remove any Manual Suppressions (USER_SUPPRESSED) on these profiles. A profile may receive email marketing after a manual suppression is removed so long as they have not revoked consent, i.e. unsubscribed. Not supported for SMS marketing. Only manual suppressions (USER_SUPPRESSED) will be removed. `UNSUBSCRIBE` and `SPAM_REPORT` suppressions are removed whenever a [profile resubscribes](https://developers.klaviyo.com/en/reference/subscribe_profiles). `INVALID_EMAIL` and `HARD_BOUNCE` suppressions cannot be removed by the API. Maximum number of profile can be submitted for unsuppression: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:write`
|
1531
|
+
Unsuppress one or more profiles, this will remove any Manual Suppressions (USER_SUPPRESSED) on these profiles. A profile may receive email marketing after a manual suppression is removed so long as they have not revoked [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api), i.e. unsubscribed. Not supported for SMS marketing. Only manual suppressions (USER_SUPPRESSED) will be removed. `UNSUBSCRIBE` and `SPAM_REPORT` suppressions are removed whenever a [profile resubscribes](https://developers.klaviyo.com/en/reference/subscribe_profiles). `INVALID_EMAIL` and `HARD_BOUNCE` suppressions cannot be removed by the API. Maximum number of profile can be submitted for unsuppression: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:write`
|
910
1532
|
|
911
1533
|
### Examples
|
912
1534
|
|