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
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2023-
|
6
|
+
The version of the OpenAPI document: 2023-12-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -51,7 +51,7 @@ module KlaviyoAPI
|
|
51
51
|
# header parameters
|
52
52
|
header_params = opts[:header_params] || {}
|
53
53
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
54
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
55
55
|
# HTTP header 'Accept' (if needed)
|
56
56
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
57
|
# HTTP header 'Content-Type'
|
@@ -121,7 +121,7 @@ module KlaviyoAPI
|
|
121
121
|
# header parameters
|
122
122
|
header_params = opts[:header_params] || {}
|
123
123
|
# klaviyo api revision
|
124
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
124
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
125
125
|
# HTTP header 'Accept' (if needed)
|
126
126
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
127
127
|
# HTTP header 'Content-Type'
|
@@ -159,15 +159,586 @@ module KlaviyoAPI
|
|
159
159
|
return data, status_code, headers
|
160
160
|
end
|
161
161
|
|
162
|
+
# Get Bulk Profile Import Job
|
163
|
+
# Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
164
|
+
# @param job_id [String] ID of the job to retrieve.
|
165
|
+
# @param [Hash] opts the optional parameters
|
166
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
167
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
168
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
|
169
|
+
# @return [Hash<String, Object>]
|
170
|
+
def get_bulk_profile_import_job(job_id, opts = {})
|
171
|
+
data, _status_code, _headers = get_bulk_profile_import_job_with_http_info(job_id, opts)
|
172
|
+
data
|
173
|
+
end
|
174
|
+
|
175
|
+
# Get Bulk Profile Import Job
|
176
|
+
# Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
177
|
+
# @param job_id [String] ID of the job to retrieve.
|
178
|
+
# @param [Hash] opts the optional parameters
|
179
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
180
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
181
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
|
182
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
183
|
+
def get_bulk_profile_import_job_with_http_info(job_id, opts = {})
|
184
|
+
if @api_client.config.debugging
|
185
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_job ...'
|
186
|
+
end
|
187
|
+
# verify the required parameter 'job_id' is set
|
188
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
189
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_profile_import_job"
|
190
|
+
end
|
191
|
+
allowable_values = ["name", "created", "updated"]
|
192
|
+
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
193
|
+
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
194
|
+
end
|
195
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "expires_at", "started_at"]
|
196
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile_bulk_import_job'] && !opts[:'fields_profile_bulk_import_job'].all? { |item| allowable_values.include?(item) }
|
197
|
+
fail ArgumentError, "invalid value for \"fields_profile_bulk_import_job\", must include one of #{allowable_values}"
|
198
|
+
end
|
199
|
+
allowable_values = ["lists"]
|
200
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
201
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
202
|
+
end
|
203
|
+
# resource path
|
204
|
+
local_var_path = '/api/profile-bulk-import-jobs/{job_id}/'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
205
|
+
|
206
|
+
# query parameters
|
207
|
+
query_params = opts[:query_params] || {}
|
208
|
+
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
209
|
+
query_params[:'fields[profile-bulk-import-job]'] = @api_client.build_collection_param(opts[:'fields_profile_bulk_import_job'], :csv) if !opts[:'fields_profile_bulk_import_job'].nil?
|
210
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
211
|
+
|
212
|
+
# header parameters
|
213
|
+
header_params = opts[:header_params] || {}
|
214
|
+
# klaviyo api revision
|
215
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
216
|
+
# HTTP header 'Accept' (if needed)
|
217
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
218
|
+
|
219
|
+
# form parameters
|
220
|
+
form_params = opts[:form_params] || {}
|
221
|
+
|
222
|
+
# http body (model)
|
223
|
+
post_body = opts[:debug_body]
|
224
|
+
|
225
|
+
# return_type
|
226
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
227
|
+
|
228
|
+
# auth_names
|
229
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
230
|
+
|
231
|
+
new_options = opts.merge(
|
232
|
+
:operation => :"ProfilesApi.get_bulk_profile_import_job",
|
233
|
+
:header_params => header_params,
|
234
|
+
:query_params => query_params,
|
235
|
+
:form_params => form_params,
|
236
|
+
:body => post_body,
|
237
|
+
:auth_names => auth_names,
|
238
|
+
:return_type => return_type
|
239
|
+
)
|
240
|
+
|
241
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
242
|
+
if @api_client.config.debugging
|
243
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
244
|
+
end
|
245
|
+
return data, status_code, headers
|
246
|
+
end
|
247
|
+
|
248
|
+
# Get Bulk Profile Import Job Import Errors
|
249
|
+
# Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
250
|
+
# @param id [String]
|
251
|
+
# @param [Hash] opts the optional parameters
|
252
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
253
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
254
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
255
|
+
# @return [Hash<String, Object>]
|
256
|
+
def get_bulk_profile_import_job_import_errors(id, opts = {})
|
257
|
+
data, _status_code, _headers = get_bulk_profile_import_job_import_errors_with_http_info(id, opts)
|
258
|
+
data
|
259
|
+
end
|
260
|
+
|
261
|
+
# Get Bulk Profile Import Job Import Errors
|
262
|
+
# Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
263
|
+
# @param id [String]
|
264
|
+
# @param [Hash] opts the optional parameters
|
265
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
266
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
267
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
268
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
269
|
+
def get_bulk_profile_import_job_import_errors_with_http_info(id, opts = {})
|
270
|
+
if @api_client.config.debugging
|
271
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_job_import_errors ...'
|
272
|
+
end
|
273
|
+
# verify the required parameter 'id' is set
|
274
|
+
if @api_client.config.client_side_validation && id.nil?
|
275
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_import_errors"
|
276
|
+
end
|
277
|
+
allowable_values = ["code", "title", "detail", "source", "source.pointer", "original_payload"]
|
278
|
+
if @api_client.config.client_side_validation && opts[:'fields_import_error'] && !opts[:'fields_import_error'].all? { |item| allowable_values.include?(item) }
|
279
|
+
fail ArgumentError, "invalid value for \"fields_import_error\", must include one of #{allowable_values}"
|
280
|
+
end
|
281
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
282
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_import_errors, must be smaller than or equal to 100.'
|
283
|
+
end
|
284
|
+
|
285
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
286
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_import_errors, must be greater than or equal to 1.'
|
287
|
+
end
|
288
|
+
|
289
|
+
# resource path
|
290
|
+
local_var_path = '/api/profile-bulk-import-jobs/{id}/import-errors/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
291
|
+
|
292
|
+
# query parameters
|
293
|
+
query_params = opts[:query_params] || {}
|
294
|
+
query_params[:'fields[import-error]'] = @api_client.build_collection_param(opts[:'fields_import_error'], :csv) if !opts[:'fields_import_error'].nil?
|
295
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
296
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
297
|
+
|
298
|
+
# header parameters
|
299
|
+
header_params = opts[:header_params] || {}
|
300
|
+
# klaviyo api revision
|
301
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
302
|
+
# HTTP header 'Accept' (if needed)
|
303
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
304
|
+
|
305
|
+
# form parameters
|
306
|
+
form_params = opts[:form_params] || {}
|
307
|
+
|
308
|
+
# http body (model)
|
309
|
+
post_body = opts[:debug_body]
|
310
|
+
|
311
|
+
# return_type
|
312
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
313
|
+
|
314
|
+
# auth_names
|
315
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
316
|
+
|
317
|
+
new_options = opts.merge(
|
318
|
+
:operation => :"ProfilesApi.get_bulk_profile_import_job_import_errors",
|
319
|
+
:header_params => header_params,
|
320
|
+
:query_params => query_params,
|
321
|
+
:form_params => form_params,
|
322
|
+
:body => post_body,
|
323
|
+
:auth_names => auth_names,
|
324
|
+
:return_type => return_type
|
325
|
+
)
|
326
|
+
|
327
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
328
|
+
if @api_client.config.debugging
|
329
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_job_import_errors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
330
|
+
end
|
331
|
+
return data, status_code, headers
|
332
|
+
end
|
333
|
+
|
334
|
+
# Get Bulk Profile Import Job Lists
|
335
|
+
# Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
336
|
+
# @param id [String]
|
337
|
+
# @param [Hash] opts the optional parameters
|
338
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
339
|
+
# @return [Hash<String, Object>]
|
340
|
+
def get_bulk_profile_import_job_lists(id, opts = {})
|
341
|
+
data, _status_code, _headers = get_bulk_profile_import_job_lists_with_http_info(id, opts)
|
342
|
+
data
|
343
|
+
end
|
344
|
+
|
345
|
+
# Get Bulk Profile Import Job Lists
|
346
|
+
# Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
347
|
+
# @param id [String]
|
348
|
+
# @param [Hash] opts the optional parameters
|
349
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
350
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
351
|
+
def get_bulk_profile_import_job_lists_with_http_info(id, opts = {})
|
352
|
+
if @api_client.config.debugging
|
353
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_job_lists ...'
|
354
|
+
end
|
355
|
+
# verify the required parameter 'id' is set
|
356
|
+
if @api_client.config.client_side_validation && id.nil?
|
357
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_lists"
|
358
|
+
end
|
359
|
+
allowable_values = ["name", "created", "updated"]
|
360
|
+
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
361
|
+
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
362
|
+
end
|
363
|
+
# resource path
|
364
|
+
local_var_path = '/api/profile-bulk-import-jobs/{id}/lists/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
365
|
+
|
366
|
+
# query parameters
|
367
|
+
query_params = opts[:query_params] || {}
|
368
|
+
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
369
|
+
|
370
|
+
# header parameters
|
371
|
+
header_params = opts[:header_params] || {}
|
372
|
+
# klaviyo api revision
|
373
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
374
|
+
# HTTP header 'Accept' (if needed)
|
375
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
376
|
+
|
377
|
+
# form parameters
|
378
|
+
form_params = opts[:form_params] || {}
|
379
|
+
|
380
|
+
# http body (model)
|
381
|
+
post_body = opts[:debug_body]
|
382
|
+
|
383
|
+
# return_type
|
384
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
385
|
+
|
386
|
+
# auth_names
|
387
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
388
|
+
|
389
|
+
new_options = opts.merge(
|
390
|
+
:operation => :"ProfilesApi.get_bulk_profile_import_job_lists",
|
391
|
+
:header_params => header_params,
|
392
|
+
:query_params => query_params,
|
393
|
+
:form_params => form_params,
|
394
|
+
:body => post_body,
|
395
|
+
:auth_names => auth_names,
|
396
|
+
:return_type => return_type
|
397
|
+
)
|
398
|
+
|
399
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
400
|
+
if @api_client.config.debugging
|
401
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_job_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
402
|
+
end
|
403
|
+
return data, status_code, headers
|
404
|
+
end
|
405
|
+
|
406
|
+
# Get Bulk Profile Import Job Profiles
|
407
|
+
# 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`
|
408
|
+
# @param id [String]
|
409
|
+
# @param [Hash] opts the optional parameters
|
410
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
411
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
412
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
413
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
414
|
+
# @return [Hash<String, Object>]
|
415
|
+
def get_bulk_profile_import_job_profiles(id, opts = {})
|
416
|
+
data, _status_code, _headers = get_bulk_profile_import_job_profiles_with_http_info(id, opts)
|
417
|
+
data
|
418
|
+
end
|
419
|
+
|
420
|
+
# Get Bulk Profile Import Job Profiles
|
421
|
+
# 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`
|
422
|
+
# @param id [String]
|
423
|
+
# @param [Hash] opts the optional parameters
|
424
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
425
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
426
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
427
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
428
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
429
|
+
def get_bulk_profile_import_job_profiles_with_http_info(id, opts = {})
|
430
|
+
if @api_client.config.debugging
|
431
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_job_profiles ...'
|
432
|
+
end
|
433
|
+
# verify the required parameter 'id' is set
|
434
|
+
if @api_client.config.client_side_validation && id.nil?
|
435
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_profiles"
|
436
|
+
end
|
437
|
+
allowable_values = ["subscriptions", "predictive_analytics"]
|
438
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
439
|
+
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
440
|
+
end
|
441
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
442
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
443
|
+
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
444
|
+
end
|
445
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
446
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_profiles, must be smaller than or equal to 100.'
|
447
|
+
end
|
448
|
+
|
449
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
450
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_profiles, must be greater than or equal to 1.'
|
451
|
+
end
|
452
|
+
|
453
|
+
# resource path
|
454
|
+
local_var_path = '/api/profile-bulk-import-jobs/{id}/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
455
|
+
|
456
|
+
# query parameters
|
457
|
+
query_params = opts[:query_params] || {}
|
458
|
+
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
459
|
+
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
460
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
461
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
462
|
+
|
463
|
+
# header parameters
|
464
|
+
header_params = opts[:header_params] || {}
|
465
|
+
# klaviyo api revision
|
466
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
467
|
+
# HTTP header 'Accept' (if needed)
|
468
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
469
|
+
|
470
|
+
# form parameters
|
471
|
+
form_params = opts[:form_params] || {}
|
472
|
+
|
473
|
+
# http body (model)
|
474
|
+
post_body = opts[:debug_body]
|
475
|
+
|
476
|
+
# return_type
|
477
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
478
|
+
|
479
|
+
# auth_names
|
480
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
481
|
+
|
482
|
+
new_options = opts.merge(
|
483
|
+
:operation => :"ProfilesApi.get_bulk_profile_import_job_profiles",
|
484
|
+
:header_params => header_params,
|
485
|
+
:query_params => query_params,
|
486
|
+
:form_params => form_params,
|
487
|
+
:body => post_body,
|
488
|
+
:auth_names => auth_names,
|
489
|
+
:return_type => return_type
|
490
|
+
)
|
491
|
+
|
492
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
493
|
+
if @api_client.config.debugging
|
494
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_job_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
495
|
+
end
|
496
|
+
return data, status_code, headers
|
497
|
+
end
|
498
|
+
|
499
|
+
# Get Bulk Profile Import Job Relationships Lists
|
500
|
+
# 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`
|
501
|
+
# @param id [String]
|
502
|
+
# @param [Hash] opts the optional parameters
|
503
|
+
# @return [Hash<String, Object>]
|
504
|
+
def get_bulk_profile_import_job_relationships_lists(id, opts = {})
|
505
|
+
data, _status_code, _headers = get_bulk_profile_import_job_relationships_lists_with_http_info(id, opts)
|
506
|
+
data
|
507
|
+
end
|
508
|
+
|
509
|
+
# Get Bulk Profile Import Job Relationships Lists
|
510
|
+
# 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`
|
511
|
+
# @param id [String]
|
512
|
+
# @param [Hash] opts the optional parameters
|
513
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
514
|
+
def get_bulk_profile_import_job_relationships_lists_with_http_info(id, opts = {})
|
515
|
+
if @api_client.config.debugging
|
516
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_job_relationships_lists ...'
|
517
|
+
end
|
518
|
+
# verify the required parameter 'id' is set
|
519
|
+
if @api_client.config.client_side_validation && id.nil?
|
520
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_relationships_lists"
|
521
|
+
end
|
522
|
+
# resource path
|
523
|
+
local_var_path = '/api/profile-bulk-import-jobs/{id}/relationships/lists/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
524
|
+
|
525
|
+
# query parameters
|
526
|
+
query_params = opts[:query_params] || {}
|
527
|
+
|
528
|
+
# header parameters
|
529
|
+
header_params = opts[:header_params] || {}
|
530
|
+
# klaviyo api revision
|
531
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
532
|
+
# HTTP header 'Accept' (if needed)
|
533
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
534
|
+
|
535
|
+
# form parameters
|
536
|
+
form_params = opts[:form_params] || {}
|
537
|
+
|
538
|
+
# http body (model)
|
539
|
+
post_body = opts[:debug_body]
|
540
|
+
|
541
|
+
# return_type
|
542
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
543
|
+
|
544
|
+
# auth_names
|
545
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
546
|
+
|
547
|
+
new_options = opts.merge(
|
548
|
+
:operation => :"ProfilesApi.get_bulk_profile_import_job_relationships_lists",
|
549
|
+
:header_params => header_params,
|
550
|
+
:query_params => query_params,
|
551
|
+
:form_params => form_params,
|
552
|
+
:body => post_body,
|
553
|
+
:auth_names => auth_names,
|
554
|
+
:return_type => return_type
|
555
|
+
)
|
556
|
+
|
557
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
558
|
+
if @api_client.config.debugging
|
559
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_job_relationships_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
560
|
+
end
|
561
|
+
return data, status_code, headers
|
562
|
+
end
|
563
|
+
|
564
|
+
# Get Bulk Profile Import Job Relationships Profiles
|
565
|
+
# Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
566
|
+
# @param id [String]
|
567
|
+
# @param [Hash] opts the optional parameters
|
568
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
569
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
570
|
+
# @return [Hash<String, Object>]
|
571
|
+
def get_bulk_profile_import_job_relationships_profiles(id, opts = {})
|
572
|
+
data, _status_code, _headers = get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts)
|
573
|
+
data
|
574
|
+
end
|
575
|
+
|
576
|
+
# Get Bulk Profile Import Job Relationships Profiles
|
577
|
+
# Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
578
|
+
# @param id [String]
|
579
|
+
# @param [Hash] opts the optional parameters
|
580
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
581
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
582
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
583
|
+
def get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts = {})
|
584
|
+
if @api_client.config.debugging
|
585
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_job_relationships_profiles ...'
|
586
|
+
end
|
587
|
+
# verify the required parameter 'id' is set
|
588
|
+
if @api_client.config.client_side_validation && id.nil?
|
589
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_relationships_profiles"
|
590
|
+
end
|
591
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
592
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_relationships_profiles, must be smaller than or equal to 100.'
|
593
|
+
end
|
594
|
+
|
595
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
596
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_relationships_profiles, must be greater than or equal to 1.'
|
597
|
+
end
|
598
|
+
|
599
|
+
# resource path
|
600
|
+
local_var_path = '/api/profile-bulk-import-jobs/{id}/relationships/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
601
|
+
|
602
|
+
# query parameters
|
603
|
+
query_params = opts[:query_params] || {}
|
604
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
605
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
606
|
+
|
607
|
+
# header parameters
|
608
|
+
header_params = opts[:header_params] || {}
|
609
|
+
# klaviyo api revision
|
610
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
611
|
+
# HTTP header 'Accept' (if needed)
|
612
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
613
|
+
|
614
|
+
# form parameters
|
615
|
+
form_params = opts[:form_params] || {}
|
616
|
+
|
617
|
+
# http body (model)
|
618
|
+
post_body = opts[:debug_body]
|
619
|
+
|
620
|
+
# return_type
|
621
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
622
|
+
|
623
|
+
# auth_names
|
624
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
625
|
+
|
626
|
+
new_options = opts.merge(
|
627
|
+
:operation => :"ProfilesApi.get_bulk_profile_import_job_relationships_profiles",
|
628
|
+
:header_params => header_params,
|
629
|
+
:query_params => query_params,
|
630
|
+
:form_params => form_params,
|
631
|
+
:body => post_body,
|
632
|
+
:auth_names => auth_names,
|
633
|
+
:return_type => return_type
|
634
|
+
)
|
635
|
+
|
636
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
637
|
+
if @api_client.config.debugging
|
638
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_job_relationships_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
639
|
+
end
|
640
|
+
return data, status_code, headers
|
641
|
+
end
|
642
|
+
|
643
|
+
# Get Bulk Profile Import Jobs
|
644
|
+
# Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
645
|
+
# @param [Hash] opts the optional parameters
|
646
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
647
|
+
# @option opts [String] :filter 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`
|
648
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
649
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
650
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
|
651
|
+
# @return [Hash<String, Object>]
|
652
|
+
def get_bulk_profile_import_jobs(opts = {})
|
653
|
+
data, _status_code, _headers = get_bulk_profile_import_jobs_with_http_info(opts)
|
654
|
+
data
|
655
|
+
end
|
656
|
+
|
657
|
+
# Get Bulk Profile Import Jobs
|
658
|
+
# Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
659
|
+
# @param [Hash] opts the optional parameters
|
660
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
661
|
+
# @option opts [String] :filter 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`
|
662
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
663
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
664
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
|
665
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
666
|
+
def get_bulk_profile_import_jobs_with_http_info(opts = {})
|
667
|
+
if @api_client.config.debugging
|
668
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_jobs ...'
|
669
|
+
end
|
670
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "expires_at", "started_at"]
|
671
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile_bulk_import_job'] && !opts[:'fields_profile_bulk_import_job'].all? { |item| allowable_values.include?(item) }
|
672
|
+
fail ArgumentError, "invalid value for \"fields_profile_bulk_import_job\", must include one of #{allowable_values}"
|
673
|
+
end
|
674
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
675
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_jobs, must be smaller than or equal to 100.'
|
676
|
+
end
|
677
|
+
|
678
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
679
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_jobs, must be greater than or equal to 1.'
|
680
|
+
end
|
681
|
+
|
682
|
+
allowable_values = ["created_at", "-created_at"]
|
683
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
684
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
685
|
+
end
|
686
|
+
# resource path
|
687
|
+
local_var_path = '/api/profile-bulk-import-jobs/'
|
688
|
+
|
689
|
+
# query parameters
|
690
|
+
query_params = opts[:query_params] || {}
|
691
|
+
query_params[:'fields[profile-bulk-import-job]'] = @api_client.build_collection_param(opts[:'fields_profile_bulk_import_job'], :csv) if !opts[:'fields_profile_bulk_import_job'].nil?
|
692
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
693
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
694
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
695
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
696
|
+
|
697
|
+
# header parameters
|
698
|
+
header_params = opts[:header_params] || {}
|
699
|
+
# klaviyo api revision
|
700
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
701
|
+
# HTTP header 'Accept' (if needed)
|
702
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
703
|
+
|
704
|
+
# form parameters
|
705
|
+
form_params = opts[:form_params] || {}
|
706
|
+
|
707
|
+
# http body (model)
|
708
|
+
post_body = opts[:debug_body]
|
709
|
+
|
710
|
+
# return_type
|
711
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
712
|
+
|
713
|
+
# auth_names
|
714
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
715
|
+
|
716
|
+
new_options = opts.merge(
|
717
|
+
:operation => :"ProfilesApi.get_bulk_profile_import_jobs",
|
718
|
+
:header_params => header_params,
|
719
|
+
:query_params => query_params,
|
720
|
+
:form_params => form_params,
|
721
|
+
:body => post_body,
|
722
|
+
:auth_names => auth_names,
|
723
|
+
:return_type => return_type
|
724
|
+
)
|
725
|
+
|
726
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
727
|
+
if @api_client.config.debugging
|
728
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
729
|
+
end
|
730
|
+
return data, status_code, headers
|
731
|
+
end
|
732
|
+
|
162
733
|
# Get Profile
|
163
|
-
# Get the profile with the given profile ID
|
734
|
+
# Get the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read`
|
164
735
|
# @param id [String]
|
165
736
|
# @param [Hash] opts the optional parameters
|
166
|
-
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
167
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
168
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-
|
169
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
170
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
737
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
738
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
739
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
740
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
741
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
|
171
742
|
# @return [Hash<String, Object>]
|
172
743
|
def get_profile(id, opts = {})
|
173
744
|
data, _status_code, _headers = get_profile_with_http_info(id, opts)
|
@@ -175,14 +746,14 @@ module KlaviyoAPI
|
|
175
746
|
end
|
176
747
|
|
177
748
|
# Get Profile
|
178
|
-
# Get the profile with the given profile ID
|
749
|
+
# Get the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read`
|
179
750
|
# @param id [String]
|
180
751
|
# @param [Hash] opts the optional parameters
|
181
|
-
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
182
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
183
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-
|
184
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
185
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
752
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
753
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
754
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
755
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
756
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
|
186
757
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
187
758
|
def get_profile_with_http_info(id, opts = {})
|
188
759
|
if @api_client.config.debugging
|
@@ -192,7 +763,7 @@ module KlaviyoAPI
|
|
192
763
|
if @api_client.config.client_side_validation && id.nil?
|
193
764
|
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile"
|
194
765
|
end
|
195
|
-
allowable_values = ["predictive_analytics"]
|
766
|
+
allowable_values = ["subscriptions", "predictive_analytics"]
|
196
767
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
197
768
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
198
769
|
end
|
@@ -200,7 +771,7 @@ module KlaviyoAPI
|
|
200
771
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
201
772
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
202
773
|
end
|
203
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.
|
774
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
204
775
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
205
776
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
206
777
|
end
|
@@ -226,7 +797,7 @@ module KlaviyoAPI
|
|
226
797
|
# header parameters
|
227
798
|
header_params = opts[:header_params] || {}
|
228
799
|
# klaviyo api revision
|
229
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
800
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
230
801
|
# HTTP header 'Accept' (if needed)
|
231
802
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
232
803
|
|
@@ -260,10 +831,10 @@ module KlaviyoAPI
|
|
260
831
|
end
|
261
832
|
|
262
833
|
# Get Profile Lists
|
263
|
-
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
834
|
+
# 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`
|
264
835
|
# @param id [String]
|
265
836
|
# @param [Hash] opts the optional parameters
|
266
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
837
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
267
838
|
# @return [Hash<String, Object>]
|
268
839
|
def get_profile_lists(id, opts = {})
|
269
840
|
data, _status_code, _headers = get_profile_lists_with_http_info(id, opts)
|
@@ -271,10 +842,10 @@ module KlaviyoAPI
|
|
271
842
|
end
|
272
843
|
|
273
844
|
# Get Profile Lists
|
274
|
-
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
845
|
+
# 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`
|
275
846
|
# @param id [String]
|
276
847
|
# @param [Hash] opts the optional parameters
|
277
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
848
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
278
849
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
279
850
|
def get_profile_lists_with_http_info(id, opts = {})
|
280
851
|
if @api_client.config.debugging
|
@@ -298,7 +869,7 @@ module KlaviyoAPI
|
|
298
869
|
# header parameters
|
299
870
|
header_params = opts[:header_params] || {}
|
300
871
|
# klaviyo api revision
|
301
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
872
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
302
873
|
# HTTP header 'Accept' (if needed)
|
303
874
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
304
875
|
|
@@ -332,7 +903,7 @@ module KlaviyoAPI
|
|
332
903
|
end
|
333
904
|
|
334
905
|
# Get Profile Relationships Lists
|
335
|
-
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
906
|
+
# 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`
|
336
907
|
# @param id [String]
|
337
908
|
# @param [Hash] opts the optional parameters
|
338
909
|
# @return [Hash<String, Object>]
|
@@ -342,7 +913,7 @@ module KlaviyoAPI
|
|
342
913
|
end
|
343
914
|
|
344
915
|
# Get Profile Relationships Lists
|
345
|
-
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
916
|
+
# 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`
|
346
917
|
# @param id [String]
|
347
918
|
# @param [Hash] opts the optional parameters
|
348
919
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -363,7 +934,7 @@ module KlaviyoAPI
|
|
363
934
|
# header parameters
|
364
935
|
header_params = opts[:header_params] || {}
|
365
936
|
# klaviyo api revision
|
366
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
937
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
367
938
|
# HTTP header 'Accept' (if needed)
|
368
939
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
369
940
|
|
@@ -428,7 +999,7 @@ module KlaviyoAPI
|
|
428
999
|
# header parameters
|
429
1000
|
header_params = opts[:header_params] || {}
|
430
1001
|
# klaviyo api revision
|
431
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1002
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
432
1003
|
# HTTP header 'Accept' (if needed)
|
433
1004
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
434
1005
|
|
@@ -465,7 +1036,7 @@ module KlaviyoAPI
|
|
465
1036
|
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
|
466
1037
|
# @param id [String]
|
467
1038
|
# @param [Hash] opts the optional parameters
|
468
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
1039
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
469
1040
|
# @return [Hash<String, Object>]
|
470
1041
|
def get_profile_segments(id, opts = {})
|
471
1042
|
data, _status_code, _headers = get_profile_segments_with_http_info(id, opts)
|
@@ -476,7 +1047,7 @@ module KlaviyoAPI
|
|
476
1047
|
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
|
477
1048
|
# @param id [String]
|
478
1049
|
# @param [Hash] opts the optional parameters
|
479
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-
|
1050
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
480
1051
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
481
1052
|
def get_profile_segments_with_http_info(id, opts = {})
|
482
1053
|
if @api_client.config.debugging
|
@@ -500,7 +1071,7 @@ module KlaviyoAPI
|
|
500
1071
|
# header parameters
|
501
1072
|
header_params = opts[:header_params] || {}
|
502
1073
|
# klaviyo api revision
|
503
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1074
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
504
1075
|
# HTTP header 'Accept' (if needed)
|
505
1076
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
506
1077
|
|
@@ -534,14 +1105,14 @@ module KlaviyoAPI
|
|
534
1105
|
end
|
535
1106
|
|
536
1107
|
# Get Profiles
|
537
|
-
# 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-
|
1108
|
+
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
538
1109
|
# @param [Hash] opts the optional parameters
|
539
|
-
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
540
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-
|
541
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
542
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1110
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1111
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
1112
|
+
# @option opts [String] :filter 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`
|
1113
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
543
1114
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
544
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1115
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
|
545
1116
|
# @return [Hash<String, Object>]
|
546
1117
|
def get_profiles(opts = {})
|
547
1118
|
data, _status_code, _headers = get_profiles_with_http_info(opts)
|
@@ -549,24 +1120,24 @@ module KlaviyoAPI
|
|
549
1120
|
end
|
550
1121
|
|
551
1122
|
# Get Profiles
|
552
|
-
# 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-
|
1123
|
+
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
553
1124
|
# @param [Hash] opts the optional parameters
|
554
|
-
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
555
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-
|
556
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
557
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1125
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1126
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
1127
|
+
# @option opts [String] :filter 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`
|
1128
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
558
1129
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
559
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1130
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
|
560
1131
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
561
1132
|
def get_profiles_with_http_info(opts = {})
|
562
1133
|
if @api_client.config.debugging
|
563
1134
|
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_profiles ...'
|
564
1135
|
end
|
565
|
-
allowable_values = ["predictive_analytics"]
|
1136
|
+
allowable_values = ["subscriptions", "predictive_analytics"]
|
566
1137
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
567
1138
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
568
1139
|
end
|
569
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.
|
1140
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
570
1141
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
571
1142
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
572
1143
|
end
|
@@ -578,7 +1149,7 @@ module KlaviyoAPI
|
|
578
1149
|
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profiles, must be greater than or equal to 1.'
|
579
1150
|
end
|
580
1151
|
|
581
|
-
allowable_values = ["created", "-created", "email", "-email", "id", "-id", "updated", "-updated"]
|
1152
|
+
allowable_values = ["created", "-created", "email", "-email", "id", "-id", "updated", "-updated", "subscriptions.email.marketing.list_suppressions.timestamp", "-subscriptions.email.marketing.list_suppressions.timestamp", "subscriptions.email.marketing.suppression.timestamp", "-subscriptions.email.marketing.suppression.timestamp"]
|
582
1153
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
583
1154
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
584
1155
|
end
|
@@ -597,7 +1168,7 @@ module KlaviyoAPI
|
|
597
1168
|
# header parameters
|
598
1169
|
header_params = opts[:header_params] || {}
|
599
1170
|
# klaviyo api revision
|
600
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1171
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
601
1172
|
# HTTP header 'Accept' (if needed)
|
602
1173
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
603
1174
|
|
@@ -662,7 +1233,7 @@ module KlaviyoAPI
|
|
662
1233
|
# header parameters
|
663
1234
|
header_params = opts[:header_params] || {}
|
664
1235
|
# klaviyo api revision
|
665
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1236
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
666
1237
|
# HTTP header 'Accept' (if needed)
|
667
1238
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
668
1239
|
# HTTP header 'Content-Type'
|
@@ -700,8 +1271,78 @@ module KlaviyoAPI
|
|
700
1271
|
return data, status_code, headers
|
701
1272
|
end
|
702
1273
|
|
1274
|
+
# Spawn Bulk Profile Import Job
|
1275
|
+
# *Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
|
1276
|
+
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
1277
|
+
# @param [Hash] opts the optional parameters
|
1278
|
+
# @return [Hash<String, Object>]
|
1279
|
+
def spawn_bulk_profile_import_job(profile_import_job_create_query, opts = {})
|
1280
|
+
data, _status_code, _headers = spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query, opts)
|
1281
|
+
data
|
1282
|
+
end
|
1283
|
+
|
1284
|
+
# Spawn Bulk Profile Import Job
|
1285
|
+
# *Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
|
1286
|
+
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
1287
|
+
# @param [Hash] opts the optional parameters
|
1288
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1289
|
+
def spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query, opts = {})
|
1290
|
+
if @api_client.config.debugging
|
1291
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.spawn_bulk_profile_import_job ...'
|
1292
|
+
end
|
1293
|
+
# verify the required parameter 'profile_import_job_create_query' is set
|
1294
|
+
if @api_client.config.client_side_validation && profile_import_job_create_query.nil?
|
1295
|
+
fail ArgumentError, "Missing the required parameter 'profile_import_job_create_query' when calling ProfilesApi.spawn_bulk_profile_import_job"
|
1296
|
+
end
|
1297
|
+
# resource path
|
1298
|
+
local_var_path = '/api/profile-bulk-import-jobs/'
|
1299
|
+
|
1300
|
+
# query parameters
|
1301
|
+
query_params = opts[:query_params] || {}
|
1302
|
+
|
1303
|
+
# header parameters
|
1304
|
+
header_params = opts[:header_params] || {}
|
1305
|
+
# klaviyo api revision
|
1306
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
1307
|
+
# HTTP header 'Accept' (if needed)
|
1308
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1309
|
+
# HTTP header 'Content-Type'
|
1310
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
1311
|
+
if !content_type.nil?
|
1312
|
+
header_params['Content-Type'] = content_type
|
1313
|
+
end
|
1314
|
+
|
1315
|
+
# form parameters
|
1316
|
+
form_params = opts[:form_params] || {}
|
1317
|
+
|
1318
|
+
# http body (model)
|
1319
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_import_job_create_query)
|
1320
|
+
|
1321
|
+
# return_type
|
1322
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1323
|
+
|
1324
|
+
# auth_names
|
1325
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1326
|
+
|
1327
|
+
new_options = opts.merge(
|
1328
|
+
:operation => :"ProfilesApi.spawn_bulk_profile_import_job",
|
1329
|
+
:header_params => header_params,
|
1330
|
+
:query_params => query_params,
|
1331
|
+
:form_params => form_params,
|
1332
|
+
:body => post_body,
|
1333
|
+
:auth_names => auth_names,
|
1334
|
+
:return_type => return_type
|
1335
|
+
)
|
1336
|
+
|
1337
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1338
|
+
if @api_client.config.debugging
|
1339
|
+
@api_client.config.logger.debug "API called: ProfilesApi#spawn_bulk_profile_import_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1340
|
+
end
|
1341
|
+
return data, status_code, headers
|
1342
|
+
end
|
1343
|
+
|
703
1344
|
# Subscribe Profiles
|
704
|
-
# 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
|
1345
|
+
# Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about suppressed profiles 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`
|
705
1346
|
# @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
|
706
1347
|
# @param [Hash] opts the optional parameters
|
707
1348
|
# @return [nil]
|
@@ -711,7 +1352,7 @@ module KlaviyoAPI
|
|
711
1352
|
end
|
712
1353
|
|
713
1354
|
# Subscribe Profiles
|
714
|
-
# 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
|
1355
|
+
# Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about suppressed profiles 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`
|
715
1356
|
# @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
|
716
1357
|
# @param [Hash] opts the optional parameters
|
717
1358
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -732,7 +1373,7 @@ module KlaviyoAPI
|
|
732
1373
|
# header parameters
|
733
1374
|
header_params = opts[:header_params] || {}
|
734
1375
|
# klaviyo api revision
|
735
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1376
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
736
1377
|
# HTTP header 'Accept' (if needed)
|
737
1378
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
738
1379
|
# HTTP header 'Content-Type'
|
@@ -771,7 +1412,7 @@ module KlaviyoAPI
|
|
771
1412
|
end
|
772
1413
|
|
773
1414
|
# Suppress Profiles
|
774
|
-
# 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
|
1415
|
+
# 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`
|
775
1416
|
# @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
|
776
1417
|
# @param [Hash] opts the optional parameters
|
777
1418
|
# @return [nil]
|
@@ -781,7 +1422,7 @@ module KlaviyoAPI
|
|
781
1422
|
end
|
782
1423
|
|
783
1424
|
# Suppress Profiles
|
784
|
-
# 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
|
1425
|
+
# 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`
|
785
1426
|
# @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
|
786
1427
|
# @param [Hash] opts the optional parameters
|
787
1428
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -802,7 +1443,7 @@ module KlaviyoAPI
|
|
802
1443
|
# header parameters
|
803
1444
|
header_params = opts[:header_params] || {}
|
804
1445
|
# klaviyo api revision
|
805
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1446
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
806
1447
|
# HTTP header 'Accept' (if needed)
|
807
1448
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
808
1449
|
# HTTP header 'Content-Type'
|
@@ -841,7 +1482,7 @@ module KlaviyoAPI
|
|
841
1482
|
end
|
842
1483
|
|
843
1484
|
# Unsubscribe Profiles
|
844
|
-
# 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:** `
|
1485
|
+
# Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
845
1486
|
# @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
|
846
1487
|
# @param [Hash] opts the optional parameters
|
847
1488
|
# @return [nil]
|
@@ -851,7 +1492,7 @@ module KlaviyoAPI
|
|
851
1492
|
end
|
852
1493
|
|
853
1494
|
# Unsubscribe Profiles
|
854
|
-
# 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:** `
|
1495
|
+
# Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
855
1496
|
# @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
|
856
1497
|
# @param [Hash] opts the optional parameters
|
857
1498
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -872,7 +1513,7 @@ module KlaviyoAPI
|
|
872
1513
|
# header parameters
|
873
1514
|
header_params = opts[:header_params] || {}
|
874
1515
|
# klaviyo api revision
|
875
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1516
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
876
1517
|
# HTTP header 'Accept' (if needed)
|
877
1518
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
878
1519
|
# HTTP header 'Content-Type'
|
@@ -911,7 +1552,7 @@ module KlaviyoAPI
|
|
911
1552
|
end
|
912
1553
|
|
913
1554
|
# Unsuppress Profiles
|
914
|
-
# 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`
|
1555
|
+
# 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`
|
915
1556
|
# @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
|
916
1557
|
# @param [Hash] opts the optional parameters
|
917
1558
|
# @return [nil]
|
@@ -921,7 +1562,7 @@ module KlaviyoAPI
|
|
921
1562
|
end
|
922
1563
|
|
923
1564
|
# Unsuppress Profiles
|
924
|
-
# 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`
|
1565
|
+
# 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`
|
925
1566
|
# @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
|
926
1567
|
# @param [Hash] opts the optional parameters
|
927
1568
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -942,7 +1583,7 @@ module KlaviyoAPI
|
|
942
1583
|
# header parameters
|
943
1584
|
header_params = opts[:header_params] || {}
|
944
1585
|
# klaviyo api revision
|
945
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1586
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
946
1587
|
# HTTP header 'Accept' (if needed)
|
947
1588
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
948
1589
|
# HTTP header 'Content-Type'
|
@@ -1018,7 +1659,7 @@ module KlaviyoAPI
|
|
1018
1659
|
# header parameters
|
1019
1660
|
header_params = opts[:header_params] || {}
|
1020
1661
|
# klaviyo api revision
|
1021
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1662
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
1022
1663
|
# HTTP header 'Accept' (if needed)
|
1023
1664
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1024
1665
|
# HTTP header 'Content-Type'
|