klaviyo-api-sdk 5.0.0 → 5.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +281 -201
- data/docs/AccountsApi.md +4 -4
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +1 -1
- data/docs/CampaignsApi.md +51 -51
- data/docs/CatalogsApi.md +175 -175
- data/docs/CouponsApi.md +44 -44
- data/docs/EventsApi.md +26 -26
- data/docs/FlowsApi.md +70 -70
- data/docs/ImagesApi.md +12 -12
- data/docs/ListsApi.md +43 -43
- data/docs/MarketingSubscriptionParameters.md +1 -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/ProfilesApi.md +650 -28
- data/docs/SegmentsApi.md +33 -33
- 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/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +7 -7
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +74 -74
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +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 +34 -34
- 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 +66 -66
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +690 -49
- data/lib/klaviyo-api-sdk/api/segments_api.rb +42 -42
- 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/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/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_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/marketing_subscription_parameters.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +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/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +9 -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 +131 -18
- data/spec/api/segments_api_spec.rb +18 -18
- data/spec/api/tags_api_spec.rb +20 -20
- data/spec/api/templates_api_spec.rb +10 -10
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/audiences_sub_object_spec.rb +1 -1
- data/spec/models/back_in_stock_subscription_enum_spec.rb +1 -1
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_clone_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_clone_query_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_create_query_spec.rb +1 -1
- data/spec/models/campaign_enum_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_spec.rb +1 -1
- data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +1 -1
- data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_message_create_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_message_enum_spec.rb +1 -1
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_message_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +1 -1
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_send_job_create_query_spec.rb +1 -1
- data/spec/models/campaign_send_job_enum_spec.rb +1 -1
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_data_inner_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_enum_spec.rb +1 -1
- data/spec/models/catalog_category_item_op_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +1 -1
- data/spec/models/catalog_item_category_op_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_enum_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_spec.rb +1 -1
- data/spec/models/coupon_code_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes_spec.rb +1 -1
- data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_code_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_code_create_job_create_query_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_data_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_code_create_query_spec.rb +1 -1
- data/spec/models/coupon_code_enum_spec.rb +1 -1
- data/spec/models/coupon_code_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_code_update_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_code_update_query_spec.rb +1 -1
- data/spec/models/coupon_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_create_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_create_query_spec.rb +1 -1
- data/spec/models/coupon_enum_spec.rb +1 -1
- data/spec/models/coupon_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/coupon_update_query_resource_object_spec.rb +1 -1
- data/spec/models/coupon_update_query_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +1 -1
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +1 -1
- data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/data_privacy_profile_query_resource_object_spec.rb +1 -1
- data/spec/models/device_metadata_spec.rb +1 -1
- data/spec/models/email_content_sub_object_spec.rb +1 -1
- data/spec/models/email_send_options_sub_object_spec.rb +1 -1
- data/spec/models/email_subscription_parameters_spec.rb +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_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/flow_update_query_resource_object_spec.rb +1 -1
- data/spec/models/flow_update_query_spec.rb +1 -1
- data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +1 -1
- data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +1 -1
- data/spec/models/get_accounts4_xx_response_spec.rb +1 -1
- data/spec/models/image_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/image_create_query_resource_object_spec.rb +1 -1
- data/spec/models/image_create_query_spec.rb +1 -1
- data/spec/models/image_enum_spec.rb +1 -1
- data/spec/models/image_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/image_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/image_partial_update_query_spec.rb +1 -1
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/list_create_query_resource_object_spec.rb +1 -1
- data/spec/models/list_create_query_spec.rb +1 -1
- data/spec/models/list_enum_spec.rb +1 -1
- data/spec/models/list_members_add_query_data_inner_spec.rb +1 -1
- data/spec/models/list_members_add_query_spec.rb +1 -1
- data/spec/models/list_members_delete_query_spec.rb +1 -1
- data/spec/models/list_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/list_partial_update_query_spec.rb +1 -1
- data/spec/models/marketing_subscription_parameters_spec.rb +1 -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 -1
- data/spec/models/profile_upsert_query_resource_object_spec.rb +1 -1
- data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +1 -1
- data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/push_token_create_query_resource_object_spec.rb +1 -1
- data/spec/models/push_token_create_query_spec.rb +1 -1
- data/spec/models/push_token_enum_spec.rb +1 -1
- data/spec/models/render_options_sub_object_spec.rb +1 -1
- data/spec/models/segment_enum_spec.rb +1 -1
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/segment_partial_update_query_spec.rb +1 -1
- data/spec/models/send_strategy_sub_object_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_spec.rb +1 -1
- data/spec/models/sms_content_sub_object_create_spec.rb +1 -1
- data/spec/models/sms_send_options_sub_object_spec.rb +1 -1
- data/spec/models/sms_subscription_parameters_spec.rb +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/utm_params_sub_object_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +26 -2
data/docs/SegmentsApi.md
CHANGED
@@ -19,7 +19,7 @@ All URIs are relative to *https://a.klaviyo.com*
|
|
19
19
|
|
20
20
|
Get Segment
|
21
21
|
|
22
|
-
Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=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/v2023-
|
22
|
+
Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=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/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read`
|
23
23
|
|
24
24
|
### Examples
|
25
25
|
|
@@ -38,9 +38,9 @@ api_instance = KlaviyoAPI::SegmentsApi.new
|
|
38
38
|
id = 'id_example' # String |
|
39
39
|
opts = {
|
40
40
|
additional_fields_segment: ['profile_count'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'profile_count'
|
41
|
-
fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
42
|
-
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
43
|
-
include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
41
|
+
fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
42
|
+
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
43
|
+
include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
|
44
44
|
}
|
45
45
|
|
46
46
|
begin
|
@@ -76,9 +76,9 @@ end
|
|
76
76
|
| ---- | ---- | ----------- | ----- |
|
77
77
|
| **id** | **String** | | |
|
78
78
|
| **additional_fields_segment** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'profile_count' | [optional] |
|
79
|
-
| **fields_segment** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
80
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
81
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
79
|
+
| **fields_segment** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
80
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
81
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] |
|
82
82
|
|
83
83
|
### Return type
|
84
84
|
|
@@ -119,11 +119,11 @@ api_instance = KlaviyoAPI::SegmentsApi.new
|
|
119
119
|
id = 'id_example' # String |
|
120
120
|
opts = {
|
121
121
|
additional_fields_profile: ['subscriptions'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
122
|
-
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
123
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
124
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
122
|
+
fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
123
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`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`
|
124
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
125
125
|
page_size: 56, # Integer | Default: 20. Min: 1. Max: 100.
|
126
|
-
sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
126
|
+
sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
|
127
127
|
}
|
128
128
|
|
129
129
|
begin
|
@@ -159,11 +159,11 @@ end
|
|
159
159
|
| ---- | ---- | ----------- | ----- |
|
160
160
|
| **id** | **String** | | |
|
161
161
|
| **additional_fields_profile** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | [optional] |
|
162
|
-
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
163
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
164
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
162
|
+
| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
163
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`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] |
|
164
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
|
165
165
|
| **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
|
166
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
166
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] |
|
167
167
|
|
168
168
|
### Return type
|
169
169
|
|
@@ -203,10 +203,10 @@ end
|
|
203
203
|
api_instance = KlaviyoAPI::SegmentsApi.new
|
204
204
|
id = 'id_example' # String |
|
205
205
|
opts = {
|
206
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
207
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
206
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`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`
|
207
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
208
208
|
page_size: 56, # Integer | Default: 20. Min: 1. Max: 1000.
|
209
|
-
sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
209
|
+
sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
|
210
210
|
}
|
211
211
|
|
212
212
|
begin
|
@@ -241,10 +241,10 @@ end
|
|
241
241
|
| Name | Type | Description | Notes |
|
242
242
|
| ---- | ---- | ----------- | ----- |
|
243
243
|
| **id** | **String** | | |
|
244
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
245
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
244
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`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] |
|
245
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
|
246
246
|
| **page_size** | **Integer** | Default: 20. Min: 1. Max: 1000. | [optional][default to 20] |
|
247
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
247
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] |
|
248
248
|
|
249
249
|
### Return type
|
250
250
|
|
@@ -355,7 +355,7 @@ end
|
|
355
355
|
api_instance = KlaviyoAPI::SegmentsApi.new
|
356
356
|
id = 'id_example' # String |
|
357
357
|
opts = {
|
358
|
-
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
358
|
+
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
359
359
|
}
|
360
360
|
|
361
361
|
begin
|
@@ -390,7 +390,7 @@ end
|
|
390
390
|
| Name | Type | Description | Notes |
|
391
391
|
| ---- | ---- | ----------- | ----- |
|
392
392
|
| **id** | **String** | | |
|
393
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
393
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
394
394
|
|
395
395
|
### Return type
|
396
396
|
|
@@ -429,11 +429,11 @@ end
|
|
429
429
|
|
430
430
|
api_instance = KlaviyoAPI::SegmentsApi.new
|
431
431
|
opts = {
|
432
|
-
fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
433
|
-
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
434
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
435
|
-
include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
436
|
-
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
432
|
+
fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
433
|
+
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
434
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
|
435
|
+
include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
|
436
|
+
page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
437
437
|
}
|
438
438
|
|
439
439
|
begin
|
@@ -467,11 +467,11 @@ end
|
|
467
467
|
|
468
468
|
| Name | Type | Description | Notes |
|
469
469
|
| ---- | ---- | ----------- | ----- |
|
470
|
-
| **fields_segment** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
471
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
472
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
473
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
474
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
470
|
+
| **fields_segment** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
471
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
472
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` | [optional] |
|
473
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] |
|
474
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
|
475
475
|
|
476
476
|
### Return type
|
477
477
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**ProfileSubscriptionBulkCreateJobEnum**](ProfileSubscriptionBulkCreateJobEnum.md) | | |
|
8
8
|
| **attributes** | [**SubscriptionCreateJobCreateQueryResourceObjectAttributes**](SubscriptionCreateJobCreateQueryResourceObjectAttributes.md) | | |
|
9
|
-
| **relationships** | [**SubscriptionCreateJobCreateQueryResourceObjectRelationships**](SubscriptionCreateJobCreateQueryResourceObjectRelationships.md) | |
|
9
|
+
| **relationships** | [**SubscriptionCreateJobCreateQueryResourceObjectRelationships**](SubscriptionCreateJobCreateQueryResourceObjectRelationships.md) | | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **list** | [**SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList**](SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.md) | |
|
7
|
+
| **list** | [**SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList**](SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.md) | | [optional] |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**ListEnum**](ListEnum.md) | | |
|
8
|
-
| **id** | **String** |
|
8
|
+
| **id** | **String** | The list to remove the profiles from | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/TagsApi.md
CHANGED
@@ -324,7 +324,7 @@ nil (empty response body)
|
|
324
324
|
|
325
325
|
Create Tag Relationships Lists
|
326
326
|
|
327
|
-
Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
327
|
+
Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:write` `tags:write`
|
328
328
|
|
329
329
|
### Examples
|
330
330
|
|
@@ -753,7 +753,7 @@ nil (empty response body)
|
|
753
753
|
|
754
754
|
Delete Tag Relationships Lists
|
755
755
|
|
756
|
-
Remove a tag's association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
756
|
+
Remove a tag's association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:write` `tags:write`
|
757
757
|
|
758
758
|
### Examples
|
759
759
|
|
@@ -915,9 +915,9 @@ end
|
|
915
915
|
api_instance = KlaviyoAPI::TagsApi.new
|
916
916
|
id = 'abcd1234-ef56-gh78-ij90-abcdef123456' # String | The Tag ID
|
917
917
|
opts = {
|
918
|
-
fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
919
|
-
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
920
|
-
include: ['tag-group'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
918
|
+
fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
919
|
+
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
920
|
+
include: ['tag-group'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
|
921
921
|
}
|
922
922
|
|
923
923
|
begin
|
@@ -952,9 +952,9 @@ end
|
|
952
952
|
| Name | Type | Description | Notes |
|
953
953
|
| ---- | ---- | ----------- | ----- |
|
954
954
|
| **id** | **String** | The Tag ID | |
|
955
|
-
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
956
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
957
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
955
|
+
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
956
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
957
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] |
|
958
958
|
|
959
959
|
### Return type
|
960
960
|
|
@@ -994,7 +994,7 @@ end
|
|
994
994
|
api_instance = KlaviyoAPI::TagsApi.new
|
995
995
|
id = 'zyxw9876-vu54-ts32-rq10-zyxwvu654321' # String | The Tag Group ID
|
996
996
|
opts = {
|
997
|
-
fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
997
|
+
fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
998
998
|
}
|
999
999
|
|
1000
1000
|
begin
|
@@ -1029,7 +1029,7 @@ end
|
|
1029
1029
|
| Name | Type | Description | Notes |
|
1030
1030
|
| ---- | ---- | ----------- | ----- |
|
1031
1031
|
| **id** | **String** | The Tag Group ID | |
|
1032
|
-
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1032
|
+
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1033
1033
|
|
1034
1034
|
### Return type
|
1035
1035
|
|
@@ -1140,7 +1140,7 @@ end
|
|
1140
1140
|
api_instance = KlaviyoAPI::TagsApi.new
|
1141
1141
|
id = 'id_example' # String |
|
1142
1142
|
opts = {
|
1143
|
-
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1143
|
+
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
1144
1144
|
}
|
1145
1145
|
|
1146
1146
|
begin
|
@@ -1175,7 +1175,7 @@ end
|
|
1175
1175
|
| Name | Type | Description | Notes |
|
1176
1176
|
| ---- | ---- | ----------- | ----- |
|
1177
1177
|
| **id** | **String** | | |
|
1178
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1178
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1179
1179
|
|
1180
1180
|
### Return type
|
1181
1181
|
|
@@ -1214,10 +1214,10 @@ end
|
|
1214
1214
|
|
1215
1215
|
api_instance = KlaviyoAPI::TagsApi.new
|
1216
1216
|
opts = {
|
1217
|
-
fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1218
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1219
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1220
|
-
sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1217
|
+
fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
1218
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
1219
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
1220
|
+
sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
|
1221
1221
|
}
|
1222
1222
|
|
1223
1223
|
begin
|
@@ -1251,10 +1251,10 @@ end
|
|
1251
1251
|
|
1252
1252
|
| Name | Type | Description | Notes |
|
1253
1253
|
| ---- | ---- | ----------- | ----- |
|
1254
|
-
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1255
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1256
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1257
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1254
|
+
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1255
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals` | [optional] |
|
1256
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
|
1257
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] |
|
1258
1258
|
|
1259
1259
|
### Return type
|
1260
1260
|
|
@@ -1418,7 +1418,7 @@ end
|
|
1418
1418
|
|
1419
1419
|
Get Tag Relationships Lists
|
1420
1420
|
|
1421
|
-
Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1421
|
+
Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
|
1422
1422
|
|
1423
1423
|
### Examples
|
1424
1424
|
|
@@ -1649,7 +1649,7 @@ end
|
|
1649
1649
|
api_instance = KlaviyoAPI::TagsApi.new
|
1650
1650
|
id = 'id_example' # String |
|
1651
1651
|
opts = {
|
1652
|
-
fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1652
|
+
fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
1653
1653
|
}
|
1654
1654
|
|
1655
1655
|
begin
|
@@ -1684,7 +1684,7 @@ end
|
|
1684
1684
|
| Name | Type | Description | Notes |
|
1685
1685
|
| ---- | ---- | ----------- | ----- |
|
1686
1686
|
| **id** | **String** | | |
|
1687
|
-
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1687
|
+
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1688
1688
|
|
1689
1689
|
### Return type
|
1690
1690
|
|
@@ -1723,12 +1723,12 @@ end
|
|
1723
1723
|
|
1724
1724
|
api_instance = KlaviyoAPI::TagsApi.new
|
1725
1725
|
opts = {
|
1726
|
-
fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1727
|
-
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1728
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1729
|
-
include: ['tag-group'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1730
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1731
|
-
sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1726
|
+
fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
1727
|
+
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
1728
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
1729
|
+
include: ['tag-group'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
|
1730
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
1731
|
+
sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
|
1732
1732
|
}
|
1733
1733
|
|
1734
1734
|
begin
|
@@ -1762,12 +1762,12 @@ end
|
|
1762
1762
|
|
1763
1763
|
| Name | Type | Description | Notes |
|
1764
1764
|
| ---- | ---- | ----------- | ----- |
|
1765
|
-
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1766
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1767
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1768
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1769
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1770
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1765
|
+
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1766
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1767
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with` | [optional] |
|
1768
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] |
|
1769
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
|
1770
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] |
|
1771
1771
|
|
1772
1772
|
### Return type
|
1773
1773
|
|
data/docs/TemplatesApi.md
CHANGED
@@ -19,7 +19,7 @@ All URIs are relative to *https://a.klaviyo.com*
|
|
19
19
|
|
20
20
|
Create Template
|
21
21
|
|
22
|
-
Create a new custom HTML template. If there are 1,000 or more templates in an account, creation will fail as there is a limit of 1,000 templates that can be created via the API. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
22
|
+
Create a new custom HTML template. If there are 1,000 or more templates in an account, creation will fail as there is a limit of 1,000 templates that can be created via the API. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:write`
|
23
23
|
|
24
24
|
### Examples
|
25
25
|
|
@@ -90,7 +90,7 @@ end
|
|
90
90
|
|
91
91
|
Create Template Clone
|
92
92
|
|
93
|
-
Create a clone of a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
93
|
+
Create a clone of a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:write`
|
94
94
|
|
95
95
|
### Examples
|
96
96
|
|
@@ -232,7 +232,7 @@ end
|
|
232
232
|
|
233
233
|
Delete Template
|
234
234
|
|
235
|
-
Delete a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
235
|
+
Delete a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:write`
|
236
236
|
|
237
237
|
### Examples
|
238
238
|
|
@@ -320,7 +320,7 @@ end
|
|
320
320
|
api_instance = KlaviyoAPI::TemplatesApi.new
|
321
321
|
id = 'id_example' # String | The ID of template
|
322
322
|
opts = {
|
323
|
-
fields_template: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
323
|
+
fields_template: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
324
324
|
}
|
325
325
|
|
326
326
|
begin
|
@@ -355,7 +355,7 @@ end
|
|
355
355
|
| Name | Type | Description | Notes |
|
356
356
|
| ---- | ---- | ----------- | ----- |
|
357
357
|
| **id** | **String** | The ID of template | |
|
358
|
-
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
358
|
+
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
359
359
|
|
360
360
|
### Return type
|
361
361
|
|
@@ -394,10 +394,10 @@ end
|
|
394
394
|
|
395
395
|
api_instance = KlaviyoAPI::TemplatesApi.new
|
396
396
|
opts = {
|
397
|
-
fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
398
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
399
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
400
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
397
|
+
fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
398
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
399
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
|
400
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
|
401
401
|
}
|
402
402
|
|
403
403
|
begin
|
@@ -431,10 +431,10 @@ end
|
|
431
431
|
|
432
432
|
| Name | Type | Description | Notes |
|
433
433
|
| ---- | ---- | ----------- | ----- |
|
434
|
-
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
435
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
436
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
437
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
434
|
+
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
|
435
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` | [optional] |
|
436
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
|
437
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] |
|
438
438
|
|
439
439
|
### Return type
|
440
440
|
|
@@ -456,7 +456,7 @@ end
|
|
456
456
|
|
457
457
|
Update Template
|
458
458
|
|
459
|
-
Update a template with the given template ID. Does not currently update drag & drop templates.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
459
|
+
Update a template with the given template ID. Does not currently update drag & drop templates.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:write`
|
460
460
|
|
461
461
|
### Examples
|
462
462
|
|
data/klaviyo-api-sdk.gemspec
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
|
6
6
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
7
7
|
|
8
|
-
The version of the OpenAPI document: 2023-
|
8
|
+
The version of the OpenAPI document: 2023-12-15
|
9
9
|
Contact: developers@klaviyo.com
|
10
10
|
Generated by: https://openapi-generator.tech
|
11
11
|
OpenAPI Generator version: 6.2.1
|
@@ -17,7 +17,7 @@ require "klaviyo-api-sdk/version"
|
|
17
17
|
|
18
18
|
Gem::Specification.new do |s|
|
19
19
|
s.name = "klaviyo-api-sdk"
|
20
|
-
s.version = "5.
|
20
|
+
s.version = "5.1.0"
|
21
21
|
s.authors = ['Klaviyo Team']
|
22
22
|
s.email = ['libraries@klaviyo.com']
|
23
23
|
s.summary = 'You heard us, a Ruby wrapper for the Klaviyo API'
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2023-
|
6
|
+
The version of the OpenAPI document: 2023-12-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -23,7 +23,7 @@ module KlaviyoAPI
|
|
23
23
|
# Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
|
24
24
|
# @param id [String] The ID of the account
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-
|
26
|
+
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
27
27
|
# @return [Hash<String, Object>]
|
28
28
|
def get_account(id, opts = {})
|
29
29
|
data, _status_code, _headers = get_account_with_http_info(id, opts)
|
@@ -34,7 +34,7 @@ module KlaviyoAPI
|
|
34
34
|
# Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
|
35
35
|
# @param id [String] The ID of the account
|
36
36
|
# @param [Hash] opts the optional parameters
|
37
|
-
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-
|
37
|
+
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
38
38
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
39
39
|
def get_account_with_http_info(id, opts = {})
|
40
40
|
if @api_client.config.debugging
|
@@ -58,7 +58,7 @@ module KlaviyoAPI
|
|
58
58
|
# header parameters
|
59
59
|
header_params = opts[:header_params] || {}
|
60
60
|
# klaviyo api revision
|
61
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
61
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
62
62
|
# HTTP header 'Accept' (if needed)
|
63
63
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
64
64
|
|
@@ -94,7 +94,7 @@ module KlaviyoAPI
|
|
94
94
|
# Get Accounts
|
95
95
|
# Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
|
96
96
|
# @param [Hash] opts the optional parameters
|
97
|
-
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-
|
97
|
+
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
98
98
|
# @return [Hash<String, Object>]
|
99
99
|
def get_accounts(opts = {})
|
100
100
|
data, _status_code, _headers = get_accounts_with_http_info(opts)
|
@@ -104,7 +104,7 @@ module KlaviyoAPI
|
|
104
104
|
# Get Accounts
|
105
105
|
# Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
|
106
106
|
# @param [Hash] opts the optional parameters
|
107
|
-
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-
|
107
|
+
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
|
108
108
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
109
109
|
def get_accounts_with_http_info(opts = {})
|
110
110
|
if @api_client.config.debugging
|
@@ -124,7 +124,7 @@ module KlaviyoAPI
|
|
124
124
|
# header parameters
|
125
125
|
header_params = opts[:header_params] || {}
|
126
126
|
# klaviyo api revision
|
127
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
127
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
|
128
128
|
# HTTP header 'Accept' (if needed)
|
129
129
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
130
130
|
|