klaviyo-api-sdk 1.1.0 → 1.2.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 +10 -0
- data/README.md +314 -136
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +20 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CampaignTagOp.md +18 -0
- data/docs/CampaignTagOpDataInner.md +20 -0
- data/docs/CampaignsApi.md +1277 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +6 -6
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +2 -2
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +2 -2
- data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +2 -2
- data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +21 -19
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogItemDeleteQueryAsSubResource.md +2 -2
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogItemUpdateQueryAsSubResource.md +2 -2
- data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +18 -16
- data/docs/CatalogJobErrorPayload.md +8 -8
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +27 -27
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +2 -2
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +2 -2
- data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +22 -22
- data/docs/CatalogsApi.md +238 -238
- data/docs/ErrorSource.md +1 -1
- data/docs/EventsApi.md +26 -26
- data/docs/FlowsApi.md +64 -56
- data/docs/GetCampaigns4XXResponse.md +18 -0
- data/docs/GetCampaigns4XXResponseErrorsInner.md +26 -0
- data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +20 -0
- data/docs/IncludedCategories.md +2 -2
- data/docs/IncludedCategoriesAttributes.md +5 -5
- data/docs/IncludedItems.md +2 -2
- data/docs/IncludedItemsAttributes.md +22 -20
- data/docs/IncludedLists.md +2 -2
- data/docs/IncludedListsAttributes.md +4 -4
- data/docs/IncludedProfiles.md +2 -2
- data/docs/IncludedProfilesAttributes.md +21 -21
- data/docs/IncludedSegments.md +1 -1
- data/docs/IncludedSegmentsAttributes.md +22 -0
- data/docs/IncludedTags.md +24 -0
- data/docs/IncludedVariants.md +2 -2
- data/docs/IncludedVariantsAttributes.md +28 -28
- data/docs/ListCreateQueryAsSubResourceAttributes.md +2 -2
- data/docs/ListPartialUpdateQueryAsSubResource.md +2 -2
- data/docs/ListsApi.md +30 -30
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +5 -5
- data/docs/MetricsApi.md +9 -9
- data/docs/OnsiteProfileMetaIdentifiers.md +10 -10
- data/docs/ProfileCreateQueryAsSubResourceAttributes.md +18 -18
- data/docs/ProfileLocation.md +15 -15
- data/docs/ProfileLocationLongitude.md +49 -0
- data/docs/ProfilePartialUpdateQueryAsSubResource.md +2 -2
- data/docs/ProfilesApi.md +26 -26
- data/docs/STOScheduleOptions.md +18 -0
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +1 -1
- data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/SegmentsApi.md +19 -19
- data/docs/SendOptionsSubObject.md +1 -3
- data/docs/SendStrategySubObject.md +4 -2
- data/docs/Subscription.md +8 -4
- data/docs/SubscriptionChannels.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +2 -2
- data/docs/Suppression.md +1 -1
- data/docs/TagsApi.md +24 -24
- data/docs/TemplateCloneQueryAsSubResource.md +0 -2
- data/docs/TemplatesApi.md +11 -11
- data/docs/ThrottledScheduleOptions.md +1 -1
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +1275 -0
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +299 -299
- data/lib/klaviyo-api-sdk/api/client_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/events_api.rb +33 -33
- data/lib/klaviyo-api-sdk/api/flows_api.rb +86 -74
- data/lib/klaviyo-api-sdk/api/lists_api.rb +39 -39
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +34 -34
- data/lib/klaviyo-api-sdk/api/segments_api.rb +25 -25
- data/lib/klaviyo-api-sdk/api/tags_api.rb +41 -41
- data/lib/klaviyo-api-sdk/api/templates_api.rb +18 -18
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb +225 -0
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_tag_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/campaign_tag_op_data_inner.rb +272 -0
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +5 -2
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +23 -3
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +2 -2
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +20 -2
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +5 -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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +16 -8
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +2 -2
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +12 -2
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/error_source.rb +2 -1
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response.rb +226 -0
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner.rb +275 -0
- data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner_source.rb +228 -0
- data/lib/klaviyo-api-sdk/models/included_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +4 -1
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flows.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_items.rb +2 -1
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +23 -2
- data/lib/klaviyo-api-sdk/models/included_lists.rb +2 -1
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +4 -1
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +2 -1
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +13 -1
- data/lib/klaviyo-api-sdk/models/included_segments.rb +2 -2
- data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +240 -0
- data/lib/klaviyo-api-sdk/models/included_tags.rb +301 -0
- data/lib/klaviyo-api-sdk/models/included_variants.rb +2 -1
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +16 -2
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +2 -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_as_sub_resource.rb +2 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +17 -15
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +16 -11
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +10 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +9 -2
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +2 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +2 -2
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/send_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +5 -15
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +15 -6
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +225 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +26 -5
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource_attributes.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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_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_as_sub_resource.rb +2 -13
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +1 -1
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
- 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_as_sub_resource.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/utm_param_info.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 +14 -5
- data/spec/api/campaigns_api_spec.rb +284 -0
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_tag_op_data_inner_spec.rb +44 -0
- data/spec/models/campaign_tag_op_spec.rb +34 -0
- data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +40 -0
- data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +58 -0
- data/spec/models/get_campaigns4_xx_response_spec.rb +34 -0
- data/spec/models/included_segments_attributes_spec.rb +46 -0
- data/spec/models/included_tags_spec.rb +56 -0
- data/spec/models/profile_location_longitude_spec.rb +31 -0
- data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/sto_schedule_options_spec.rb +34 -0
- data/spec/models/subscription_channels_spec.rb +48 -0
- data/spec/spec_helper.rb +1 -1
- metadata +51 -6
@@ -4,9 +4,10 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **method** | **String** | Describes the shape of the options object. Allowed values: ['static', 'throttled', 'immediate'] | |
|
7
|
+
| **method** | **String** | Describes the shape of the options object. Allowed values: ['static', 'throttled', 'immediate', 'smart_send_time'] | |
|
8
8
|
| **options_static** | [**StaticScheduleOptions**](StaticScheduleOptions.md) | | [optional] |
|
9
9
|
| **options_throttled** | [**ThrottledScheduleOptions**](ThrottledScheduleOptions.md) | | [optional] |
|
10
|
+
| **options_sto** | [**STOScheduleOptions**](STOScheduleOptions.md) | | [optional] |
|
10
11
|
|
11
12
|
## Example
|
12
13
|
|
@@ -16,7 +17,8 @@ require 'klaviyo-api-sdk'
|
|
16
17
|
instance = KlaviyoAPI::SendStrategySubObject.new(
|
17
18
|
method: static,
|
18
19
|
options_static: null,
|
19
|
-
options_throttled: null
|
20
|
+
options_throttled: null,
|
21
|
+
options_sto: null
|
20
22
|
)
|
21
23
|
```
|
22
24
|
|
data/docs/Subscription.md
CHANGED
@@ -4,8 +4,10 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **
|
7
|
+
| **channels** | [**SubscriptionChannels**](SubscriptionChannels.md) | | [optional] |
|
8
|
+
| **email** | **String** | The email address to subscribe or to set on the profile if `channels` is specified and the email channel is omitted. | [optional] |
|
9
|
+
| **phone_number** | **String** | The phone number to subscribe or to set on the profile if `channels` is specified and the SMS channel is omitted. | [optional] |
|
10
|
+
| **profile_id** | **String** | The ID of the profile to subscribe. If provided, this will be used to perform the lookup. | [optional] |
|
9
11
|
|
10
12
|
## Example
|
11
13
|
|
@@ -13,8 +15,10 @@
|
|
13
15
|
require 'klaviyo-api-sdk'
|
14
16
|
|
15
17
|
instance = KlaviyoAPI::Subscription.new(
|
16
|
-
|
17
|
-
|
18
|
+
channels: null,
|
19
|
+
email: matt-kemp@klaviyo-demo.com,
|
20
|
+
phone_number: +15005550006,
|
21
|
+
profile_id: 01GDDKASAP8TKDDA2GRZDSVP4H
|
18
22
|
)
|
19
23
|
```
|
20
24
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# KlaviyoAPI::SubscriptionChannels
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **email** | **Array<String>** | The communication types to subscribe to on the \"EMAIL\" Channel. Currently supports \"MARKETING\". | [optional] |
|
8
|
+
| **sms** | **Array<String>** | The communication types to subscribe to on the \"SMS\" Channel. Currently supports \"MARKETING\". | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'klaviyo-api-sdk'
|
14
|
+
|
15
|
+
instance = KlaviyoAPI::SubscriptionChannels.new(
|
16
|
+
email: ["MARKETING"],
|
17
|
+
sms: ["MARKETING"]
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/Suppression.md
CHANGED
data/docs/TagsApi.md
CHANGED
@@ -478,7 +478,7 @@ end
|
|
478
478
|
api_instance = KlaviyoAPI::TagsApi.new
|
479
479
|
id = 'abcd1234-ef56-gh78-ij90-abcdef123456' # String | The Tag ID
|
480
480
|
opts = {
|
481
|
-
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
481
|
+
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
482
482
|
}
|
483
483
|
|
484
484
|
begin
|
@@ -513,7 +513,7 @@ end
|
|
513
513
|
| Name | Type | Description | Notes |
|
514
514
|
| ---- | ---- | ----------- | ----- |
|
515
515
|
| **id** | **String** | The Tag ID | |
|
516
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
516
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
517
517
|
|
518
518
|
### Return type
|
519
519
|
|
@@ -553,7 +553,7 @@ end
|
|
553
553
|
api_instance = KlaviyoAPI::TagsApi.new
|
554
554
|
id = 'zyxw9876-vu54-ts32-rq10-zyxwvu654321' # String | The Tag Group ID
|
555
555
|
opts = {
|
556
|
-
fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
556
|
+
fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
557
557
|
}
|
558
558
|
|
559
559
|
begin
|
@@ -588,7 +588,7 @@ end
|
|
588
588
|
| Name | Type | Description | Notes |
|
589
589
|
| ---- | ---- | ----------- | ----- |
|
590
590
|
| **id** | **String** | The Tag Group ID | |
|
591
|
-
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
591
|
+
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
592
592
|
|
593
593
|
### Return type
|
594
594
|
|
@@ -701,7 +701,7 @@ end
|
|
701
701
|
api_instance = KlaviyoAPI::TagsApi.new
|
702
702
|
id = 'zyxw9876-vu54-ts32-rq10-zyxwvu654321' # String | The Tag Group ID
|
703
703
|
opts = {
|
704
|
-
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
704
|
+
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
705
705
|
}
|
706
706
|
|
707
707
|
begin
|
@@ -736,7 +736,7 @@ end
|
|
736
736
|
| Name | Type | Description | Notes |
|
737
737
|
| ---- | ---- | ----------- | ----- |
|
738
738
|
| **id** | **String** | The Tag Group ID | |
|
739
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
739
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
740
740
|
|
741
741
|
### Return type
|
742
742
|
|
@@ -775,10 +775,10 @@ end
|
|
775
775
|
|
776
776
|
api_instance = KlaviyoAPI::TagsApi.new
|
777
777
|
opts = {
|
778
|
-
fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
779
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
780
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
781
|
-
sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
778
|
+
fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
779
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
780
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
781
|
+
sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
782
782
|
}
|
783
783
|
|
784
784
|
begin
|
@@ -812,10 +812,10 @@ end
|
|
812
812
|
|
813
813
|
| Name | Type | Description | Notes |
|
814
814
|
| ---- | ---- | ----------- | ----- |
|
815
|
-
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
816
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
817
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
818
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
815
|
+
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
816
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals` | [optional] |
|
817
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
818
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
|
819
819
|
|
820
820
|
### Return type
|
821
821
|
|
@@ -928,7 +928,7 @@ end
|
|
928
928
|
api_instance = KlaviyoAPI::TagsApi.new
|
929
929
|
id = 'abcd1234-ef56-gh78-ij90-abcdef123456' # String | The Tag ID
|
930
930
|
opts = {
|
931
|
-
fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
931
|
+
fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
932
932
|
}
|
933
933
|
|
934
934
|
begin
|
@@ -963,7 +963,7 @@ end
|
|
963
963
|
| Name | Type | Description | Notes |
|
964
964
|
| ---- | ---- | ----------- | ----- |
|
965
965
|
| **id** | **String** | The Tag ID | |
|
966
|
-
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
966
|
+
| **fields_tag_group** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
967
967
|
|
968
968
|
### Return type
|
969
969
|
|
@@ -1002,10 +1002,10 @@ end
|
|
1002
1002
|
|
1003
1003
|
api_instance = KlaviyoAPI::TagsApi.new
|
1004
1004
|
opts = {
|
1005
|
-
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1006
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1007
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1008
|
-
sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1005
|
+
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
1006
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
1007
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
1008
|
+
sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
1009
1009
|
}
|
1010
1010
|
|
1011
1011
|
begin
|
@@ -1039,10 +1039,10 @@ end
|
|
1039
1039
|
|
1040
1040
|
| Name | Type | Description | Notes |
|
1041
1041
|
| ---- | ---- | ----------- | ----- |
|
1042
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1043
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1044
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1045
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1042
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
1043
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with` | [optional] |
|
1044
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
1045
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
|
1046
1046
|
|
1047
1047
|
### Return type
|
1048
1048
|
|
@@ -5,7 +5,6 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | **String** | | |
|
8
|
-
| **id** | **Object** | The ID of MessageTemplate | |
|
9
8
|
| **attributes** | [**TemplateCloneQueryAsSubResourceAttributes**](TemplateCloneQueryAsSubResourceAttributes.md) | | |
|
10
9
|
|
11
10
|
## Example
|
@@ -15,7 +14,6 @@ require 'klaviyo-api-sdk'
|
|
15
14
|
|
16
15
|
instance = KlaviyoAPI::TemplateCloneQueryAsSubResource.new(
|
17
16
|
type: null,
|
18
|
-
id: null,
|
19
17
|
attributes: null
|
20
18
|
)
|
21
19
|
```
|
data/docs/TemplatesApi.md
CHANGED
@@ -106,7 +106,7 @@ KlaviyoAPI.configure do |config|
|
|
106
106
|
end
|
107
107
|
|
108
108
|
api_instance = KlaviyoAPI::TemplatesApi.new
|
109
|
-
template_clone_query = KlaviyoAPI::TemplateCloneQuery.new({data: KlaviyoAPI::TemplateCloneQueryAsSubResource.new({type: 'template',
|
109
|
+
template_clone_query = KlaviyoAPI::TemplateCloneQuery.new({data: KlaviyoAPI::TemplateCloneQueryAsSubResource.new({type: 'template', attributes: KlaviyoAPI::TemplateCloneQueryAsSubResourceAttributes.new({id: 'id_example'})})}) # TemplateCloneQuery |
|
110
110
|
|
111
111
|
begin
|
112
112
|
# Create Template Clone
|
@@ -321,7 +321,7 @@ end
|
|
321
321
|
api_instance = KlaviyoAPI::TemplatesApi.new
|
322
322
|
id = 'id_example' # String | The ID of template
|
323
323
|
opts = {
|
324
|
-
fields_template: ['company_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
324
|
+
fields_template: ['company_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
325
325
|
}
|
326
326
|
|
327
327
|
begin
|
@@ -356,7 +356,7 @@ end
|
|
356
356
|
| Name | Type | Description | Notes |
|
357
357
|
| ---- | ---- | ----------- | ----- |
|
358
358
|
| **id** | **String** | The ID of template | |
|
359
|
-
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
359
|
+
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
360
360
|
|
361
361
|
### Return type
|
362
362
|
|
@@ -395,10 +395,10 @@ end
|
|
395
395
|
|
396
396
|
api_instance = KlaviyoAPI::TemplatesApi.new
|
397
397
|
opts = {
|
398
|
-
fields_template: ['company_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
399
|
-
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
400
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
401
|
-
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
398
|
+
fields_template: ['company_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
|
399
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
400
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
|
401
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
|
402
402
|
}
|
403
403
|
|
404
404
|
begin
|
@@ -432,10 +432,10 @@ end
|
|
432
432
|
|
433
433
|
| Name | Type | Description | Notes |
|
434
434
|
| ---- | ---- | ----------- | ----- |
|
435
|
-
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
436
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
437
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
438
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
435
|
+
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
|
436
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` | [optional] |
|
437
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
|
438
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
|
439
439
|
|
440
440
|
### Return type
|
441
441
|
|
@@ -14,9 +14,9 @@
|
|
14
14
|
require 'klaviyo-api-sdk'
|
15
15
|
|
16
16
|
instance = KlaviyoAPI::UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.new(
|
17
|
-
list_id:
|
18
|
-
emails:
|
19
|
-
phone_numbers:
|
17
|
+
list_id: Y6nRLr,
|
18
|
+
emails: ["matt-kemp@klaviyo-demo.com", "sarah.mason@klaviyo-demo.com",
|
19
|
+
phone_numbers: ["+15005550006","+15005550007"]
|
20
20
|
)
|
21
21
|
```
|
22
22
|
|
data/klaviyo-api-sdk.gemspec
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
|
6
6
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
7
7
|
|
8
|
-
The version of the OpenAPI document: 2023-
|
8
|
+
The version of the OpenAPI document: 2023-02-22
|
9
9
|
Contact: developers@klaviyo.com
|
10
10
|
Generated by: https://openapi-generator.tech
|
11
11
|
OpenAPI Generator version: 6.2.1
|
@@ -17,7 +17,7 @@ require "klaviyo-api-sdk/version"
|
|
17
17
|
|
18
18
|
Gem::Specification.new do |s|
|
19
19
|
s.name = "klaviyo-api-sdk"
|
20
|
-
s.version = "1.
|
20
|
+
s.version = "1.2.0"
|
21
21
|
s.authors = ['Klaviyo Team']
|
22
22
|
s.email = ['libraries@klaviyo.com']
|
23
23
|
s.summary = 'You heard us, a Ruby wrapper for the Klaviyo API'
|