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,12 +20,12 @@ module KlaviyoAPI
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Get Flow
|
23
|
-
# Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
23
|
+
# Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
24
24
|
# @param id [String]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
27
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
28
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
26
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
27
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
28
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
29
29
|
# @return [Hash<String, Object>]
|
30
30
|
def get_flow(id, opts = {})
|
31
31
|
data, _status_code, _headers = get_flow_with_http_info(id, opts)
|
@@ -33,12 +33,12 @@ module KlaviyoAPI
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# Get Flow
|
36
|
-
# Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
36
|
+
# Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
37
37
|
# @param id [String]
|
38
38
|
# @param [Hash] opts the optional parameters
|
39
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
40
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
41
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
39
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
40
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
41
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
42
42
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
43
43
|
def get_flow_with_http_info(id, opts = {})
|
44
44
|
if @api_client.config.debugging
|
@@ -72,7 +72,7 @@ module KlaviyoAPI
|
|
72
72
|
# header parameters
|
73
73
|
header_params = opts[:header_params] || {}
|
74
74
|
# klaviyo api revision
|
75
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
75
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
76
76
|
# HTTP header 'Accept' (if needed)
|
77
77
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
78
78
|
|
@@ -106,13 +106,13 @@ module KlaviyoAPI
|
|
106
106
|
end
|
107
107
|
|
108
108
|
# Get Flow Action
|
109
|
-
# Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
109
|
+
# Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
110
110
|
# @param id [String]
|
111
111
|
# @param [Hash] opts the optional parameters
|
112
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
113
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
114
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
115
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
112
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
113
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
114
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
115
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
116
116
|
# @return [Hash<String, Object>]
|
117
117
|
def get_flow_action(id, opts = {})
|
118
118
|
data, _status_code, _headers = get_flow_action_with_http_info(id, opts)
|
@@ -120,13 +120,13 @@ module KlaviyoAPI
|
|
120
120
|
end
|
121
121
|
|
122
122
|
# Get Flow Action
|
123
|
-
# Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
123
|
+
# Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
124
124
|
# @param id [String]
|
125
125
|
# @param [Hash] opts the optional parameters
|
126
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
127
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
128
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
129
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
126
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
127
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
128
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
129
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
130
130
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
131
131
|
def get_flow_action_with_http_info(id, opts = {})
|
132
132
|
if @api_client.config.debugging
|
@@ -165,7 +165,7 @@ module KlaviyoAPI
|
|
165
165
|
# header parameters
|
166
166
|
header_params = opts[:header_params] || {}
|
167
167
|
# klaviyo api revision
|
168
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
168
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
169
169
|
# HTTP header 'Accept' (if needed)
|
170
170
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
171
171
|
|
@@ -199,36 +199,36 @@ module KlaviyoAPI
|
|
199
199
|
end
|
200
200
|
|
201
201
|
# Get Flow For Flow Action
|
202
|
-
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
203
|
-
# @param
|
202
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
203
|
+
# @param id [String]
|
204
204
|
# @param [Hash] opts the optional parameters
|
205
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
205
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
206
206
|
# @return [Hash<String, Object>]
|
207
|
-
def get_flow_action_flow(
|
208
|
-
data, _status_code, _headers = get_flow_action_flow_with_http_info(
|
207
|
+
def get_flow_action_flow(id, opts = {})
|
208
|
+
data, _status_code, _headers = get_flow_action_flow_with_http_info(id, opts)
|
209
209
|
data
|
210
210
|
end
|
211
211
|
|
212
212
|
# Get Flow For Flow Action
|
213
|
-
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
214
|
-
# @param
|
213
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
214
|
+
# @param id [String]
|
215
215
|
# @param [Hash] opts the optional parameters
|
216
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
216
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
217
217
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
218
|
-
def get_flow_action_flow_with_http_info(
|
218
|
+
def get_flow_action_flow_with_http_info(id, opts = {})
|
219
219
|
if @api_client.config.debugging
|
220
220
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_action_flow ...'
|
221
221
|
end
|
222
|
-
# verify the required parameter '
|
223
|
-
if @api_client.config.client_side_validation &&
|
224
|
-
fail ArgumentError, "Missing the required parameter '
|
222
|
+
# verify the required parameter 'id' is set
|
223
|
+
if @api_client.config.client_side_validation && id.nil?
|
224
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action_flow"
|
225
225
|
end
|
226
226
|
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
227
227
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
228
228
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
229
229
|
end
|
230
230
|
# resource path
|
231
|
-
local_var_path = '/api/flow-actions/{
|
231
|
+
local_var_path = '/api/flow-actions/{id}/flow/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
232
232
|
|
233
233
|
# query parameters
|
234
234
|
query_params = opts[:query_params] || {}
|
@@ -237,7 +237,7 @@ module KlaviyoAPI
|
|
237
237
|
# header parameters
|
238
238
|
header_params = opts[:header_params] || {}
|
239
239
|
# klaviyo api revision
|
240
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
240
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
241
241
|
# HTTP header 'Accept' (if needed)
|
242
242
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
243
243
|
|
@@ -271,58 +271,69 @@ module KlaviyoAPI
|
|
271
271
|
end
|
272
272
|
|
273
273
|
# Get Messages For Flow Action
|
274
|
-
# Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
275
|
-
# @param
|
274
|
+
# Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
275
|
+
# @param id [String]
|
276
276
|
# @param [Hash] opts the optional parameters
|
277
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
278
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
279
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
280
|
-
# @option opts [
|
277
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
278
|
+
# @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>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
279
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
280
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
281
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
281
282
|
# @return [Hash<String, Object>]
|
282
|
-
def get_flow_action_messages(
|
283
|
-
data, _status_code, _headers = get_flow_action_messages_with_http_info(
|
283
|
+
def get_flow_action_messages(id, opts = {})
|
284
|
+
data, _status_code, _headers = get_flow_action_messages_with_http_info(id, opts)
|
284
285
|
data
|
285
286
|
end
|
286
287
|
|
287
288
|
# Get Messages For Flow Action
|
288
|
-
# Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
289
|
-
# @param
|
289
|
+
# Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
290
|
+
# @param id [String]
|
290
291
|
# @param [Hash] opts the optional parameters
|
291
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
292
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
293
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
294
|
-
# @option opts [
|
292
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
293
|
+
# @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>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
294
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
295
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
296
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
295
297
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
296
|
-
def get_flow_action_messages_with_http_info(
|
298
|
+
def get_flow_action_messages_with_http_info(id, opts = {})
|
297
299
|
if @api_client.config.debugging
|
298
300
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_action_messages ...'
|
299
301
|
end
|
300
|
-
# verify the required parameter '
|
301
|
-
if @api_client.config.client_side_validation &&
|
302
|
-
fail ArgumentError, "Missing the required parameter '
|
302
|
+
# verify the required parameter 'id' is set
|
303
|
+
if @api_client.config.client_side_validation && id.nil?
|
304
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action_messages"
|
303
305
|
end
|
304
306
|
allowable_values = ["name", "channel", "content", "created", "updated"]
|
305
307
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
306
308
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
307
309
|
end
|
310
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
311
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_messages, must be smaller than or equal to 50.'
|
312
|
+
end
|
313
|
+
|
314
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
315
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_messages, must be greater than or equal to 1.'
|
316
|
+
end
|
317
|
+
|
308
318
|
allowable_values = ["created", "-created", "id", "-id", "name", "-name", "updated", "-updated"]
|
309
319
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
310
320
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
311
321
|
end
|
312
322
|
# resource path
|
313
|
-
local_var_path = '/api/flow-actions/{
|
323
|
+
local_var_path = '/api/flow-actions/{id}/flow-messages/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
314
324
|
|
315
325
|
# query parameters
|
316
326
|
query_params = opts[:query_params] || {}
|
317
327
|
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
318
328
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
319
329
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
330
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
320
331
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
321
332
|
|
322
333
|
# header parameters
|
323
334
|
header_params = opts[:header_params] || {}
|
324
335
|
# klaviyo api revision
|
325
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
336
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
326
337
|
# HTTP header 'Accept' (if needed)
|
327
338
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
328
339
|
|
@@ -356,7 +367,7 @@ module KlaviyoAPI
|
|
356
367
|
end
|
357
368
|
|
358
369
|
# Get Flow Action Relationships Flow
|
359
|
-
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
370
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
360
371
|
# @param id [String]
|
361
372
|
# @param [Hash] opts the optional parameters
|
362
373
|
# @return [Hash<String, Object>]
|
@@ -366,7 +377,7 @@ module KlaviyoAPI
|
|
366
377
|
end
|
367
378
|
|
368
379
|
# Get Flow Action Relationships Flow
|
369
|
-
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
380
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
370
381
|
# @param id [String]
|
371
382
|
# @param [Hash] opts the optional parameters
|
372
383
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -387,7 +398,7 @@ module KlaviyoAPI
|
|
387
398
|
# header parameters
|
388
399
|
header_params = opts[:header_params] || {}
|
389
400
|
# klaviyo api revision
|
390
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
401
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
391
402
|
# HTTP header 'Accept' (if needed)
|
392
403
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
393
404
|
|
@@ -421,12 +432,13 @@ module KlaviyoAPI
|
|
421
432
|
end
|
422
433
|
|
423
434
|
# Get Flow Action Relationships Messages
|
424
|
-
# Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
435
|
+
# Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
425
436
|
# @param id [String]
|
426
437
|
# @param [Hash] opts the optional parameters
|
427
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
428
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
429
|
-
# @option opts [
|
438
|
+
# @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`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
439
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
440
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
441
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
430
442
|
# @return [Hash<String, Object>]
|
431
443
|
def get_flow_action_relationships_messages(id, opts = {})
|
432
444
|
data, _status_code, _headers = get_flow_action_relationships_messages_with_http_info(id, opts)
|
@@ -434,12 +446,13 @@ module KlaviyoAPI
|
|
434
446
|
end
|
435
447
|
|
436
448
|
# Get Flow Action Relationships Messages
|
437
|
-
# Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
449
|
+
# Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
438
450
|
# @param id [String]
|
439
451
|
# @param [Hash] opts the optional parameters
|
440
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
441
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
442
|
-
# @option opts [
|
452
|
+
# @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`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
453
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
454
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
455
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
443
456
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
444
457
|
def get_flow_action_relationships_messages_with_http_info(id, opts = {})
|
445
458
|
if @api_client.config.debugging
|
@@ -449,6 +462,14 @@ module KlaviyoAPI
|
|
449
462
|
if @api_client.config.client_side_validation && id.nil?
|
450
463
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action_relationships_messages"
|
451
464
|
end
|
465
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
466
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_relationships_messages, must be smaller than or equal to 50.'
|
467
|
+
end
|
468
|
+
|
469
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
470
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_relationships_messages, must be greater than or equal to 1.'
|
471
|
+
end
|
472
|
+
|
452
473
|
allowable_values = ["created", "-created", "id", "-id", "name", "-name", "updated", "-updated"]
|
453
474
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
454
475
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
@@ -460,12 +481,13 @@ module KlaviyoAPI
|
|
460
481
|
query_params = opts[:query_params] || {}
|
461
482
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
462
483
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
484
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
463
485
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
464
486
|
|
465
487
|
# header parameters
|
466
488
|
header_params = opts[:header_params] || {}
|
467
489
|
# klaviyo api revision
|
468
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
490
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
469
491
|
# HTTP header 'Accept' (if needed)
|
470
492
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
471
493
|
|
@@ -499,58 +521,69 @@ module KlaviyoAPI
|
|
499
521
|
end
|
500
522
|
|
501
523
|
# Get Flow Actions For Flow
|
502
|
-
# Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
503
|
-
# @param
|
524
|
+
# Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
525
|
+
# @param id [String]
|
504
526
|
# @param [Hash] opts the optional parameters
|
505
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
506
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
507
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
508
|
-
# @option opts [
|
527
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
528
|
+
# @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>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
529
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
530
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
531
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
509
532
|
# @return [Hash<String, Object>]
|
510
|
-
def get_flow_flow_actions(
|
511
|
-
data, _status_code, _headers = get_flow_flow_actions_with_http_info(
|
533
|
+
def get_flow_flow_actions(id, opts = {})
|
534
|
+
data, _status_code, _headers = get_flow_flow_actions_with_http_info(id, opts)
|
512
535
|
data
|
513
536
|
end
|
514
537
|
|
515
538
|
# Get Flow Actions For Flow
|
516
|
-
# Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
517
|
-
# @param
|
539
|
+
# Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
540
|
+
# @param id [String]
|
518
541
|
# @param [Hash] opts the optional parameters
|
519
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
520
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
521
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
522
|
-
# @option opts [
|
542
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
543
|
+
# @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>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
544
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
545
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
546
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
523
547
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
524
|
-
def get_flow_flow_actions_with_http_info(
|
548
|
+
def get_flow_flow_actions_with_http_info(id, opts = {})
|
525
549
|
if @api_client.config.debugging
|
526
550
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_flow_actions ...'
|
527
551
|
end
|
528
|
-
# verify the required parameter '
|
529
|
-
if @api_client.config.client_side_validation &&
|
530
|
-
fail ArgumentError, "Missing the required parameter '
|
552
|
+
# verify the required parameter 'id' is set
|
553
|
+
if @api_client.config.client_side_validation && id.nil?
|
554
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_flow_actions"
|
531
555
|
end
|
532
556
|
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "send_options", "send_options.use_smart_sending", "send_options.is_transactional", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language"]
|
533
557
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
534
558
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
535
559
|
end
|
560
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
561
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_flow_actions, must be smaller than or equal to 50.'
|
562
|
+
end
|
563
|
+
|
564
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
565
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_flow_actions, must be greater than or equal to 1.'
|
566
|
+
end
|
567
|
+
|
536
568
|
allowable_values = ["action_type", "-action_type", "created", "-created", "id", "-id", "status", "-status", "updated", "-updated"]
|
537
569
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
538
570
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
539
571
|
end
|
540
572
|
# resource path
|
541
|
-
local_var_path = '/api/flows/{
|
573
|
+
local_var_path = '/api/flows/{id}/flow-actions/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
542
574
|
|
543
575
|
# query parameters
|
544
576
|
query_params = opts[:query_params] || {}
|
545
577
|
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
546
578
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
547
579
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
580
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
548
581
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
549
582
|
|
550
583
|
# header parameters
|
551
584
|
header_params = opts[:header_params] || {}
|
552
585
|
# klaviyo api revision
|
553
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
586
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
554
587
|
# HTTP header 'Accept' (if needed)
|
555
588
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
556
589
|
|
@@ -584,12 +617,12 @@ module KlaviyoAPI
|
|
584
617
|
end
|
585
618
|
|
586
619
|
# Get Flow Message
|
587
|
-
# Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
620
|
+
# Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
588
621
|
# @param id [String]
|
589
622
|
# @param [Hash] opts the optional parameters
|
590
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
591
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
592
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
623
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
624
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
625
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
593
626
|
# @return [Hash<String, Object>]
|
594
627
|
def get_flow_message(id, opts = {})
|
595
628
|
data, _status_code, _headers = get_flow_message_with_http_info(id, opts)
|
@@ -597,12 +630,12 @@ module KlaviyoAPI
|
|
597
630
|
end
|
598
631
|
|
599
632
|
# Get Flow Message
|
600
|
-
# Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
633
|
+
# Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
601
634
|
# @param id [String]
|
602
635
|
# @param [Hash] opts the optional parameters
|
603
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
604
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
605
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
636
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
637
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
638
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
606
639
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
607
640
|
def get_flow_message_with_http_info(id, opts = {})
|
608
641
|
if @api_client.config.debugging
|
@@ -636,7 +669,7 @@ module KlaviyoAPI
|
|
636
669
|
# header parameters
|
637
670
|
header_params = opts[:header_params] || {}
|
638
671
|
# klaviyo api revision
|
639
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
672
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
640
673
|
# HTTP header 'Accept' (if needed)
|
641
674
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
642
675
|
|
@@ -670,36 +703,36 @@ module KlaviyoAPI
|
|
670
703
|
end
|
671
704
|
|
672
705
|
# Get Flow Action For Message
|
673
|
-
# Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
674
|
-
# @param
|
706
|
+
# Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
707
|
+
# @param id [String]
|
675
708
|
# @param [Hash] opts the optional parameters
|
676
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
709
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
677
710
|
# @return [Hash<String, Object>]
|
678
|
-
def get_flow_message_action(
|
679
|
-
data, _status_code, _headers = get_flow_message_action_with_http_info(
|
711
|
+
def get_flow_message_action(id, opts = {})
|
712
|
+
data, _status_code, _headers = get_flow_message_action_with_http_info(id, opts)
|
680
713
|
data
|
681
714
|
end
|
682
715
|
|
683
716
|
# Get Flow Action For Message
|
684
|
-
# Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
685
|
-
# @param
|
717
|
+
# Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
718
|
+
# @param id [String]
|
686
719
|
# @param [Hash] opts the optional parameters
|
687
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
720
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
688
721
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
689
|
-
def get_flow_message_action_with_http_info(
|
722
|
+
def get_flow_message_action_with_http_info(id, opts = {})
|
690
723
|
if @api_client.config.debugging
|
691
724
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_message_action ...'
|
692
725
|
end
|
693
|
-
# verify the required parameter '
|
694
|
-
if @api_client.config.client_side_validation &&
|
695
|
-
fail ArgumentError, "Missing the required parameter '
|
726
|
+
# verify the required parameter 'id' is set
|
727
|
+
if @api_client.config.client_side_validation && id.nil?
|
728
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_message_action"
|
696
729
|
end
|
697
730
|
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "send_options", "send_options.use_smart_sending", "send_options.is_transactional", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language"]
|
698
731
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
699
732
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
700
733
|
end
|
701
734
|
# resource path
|
702
|
-
local_var_path = '/api/flow-messages/{
|
735
|
+
local_var_path = '/api/flow-messages/{id}/flow-action/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
703
736
|
|
704
737
|
# query parameters
|
705
738
|
query_params = opts[:query_params] || {}
|
@@ -708,7 +741,7 @@ module KlaviyoAPI
|
|
708
741
|
# header parameters
|
709
742
|
header_params = opts[:header_params] || {}
|
710
743
|
# klaviyo api revision
|
711
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
744
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
712
745
|
# HTTP header 'Accept' (if needed)
|
713
746
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
714
747
|
|
@@ -742,7 +775,7 @@ module KlaviyoAPI
|
|
742
775
|
end
|
743
776
|
|
744
777
|
# Get Flow Message Relationships Action
|
745
|
-
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
778
|
+
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
746
779
|
# @param id [String]
|
747
780
|
# @param [Hash] opts the optional parameters
|
748
781
|
# @return [Hash<String, Object>]
|
@@ -752,7 +785,7 @@ module KlaviyoAPI
|
|
752
785
|
end
|
753
786
|
|
754
787
|
# Get Flow Message Relationships Action
|
755
|
-
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
788
|
+
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
756
789
|
# @param id [String]
|
757
790
|
# @param [Hash] opts the optional parameters
|
758
791
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -773,7 +806,7 @@ module KlaviyoAPI
|
|
773
806
|
# header parameters
|
774
807
|
header_params = opts[:header_params] || {}
|
775
808
|
# klaviyo api revision
|
776
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
809
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
777
810
|
# HTTP header 'Accept' (if needed)
|
778
811
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
779
812
|
|
@@ -807,11 +840,12 @@ module KlaviyoAPI
|
|
807
840
|
end
|
808
841
|
|
809
842
|
# Get Flow Relationships Flow Actions
|
810
|
-
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
843
|
+
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
811
844
|
# @param id [String]
|
812
845
|
# @param [Hash] opts the optional parameters
|
813
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
814
|
-
# @option opts [
|
846
|
+
# @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>`action_type`: `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
847
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
848
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
815
849
|
# @return [Hash<String, Object>]
|
816
850
|
def get_flow_relationships_flow_actions(id, opts = {})
|
817
851
|
data, _status_code, _headers = get_flow_relationships_flow_actions_with_http_info(id, opts)
|
@@ -819,11 +853,12 @@ module KlaviyoAPI
|
|
819
853
|
end
|
820
854
|
|
821
855
|
# Get Flow Relationships Flow Actions
|
822
|
-
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
856
|
+
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
823
857
|
# @param id [String]
|
824
858
|
# @param [Hash] opts the optional parameters
|
825
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
826
|
-
# @option opts [
|
859
|
+
# @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>`action_type`: `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
860
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
861
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
827
862
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
828
863
|
def get_flow_relationships_flow_actions_with_http_info(id, opts = {})
|
829
864
|
if @api_client.config.debugging
|
@@ -833,6 +868,14 @@ module KlaviyoAPI
|
|
833
868
|
if @api_client.config.client_side_validation && id.nil?
|
834
869
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_relationships_flow_actions"
|
835
870
|
end
|
871
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
872
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_relationships_flow_actions, must be smaller than or equal to 100.'
|
873
|
+
end
|
874
|
+
|
875
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
876
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_relationships_flow_actions, must be greater than or equal to 1.'
|
877
|
+
end
|
878
|
+
|
836
879
|
allowable_values = ["created", "-created", "id", "-id", "status", "-status", "updated", "-updated"]
|
837
880
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
838
881
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
@@ -843,12 +886,13 @@ module KlaviyoAPI
|
|
843
886
|
# query parameters
|
844
887
|
query_params = opts[:query_params] || {}
|
845
888
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
889
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
846
890
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
847
891
|
|
848
892
|
# header parameters
|
849
893
|
header_params = opts[:header_params] || {}
|
850
894
|
# klaviyo api revision
|
851
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
895
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
852
896
|
# HTTP header 'Accept' (if needed)
|
853
897
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
854
898
|
|
@@ -882,7 +926,7 @@ module KlaviyoAPI
|
|
882
926
|
end
|
883
927
|
|
884
928
|
# Get Flow Relationships Tags
|
885
|
-
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
929
|
+
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
886
930
|
# @param id [String]
|
887
931
|
# @param [Hash] opts the optional parameters
|
888
932
|
# @return [Hash<String, Object>]
|
@@ -892,7 +936,7 @@ module KlaviyoAPI
|
|
892
936
|
end
|
893
937
|
|
894
938
|
# Get Flow Relationships Tags
|
895
|
-
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
939
|
+
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
896
940
|
# @param id [String]
|
897
941
|
# @param [Hash] opts the optional parameters
|
898
942
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -913,7 +957,7 @@ module KlaviyoAPI
|
|
913
957
|
# header parameters
|
914
958
|
header_params = opts[:header_params] || {}
|
915
959
|
# klaviyo api revision
|
916
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
960
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
917
961
|
# HTTP header 'Accept' (if needed)
|
918
962
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
919
963
|
|
@@ -947,36 +991,36 @@ module KlaviyoAPI
|
|
947
991
|
end
|
948
992
|
|
949
993
|
# Get Flow Tags
|
950
|
-
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
951
|
-
# @param
|
994
|
+
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
995
|
+
# @param id [String]
|
952
996
|
# @param [Hash] opts the optional parameters
|
953
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
997
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
954
998
|
# @return [Hash<String, Object>]
|
955
|
-
def get_flow_tags(
|
956
|
-
data, _status_code, _headers = get_flow_tags_with_http_info(
|
999
|
+
def get_flow_tags(id, opts = {})
|
1000
|
+
data, _status_code, _headers = get_flow_tags_with_http_info(id, opts)
|
957
1001
|
data
|
958
1002
|
end
|
959
1003
|
|
960
1004
|
# Get Flow Tags
|
961
|
-
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
962
|
-
# @param
|
1005
|
+
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
1006
|
+
# @param id [String]
|
963
1007
|
# @param [Hash] opts the optional parameters
|
964
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
1008
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
965
1009
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
966
|
-
def get_flow_tags_with_http_info(
|
1010
|
+
def get_flow_tags_with_http_info(id, opts = {})
|
967
1011
|
if @api_client.config.debugging
|
968
1012
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_tags ...'
|
969
1013
|
end
|
970
|
-
# verify the required parameter '
|
971
|
-
if @api_client.config.client_side_validation &&
|
972
|
-
fail ArgumentError, "Missing the required parameter '
|
1014
|
+
# verify the required parameter 'id' is set
|
1015
|
+
if @api_client.config.client_side_validation && id.nil?
|
1016
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_tags"
|
973
1017
|
end
|
974
1018
|
allowable_values = ["name"]
|
975
1019
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
976
1020
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
977
1021
|
end
|
978
1022
|
# resource path
|
979
|
-
local_var_path = '/api/flows/{
|
1023
|
+
local_var_path = '/api/flows/{id}/tags/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
980
1024
|
|
981
1025
|
# query parameters
|
982
1026
|
query_params = opts[:query_params] || {}
|
@@ -985,7 +1029,7 @@ module KlaviyoAPI
|
|
985
1029
|
# header parameters
|
986
1030
|
header_params = opts[:header_params] || {}
|
987
1031
|
# klaviyo api revision
|
988
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1032
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
989
1033
|
# HTTP header 'Accept' (if needed)
|
990
1034
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
991
1035
|
|
@@ -1019,14 +1063,15 @@ module KlaviyoAPI
|
|
1019
1063
|
end
|
1020
1064
|
|
1021
1065
|
# Get Flows
|
1022
|
-
# Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1066
|
+
# Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
1023
1067
|
# @param [Hash] opts the optional parameters
|
1024
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
1025
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
1026
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1027
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1028
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1029
|
-
# @option opts [
|
1068
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1069
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1070
|
+
# @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>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`
|
1071
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
1072
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1073
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
1074
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
1030
1075
|
# @return [Hash<String, Object>]
|
1031
1076
|
def get_flows(opts = {})
|
1032
1077
|
data, _status_code, _headers = get_flows_with_http_info(opts)
|
@@ -1034,14 +1079,15 @@ module KlaviyoAPI
|
|
1034
1079
|
end
|
1035
1080
|
|
1036
1081
|
# Get Flows
|
1037
|
-
# Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1082
|
+
# Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
1038
1083
|
# @param [Hash] opts the optional parameters
|
1039
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
1040
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
1041
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1042
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1043
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1044
|
-
# @option opts [
|
1084
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1085
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1086
|
+
# @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>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`
|
1087
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
1088
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1089
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
1090
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
1045
1091
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1046
1092
|
def get_flows_with_http_info(opts = {})
|
1047
1093
|
if @api_client.config.debugging
|
@@ -1059,6 +1105,14 @@ module KlaviyoAPI
|
|
1059
1105
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1060
1106
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1061
1107
|
end
|
1108
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
1109
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flows, must be smaller than or equal to 50.'
|
1110
|
+
end
|
1111
|
+
|
1112
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
1113
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flows, must be greater than or equal to 1.'
|
1114
|
+
end
|
1115
|
+
|
1062
1116
|
allowable_values = ["created", "-created", "id", "-id", "name", "-name", "status", "-status", "trigger_type", "-trigger_type", "updated", "-updated"]
|
1063
1117
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1064
1118
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
@@ -1073,12 +1127,13 @@ module KlaviyoAPI
|
|
1073
1127
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1074
1128
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1075
1129
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1130
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
1076
1131
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1077
1132
|
|
1078
1133
|
# header parameters
|
1079
1134
|
header_params = opts[:header_params] || {}
|
1080
1135
|
# klaviyo api revision
|
1081
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1136
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1082
1137
|
# HTTP header 'Accept' (if needed)
|
1083
1138
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1084
1139
|
|
@@ -1112,7 +1167,7 @@ module KlaviyoAPI
|
|
1112
1167
|
end
|
1113
1168
|
|
1114
1169
|
# Update Flow Status
|
1115
|
-
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1170
|
+
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
1116
1171
|
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
1117
1172
|
# @param flow_update_query [FlowUpdateQuery]
|
1118
1173
|
# @param [Hash] opts the optional parameters
|
@@ -1123,7 +1178,7 @@ module KlaviyoAPI
|
|
1123
1178
|
end
|
1124
1179
|
|
1125
1180
|
# Update Flow Status
|
1126
|
-
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `
|
1181
|
+
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
1127
1182
|
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
1128
1183
|
# @param flow_update_query [FlowUpdateQuery]
|
1129
1184
|
# @param [Hash] opts the optional parameters
|
@@ -1149,7 +1204,7 @@ module KlaviyoAPI
|
|
1149
1204
|
# header parameters
|
1150
1205
|
header_params = opts[:header_params] || {}
|
1151
1206
|
# klaviyo api revision
|
1152
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1207
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1153
1208
|
# HTTP header 'Accept' (if needed)
|
1154
1209
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1155
1210
|
# HTTP header 'Content-Type'
|