klaviyo-api-sdk 5.0.0 → 6.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +329 -201
- data/docs/AccountsApi.md +4 -4
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +1 -1
- data/docs/CampaignValuesReportEnum.md +15 -0
- data/docs/CampaignValuesRequestDTO.md +18 -0
- data/docs/CampaignValuesRequestDTOResourceObject.md +20 -0
- data/docs/CampaignValuesRequestDTOResourceObjectAttributes.md +24 -0
- data/docs/CampaignValuesRequestDTOResourceObjectAttributesTimeframe.md +49 -0
- data/docs/CampaignsApi.md +51 -51
- data/docs/CatalogsApi.md +175 -175
- data/docs/CouponsApi.md +44 -44
- data/docs/CustomTimeframe.md +20 -0
- data/docs/EventsApi.md +26 -26
- data/docs/FlowSeriesReportEnum.md +15 -0
- data/docs/FlowSeriesRequestDTO.md +18 -0
- data/docs/FlowSeriesRequestDTOResourceObject.md +20 -0
- data/docs/FlowSeriesRequestDTOResourceObjectAttributes.md +26 -0
- data/docs/FlowValuesReportEnum.md +15 -0
- data/docs/FlowValuesRequestDTO.md +18 -0
- data/docs/FlowValuesRequestDTOResourceObject.md +20 -0
- data/docs/FlowValuesRequestDTOResourceObjectAttributes.md +24 -0
- data/docs/FlowsApi.md +70 -70
- data/docs/ImagesApi.md +12 -12
- data/docs/ListsApi.md +43 -43
- data/docs/MarketingSubscriptionParameters.md +3 -1
- 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/ProfileSubscriptionCreateQueryResourceObjectAttributes.md +1 -1
- data/docs/ProfileSubscriptionDeleteQueryResourceObjectAttributes.md +1 -1
- data/docs/ProfileUpsertQuery.md +18 -0
- data/docs/ProfileUpsertQueryResourceObject.md +3 -1
- data/docs/ProfileUpsertQueryResourceObjectAttributes.md +1 -3
- data/docs/ProfilesApi.md +754 -60
- data/docs/ReportingApi.md +235 -0
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +1 -1
- data/docs/SegmentsApi.md +35 -35
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +1 -1
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationships.md +1 -1
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsListData.md +1 -1
- data/docs/TagsApi.md +35 -35
- data/docs/TemplatesApi.md +14 -14
- data/docs/Timeframe.md +18 -0
- 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 +78 -78
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +257 -257
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +64 -64
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/events_api.rb +36 -36
- data/lib/klaviyo-api-sdk/api/flows_api.rb +88 -88
- data/lib/klaviyo-api-sdk/api/images_api.rb +20 -20
- data/lib/klaviyo-api-sdk/api/lists_api.rb +68 -68
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +808 -97
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +241 -0
- data/lib/klaviyo-api-sdk/api/segments_api.rb +44 -44
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -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/campaign_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +288 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +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 +1 -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 +1 -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 +1 -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 +1 -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/custom_timeframe.rb +238 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +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 +1 -1
- 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_series_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +315 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +288 -0
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +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 +15 -5
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +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 +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -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 +2 -2
- 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 +2 -2
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +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.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +14 -5
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +5 -14
- 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 -6
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -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 +1 -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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -6
- 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 -6
- 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/timeframe.rb +259 -0
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +26 -1
- data/spec/api/accounts_api_spec.rb +3 -3
- data/spec/api/campaigns_api_spec.rb +26 -26
- data/spec/api/catalogs_api_spec.rb +93 -93
- data/spec/api/coupons_api_spec.rb +23 -23
- data/spec/api/data_privacy_api_spec.rb +1 -1
- data/spec/api/events_api_spec.rb +14 -14
- data/spec/api/flows_api_spec.rb +36 -36
- data/spec/api/images_api_spec.rb +8 -8
- data/spec/api/lists_api_spec.rb +28 -28
- data/spec/api/metrics_api_spec.rb +5 -5
- data/spec/api/profiles_api_spec.rb +143 -18
- data/spec/api/reporting_api_spec.rb +74 -0
- data/spec/api/segments_api_spec.rb +19 -19
- data/spec/api/tags_api_spec.rb +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/campaign_values_report_enum_spec.rb +28 -0
- data/spec/models/campaign_values_request_dto_resource_object_attributes_spec.rb +56 -0
- data/spec/models/campaign_values_request_dto_resource_object_attributes_timeframe_spec.rb +31 -0
- data/spec/models/campaign_values_request_dto_resource_object_spec.rb +40 -0
- data/spec/models/campaign_values_request_dto_spec.rb +34 -0
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_data_inner_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_enum_spec.rb +1 -1
- data/spec/models/catalog_category_item_op_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +1 -1
- data/spec/models/catalog_item_category_op_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_enum_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_spec.rb +1 -1
- data/spec/models/coupon_code_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes_spec.rb +1 -1
- data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_code_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_code_create_job_create_query_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_data_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_spec.rb +1 -1
- data/spec/models/coupon_code_enum_spec.rb +1 -1
- data/spec/models/coupon_code_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_code_update_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_code_update_query_spec.rb +1 -1
- data/spec/models/coupon_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_create_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_create_query_spec.rb +1 -1
- data/spec/models/coupon_enum_spec.rb +1 -1
- data/spec/models/coupon_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_update_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_update_query_spec.rb +1 -1
- data/spec/models/custom_timeframe_spec.rb +40 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +1 -1
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +1 -1
- data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/data_privacy_profile_query_resource_object_spec.rb +1 -1
- data/spec/models/device_metadata_spec.rb +1 -1
- data/spec/models/email_content_sub_object_spec.rb +1 -1
- data/spec/models/email_send_options_sub_object_spec.rb +1 -1
- data/spec/models/email_subscription_parameters_spec.rb +1 -1
- data/spec/models/email_tracking_options_sub_object_spec.rb +1 -1
- data/spec/models/event_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_series_report_enum_spec.rb +28 -0
- data/spec/models/flow_series_request_dto_resource_object_attributes_spec.rb +66 -0
- data/spec/models/flow_series_request_dto_resource_object_spec.rb +40 -0
- data/spec/models/flow_series_request_dto_spec.rb +34 -0
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/flow_update_query_resource_object_spec.rb +1 -1
- data/spec/models/flow_update_query_spec.rb +1 -1
- data/spec/models/flow_values_report_enum_spec.rb +28 -0
- data/spec/models/flow_values_request_dto_resource_object_attributes_spec.rb +56 -0
- data/spec/models/flow_values_request_dto_resource_object_spec.rb +40 -0
- data/spec/models/flow_values_request_dto_spec.rb +34 -0
- data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +1 -1
- data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +1 -1
- data/spec/models/get_accounts4_xx_response_spec.rb +1 -1
- data/spec/models/image_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/image_create_query_resource_object_spec.rb +1 -1
- data/spec/models/image_create_query_spec.rb +1 -1
- data/spec/models/image_enum_spec.rb +1 -1
- data/spec/models/image_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/image_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/image_partial_update_query_spec.rb +1 -1
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/list_create_query_resource_object_spec.rb +1 -1
- data/spec/models/list_create_query_spec.rb +1 -1
- data/spec/models/list_enum_spec.rb +1 -1
- data/spec/models/list_members_add_query_data_inner_spec.rb +1 -1
- data/spec/models/list_members_add_query_spec.rb +1 -1
- data/spec/models/list_members_delete_query_spec.rb +1 -1
- data/spec/models/list_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/list_partial_update_query_spec.rb +1 -1
- data/spec/models/marketing_subscription_parameters_spec.rb +7 -1
- data/spec/models/metric_aggregate_enum_spec.rb +1 -1
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +1 -1
- data/spec/models/metric_aggregate_query_spec.rb +1 -1
- data/spec/models/metric_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/metric_create_query_resource_object_spec.rb +1 -1
- data/spec/models/metric_enum_spec.rb +1 -1
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +1 -1
- data/spec/models/onsite_profile_meta_spec.rb +1 -1
- data/spec/models/profile_bulk_import_job_enum_spec.rb +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 +1 -1
- data/spec/models/profile_merge_enum_spec.rb +1 -1
- data/spec/models/profile_merge_query_resource_object_relationships_profiles_data_inner_spec.rb +1 -1
- data/spec/models/profile_merge_query_resource_object_relationships_profiles_spec.rb +1 -1
- data/spec/models/profile_merge_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/profile_merge_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_merge_query_spec.rb +1 -1
- data/spec/models/profile_meta_patch_properties_spec.rb +1 -1
- data/spec/models/profile_meta_patch_properties_unset_spec.rb +1 -1
- data/spec/models/profile_meta_spec.rb +1 -1
- data/spec/models/profile_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_partial_update_query_spec.rb +1 -1
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +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 +1 -7
- data/spec/models/profile_upsert_query_resource_object_spec.rb +7 -1
- data/spec/models/profile_upsert_query_spec.rb +34 -0
- data/spec/models/push_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 +1 -1
- data/spec/models/sms_tracking_options_sub_object_spec.rb +1 -1
- data/spec/models/static_schedule_options_spec.rb +1 -1
- data/spec/models/sto_schedule_options_spec.rb +1 -1
- data/spec/models/subscription_channels_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_spec.rb +1 -1
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/suppression_create_job_create_query_resource_object_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/timeframe_spec.rb +38 -0
- data/spec/models/utm_params_sub_object_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +77 -2
data/docs/ListsApi.md
CHANGED
@@ -23,7 +23,7 @@ All URIs are relative to *https://a.klaviyo.com*
|
|
23
23
|
|
24
24
|
Create List
|
25
25
|
|
26
|
-
Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
26
|
+
Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write`
|
27
27
|
|
28
28
|
### Examples
|
29
29
|
|
@@ -94,7 +94,7 @@ end
|
|
94
94
|
|
95
95
|
Add Profile To List
|
96
96
|
|
97
|
-
Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing, SMS marketing, or both. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
97
|
+
Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) to receive email marketing, SMS marketing, or both. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
|
98
98
|
|
99
99
|
### Examples
|
100
100
|
|
@@ -166,7 +166,7 @@ nil (empty response body)
|
|
166
166
|
|
167
167
|
Delete List
|
168
168
|
|
169
|
-
Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
169
|
+
Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write`
|
170
170
|
|
171
171
|
### Examples
|
172
172
|
|
@@ -236,7 +236,7 @@ nil (empty response body)
|
|
236
236
|
|
237
237
|
Remove Profile From List
|
238
238
|
|
239
|
-
Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
239
|
+
Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
|
240
240
|
|
241
241
|
### Examples
|
242
242
|
|
@@ -308,7 +308,7 @@ nil (empty response body)
|
|
308
308
|
|
309
309
|
Get List
|
310
310
|
|
311
|
-
Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/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/
|
311
|
+
Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read`
|
312
312
|
|
313
313
|
### Examples
|
314
314
|
|
@@ -327,9 +327,9 @@ api_instance = KlaviyoAPI::ListsApi.new
|
|
327
327
|
id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
|
328
328
|
opts = {
|
329
329
|
additional_fields_list: ['profile_count'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'profile_count'
|
330
|
-
fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
331
|
-
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
332
|
-
include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
330
|
+
fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
|
331
|
+
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
|
332
|
+
include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
|
333
333
|
}
|
334
334
|
|
335
335
|
begin
|
@@ -365,9 +365,9 @@ end
|
|
365
365
|
| ---- | ---- | ----------- | ----- |
|
366
366
|
| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
|
367
367
|
| **additional_fields_list** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'profile_count' | [optional] |
|
368
|
-
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
369
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
370
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
368
|
+
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
|
369
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
|
370
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships | [optional] |
|
371
371
|
|
372
372
|
### Return type
|
373
373
|
|
@@ -389,7 +389,7 @@ end
|
|
389
389
|
|
390
390
|
Get List Profiles
|
391
391
|
|
392
|
-
Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<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/
|
392
|
+
Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read`
|
393
393
|
|
394
394
|
### Examples
|
395
395
|
|
@@ -408,11 +408,11 @@ api_instance = KlaviyoAPI::ListsApi.new
|
|
408
408
|
id = 'id_example' # String |
|
409
409
|
opts = {
|
410
410
|
additional_fields_profile: ['subscriptions'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
411
|
-
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
412
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
413
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
411
|
+
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
|
412
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
413
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
|
414
414
|
page_size: 56, # Integer | Default: 20. Min: 1. Max: 100.
|
415
|
-
sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/
|
415
|
+
sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
|
416
416
|
}
|
417
417
|
|
418
418
|
begin
|
@@ -448,11 +448,11 @@ end
|
|
448
448
|
| ---- | ---- | ----------- | ----- |
|
449
449
|
| **id** | **String** | | |
|
450
450
|
| **additional_fields_profile** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | [optional] |
|
451
|
-
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
452
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
453
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
451
|
+
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
|
452
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` | [optional] |
|
453
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
|
454
454
|
| **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
|
455
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
455
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting | [optional] |
|
456
456
|
|
457
457
|
### Return type
|
458
458
|
|
@@ -474,7 +474,7 @@ end
|
|
474
474
|
|
475
475
|
Get List Relationships Profiles
|
476
476
|
|
477
|
-
Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
477
|
+
Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:read` `profiles:read`
|
478
478
|
|
479
479
|
### Examples
|
480
480
|
|
@@ -492,10 +492,10 @@ end
|
|
492
492
|
api_instance = KlaviyoAPI::ListsApi.new
|
493
493
|
id = 'id_example' # String |
|
494
494
|
opts = {
|
495
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
496
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
495
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
496
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
|
497
497
|
page_size: 56, # Integer | Default: 20. Min: 1. Max: 1000.
|
498
|
-
sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/
|
498
|
+
sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
|
499
499
|
}
|
500
500
|
|
501
501
|
begin
|
@@ -530,10 +530,10 @@ end
|
|
530
530
|
| Name | Type | Description | Notes |
|
531
531
|
| ---- | ---- | ----------- | ----- |
|
532
532
|
| **id** | **String** | | |
|
533
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
534
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
533
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` | [optional] |
|
534
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
|
535
535
|
| **page_size** | **Integer** | Default: 20. Min: 1. Max: 1000. | [optional][default to 20] |
|
536
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
536
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting | [optional] |
|
537
537
|
|
538
538
|
### Return type
|
539
539
|
|
@@ -555,7 +555,7 @@ end
|
|
555
555
|
|
556
556
|
Get List Relationships Tags
|
557
557
|
|
558
|
-
Returns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
558
|
+
Returns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
|
559
559
|
|
560
560
|
### Examples
|
561
561
|
|
@@ -626,7 +626,7 @@ end
|
|
626
626
|
|
627
627
|
Get List Tags
|
628
628
|
|
629
|
-
Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
629
|
+
Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
|
630
630
|
|
631
631
|
### Examples
|
632
632
|
|
@@ -644,7 +644,7 @@ end
|
|
644
644
|
api_instance = KlaviyoAPI::ListsApi.new
|
645
645
|
id = 'id_example' # String |
|
646
646
|
opts = {
|
647
|
-
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
647
|
+
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
|
648
648
|
}
|
649
649
|
|
650
650
|
begin
|
@@ -679,7 +679,7 @@ end
|
|
679
679
|
| Name | Type | Description | Notes |
|
680
680
|
| ---- | ---- | ----------- | ----- |
|
681
681
|
| **id** | **String** | | |
|
682
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
682
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
|
683
683
|
|
684
684
|
### Return type
|
685
685
|
|
@@ -701,7 +701,7 @@ end
|
|
701
701
|
|
702
702
|
Get Lists
|
703
703
|
|
704
|
-
Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
704
|
+
Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:read`
|
705
705
|
|
706
706
|
### Examples
|
707
707
|
|
@@ -718,11 +718,11 @@ end
|
|
718
718
|
|
719
719
|
api_instance = KlaviyoAPI::ListsApi.new
|
720
720
|
opts = {
|
721
|
-
fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
722
|
-
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
723
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
724
|
-
include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
725
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
721
|
+
fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
|
722
|
+
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
|
723
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
|
724
|
+
include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
|
725
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
|
726
726
|
}
|
727
727
|
|
728
728
|
begin
|
@@ -756,11 +756,11 @@ end
|
|
756
756
|
|
757
757
|
| Name | Type | Description | Notes |
|
758
758
|
| ---- | ---- | ----------- | ----- |
|
759
|
-
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
760
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
761
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
762
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
763
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
759
|
+
| **fields_list** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
|
760
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
|
761
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` | [optional] |
|
762
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships | [optional] |
|
763
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
|
764
764
|
|
765
765
|
### Return type
|
766
766
|
|
@@ -782,7 +782,7 @@ end
|
|
782
782
|
|
783
783
|
Update List
|
784
784
|
|
785
|
-
Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
785
|
+
Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write`
|
786
786
|
|
787
787
|
### Examples
|
788
788
|
|
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **consent** | **String** | The Consent status to subscribe to for the \"Marketing\" type. Currently supports \"SUBSCRIBED\". | |
|
8
|
+
| **consented_at** | **Time** | The timestamp of when the profile's consent was gathered | [optional] |
|
8
9
|
|
9
10
|
## Example
|
10
11
|
|
@@ -12,7 +13,8 @@
|
|
12
13
|
require 'klaviyo-api-sdk'
|
13
14
|
|
14
15
|
instance = KlaviyoAPI::MarketingSubscriptionParameters.new(
|
15
|
-
consent:
|
16
|
+
consent: SUBSCRIBED,
|
17
|
+
consented_at: null
|
16
18
|
)
|
17
19
|
```
|
18
20
|
|
data/docs/MetricsApi.md
CHANGED
@@ -33,7 +33,7 @@ end
|
|
33
33
|
api_instance = KlaviyoAPI::MetricsApi.new
|
34
34
|
id = 'id_example' # String | Metric ID
|
35
35
|
opts = {
|
36
|
-
fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
36
|
+
fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
|
37
37
|
}
|
38
38
|
|
39
39
|
begin
|
@@ -68,7 +68,7 @@ end
|
|
68
68
|
| Name | Type | Description | Notes |
|
69
69
|
| ---- | ---- | ----------- | ----- |
|
70
70
|
| **id** | **String** | Metric ID | |
|
71
|
-
| **fields_metric** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
71
|
+
| **fields_metric** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
|
72
72
|
|
73
73
|
### Return type
|
74
74
|
|
@@ -107,9 +107,9 @@ end
|
|
107
107
|
|
108
108
|
api_instance = KlaviyoAPI::MetricsApi.new
|
109
109
|
opts = {
|
110
|
-
fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/
|
111
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/
|
112
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/
|
110
|
+
fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
|
111
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`
|
112
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
|
113
113
|
}
|
114
114
|
|
115
115
|
begin
|
@@ -143,9 +143,9 @@ end
|
|
143
143
|
|
144
144
|
| Name | Type | Description | Notes |
|
145
145
|
| ---- | ---- | ----------- | ----- |
|
146
|
-
| **fields_metric** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/
|
147
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
148
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/
|
146
|
+
| **fields_metric** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
|
147
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals` | [optional] |
|
148
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
|
149
149
|
|
150
150
|
### Return type
|
151
151
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# KlaviyoAPI::ProfileBulkImportJobEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'klaviyo-api-sdk'
|
12
|
+
|
13
|
+
instance = KlaviyoAPI::ProfileBulkImportJobEnum.new()
|
14
|
+
```
|
15
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# KlaviyoAPI::ProfileImportJobCreateQuery
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**ProfileImportJobCreateQueryResourceObject**](ProfileImportJobCreateQueryResourceObject.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'klaviyo-api-sdk'
|
13
|
+
|
14
|
+
instance = KlaviyoAPI::ProfileImportJobCreateQuery.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# KlaviyoAPI::ProfileImportJobCreateQueryResourceObject
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**ProfileBulkImportJobEnum**](ProfileBulkImportJobEnum.md) | | |
|
8
|
+
| **attributes** | [**ProfileImportJobCreateQueryResourceObjectAttributes**](ProfileImportJobCreateQueryResourceObjectAttributes.md) | | |
|
9
|
+
| **relationships** | [**ProfileImportJobCreateQueryResourceObjectRelationships**](ProfileImportJobCreateQueryResourceObjectRelationships.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'klaviyo-api-sdk'
|
15
|
+
|
16
|
+
instance = KlaviyoAPI::ProfileImportJobCreateQueryResourceObject.new(
|
17
|
+
type: null,
|
18
|
+
attributes: null,
|
19
|
+
relationships: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectAttributes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **profiles** | [**ProfileImportJobCreateQueryResourceObjectAttributesProfiles**](ProfileImportJobCreateQueryResourceObjectAttributesProfiles.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'klaviyo-api-sdk'
|
13
|
+
|
14
|
+
instance = KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectAttributes.new(
|
15
|
+
profiles: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectAttributesProfiles
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<ProfileUpsertQueryResourceObject>**](ProfileUpsertQueryResourceObject.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'klaviyo-api-sdk'
|
13
|
+
|
14
|
+
instance = KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectAttributesProfiles.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectRelationships
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **lists** | [**ProfileImportJobCreateQueryResourceObjectRelationshipsLists**](ProfileImportJobCreateQueryResourceObjectRelationshipsLists.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'klaviyo-api-sdk'
|
13
|
+
|
14
|
+
instance = KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectRelationships.new(
|
15
|
+
lists: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectRelationshipsLists
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<ProfileImportJobCreateQueryResourceObjectRelationshipsListsDataInner>**](ProfileImportJobCreateQueryResourceObjectRelationshipsListsDataInner.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'klaviyo-api-sdk'
|
13
|
+
|
14
|
+
instance = KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectRelationshipsLists.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectRelationshipsListsDataInner
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**ListEnum**](ListEnum.md) | | |
|
8
|
+
| **id** | **String** | Optional list to add the profiles to | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'klaviyo-api-sdk'
|
14
|
+
|
15
|
+
instance = KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectRelationshipsListsDataInner.new(
|
16
|
+
type: null,
|
17
|
+
id: VRgFBd
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **email** | **String** | The email address to subscribe or to set on the profile if `channels` is specified and the email channel is omitted. | [optional] |
|
8
|
-
| **phone_number** | **String** | The phone number to subscribe or to set on the profile if `channels` is specified and the SMS channel is omitted. | [optional] |
|
8
|
+
| **phone_number** | **String** | The phone number to subscribe or to set on the profile if `channels` is specified and the SMS channel is omitted. This must be in E.164 format. | [optional] |
|
9
9
|
| **subscriptions** | [**SubscriptionChannels**](SubscriptionChannels.md) | | [optional] |
|
10
10
|
|
11
11
|
## Example
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **email** | **String** | The email address to unsubscribe. | [optional] |
|
8
|
-
| **phone_number** | **String** | The phone number to unsubscribe. | [optional] |
|
8
|
+
| **phone_number** | **String** | The phone number to unsubscribe. This must be in E.164 format. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# KlaviyoAPI::ProfileUpsertQuery
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**ProfileUpsertQueryResourceObject**](ProfileUpsertQueryResourceObject.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'klaviyo-api-sdk'
|
13
|
+
|
14
|
+
instance = KlaviyoAPI::ProfileUpsertQuery.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -7,6 +7,7 @@
|
|
7
7
|
| **type** | [**ProfileEnum**](ProfileEnum.md) | | |
|
8
8
|
| **id** | **String** | Primary key that uniquely identifies this profile. Generated by Klaviyo. | [optional] |
|
9
9
|
| **attributes** | [**ProfileUpsertQueryResourceObjectAttributes**](ProfileUpsertQueryResourceObjectAttributes.md) | | |
|
10
|
+
| **meta** | [**ProfileMeta**](ProfileMeta.md) | | [optional] |
|
10
11
|
|
11
12
|
## Example
|
12
13
|
|
@@ -16,7 +17,8 @@ require 'klaviyo-api-sdk'
|
|
16
17
|
instance = KlaviyoAPI::ProfileUpsertQueryResourceObject.new(
|
17
18
|
type: null,
|
18
19
|
id: 01GDDKASAP8TKDDA2GRZDSVP4H,
|
19
|
-
attributes: null
|
20
|
+
attributes: null,
|
21
|
+
meta: null
|
20
22
|
)
|
21
23
|
```
|
22
24
|
|
@@ -16,7 +16,6 @@
|
|
16
16
|
| **image** | **String** | URL pointing to the location of a profile image | [optional] |
|
17
17
|
| **location** | [**ProfileLocation**](ProfileLocation.md) | | [optional] |
|
18
18
|
| **properties** | **Object** | An object containing key/value pairs for any custom properties assigned to this profile | [optional] |
|
19
|
-
| **meta** | [**ProfileMeta**](ProfileMeta.md) | | [optional] |
|
20
19
|
|
21
20
|
## Example
|
22
21
|
|
@@ -35,8 +34,7 @@ instance = KlaviyoAPI::ProfileUpsertQueryResourceObjectAttributes.new(
|
|
35
34
|
title: Engineer,
|
36
35
|
image: https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg,
|
37
36
|
location: null,
|
38
|
-
properties: {"pseudonym":"Dr. Octopus"}
|
39
|
-
meta: null
|
37
|
+
properties: {"pseudonym":"Dr. Octopus"}
|
40
38
|
)
|
41
39
|
```
|
42
40
|
|