klaviyo-api-sdk 2.0.0 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +65 -0
- data/README.md +487 -230
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +160 -0
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +89 -89
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +357 -357
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +52 -52
- data/lib/klaviyo-api-sdk/api/flows_api.rb +210 -155
- data/lib/klaviyo-api-sdk/api/lists_api.rb +80 -72
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +18 -18
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +86 -92
- data/lib/klaviyo-api-sdk/api/segments_api.rb +68 -60
- data/lib/klaviyo-api-sdk/api/tags_api.rb +107 -107
- data/lib/klaviyo-api-sdk/api/templates_api.rb +32 -32
- 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/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +35 -35
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.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 +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +14 -14
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.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 +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.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 +19 -19
- 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 +19 -19
- 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_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +17 -17
- 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 +19 -19
- 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_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 +2 -2
- 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 +19 -19
- 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_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships.rb → catalog_category_update_query_resource_object_relationships.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items.rb → catalog_category_update_query_resource_object_relationships_items.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_update_query_resource_object_relationships_items_data_inner.rb} +4 -4
- 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 +2 -2
- data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_resource_object_relationships_categories_data_inner.rb → catalog_item_category_op_data_inner.rb} +4 -4
- 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 +19 -19
- 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_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +71 -71
- 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 +2 -2
- 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 +19 -19
- 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_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 +19 -19
- 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_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +43 -43
- 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 +19 -19
- 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_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +114 -114
- 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 +19 -19
- 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_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 +19 -19
- 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_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +57 -57
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +30 -30
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object_attributes.rb +16 -16
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response.rb → get_create_variants_jobs5_xx_response.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner.rb → get_create_variants_jobs5_xx_response_errors_inner.rb} +40 -40
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner_source.rb → get_create_variants_jobs5_xx_response_errors_inner_source.rb} +17 -17
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +19 -19
- 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 +19 -19
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +67 -67
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +39 -39
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
- 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_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/{onsite_profile_create_query_resource_object_attributes.rb → profile_partial_update_query_resource_object_attributes.rb} +48 -48
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.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_unsubscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.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 +19 -19
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription.rb +15 -15
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +23 -23
- data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.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 +19 -19
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +15 -15
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +14 -14
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.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 +19 -19
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +17 -17
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +32 -32
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +17 -17
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -16
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +15 -15
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object_attributes.rb +18 -18
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object_attributes.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 +10 -46
- metadata +16 -558
- data/Gemfile +0 -9
- data/Rakefile +0 -10
- data/docs/AudiencesSubObject.md +0 -20
- data/docs/CampaignCloneQuery.md +0 -18
- data/docs/CampaignCloneQueryResourceObject.md +0 -20
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignCreateQuery.md +0 -18
- data/docs/CampaignCreateQueryResourceObject.md +0 -20
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/CampaignEnum.md +0 -15
- data/docs/CampaignMessageAssignTemplateQuery.md +0 -18
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +0 -20
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignMessageEnum.md +0 -15
- data/docs/CampaignMessagePartialUpdateQuery.md +0 -18
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignPartialUpdateQuery.md +0 -18
- data/docs/CampaignPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +0 -26
- data/docs/CampaignRecipientEstimationEnum.md +0 -15
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +0 -18
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignRecipientEstimationJobEnum.md +0 -15
- data/docs/CampaignSendJobCreateQuery.md +0 -18
- data/docs/CampaignSendJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignSendJobEnum.md +0 -15
- data/docs/CampaignSendJobPartialUpdateQuery.md +0 -18
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignsApi.md +0 -1275
- data/docs/CatalogCategoryBulkCreateJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogCategoryCreateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateQueryResourceObject.md +0 -22
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +0 -24
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryEnum.md +0 -15
- data/docs/CatalogCategoryItemOp.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryUpdateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemBulkCreateJobEnum.md +0 -15
- data/docs/CatalogItemBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogItemBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogItemCategoryOp.md +0 -18
- data/docs/CatalogItemCreateJobCreateQuery.md +0 -18
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemCreateQuery.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObject.md +0 -22
- data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogItemEnum.md +0 -15
- data/docs/CatalogItemUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemUpdateQuery.md +0 -18
- data/docs/CatalogItemUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +0 -34
- data/docs/CatalogJobErrorPayload.md +0 -26
- data/docs/CatalogVariantBulkCreateJobEnum.md +0 -15
- data/docs/CatalogVariantBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogVariantBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogVariantCreateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +0 -46
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItems.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogVariantEnum.md +0 -15
- data/docs/CatalogVariantUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantUpdateQuery.md +0 -18
- data/docs/CatalogVariantUpdateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogsApi.md +0 -4032
- data/docs/ClientApi.md +0 -205
- data/docs/CollectionLinks.md +0 -26
- data/docs/ContentSubObject.md +0 -28
- data/docs/DataPrivacyApi.md +0 -78
- data/docs/DataPrivacyCreateDeletionJobQuery.md +0 -18
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +0 -20
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +0 -22
- data/docs/DataPrivacyDeletionJobEnum.md +0 -15
- data/docs/EmailChannel.md +0 -18
- data/docs/EmailMarketing.md +0 -32
- data/docs/EmailMarketingListSuppression.md +0 -22
- data/docs/EmailMarketingSuppression.md +0 -20
- data/docs/EmailMessageContent.md +0 -24
- data/docs/EmailTrackingOptions.md +0 -24
- data/docs/ErrorSource.md +0 -18
- data/docs/EventCreateQuery.md +0 -18
- data/docs/EventCreateQueryResourceObject.md +0 -20
- data/docs/EventCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/EventEnum.md +0 -15
- data/docs/EventsApi.md +0 -544
- data/docs/FlowActionEnum.md +0 -15
- data/docs/FlowEnum.md +0 -15
- data/docs/FlowMessageEnum.md +0 -15
- data/docs/FlowUpdateQuery.md +0 -18
- data/docs/FlowUpdateQueryResourceObject.md +0 -22
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/FlowsApi.md +0 -1173
- data/docs/GetCampaigns4XXResponse.md +0 -18
- data/docs/GetCampaigns4XXResponseErrorsInner.md +0 -26
- data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +0 -20
- data/docs/ListCreateQuery.md +0 -18
- data/docs/ListCreateQueryResourceObject.md +0 -20
- data/docs/ListCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/ListEnum.md +0 -15
- data/docs/ListMembersAddQuery.md +0 -18
- data/docs/ListMembersAddQueryDataInner.md +0 -20
- data/docs/ListMembersDeleteQuery.md +0 -18
- data/docs/ListPartialUpdateQuery.md +0 -18
- data/docs/ListPartialUpdateQueryResourceObject.md +0 -22
- data/docs/ListsApi.md +0 -832
- data/docs/MetricAggregateEnum.md +0 -15
- data/docs/MetricAggregateQuery.md +0 -18
- data/docs/MetricAggregateQueryResourceObject.md +0 -20
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +0 -36
- data/docs/MetricAggregateRowDTO.md +0 -20
- data/docs/MetricCreateQuery.md +0 -20
- data/docs/MetricEnum.md +0 -15
- data/docs/MetricsApi.md +0 -233
- data/docs/ObjectLinks.md +0 -18
- data/docs/OnsiteProfileCreateQuery.md +0 -18
- data/docs/OnsiteProfileCreateQueryResourceObject.md +0 -22
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +0 -38
- data/docs/OnsiteProfileMeta.md +0 -18
- data/docs/OnsiteProfileMetaIdentifiers.md +0 -28
- data/docs/OnsiteSubscriptionCreateQuery.md +0 -18
- data/docs/OnsiteSubscriptionCreateQueryResourceObject.md +0 -20
- data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md +0 -26
- data/docs/PredictiveAnalytics.md +0 -34
- data/docs/ProfileAggregateEnum.md +0 -15
- data/docs/ProfileCreateQuery.md +0 -18
- data/docs/ProfileCreateQueryResourceObject.md +0 -20
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +0 -36
- data/docs/ProfileEnum.md +0 -15
- data/docs/ProfileLocation.md +0 -34
- data/docs/ProfileLocationLatitude.md +0 -49
- data/docs/ProfileLocationLongitude.md +0 -49
- data/docs/ProfilePartialUpdateQuery.md +0 -18
- data/docs/ProfilePartialUpdateQueryResourceObject.md +0 -22
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileUnsubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileUnsuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfilesApi.md +0 -909
- data/docs/SMSChannel.md +0 -18
- data/docs/SMSMarketing.md +0 -24
- data/docs/SMSMessageContent.md +0 -20
- data/docs/SMSRenderOptions.md +0 -24
- data/docs/SMSTrackingOptions.md +0 -20
- data/docs/STOScheduleOptions.md +0 -18
- data/docs/SegmentEnum.md +0 -15
- data/docs/SegmentPartialUpdateQuery.md +0 -18
- data/docs/SegmentPartialUpdateQueryResourceObject.md +0 -22
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/SegmentsApi.md +0 -543
- data/docs/SendOptions.md +0 -20
- data/docs/SendOptionsSubObject.md +0 -18
- data/docs/SendStrategySubObject.md +0 -24
- data/docs/SendTimeSubObject.md +0 -20
- data/docs/StaticScheduleOptions.md +0 -22
- data/docs/Subscription.md +0 -24
- data/docs/SubscriptionChannels.md +0 -20
- data/docs/SubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/SubscriptionEnum.md +0 -15
- data/docs/Subscriptions.md +0 -20
- data/docs/Suppression.md +0 -18
- data/docs/SuppressionCreateJobCreateQuery.md +0 -18
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagCampaignOp.md +0 -18
- data/docs/TagCampaignOpDataInner.md +0 -20
- data/docs/TagCreateQuery.md +0 -18
- data/docs/TagCreateQueryResourceObject.md +0 -20
- data/docs/TagCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagEnum.md +0 -15
- data/docs/TagFlowOp.md +0 -18
- data/docs/TagFlowOpDataInner.md +0 -20
- data/docs/TagGroupCreateQuery.md +0 -18
- data/docs/TagGroupCreateQueryResourceObject.md +0 -20
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagGroupEnum.md +0 -15
- data/docs/TagGroupUpdateQuery.md +0 -18
- data/docs/TagGroupUpdateQueryResourceObject.md +0 -22
- data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagListOp.md +0 -18
- data/docs/TagListOpDataInner.md +0 -20
- data/docs/TagSegmentOp.md +0 -18
- data/docs/TagSegmentOpDataInner.md +0 -20
- data/docs/TagUpdateQuery.md +0 -18
- data/docs/TagUpdateQueryResourceObject.md +0 -22
- data/docs/TagUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagsApi.md +0 -1923
- data/docs/TemplateCloneQuery.md +0 -18
- data/docs/TemplateCloneQueryResourceObject.md +0 -20
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +0 -22
- data/docs/TemplateCreateQuery.md +0 -18
- data/docs/TemplateCreateQueryResourceObject.md +0 -20
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +0 -32
- data/docs/TemplateEnum.md +0 -15
- data/docs/TemplateRenderQuery.md +0 -18
- data/docs/TemplateRenderQueryResourceObject.md +0 -20
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +0 -22
- data/docs/TemplateUpdateQuery.md +0 -18
- data/docs/TemplateUpdateQueryResourceObject.md +0 -22
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +0 -30
- data/docs/TemplatesApi.md +0 -525
- data/docs/TestApiAnalyticsSampleEnum.md +0 -15
- data/docs/TestListEnum.md +0 -15
- data/docs/ThrottledScheduleOptions.md +0 -20
- data/docs/TrackingOptionsSubObject.md +0 -24
- data/docs/UTMParamsSubObject.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/UnsuppressionCreateJobCreateQuery.md +0 -18
- data/docs/UnsuppressionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/UnsuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/UtmParamInfo.md +0 -20
- data/git_push.sh +0 -57
- data/lib/klaviyo-api-sdk/api/client_api.rb +0 -249
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +0 -284
- data/lib/klaviyo-api-sdk/models/collection_links.rb +0 -260
- data/lib/klaviyo-api-sdk/models/email_channel.rb +0 -219
- data/lib/klaviyo-api-sdk/models/email_marketing.rb +0 -298
- data/lib/klaviyo-api-sdk/models/email_marketing_list_suppression.rb +0 -255
- data/lib/klaviyo-api-sdk/models/email_marketing_suppression.rb +0 -240
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +0 -266
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +0 -268
- data/lib/klaviyo-api-sdk/models/error_source.rb +0 -227
- data/lib/klaviyo-api-sdk/models/flow_action_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +0 -242
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/object_links.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +0 -247
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +0 -269
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object.rb +0 -238
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object_attributes.rb +0 -265
- data/lib/klaviyo-api-sdk/models/predictive_analytics.rb +0 -300
- data/lib/klaviyo-api-sdk/models/profile_aggregate_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/send_options.rb +0 -238
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +0 -240
- data/lib/klaviyo-api-sdk/models/sms_channel.rb +0 -219
- data/lib/klaviyo-api-sdk/models/sms_marketing.rb +0 -270
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +0 -238
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +0 -266
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +0 -240
- data/lib/klaviyo-api-sdk/models/subscription_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/subscriptions.rb +0 -228
- data/lib/klaviyo-api-sdk/models/test_api_analytics_sample_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/test_list_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +0 -238
- data/spec/api/campaigns_api_spec.rb +0 -255
- data/spec/api/catalogs_api_spec.rb +0 -751
- data/spec/api/client_api_spec.rb +0 -74
- data/spec/api/data_privacy_api_spec.rb +0 -47
- data/spec/api/events_api_spec.rb +0 -132
- data/spec/api/flows_api_spec.rb +0 -247
- data/spec/api/lists_api_spec.rb +0 -180
- data/spec/api/metrics_api_spec.rb +0 -74
- data/spec/api/profiles_api_spec.rb +0 -194
- data/spec/api/segments_api_spec.rb +0 -130
- data/spec/api/tags_api_spec.rb +0 -367
- data/spec/api/templates_api_spec.rb +0 -124
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/audiences_sub_object_spec.rb +0 -40
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_clone_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_clone_query_spec.rb +0 -34
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/campaign_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_create_query_spec.rb +0 -34
- data/spec/models/campaign_enum_spec.rb +0 -28
- data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_spec.rb +0 -34
- data/spec/models/campaign_message_enum_spec.rb +0 -28
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_message_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_enum_spec.rb +0 -28
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_send_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_send_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +0 -34
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +0 -56
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_category_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_enum_spec.rb +0 -28
- data/spec/models/catalog_category_item_op_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_category_update_query_spec.rb +0 -34
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_category_op_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_item_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_enum_spec.rb +0 -28
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +0 -82
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_item_update_query_spec.rb +0 -34
- data/spec/models/catalog_job_error_payload_spec.rb +0 -58
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +0 -126
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_data_inner_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_update_query_spec.rb +0 -34
- data/spec/models/collection_links_spec.rb +0 -58
- data/spec/models/content_sub_object_spec.rb +0 -64
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +0 -40
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +0 -34
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +0 -28
- data/spec/models/email_channel_spec.rb +0 -34
- data/spec/models/email_marketing_list_suppression_spec.rb +0 -46
- data/spec/models/email_marketing_spec.rb +0 -76
- data/spec/models/email_marketing_suppression_spec.rb +0 -40
- data/spec/models/email_message_content_spec.rb +0 -52
- data/spec/models/email_tracking_options_spec.rb +0 -52
- data/spec/models/error_source_spec.rb +0 -34
- data/spec/models/event_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/event_create_query_resource_object_spec.rb +0 -40
- data/spec/models/event_create_query_spec.rb +0 -34
- data/spec/models/event_enum_spec.rb +0 -28
- data/spec/models/flow_action_enum_spec.rb +0 -28
- data/spec/models/flow_enum_spec.rb +0 -28
- data/spec/models/flow_message_enum_spec.rb +0 -28
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/flow_update_query_resource_object_spec.rb +0 -46
- data/spec/models/flow_update_query_spec.rb +0 -34
- data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +0 -40
- data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +0 -58
- data/spec/models/get_campaigns4_xx_response_spec.rb +0 -34
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/list_create_query_resource_object_spec.rb +0 -40
- data/spec/models/list_create_query_spec.rb +0 -34
- data/spec/models/list_enum_spec.rb +0 -28
- data/spec/models/list_members_add_query_data_inner_spec.rb +0 -44
- data/spec/models/list_members_add_query_spec.rb +0 -34
- data/spec/models/list_members_delete_query_spec.rb +0 -34
- data/spec/models/list_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/list_partial_update_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_enum_spec.rb +0 -28
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +0 -40
- data/spec/models/metric_aggregate_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_row_dto_spec.rb +0 -40
- data/spec/models/metric_create_query_spec.rb +0 -40
- data/spec/models/metric_enum_spec.rb +0 -28
- data/spec/models/object_links_spec.rb +0 -34
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +0 -94
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +0 -46
- data/spec/models/onsite_profile_create_query_spec.rb +0 -34
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +0 -64
- data/spec/models/onsite_profile_meta_spec.rb +0 -34
- data/spec/models/onsite_subscription_create_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/onsite_subscription_create_query_resource_object_spec.rb +0 -40
- data/spec/models/onsite_subscription_create_query_spec.rb +0 -34
- data/spec/models/predictive_analytics_spec.rb +0 -82
- data/spec/models/profile_aggregate_enum_spec.rb +0 -28
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +0 -88
- data/spec/models/profile_create_query_resource_object_spec.rb +0 -40
- data/spec/models/profile_create_query_spec.rb +0 -34
- data/spec/models/profile_enum_spec.rb +0 -28
- data/spec/models/profile_location_latitude_spec.rb +0 -31
- data/spec/models/profile_location_longitude_spec.rb +0 -31
- data/spec/models/profile_location_spec.rb +0 -82
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/profile_partial_update_query_spec.rb +0 -34
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_unsubscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_unsuppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/segment_enum_spec.rb +0 -28
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/segment_partial_update_query_spec.rb +0 -34
- data/spec/models/send_options_spec.rb +0 -40
- data/spec/models/send_options_sub_object_spec.rb +0 -34
- data/spec/models/send_strategy_sub_object_spec.rb +0 -52
- data/spec/models/send_time_sub_object_spec.rb +0 -40
- data/spec/models/sms_channel_spec.rb +0 -34
- data/spec/models/sms_marketing_spec.rb +0 -52
- data/spec/models/sms_message_content_spec.rb +0 -40
- data/spec/models/sms_render_options_spec.rb +0 -52
- data/spec/models/sms_tracking_options_spec.rb +0 -40
- data/spec/models/static_schedule_options_spec.rb +0 -46
- data/spec/models/sto_schedule_options_spec.rb +0 -34
- data/spec/models/subscription_channels_spec.rb +0 -48
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/subscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/subscription_enum_spec.rb +0 -28
- data/spec/models/subscription_spec.rb +0 -52
- data/spec/models/subscriptions_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/suppression_spec.rb +0 -34
- data/spec/models/tag_campaign_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_campaign_op_spec.rb +0 -34
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_create_query_spec.rb +0 -34
- data/spec/models/tag_enum_spec.rb +0 -28
- data/spec/models/tag_flow_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_flow_op_spec.rb +0 -34
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_group_create_query_spec.rb +0 -34
- data/spec/models/tag_group_enum_spec.rb +0 -28
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_group_update_query_spec.rb +0 -34
- data/spec/models/tag_list_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_list_op_spec.rb +0 -34
- data/spec/models/tag_segment_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_segment_op_spec.rb +0 -34
- data/spec/models/tag_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/tag_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_update_query_spec.rb +0 -34
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_clone_query_resource_object_spec.rb +0 -40
- data/spec/models/template_clone_query_spec.rb +0 -34
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/template_create_query_resource_object_spec.rb +0 -40
- data/spec/models/template_create_query_spec.rb +0 -34
- data/spec/models/template_enum_spec.rb +0 -28
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_render_query_resource_object_spec.rb +0 -40
- data/spec/models/template_render_query_spec.rb +0 -34
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +0 -52
- data/spec/models/template_update_query_resource_object_spec.rb +0 -46
- data/spec/models/template_update_query_spec.rb +0 -34
- data/spec/models/test_api_analytics_sample_enum_spec.rb +0 -28
- data/spec/models/test_list_enum_spec.rb +0 -28
- data/spec/models/throttled_schedule_options_spec.rb +0 -40
- data/spec/models/tracking_options_sub_object_spec.rb +0 -52
- data/spec/models/unsubscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/unsubscription_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/unsubscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/unsuppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/utm_param_info_spec.rb +0 -40
- data/spec/models/utm_params_sub_object_spec.rb +0 -40
- data/spec/spec_helper.rb +0 -111
@@ -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-06-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -20,7 +20,7 @@ module KlaviyoAPI
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Create List
|
23
|
-
# Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
23
|
+
# Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
24
24
|
# @param list_create_query [ListCreateQuery]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [Hash<String, Object>]
|
@@ -30,7 +30,7 @@ module KlaviyoAPI
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Create List
|
33
|
-
# Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
33
|
+
# Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
34
34
|
# @param list_create_query [ListCreateQuery]
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -51,7 +51,7 @@ module KlaviyoAPI
|
|
51
51
|
# header parameters
|
52
52
|
header_params = opts[:header_params] || {}
|
53
53
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
54
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
55
55
|
# HTTP header 'Accept' (if needed)
|
56
56
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
57
|
# HTTP header 'Content-Type'
|
@@ -90,7 +90,7 @@ module KlaviyoAPI
|
|
90
90
|
end
|
91
91
|
|
92
92
|
# Add Profile To List
|
93
|
-
# Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
93
|
+
# Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write` `profiles:write`
|
94
94
|
# @param id [String]
|
95
95
|
# @param list_members_add_query [ListMembersAddQuery]
|
96
96
|
# @param [Hash] opts the optional parameters
|
@@ -101,7 +101,7 @@ module KlaviyoAPI
|
|
101
101
|
end
|
102
102
|
|
103
103
|
# Add Profile To List
|
104
|
-
# Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
104
|
+
# Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write` `profiles:write`
|
105
105
|
# @param id [String]
|
106
106
|
# @param list_members_add_query [ListMembersAddQuery]
|
107
107
|
# @param [Hash] opts the optional parameters
|
@@ -127,7 +127,7 @@ module KlaviyoAPI
|
|
127
127
|
# header parameters
|
128
128
|
header_params = opts[:header_params] || {}
|
129
129
|
# klaviyo api revision
|
130
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
130
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
131
131
|
# HTTP header 'Accept' (if needed)
|
132
132
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
133
133
|
# HTTP header 'Content-Type'
|
@@ -166,7 +166,7 @@ module KlaviyoAPI
|
|
166
166
|
end
|
167
167
|
|
168
168
|
# Delete List
|
169
|
-
# Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
169
|
+
# Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
170
170
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
171
171
|
# @param [Hash] opts the optional parameters
|
172
172
|
# @return [nil]
|
@@ -176,7 +176,7 @@ module KlaviyoAPI
|
|
176
176
|
end
|
177
177
|
|
178
178
|
# Delete List
|
179
|
-
# Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
179
|
+
# Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
180
180
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
181
181
|
# @param [Hash] opts the optional parameters
|
182
182
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -197,7 +197,7 @@ module KlaviyoAPI
|
|
197
197
|
# header parameters
|
198
198
|
header_params = opts[:header_params] || {}
|
199
199
|
# klaviyo api revision
|
200
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
200
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
201
201
|
# HTTP header 'Accept' (if needed)
|
202
202
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
203
203
|
|
@@ -231,7 +231,7 @@ module KlaviyoAPI
|
|
231
231
|
end
|
232
232
|
|
233
233
|
# Remove Profile From List
|
234
|
-
# Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
234
|
+
# Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write` `profiles:write`
|
235
235
|
# @param id [String]
|
236
236
|
# @param list_members_delete_query [ListMembersDeleteQuery]
|
237
237
|
# @param [Hash] opts the optional parameters
|
@@ -242,7 +242,7 @@ module KlaviyoAPI
|
|
242
242
|
end
|
243
243
|
|
244
244
|
# Remove Profile From List
|
245
|
-
# Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
245
|
+
# Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write` `profiles:write`
|
246
246
|
# @param id [String]
|
247
247
|
# @param list_members_delete_query [ListMembersDeleteQuery]
|
248
248
|
# @param [Hash] opts the optional parameters
|
@@ -268,7 +268,7 @@ module KlaviyoAPI
|
|
268
268
|
# header parameters
|
269
269
|
header_params = opts[:header_params] || {}
|
270
270
|
# klaviyo api revision
|
271
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
271
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
272
272
|
# HTTP header 'Accept' (if needed)
|
273
273
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
274
274
|
# HTTP header 'Content-Type'
|
@@ -307,10 +307,10 @@ module KlaviyoAPI
|
|
307
307
|
end
|
308
308
|
|
309
309
|
# Get List
|
310
|
-
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
310
|
+
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
311
311
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
312
312
|
# @param [Hash] opts the optional parameters
|
313
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
313
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
314
314
|
# @return [Hash<String, Object>]
|
315
315
|
def get_list(id, opts = {})
|
316
316
|
data, _status_code, _headers = get_list_with_http_info(id, opts)
|
@@ -318,10 +318,10 @@ module KlaviyoAPI
|
|
318
318
|
end
|
319
319
|
|
320
320
|
# Get List
|
321
|
-
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
321
|
+
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
322
322
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
323
323
|
# @param [Hash] opts the optional parameters
|
324
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
324
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
325
325
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
326
326
|
def get_list_with_http_info(id, opts = {})
|
327
327
|
if @api_client.config.debugging
|
@@ -345,7 +345,7 @@ module KlaviyoAPI
|
|
345
345
|
# header parameters
|
346
346
|
header_params = opts[:header_params] || {}
|
347
347
|
# klaviyo api revision
|
348
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
348
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
349
349
|
# HTTP header 'Accept' (if needed)
|
350
350
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
351
351
|
|
@@ -379,37 +379,37 @@ module KlaviyoAPI
|
|
379
379
|
end
|
380
380
|
|
381
381
|
# Get List Profiles
|
382
|
-
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields
|
383
|
-
# @param
|
382
|
+
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read` `profiles:read`
|
383
|
+
# @param id [String]
|
384
384
|
# @param [Hash] opts the optional parameters
|
385
385
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
386
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-
|
387
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
388
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
389
|
-
# @option opts [Integer] :page_size
|
386
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
387
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
|
388
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
389
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
390
390
|
# @return [Hash<String, Object>]
|
391
|
-
def get_list_profiles(
|
392
|
-
data, _status_code, _headers = get_list_profiles_with_http_info(
|
391
|
+
def get_list_profiles(id, opts = {})
|
392
|
+
data, _status_code, _headers = get_list_profiles_with_http_info(id, opts)
|
393
393
|
data
|
394
394
|
end
|
395
395
|
|
396
396
|
# Get List Profiles
|
397
|
-
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields
|
398
|
-
# @param
|
397
|
+
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read` `profiles:read`
|
398
|
+
# @param id [String]
|
399
399
|
# @param [Hash] opts the optional parameters
|
400
400
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
|
401
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-
|
402
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
403
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
404
|
-
# @option opts [Integer] :page_size
|
401
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
402
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
|
403
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
404
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
405
405
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
406
|
-
def get_list_profiles_with_http_info(
|
406
|
+
def get_list_profiles_with_http_info(id, opts = {})
|
407
407
|
if @api_client.config.debugging
|
408
408
|
@api_client.config.logger.debug 'Calling API: ListsApi.get_list_profiles ...'
|
409
409
|
end
|
410
|
-
# verify the required parameter '
|
411
|
-
if @api_client.config.client_side_validation &&
|
412
|
-
fail ArgumentError, "Missing the required parameter '
|
410
|
+
# verify the required parameter 'id' is set
|
411
|
+
if @api_client.config.client_side_validation && id.nil?
|
412
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.get_list_profiles"
|
413
413
|
end
|
414
414
|
allowable_values = ["predictive_analytics"]
|
415
415
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
@@ -419,8 +419,16 @@ module KlaviyoAPI
|
|
419
419
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
420
420
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
421
421
|
end
|
422
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
423
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ListsApi.get_list_profiles, must be smaller than or equal to 100.'
|
424
|
+
end
|
425
|
+
|
426
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
427
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ListsApi.get_list_profiles, must be greater than or equal to 1.'
|
428
|
+
end
|
429
|
+
|
422
430
|
# resource path
|
423
|
-
local_var_path = '/api/lists/{
|
431
|
+
local_var_path = '/api/lists/{id}/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
424
432
|
|
425
433
|
# query parameters
|
426
434
|
query_params = opts[:query_params] || {}
|
@@ -433,7 +441,7 @@ module KlaviyoAPI
|
|
433
441
|
# header parameters
|
434
442
|
header_params = opts[:header_params] || {}
|
435
443
|
# klaviyo api revision
|
436
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
444
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
437
445
|
# HTTP header 'Accept' (if needed)
|
438
446
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
439
447
|
|
@@ -467,10 +475,10 @@ module KlaviyoAPI
|
|
467
475
|
end
|
468
476
|
|
469
477
|
# Get List Relationships Profiles
|
470
|
-
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID
|
478
|
+
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read` `profiles:read`
|
471
479
|
# @param id [String]
|
472
480
|
# @param [Hash] opts the optional parameters
|
473
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
481
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
474
482
|
# @return [Hash<String, Object>]
|
475
483
|
def get_list_relationships_profiles(id, opts = {})
|
476
484
|
data, _status_code, _headers = get_list_relationships_profiles_with_http_info(id, opts)
|
@@ -478,10 +486,10 @@ module KlaviyoAPI
|
|
478
486
|
end
|
479
487
|
|
480
488
|
# Get List Relationships Profiles
|
481
|
-
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID
|
489
|
+
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read` `profiles:read`
|
482
490
|
# @param id [String]
|
483
491
|
# @param [Hash] opts the optional parameters
|
484
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
492
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
485
493
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
486
494
|
def get_list_relationships_profiles_with_http_info(id, opts = {})
|
487
495
|
if @api_client.config.debugging
|
@@ -501,7 +509,7 @@ module KlaviyoAPI
|
|
501
509
|
# header parameters
|
502
510
|
header_params = opts[:header_params] || {}
|
503
511
|
# klaviyo api revision
|
504
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
512
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
505
513
|
# HTTP header 'Accept' (if needed)
|
506
514
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
507
515
|
|
@@ -535,7 +543,7 @@ module KlaviyoAPI
|
|
535
543
|
end
|
536
544
|
|
537
545
|
# Get List Relationships Tags
|
538
|
-
# Returns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
546
|
+
# Returns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:read` `tags:read`
|
539
547
|
# @param id [String]
|
540
548
|
# @param [Hash] opts the optional parameters
|
541
549
|
# @return [Hash<String, Object>]
|
@@ -545,7 +553,7 @@ module KlaviyoAPI
|
|
545
553
|
end
|
546
554
|
|
547
555
|
# Get List Relationships Tags
|
548
|
-
# Returns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
556
|
+
# Returns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:read` `tags:read`
|
549
557
|
# @param id [String]
|
550
558
|
# @param [Hash] opts the optional parameters
|
551
559
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -566,7 +574,7 @@ module KlaviyoAPI
|
|
566
574
|
# header parameters
|
567
575
|
header_params = opts[:header_params] || {}
|
568
576
|
# klaviyo api revision
|
569
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
577
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
570
578
|
# HTTP header 'Accept' (if needed)
|
571
579
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
572
580
|
|
@@ -600,36 +608,36 @@ module KlaviyoAPI
|
|
600
608
|
end
|
601
609
|
|
602
610
|
# Get List Tags
|
603
|
-
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
604
|
-
# @param
|
611
|
+
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:read` `tags:read`
|
612
|
+
# @param id [String]
|
605
613
|
# @param [Hash] opts the optional parameters
|
606
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
614
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
607
615
|
# @return [Hash<String, Object>]
|
608
|
-
def get_list_tags(
|
609
|
-
data, _status_code, _headers = get_list_tags_with_http_info(
|
616
|
+
def get_list_tags(id, opts = {})
|
617
|
+
data, _status_code, _headers = get_list_tags_with_http_info(id, opts)
|
610
618
|
data
|
611
619
|
end
|
612
620
|
|
613
621
|
# Get List Tags
|
614
|
-
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
615
|
-
# @param
|
622
|
+
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:read` `tags:read`
|
623
|
+
# @param id [String]
|
616
624
|
# @param [Hash] opts the optional parameters
|
617
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
625
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
618
626
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
619
|
-
def get_list_tags_with_http_info(
|
627
|
+
def get_list_tags_with_http_info(id, opts = {})
|
620
628
|
if @api_client.config.debugging
|
621
629
|
@api_client.config.logger.debug 'Calling API: ListsApi.get_list_tags ...'
|
622
630
|
end
|
623
|
-
# verify the required parameter '
|
624
|
-
if @api_client.config.client_side_validation &&
|
625
|
-
fail ArgumentError, "Missing the required parameter '
|
631
|
+
# verify the required parameter 'id' is set
|
632
|
+
if @api_client.config.client_side_validation && id.nil?
|
633
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.get_list_tags"
|
626
634
|
end
|
627
635
|
allowable_values = ["name"]
|
628
636
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
629
637
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
630
638
|
end
|
631
639
|
# resource path
|
632
|
-
local_var_path = '/api/lists/{
|
640
|
+
local_var_path = '/api/lists/{id}/tags/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
633
641
|
|
634
642
|
# query parameters
|
635
643
|
query_params = opts[:query_params] || {}
|
@@ -638,7 +646,7 @@ module KlaviyoAPI
|
|
638
646
|
# header parameters
|
639
647
|
header_params = opts[:header_params] || {}
|
640
648
|
# klaviyo api revision
|
641
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
649
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
642
650
|
# HTTP header 'Accept' (if needed)
|
643
651
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
644
652
|
|
@@ -672,11 +680,11 @@ module KlaviyoAPI
|
|
672
680
|
end
|
673
681
|
|
674
682
|
# Get Lists
|
675
|
-
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
683
|
+
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read`
|
676
684
|
# @param [Hash] opts the optional parameters
|
677
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
678
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
679
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
685
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
686
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-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`
|
687
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
680
688
|
# @return [Hash<String, Object>]
|
681
689
|
def get_lists(opts = {})
|
682
690
|
data, _status_code, _headers = get_lists_with_http_info(opts)
|
@@ -684,11 +692,11 @@ module KlaviyoAPI
|
|
684
692
|
end
|
685
693
|
|
686
694
|
# Get Lists
|
687
|
-
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
695
|
+
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read`
|
688
696
|
# @param [Hash] opts the optional parameters
|
689
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-
|
690
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
691
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
697
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
698
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-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`
|
699
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
692
700
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
693
701
|
def get_lists_with_http_info(opts = {})
|
694
702
|
if @api_client.config.debugging
|
@@ -710,7 +718,7 @@ module KlaviyoAPI
|
|
710
718
|
# header parameters
|
711
719
|
header_params = opts[:header_params] || {}
|
712
720
|
# klaviyo api revision
|
713
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
721
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
714
722
|
# HTTP header 'Accept' (if needed)
|
715
723
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
716
724
|
|
@@ -744,7 +752,7 @@ module KlaviyoAPI
|
|
744
752
|
end
|
745
753
|
|
746
754
|
# Update List
|
747
|
-
# Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
755
|
+
# Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
748
756
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
749
757
|
# @param list_partial_update_query [ListPartialUpdateQuery]
|
750
758
|
# @param [Hash] opts the optional parameters
|
@@ -755,7 +763,7 @@ module KlaviyoAPI
|
|
755
763
|
end
|
756
764
|
|
757
765
|
# Update List
|
758
|
-
# Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
766
|
+
# Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
|
759
767
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
760
768
|
# @param list_partial_update_query [ListPartialUpdateQuery]
|
761
769
|
# @param [Hash] opts the optional parameters
|
@@ -781,7 +789,7 @@ module KlaviyoAPI
|
|
781
789
|
# header parameters
|
782
790
|
header_params = opts[:header_params] || {}
|
783
791
|
# klaviyo api revision
|
784
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
792
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
785
793
|
# HTTP header 'Accept' (if needed)
|
786
794
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
787
795
|
# HTTP header 'Content-Type'
|
@@ -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-06-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -20,10 +20,10 @@ module KlaviyoAPI
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Get Metric
|
23
|
-
# Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
23
|
+
# Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`
|
24
24
|
# @param id [String] Metric ID
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-
|
26
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
27
27
|
# @return [Hash<String, Object>]
|
28
28
|
def get_metric(id, opts = {})
|
29
29
|
data, _status_code, _headers = get_metric_with_http_info(id, opts)
|
@@ -31,10 +31,10 @@ module KlaviyoAPI
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Get Metric
|
34
|
-
# Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
34
|
+
# Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`
|
35
35
|
# @param id [String] Metric ID
|
36
36
|
# @param [Hash] opts the optional parameters
|
37
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-
|
37
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-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_metric_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-06-15"
|
62
62
|
# HTTP header 'Accept' (if needed)
|
63
63
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
64
64
|
|
@@ -92,11 +92,11 @@ module KlaviyoAPI
|
|
92
92
|
end
|
93
93
|
|
94
94
|
# Get Metrics
|
95
|
-
# Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
95
|
+
# Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`
|
96
96
|
# @param [Hash] opts the optional parameters
|
97
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-
|
98
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
99
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
97
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
98
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`
|
99
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
100
100
|
# @return [Hash<String, Object>]
|
101
101
|
def get_metrics(opts = {})
|
102
102
|
data, _status_code, _headers = get_metrics_with_http_info(opts)
|
@@ -104,11 +104,11 @@ module KlaviyoAPI
|
|
104
104
|
end
|
105
105
|
|
106
106
|
# Get Metrics
|
107
|
-
# Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `
|
107
|
+
# Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`
|
108
108
|
# @param [Hash] opts the optional parameters
|
109
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-
|
110
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
111
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
109
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
110
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`
|
111
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
112
112
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
113
113
|
def get_metrics_with_http_info(opts = {})
|
114
114
|
if @api_client.config.debugging
|
@@ -130,7 +130,7 @@ module KlaviyoAPI
|
|
130
130
|
# header parameters
|
131
131
|
header_params = opts[:header_params] || {}
|
132
132
|
# klaviyo api revision
|
133
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
133
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
134
134
|
# HTTP header 'Accept' (if needed)
|
135
135
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
136
136
|
|
@@ -164,7 +164,7 @@ module KlaviyoAPI
|
|
164
164
|
end
|
165
165
|
|
166
166
|
# Query Metric Aggregates
|
167
|
-
# Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request. Results can be filtered and grouped by time, event, or profile dimensions. **Request body parameters** (nested under `attributes`): * `return_fields`: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets) * `sort`: sort results by a specified field, such as `\"-timestamp\"` * `page_cursor`: results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/reference/api_overview#pagination) * `page_size`: limit the number of returned results per page * `by`: optional attributes used to group by the aggregation function * When using `by` attributes, an empty `dimensions` response is expected when the counts for the events do not have the associated dimension requested by the set `by` attribute. For example, a query including `\"by\": [\"$flow\"]` will return an empty dimensions response for counts of metrics not associated with a `$flow` * `measurement`: the measurement key supports the following values: * `\"sum_value\"`: perform a summation of the `_Event Value_`, optionally partitioned over any dimension provided in the `by` field * `\"count\"`: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the `by` field * `\"unique\"` counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the `by` field * `interval`: aggregation interval, such as `\"hour\"`,`\"day\"`,`\"week\"`, and `\"month\"` * `metric_id`: the metric ID used in the aggregation * `filter`: list of filters for specific fields, must include time range using ISO 8601 format (`\"YYYY-MM-DDTHH:MM:SS.mmmmmm\"`) * The time range can be filtered by providing a `greater-or-equal` filter on the datetime field, such as `\"greater-or-equal(datetime,2021-07-01T00:00:00)\"` and a `less-than` filter on the same datetime field, such as `\"less-than(datetime,2022-07-01T00:00:00)\"` * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date * Filter the list of supported aggregate dimensions using the common filter syntax, such as `\"equals(URL,\\\"https://www.klaviyo.com/\\\")\"` * `timezone`: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones) * While the payload accepts a timezone, the response datetimes returned will be in UTC. For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
167
|
+
# Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request. Results can be filtered and grouped by time, event, or profile dimensions. To learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint). **Request body parameters** (nested under `attributes`): * `return_fields`: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets) * `sort`: sort results by a specified field, such as `\"-timestamp\"` * `page_cursor`: results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/reference/api_overview#pagination) * `page_size`: limit the number of returned results per page * `by`: optional attributes used to group by the aggregation function * When using `by` attributes, an empty `dimensions` response is expected when the counts for the events do not have the associated dimension requested by the set `by` attribute. For example, a query including `\"by\": [\"$flow\"]` will return an empty dimensions response for counts of metrics not associated with a `$flow` * `measurement`: the measurement key supports the following values: * `\"sum_value\"`: perform a summation of the `_Event Value_`, optionally partitioned over any dimension provided in the `by` field * `\"count\"`: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the `by` field * `\"unique\"` counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the `by` field * `interval`: aggregation interval, such as `\"hour\"`,`\"day\"`,`\"week\"`, and `\"month\"` * `metric_id`: the metric ID used in the aggregation * `filter`: list of filters for specific fields, must include time range using ISO 8601 format (`\"YYYY-MM-DDTHH:MM:SS.mmmmmm\"`) * The time range can be filtered by providing a `greater-or-equal` filter on the datetime field, such as `\"greater-or-equal(datetime,2021-07-01T00:00:00)\"` and a `less-than` filter on the same datetime field, such as `\"less-than(datetime,2022-07-01T00:00:00)\"` * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date * Filter the list of supported aggregate dimensions using the common filter syntax, such as `\"equals(URL,\\\"https://www.klaviyo.com/\\\")\"` * `timezone`: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones) * While the payload accepts a timezone, the response datetimes returned will be in UTC. For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `metrics:read`
|
168
168
|
# @param metric_aggregate_query [MetricAggregateQuery] Retrieve Metric Aggregations
|
169
169
|
# @param [Hash] opts the optional parameters
|
170
170
|
# @return [Hash<String, Object>]
|
@@ -174,7 +174,7 @@ module KlaviyoAPI
|
|
174
174
|
end
|
175
175
|
|
176
176
|
# Query Metric Aggregates
|
177
|
-
# Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request. Results can be filtered and grouped by time, event, or profile dimensions. **Request body parameters** (nested under `attributes`): * `return_fields`: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets) * `sort`: sort results by a specified field, such as `\"-timestamp\"` * `page_cursor`: results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/reference/api_overview#pagination) * `page_size`: limit the number of returned results per page * `by`: optional attributes used to group by the aggregation function * When using `by` attributes, an empty `dimensions` response is expected when the counts for the events do not have the associated dimension requested by the set `by` attribute. For example, a query including `\"by\": [\"$flow\"]` will return an empty dimensions response for counts of metrics not associated with a `$flow` * `measurement`: the measurement key supports the following values: * `\"sum_value\"`: perform a summation of the `_Event Value_`, optionally partitioned over any dimension provided in the `by` field * `\"count\"`: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the `by` field * `\"unique\"` counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the `by` field * `interval`: aggregation interval, such as `\"hour\"`,`\"day\"`,`\"week\"`, and `\"month\"` * `metric_id`: the metric ID used in the aggregation * `filter`: list of filters for specific fields, must include time range using ISO 8601 format (`\"YYYY-MM-DDTHH:MM:SS.mmmmmm\"`) * The time range can be filtered by providing a `greater-or-equal` filter on the datetime field, such as `\"greater-or-equal(datetime,2021-07-01T00:00:00)\"` and a `less-than` filter on the same datetime field, such as `\"less-than(datetime,2022-07-01T00:00:00)\"` * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date * Filter the list of supported aggregate dimensions using the common filter syntax, such as `\"equals(URL,\\\"https://www.klaviyo.com/\\\")\"` * `timezone`: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones) * While the payload accepts a timezone, the response datetimes returned will be in UTC. For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
177
|
+
# Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request. Results can be filtered and grouped by time, event, or profile dimensions. To learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint). **Request body parameters** (nested under `attributes`): * `return_fields`: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets) * `sort`: sort results by a specified field, such as `\"-timestamp\"` * `page_cursor`: results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/reference/api_overview#pagination) * `page_size`: limit the number of returned results per page * `by`: optional attributes used to group by the aggregation function * When using `by` attributes, an empty `dimensions` response is expected when the counts for the events do not have the associated dimension requested by the set `by` attribute. For example, a query including `\"by\": [\"$flow\"]` will return an empty dimensions response for counts of metrics not associated with a `$flow` * `measurement`: the measurement key supports the following values: * `\"sum_value\"`: perform a summation of the `_Event Value_`, optionally partitioned over any dimension provided in the `by` field * `\"count\"`: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the `by` field * `\"unique\"` counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the `by` field * `interval`: aggregation interval, such as `\"hour\"`,`\"day\"`,`\"week\"`, and `\"month\"` * `metric_id`: the metric ID used in the aggregation * `filter`: list of filters for specific fields, must include time range using ISO 8601 format (`\"YYYY-MM-DDTHH:MM:SS.mmmmmm\"`) * The time range can be filtered by providing a `greater-or-equal` filter on the datetime field, such as `\"greater-or-equal(datetime,2021-07-01T00:00:00)\"` and a `less-than` filter on the same datetime field, such as `\"less-than(datetime,2022-07-01T00:00:00)\"` * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date * Filter the list of supported aggregate dimensions using the common filter syntax, such as `\"equals(URL,\\\"https://www.klaviyo.com/\\\")\"` * `timezone`: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones) * While the payload accepts a timezone, the response datetimes returned will be in UTC. For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `metrics:read`
|
178
178
|
# @param metric_aggregate_query [MetricAggregateQuery] Retrieve Metric Aggregations
|
179
179
|
# @param [Hash] opts the optional parameters
|
180
180
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -195,7 +195,7 @@ module KlaviyoAPI
|
|
195
195
|
# header parameters
|
196
196
|
header_params = opts[:header_params] || {}
|
197
197
|
# klaviyo api revision
|
198
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
198
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
199
199
|
# HTTP header 'Accept' (if needed)
|
200
200
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
201
201
|
# HTTP header 'Content-Type'
|