klaviyo-api-sdk 4.0.0 → 4.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +9 -0
- data/README.md +457 -176
- data/Rakefile +10 -0
- data/docs/AccountsApi.md +157 -0
- data/docs/AudiencesSubObject.md +20 -0
- data/docs/BackInStockSubscriptionEnum.md +15 -0
- data/docs/CampaignCloneQuery.md +18 -0
- data/docs/CampaignCloneQueryResourceObject.md +22 -0
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignCreateQuery.md +18 -0
- data/docs/CampaignCreateQueryResourceObject.md +20 -0
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +28 -0
- data/docs/CampaignCreateQueryResourceObjectAttributesCampaignMessages.md +18 -0
- data/docs/CampaignCreateQueryResourceObjectAttributesSendOptions.md +49 -0
- data/docs/CampaignCreateQueryResourceObjectAttributesTrackingOptions.md +49 -0
- data/docs/CampaignEnum.md +15 -0
- data/docs/CampaignMessageAssignTemplateQuery.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +22 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationships.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplateData.md +20 -0
- data/docs/CampaignMessageCreateQueryResourceObject.md +20 -0
- data/docs/CampaignMessageCreateQueryResourceObjectAttributes.md +24 -0
- data/docs/CampaignMessageCreateQueryResourceObjectAttributesContent.md +49 -0
- data/docs/CampaignMessageEnum.md +15 -0
- data/docs/CampaignMessagePartialUpdateQuery.md +18 -0
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +22 -0
- data/docs/CampaignPartialUpdateQuery.md +18 -0
- data/docs/CampaignPartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +26 -0
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignRecipientEstimationJobEnum.md +15 -0
- data/docs/CampaignSendJobCreateQuery.md +18 -0
- data/docs/CampaignSendJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignSendJobEnum.md +15 -0
- data/docs/CampaignSendJobPartialUpdateQuery.md +18 -0
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignsApi.md +1735 -0
- data/docs/CatalogCategoryBulkCreateJobEnum.md +15 -0
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogCategoryCreateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributesCategories.md +18 -0
- data/docs/CatalogCategoryCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateQueryResourceObject.md +22 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +24 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItems.md +18 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItemsDataInner.md +20 -0
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributesCategories.md +18 -0
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryEnum.md +15 -0
- data/docs/CatalogCategoryItemOp.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributesCategories.md +18 -0
- data/docs/CatalogCategoryUpdateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateQueryResourceObject.md +24 -0
- data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemBulkCreateJobEnum.md +15 -0
- data/docs/CatalogItemBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogItemBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogItemCategoryOp.md +18 -0
- data/docs/CatalogItemCreateJobCreateQuery.md +18 -0
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributesItems.md +18 -0
- data/docs/CatalogItemCreateQuery.md +18 -0
- data/docs/CatalogItemCreateQueryResourceObject.md +22 -0
- data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +40 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +18 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributesItems.md +18 -0
- data/docs/CatalogItemDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogItemEnum.md +15 -0
- data/docs/CatalogItemUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributesItems.md +18 -0
- data/docs/CatalogItemUpdateQuery.md +18 -0
- data/docs/CatalogItemUpdateQueryResourceObject.md +24 -0
- data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +34 -0
- data/docs/CatalogVariantBulkCreateJobEnum.md +15 -0
- data/docs/CatalogVariantBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogVariantBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogVariantCreateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributesVariants.md +18 -0
- data/docs/CatalogVariantCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObject.md +22 -0
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +46 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItem.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemData.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributesVariants.md +18 -0
- data/docs/CatalogVariantDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogVariantEnum.md +15 -0
- data/docs/CatalogVariantUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributesVariants.md +18 -0
- data/docs/CatalogVariantUpdateQuery.md +18 -0
- data/docs/CatalogVariantUpdateQueryResourceObject.md +22 -0
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +40 -0
- data/docs/CatalogsApi.md +4103 -0
- data/docs/CouponCodeBulkCreateJobEnum.md +15 -0
- data/docs/CouponCodeCreateJobCreateQuery.md +18 -0
- data/docs/CouponCodeCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CouponCodeCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CouponCodeCreateJobCreateQueryResourceObjectAttributesCouponCodes.md +18 -0
- data/docs/CouponCodeCreateQuery.md +18 -0
- data/docs/CouponCodeCreateQueryResourceObject.md +22 -0
- data/docs/CouponCodeCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/CouponCodeCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CouponCodeCreateQueryResourceObjectRelationshipsCoupon.md +18 -0
- data/docs/CouponCodeCreateQueryResourceObjectRelationshipsCouponData.md +20 -0
- data/docs/CouponCodeEnum.md +15 -0
- data/docs/CouponCodeUpdateQuery.md +18 -0
- data/docs/CouponCodeUpdateQueryResourceObject.md +22 -0
- data/docs/CouponCodeUpdateQueryResourceObjectAttributes.md +20 -0
- data/docs/CouponCreateQuery.md +18 -0
- data/docs/CouponCreateQueryResourceObject.md +20 -0
- data/docs/CouponCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/CouponEnum.md +15 -0
- data/docs/CouponUpdateQuery.md +18 -0
- data/docs/CouponUpdateQueryResourceObject.md +22 -0
- data/docs/CouponUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CouponsApi.md +1277 -0
- data/docs/DataPrivacyApi.md +78 -0
- data/docs/DataPrivacyCreateDeletionJobQuery.md +18 -0
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +20 -0
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +18 -0
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributesProfile.md +18 -0
- data/docs/DataPrivacyDeletionJobEnum.md +15 -0
- data/docs/DataPrivacyProfileQueryResourceObject.md +22 -0
- data/docs/DataPrivacyProfileQueryResourceObjectAttributes.md +20 -0
- data/docs/DeviceMetadata.md +40 -0
- data/docs/EmailContentSubObject.md +30 -0
- data/docs/EmailSendOptionsSubObject.md +18 -0
- data/docs/EmailTrackingOptionsSubObject.md +24 -0
- data/docs/EventCreateQueryV2.md +18 -0
- data/docs/EventCreateQueryV2ResourceObject.md +20 -0
- data/docs/EventCreateQueryV2ResourceObjectAttributes.md +28 -0
- data/docs/EventCreateQueryV2ResourceObjectAttributesMetric.md +18 -0
- data/docs/EventCreateQueryV2ResourceObjectAttributesProfile.md +18 -0
- data/docs/EventEnum.md +15 -0
- data/docs/EventsApi.md +544 -0
- data/docs/FlowEnum.md +15 -0
- data/docs/FlowUpdateQuery.md +18 -0
- data/docs/FlowUpdateQueryResourceObject.md +22 -0
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/FlowsApi.md +1335 -0
- data/docs/GetAccounts4XXResponse.md +18 -0
- data/docs/GetAccounts4XXResponseErrorsInner.md +26 -0
- data/docs/GetAccounts4XXResponseErrorsInnerSource.md +20 -0
- data/docs/ImageCreateQuery.md +18 -0
- data/docs/ImageCreateQueryResourceObject.md +20 -0
- data/docs/ImageCreateQueryResourceObjectAttributes.md +22 -0
- data/docs/ImageEnum.md +15 -0
- data/docs/ImagePartialUpdateQuery.md +18 -0
- data/docs/ImagePartialUpdateQueryResourceObject.md +22 -0
- data/docs/ImagePartialUpdateQueryResourceObjectAttributes.md +20 -0
- data/docs/ImagesApi.md +389 -0
- data/docs/ListCreateQuery.md +18 -0
- data/docs/ListCreateQueryResourceObject.md +20 -0
- data/docs/ListCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/ListEnum.md +15 -0
- data/docs/ListMembersAddQuery.md +18 -0
- data/docs/ListMembersAddQueryDataInner.md +20 -0
- data/docs/ListMembersDeleteQuery.md +18 -0
- data/docs/ListPartialUpdateQuery.md +18 -0
- data/docs/ListPartialUpdateQueryResourceObject.md +22 -0
- data/docs/ListsApi.md +850 -0
- data/docs/MetricAggregateEnum.md +15 -0
- data/docs/MetricAggregateQuery.md +18 -0
- data/docs/MetricAggregateQueryResourceObject.md +20 -0
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +36 -0
- data/docs/MetricCreateQueryResourceObject.md +20 -0
- data/docs/MetricCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/MetricEnum.md +15 -0
- data/docs/MetricsApi.md +233 -0
- data/docs/OnsiteProfileCreateQueryResourceObject.md +24 -0
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +40 -0
- data/docs/OnsiteProfileMeta.md +18 -0
- data/docs/ProfileCreateQuery.md +18 -0
- data/docs/ProfileCreateQueryResourceObject.md +20 -0
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +36 -0
- data/docs/ProfileEnum.md +15 -0
- data/docs/ProfileIdentifierDTOResourceObject.md +22 -0
- data/docs/ProfileIdentifierDTOResourceObjectAttributes.md +24 -0
- data/docs/ProfileLocation.md +34 -0
- data/docs/ProfileLocationLatitude.md +49 -0
- data/docs/ProfileLocationLongitude.md +49 -0
- data/docs/ProfileMergeEnum.md +15 -0
- data/docs/ProfileMergeQuery.md +18 -0
- data/docs/ProfileMergeQueryResourceObject.md +22 -0
- data/docs/ProfileMergeQueryResourceObjectRelationships.md +18 -0
- data/docs/ProfileMergeQueryResourceObjectRelationshipsProfiles.md +18 -0
- data/docs/ProfileMergeQueryResourceObjectRelationshipsProfilesDataInner.md +20 -0
- data/docs/ProfileMeta.md +18 -0
- data/docs/ProfileMetaPatchProperties.md +22 -0
- data/docs/ProfileMetaPatchPropertiesUnset.md +49 -0
- data/docs/ProfilePartialUpdateQuery.md +18 -0
- data/docs/ProfilePartialUpdateQueryResourceObject.md +24 -0
- data/docs/ProfilePartialUpdateQueryResourceObjectAttributes.md +38 -0
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileSubscriptionBulkDeleteJobEnum.md +15 -0
- data/docs/ProfileSubscriptionCreateQueryResourceObject.md +22 -0
- data/docs/ProfileSubscriptionCreateQueryResourceObjectAttributes.md +22 -0
- data/docs/ProfileSubscriptionDeleteQueryResourceObject.md +20 -0
- data/docs/ProfileSubscriptionDeleteQueryResourceObjectAttributes.md +20 -0
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileSuppressionBulkDeleteJobEnum.md +15 -0
- data/docs/ProfileSuppressionCreateQueryResourceObject.md +20 -0
- data/docs/ProfileSuppressionCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/ProfileSuppressionDeleteQueryResourceObject.md +20 -0
- data/docs/ProfileSuppressionDeleteQueryResourceObjectAttributes.md +18 -0
- data/docs/ProfileUpsertQueryResourceObject.md +22 -0
- data/docs/ProfileUpsertQueryResourceObjectAttributes.md +40 -0
- data/docs/ProfilesApi.md +1044 -0
- data/docs/PushTokenCreateQuery.md +18 -0
- data/docs/PushTokenCreateQueryResourceObject.md +20 -0
- data/docs/PushTokenCreateQueryResourceObjectAttributes.md +30 -0
- data/docs/PushTokenCreateQueryResourceObjectAttributesProfile.md +18 -0
- data/docs/PushTokenEnum.md +15 -0
- data/docs/RenderOptionsSubObject.md +24 -0
- data/docs/SMSContentSubObjectCreate.md +18 -0
- data/docs/SMSSendOptionsSubObject.md +18 -0
- data/docs/SMSTrackingOptionsSubObject.md +20 -0
- data/docs/STOScheduleOptions.md +18 -0
- data/docs/SegmentEnum.md +15 -0
- data/docs/SegmentPartialUpdateQuery.md +18 -0
- data/docs/SegmentPartialUpdateQueryResourceObject.md +22 -0
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/SegmentsApi.md +561 -0
- data/docs/SendStrategySubObject.md +24 -0
- data/docs/ServerBISSubscriptionCreateQuery.md +18 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObject.md +22 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributesProfile.md +18 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant.md +18 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariantData.md +20 -0
- data/docs/StaticScheduleOptions.md +22 -0
- data/docs/SubscriptionChannels.md +20 -0
- data/docs/SubscriptionCreateJobCreateQuery.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +22 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
- data/docs/SubscriptionDeleteJobCreateQuery.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObject.md +22 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsList.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
- data/docs/SuppressionCreateJobCreateQuery.md +18 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/SuppressionDeleteJobCreateQuery.md +18 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/TagCampaignOp.md +18 -0
- data/docs/TagCampaignOpDataInner.md +20 -0
- data/docs/TagCreateQuery.md +18 -0
- data/docs/TagCreateQueryResourceObject.md +22 -0
- data/docs/TagCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/TagCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/TagCreateQueryResourceObjectRelationshipsTagGroup.md +18 -0
- data/docs/TagCreateQueryResourceObjectRelationshipsTagGroupData.md +20 -0
- data/docs/TagEnum.md +15 -0
- data/docs/TagFlowOp.md +18 -0
- data/docs/TagFlowOpDataInner.md +20 -0
- data/docs/TagGroupCreateQuery.md +18 -0
- data/docs/TagGroupCreateQueryResourceObject.md +20 -0
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagGroupEnum.md +15 -0
- data/docs/TagGroupUpdateQuery.md +18 -0
- data/docs/TagGroupUpdateQueryResourceObject.md +22 -0
- data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagListOp.md +18 -0
- data/docs/TagListOpDataInner.md +20 -0
- data/docs/TagSegmentOp.md +18 -0
- data/docs/TagSegmentOpDataInner.md +20 -0
- data/docs/TagUpdateQuery.md +18 -0
- data/docs/TagUpdateQueryResourceObject.md +22 -0
- data/docs/TagsApi.md +1929 -0
- data/docs/TemplateCloneQuery.md +18 -0
- data/docs/TemplateCloneQueryResourceObject.md +22 -0
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +18 -0
- data/docs/TemplateCreateQuery.md +18 -0
- data/docs/TemplateCreateQueryResourceObject.md +20 -0
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +30 -0
- data/docs/TemplateEnum.md +15 -0
- data/docs/TemplateRenderQuery.md +18 -0
- data/docs/TemplateRenderQueryResourceObject.md +22 -0
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +18 -0
- data/docs/TemplateUpdateQuery.md +18 -0
- data/docs/TemplateUpdateQueryResourceObject.md +22 -0
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +28 -0
- data/docs/TemplatesApi.md +524 -0
- data/docs/ThrottledScheduleOptions.md +20 -0
- data/docs/UTMParamsSubObject.md +20 -0
- data/git_push.sh +57 -0
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +9 -9
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +85 -85
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +309 -309
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +1226 -0
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +40 -40
- data/lib/klaviyo-api-sdk/api/flows_api.rb +235 -91
- data/lib/klaviyo-api-sdk/api/images_api.rb +407 -0
- data/lib/klaviyo-api-sdk/api/lists_api.rb +77 -49
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +189 -49
- data/lib/klaviyo-api-sdk/api/segments_api.rb +69 -41
- data/lib/klaviyo-api-sdk/api/tags_api.rb +89 -89
- data/lib/klaviyo-api-sdk/api/templates_api.rb +24 -24
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +34 -19
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +5 -20
- 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 +28 -28
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +26 -25
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +3 -36
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +23 -23
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +15 -15
- 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 +20 -19
- 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 +20 -19
- 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_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +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_update_query_resource_object_relationships.rb → catalog_category_create_query_resource_object_relationships.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships_items.rb → catalog_category_create_query_resource_object_relationships_items.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships_items_data_inner.rb → catalog_category_create_query_resource_object_relationships_items_data_inner.rb} +6 -39
- 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_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +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_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +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_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_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_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +72 -72
- 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_create_query_resource_object_relationships_categories_data_inner.rb +239 -0
- 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_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +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_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +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_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +118 -116
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +239 -0
- 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_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +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_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +58 -58
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/{campaign_send_job_create_query_resource_object_attributes.rb → coupon_code_create_job_create_query.rb} +14 -15
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +224 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_assign_template_query_resource_object_attributes.rb → coupon_code_create_query_resource_object_relationships_coupon_data.rb} +19 -6
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/{catalog_item_category_op_data_inner.rb → coupon_code_update_query_resource_object.rb} +23 -42
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +264 -0
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +220 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +388 -0
- data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +39 -9
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +22 -22
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +41 -41
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response.rb → get_accounts4_xx_response.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response_errors_inner.rb → get_accounts4_xx_response_errors_inner.rb} +40 -40
- data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response_errors_inner_source.rb → get_accounts4_xx_response_errors_inner_source.rb} +17 -17
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +247 -0
- data/lib/klaviyo-api-sdk/models/image_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +230 -0
- 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 +2 -36
- 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 +63 -63
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +55 -55
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.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_identifier_dto_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +12 -12
- 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_merge_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +226 -0
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +239 -0
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +15 -15
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +45 -45
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +12 -12
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +328 -0
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +372 -0
- data/lib/klaviyo-api-sdk/models/{campaign_recipient_estimation_job_create_query_resource_object_attributes.rb → push_token_create_query_resource_object_attributes_profile.rb} +15 -15
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +17 -24
- 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_strategy_sub_object.rb +17 -17
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +3 -36
- data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +15 -15
- 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_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 +14 -14
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +3 -36
- 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/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +3 -36
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +20 -20
- data/lib/klaviyo-api-sdk/models/{tag_update_query_resource_object_attributes.rb → tag_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +3 -36
- 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 +3 -36
- 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 +16 -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 +3 -36
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +3 -36
- 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/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +34 -19
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +2 -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 +25 -25
- 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 +34 -19
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +3 -18
- 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/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +58 -12
- data/spec/api/accounts_api_spec.rb +60 -0
- data/spec/api/campaigns_api_spec.rb +338 -0
- data/spec/api/catalogs_api_spec.rb +763 -0
- data/spec/api/coupons_api_spec.rb +254 -0
- data/spec/api/data_privacy_api_spec.rb +47 -0
- data/spec/api/events_api_spec.rb +132 -0
- data/spec/api/flows_api_spec.rb +279 -0
- data/spec/api/images_api_spec.rb +103 -0
- data/spec/api/lists_api_spec.rb +189 -0
- data/spec/api/metrics_api_spec.rb +74 -0
- data/spec/api/profiles_api_spec.rb +216 -0
- data/spec/api/segments_api_spec.rb +139 -0
- data/spec/api/tags_api_spec.rb +371 -0
- data/spec/api/templates_api_spec.rb +124 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/audiences_sub_object_spec.rb +40 -0
- data/spec/models/back_in_stock_subscription_enum_spec.rb +28 -0
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_clone_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_clone_query_spec.rb +34 -0
- data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +34 -0
- data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +31 -0
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +64 -0
- data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +31 -0
- data/spec/models/campaign_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_create_query_spec.rb +34 -0
- data/spec/models/campaign_enum_spec.rb +28 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +34 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_message_assign_template_query_spec.rb +34 -0
- data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +31 -0
- data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +52 -0
- data/spec/models/campaign_message_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_message_enum_spec.rb +28 -0
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_message_partial_update_query_spec.rb +34 -0
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +58 -0
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_partial_update_query_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +28 -0
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_send_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_send_job_enum_spec.rb +28 -0
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +34 -0
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +56 -0
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_data_inner_spec.rb +40 -0
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +34 -0
- data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_category_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_enum_spec.rb +28 -0
- data/spec/models/catalog_category_item_op_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +52 -0
- data/spec/models/catalog_category_update_query_spec.rb +34 -0
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_category_op_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +40 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_item_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_enum_spec.rb +28 -0
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +34 -0
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +82 -0
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +52 -0
- data/spec/models/catalog_item_update_query_spec.rb +34 -0
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +34 -0
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +126 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +40 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_variant_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +34 -0
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_variant_update_query_spec.rb +34 -0
- data/spec/models/coupon_code_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes_spec.rb +34 -0
- data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/coupon_code_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/coupon_code_create_job_create_query_spec.rb +34 -0
- data/spec/models/coupon_code_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_data_spec.rb +40 -0
- data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_spec.rb +34 -0
- data/spec/models/coupon_code_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/coupon_code_create_query_resource_object_spec.rb +46 -0
- data/spec/models/coupon_code_create_query_spec.rb +34 -0
- data/spec/models/coupon_code_enum_spec.rb +28 -0
- data/spec/models/coupon_code_update_query_resource_object_attributes_spec.rb +44 -0
- data/spec/models/coupon_code_update_query_resource_object_spec.rb +46 -0
- data/spec/models/coupon_code_update_query_spec.rb +34 -0
- data/spec/models/coupon_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/coupon_create_query_resource_object_spec.rb +40 -0
- data/spec/models/coupon_create_query_spec.rb +34 -0
- data/spec/models/coupon_enum_spec.rb +28 -0
- data/spec/models/coupon_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/coupon_update_query_resource_object_spec.rb +46 -0
- data/spec/models/coupon_update_query_spec.rb +34 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +40 -0
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +34 -0
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +28 -0
- data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/data_privacy_profile_query_resource_object_spec.rb +46 -0
- data/spec/models/device_metadata_spec.rb +112 -0
- data/spec/models/email_content_sub_object_spec.rb +70 -0
- data/spec/models/email_send_options_sub_object_spec.rb +34 -0
- data/spec/models/email_tracking_options_sub_object_spec.rb +52 -0
- data/spec/models/event_create_query_v2_resource_object_attributes_metric_spec.rb +34 -0
- data/spec/models/event_create_query_v2_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/event_create_query_v2_resource_object_attributes_spec.rb +64 -0
- data/spec/models/event_create_query_v2_resource_object_spec.rb +40 -0
- data/spec/models/event_create_query_v2_spec.rb +34 -0
- data/spec/models/event_enum_spec.rb +28 -0
- data/spec/models/flow_enum_spec.rb +28 -0
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/flow_update_query_resource_object_spec.rb +46 -0
- data/spec/models/flow_update_query_spec.rb +34 -0
- data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +40 -0
- data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +58 -0
- data/spec/models/get_accounts4_xx_response_spec.rb +34 -0
- data/spec/models/image_create_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/image_create_query_resource_object_spec.rb +40 -0
- data/spec/models/image_create_query_spec.rb +34 -0
- data/spec/models/image_enum_spec.rb +28 -0
- data/spec/models/image_partial_update_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/image_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/image_partial_update_query_spec.rb +34 -0
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/list_create_query_resource_object_spec.rb +40 -0
- data/spec/models/list_create_query_spec.rb +34 -0
- data/spec/models/list_enum_spec.rb +28 -0
- data/spec/models/list_members_add_query_data_inner_spec.rb +40 -0
- data/spec/models/list_members_add_query_spec.rb +34 -0
- data/spec/models/list_members_delete_query_spec.rb +34 -0
- data/spec/models/list_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/list_partial_update_query_spec.rb +34 -0
- data/spec/models/metric_aggregate_enum_spec.rb +28 -0
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +40 -0
- data/spec/models/metric_aggregate_query_spec.rb +34 -0
- data/spec/models/metric_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/metric_create_query_resource_object_spec.rb +40 -0
- data/spec/models/metric_enum_spec.rb +28 -0
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +100 -0
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +52 -0
- data/spec/models/onsite_profile_meta_spec.rb +34 -0
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +88 -0
- data/spec/models/profile_create_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_create_query_spec.rb +34 -0
- data/spec/models/profile_enum_spec.rb +28 -0
- data/spec/models/profile_identifier_dto_resource_object_attributes_spec.rb +52 -0
- data/spec/models/profile_identifier_dto_resource_object_spec.rb +46 -0
- data/spec/models/profile_location_latitude_spec.rb +31 -0
- data/spec/models/profile_location_longitude_spec.rb +31 -0
- data/spec/models/profile_location_spec.rb +82 -0
- data/spec/models/profile_merge_enum_spec.rb +28 -0
- data/spec/models/profile_merge_query_resource_object_relationships_profiles_data_inner_spec.rb +40 -0
- data/spec/models/profile_merge_query_resource_object_relationships_profiles_spec.rb +34 -0
- data/spec/models/profile_merge_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/profile_merge_query_resource_object_spec.rb +46 -0
- data/spec/models/profile_merge_query_spec.rb +34 -0
- data/spec/models/profile_meta_patch_properties_spec.rb +46 -0
- data/spec/models/profile_meta_patch_properties_unset_spec.rb +31 -0
- data/spec/models/profile_meta_spec.rb +34 -0
- data/spec/models/profile_partial_update_query_resource_object_attributes_spec.rb +94 -0
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +52 -0
- data/spec/models/profile_partial_update_query_spec.rb +34 -0
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/profile_subscription_create_query_resource_object_spec.rb +46 -0
- data/spec/models/profile_subscription_delete_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/profile_subscription_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_suppression_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/profile_suppression_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/profile_suppression_create_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_suppression_delete_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/profile_suppression_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_upsert_query_resource_object_attributes_spec.rb +100 -0
- data/spec/models/profile_upsert_query_resource_object_spec.rb +46 -0
- data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +86 -0
- data/spec/models/push_token_create_query_resource_object_spec.rb +40 -0
- data/spec/models/push_token_create_query_spec.rb +34 -0
- data/spec/models/push_token_enum_spec.rb +28 -0
- data/spec/models/render_options_sub_object_spec.rb +52 -0
- data/spec/models/segment_enum_spec.rb +28 -0
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/segment_partial_update_query_spec.rb +34 -0
- data/spec/models/send_strategy_sub_object_spec.rb +52 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +44 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +40 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +34 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +46 -0
- data/spec/models/server_bis_subscription_create_query_spec.rb +34 -0
- data/spec/models/sms_content_sub_object_create_spec.rb +34 -0
- data/spec/models/sms_send_options_sub_object_spec.rb +34 -0
- data/spec/models/sms_tracking_options_sub_object_spec.rb +40 -0
- data/spec/models/static_schedule_options_spec.rb +46 -0
- data/spec/models/sto_schedule_options_spec.rb +34 -0
- data/spec/models/subscription_channels_spec.rb +48 -0
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +34 -0
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_data_spec.rb +40 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_spec.rb +46 -0
- data/spec/models/subscription_delete_job_create_query_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_spec.rb +34 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/suppression_delete_job_create_query_spec.rb +34 -0
- data/spec/models/tag_campaign_op_data_inner_spec.rb +40 -0
- data/spec/models/tag_campaign_op_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_relationships_tag_group_data_spec.rb +40 -0
- data/spec/models/tag_create_query_resource_object_relationships_tag_group_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_create_query_spec.rb +34 -0
- data/spec/models/tag_enum_spec.rb +28 -0
- data/spec/models/tag_flow_op_data_inner_spec.rb +40 -0
- data/spec/models/tag_flow_op_spec.rb +34 -0
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_group_create_query_resource_object_spec.rb +40 -0
- data/spec/models/tag_group_create_query_spec.rb +34 -0
- data/spec/models/tag_group_enum_spec.rb +28 -0
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_group_update_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_group_update_query_spec.rb +34 -0
- data/spec/models/tag_list_op_data_inner_spec.rb +40 -0
- data/spec/models/tag_list_op_spec.rb +34 -0
- data/spec/models/tag_segment_op_data_inner_spec.rb +40 -0
- data/spec/models/tag_segment_op_spec.rb +34 -0
- data/spec/models/tag_update_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_update_query_spec.rb +34 -0
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/template_clone_query_resource_object_spec.rb +46 -0
- data/spec/models/template_clone_query_spec.rb +34 -0
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +52 -0
- data/spec/models/template_create_query_resource_object_spec.rb +40 -0
- data/spec/models/template_create_query_spec.rb +34 -0
- data/spec/models/template_enum_spec.rb +28 -0
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/template_render_query_resource_object_spec.rb +46 -0
- data/spec/models/template_render_query_spec.rb +34 -0
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/template_update_query_resource_object_spec.rb +46 -0
- data/spec/models/template_update_query_spec.rb +34 -0
- data/spec/models/throttled_schedule_options_spec.rb +40 -0
- data/spec/models/utm_params_sub_object_spec.rb +40 -0
- data/spec/spec_helper.rb +111 -0
- metadata +714 -18
- data/CHANGELOG.md +0 -91
data/docs/FlowsApi.md
ADDED
|
@@ -0,0 +1,1335 @@
|
|
|
1
|
+
# KlaviyoAPI::FlowsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://a.klaviyo.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**get_flow**](FlowsApi.md#get_flow) | **GET** /api/flows/{id}/ | Get Flow |
|
|
8
|
+
| [**get_flow_action**](FlowsApi.md#get_flow_action) | **GET** /api/flow-actions/{id}/ | Get Flow Action |
|
|
9
|
+
| [**get_flow_action_flow**](FlowsApi.md#get_flow_action_flow) | **GET** /api/flow-actions/{id}/flow/ | Get Flow For Flow Action |
|
|
10
|
+
| [**get_flow_action_messages**](FlowsApi.md#get_flow_action_messages) | **GET** /api/flow-actions/{id}/flow-messages/ | Get Flow Action Messages |
|
|
11
|
+
| [**get_flow_action_relationships_flow**](FlowsApi.md#get_flow_action_relationships_flow) | **GET** /api/flow-actions/{id}/relationships/flow/ | Get Flow Action Relationships Flow |
|
|
12
|
+
| [**get_flow_action_relationships_messages**](FlowsApi.md#get_flow_action_relationships_messages) | **GET** /api/flow-actions/{id}/relationships/flow-messages/ | Get Flow Action Relationships Messages |
|
|
13
|
+
| [**get_flow_flow_actions**](FlowsApi.md#get_flow_flow_actions) | **GET** /api/flows/{id}/flow-actions/ | Get Flow Flow Actions |
|
|
14
|
+
| [**get_flow_message**](FlowsApi.md#get_flow_message) | **GET** /api/flow-messages/{id}/ | Get Flow Message |
|
|
15
|
+
| [**get_flow_message_action**](FlowsApi.md#get_flow_message_action) | **GET** /api/flow-messages/{id}/flow-action/ | Get Flow Action For Message |
|
|
16
|
+
| [**get_flow_message_relationships_action**](FlowsApi.md#get_flow_message_relationships_action) | **GET** /api/flow-messages/{id}/relationships/flow-action/ | Get Flow Message Relationships Action |
|
|
17
|
+
| [**get_flow_message_relationships_template**](FlowsApi.md#get_flow_message_relationships_template) | **GET** /api/flow-messages/{id}/relationships/template/ | Get Flow Message Relationships Template |
|
|
18
|
+
| [**get_flow_message_template**](FlowsApi.md#get_flow_message_template) | **GET** /api/flow-messages/{id}/template/ | Get Flow Message Template |
|
|
19
|
+
| [**get_flow_relationships_flow_actions**](FlowsApi.md#get_flow_relationships_flow_actions) | **GET** /api/flows/{id}/relationships/flow-actions/ | Get Flow Relationships Flow Actions |
|
|
20
|
+
| [**get_flow_relationships_tags**](FlowsApi.md#get_flow_relationships_tags) | **GET** /api/flows/{id}/relationships/tags/ | Get Flow Relationships Tags |
|
|
21
|
+
| [**get_flow_tags**](FlowsApi.md#get_flow_tags) | **GET** /api/flows/{id}/tags/ | Get Flow Tags |
|
|
22
|
+
| [**get_flows**](FlowsApi.md#get_flows) | **GET** /api/flows/ | Get Flows |
|
|
23
|
+
| [**update_flow**](FlowsApi.md#update_flow) | **PATCH** /api/flows/{id}/ | Update Flow Status |
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
## get_flow
|
|
27
|
+
|
|
28
|
+
> Hash<String, Object> get_flow(id, opts)
|
|
29
|
+
|
|
30
|
+
Get Flow
|
|
31
|
+
|
|
32
|
+
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`
|
|
33
|
+
|
|
34
|
+
### Examples
|
|
35
|
+
|
|
36
|
+
```ruby
|
|
37
|
+
require 'time'
|
|
38
|
+
require 'klaviyo-api-sdk'
|
|
39
|
+
# setup authorization
|
|
40
|
+
KlaviyoAPI.configure do |config|
|
|
41
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
42
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
43
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
44
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
48
|
+
id = 'id_example' # String |
|
|
49
|
+
opts = {
|
|
50
|
+
fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
51
|
+
fields_flow: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
52
|
+
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
53
|
+
include: ['flow-actions'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
begin
|
|
57
|
+
# Get Flow
|
|
58
|
+
result = api_instance.get_flow(id, opts)
|
|
59
|
+
p result
|
|
60
|
+
rescue KlaviyoAPI::ApiError => e
|
|
61
|
+
puts "Error when calling FlowsApi->get_flow: #{e}"
|
|
62
|
+
end
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
#### Using the get_flow_with_http_info variant
|
|
66
|
+
|
|
67
|
+
This returns an Array which contains the response data, status code and headers.
|
|
68
|
+
|
|
69
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_with_http_info(id, opts)
|
|
70
|
+
|
|
71
|
+
```ruby
|
|
72
|
+
begin
|
|
73
|
+
# Get Flow
|
|
74
|
+
data, status_code, headers = api_instance.get_flow_with_http_info(id, opts)
|
|
75
|
+
p status_code # => 2xx
|
|
76
|
+
p headers # => { ... }
|
|
77
|
+
p data # => Hash<String, Object>
|
|
78
|
+
rescue KlaviyoAPI::ApiError => e
|
|
79
|
+
puts "Error when calling FlowsApi->get_flow_with_http_info: #{e}"
|
|
80
|
+
end
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Parameters
|
|
84
|
+
|
|
85
|
+
| Name | Type | Description | Notes |
|
|
86
|
+
| ---- | ---- | ----------- | ----- |
|
|
87
|
+
| **id** | **String** | | |
|
|
88
|
+
| **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
89
|
+
| **fields_flow** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
90
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
91
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships | [optional] |
|
|
92
|
+
|
|
93
|
+
### Return type
|
|
94
|
+
|
|
95
|
+
**Hash<String, Object>**
|
|
96
|
+
|
|
97
|
+
### Authorization
|
|
98
|
+
|
|
99
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
100
|
+
|
|
101
|
+
### HTTP request headers
|
|
102
|
+
|
|
103
|
+
- **Content-Type**: Not defined
|
|
104
|
+
- **Accept**: application/json
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
## get_flow_action
|
|
108
|
+
|
|
109
|
+
> Hash<String, Object> get_flow_action(id, opts)
|
|
110
|
+
|
|
111
|
+
Get Flow Action
|
|
112
|
+
|
|
113
|
+
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: `flow`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
114
|
+
|
|
115
|
+
### Examples
|
|
116
|
+
|
|
117
|
+
```ruby
|
|
118
|
+
require 'time'
|
|
119
|
+
require 'klaviyo-api-sdk'
|
|
120
|
+
# setup authorization
|
|
121
|
+
KlaviyoAPI.configure do |config|
|
|
122
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
123
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
124
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
125
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
129
|
+
id = 'id_example' # String |
|
|
130
|
+
opts = {
|
|
131
|
+
fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
132
|
+
fields_flow_message: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
133
|
+
fields_flow: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
134
|
+
include: ['flow'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
begin
|
|
138
|
+
# Get Flow Action
|
|
139
|
+
result = api_instance.get_flow_action(id, opts)
|
|
140
|
+
p result
|
|
141
|
+
rescue KlaviyoAPI::ApiError => e
|
|
142
|
+
puts "Error when calling FlowsApi->get_flow_action: #{e}"
|
|
143
|
+
end
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
#### Using the get_flow_action_with_http_info variant
|
|
147
|
+
|
|
148
|
+
This returns an Array which contains the response data, status code and headers.
|
|
149
|
+
|
|
150
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_action_with_http_info(id, opts)
|
|
151
|
+
|
|
152
|
+
```ruby
|
|
153
|
+
begin
|
|
154
|
+
# Get Flow Action
|
|
155
|
+
data, status_code, headers = api_instance.get_flow_action_with_http_info(id, opts)
|
|
156
|
+
p status_code # => 2xx
|
|
157
|
+
p headers # => { ... }
|
|
158
|
+
p data # => Hash<String, Object>
|
|
159
|
+
rescue KlaviyoAPI::ApiError => e
|
|
160
|
+
puts "Error when calling FlowsApi->get_flow_action_with_http_info: #{e}"
|
|
161
|
+
end
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Parameters
|
|
165
|
+
|
|
166
|
+
| Name | Type | Description | Notes |
|
|
167
|
+
| ---- | ---- | ----------- | ----- |
|
|
168
|
+
| **id** | **String** | | |
|
|
169
|
+
| **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
170
|
+
| **fields_flow_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
171
|
+
| **fields_flow** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
172
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships | [optional] |
|
|
173
|
+
|
|
174
|
+
### Return type
|
|
175
|
+
|
|
176
|
+
**Hash<String, Object>**
|
|
177
|
+
|
|
178
|
+
### Authorization
|
|
179
|
+
|
|
180
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
181
|
+
|
|
182
|
+
### HTTP request headers
|
|
183
|
+
|
|
184
|
+
- **Content-Type**: Not defined
|
|
185
|
+
- **Accept**: application/json
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
## get_flow_action_flow
|
|
189
|
+
|
|
190
|
+
> Hash<String, Object> get_flow_action_flow(id, opts)
|
|
191
|
+
|
|
192
|
+
Get Flow For Flow Action
|
|
193
|
+
|
|
194
|
+
Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
195
|
+
|
|
196
|
+
### Examples
|
|
197
|
+
|
|
198
|
+
```ruby
|
|
199
|
+
require 'time'
|
|
200
|
+
require 'klaviyo-api-sdk'
|
|
201
|
+
# setup authorization
|
|
202
|
+
KlaviyoAPI.configure do |config|
|
|
203
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
204
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
205
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
206
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
210
|
+
id = 'id_example' # String |
|
|
211
|
+
opts = {
|
|
212
|
+
fields_flow: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
begin
|
|
216
|
+
# Get Flow For Flow Action
|
|
217
|
+
result = api_instance.get_flow_action_flow(id, opts)
|
|
218
|
+
p result
|
|
219
|
+
rescue KlaviyoAPI::ApiError => e
|
|
220
|
+
puts "Error when calling FlowsApi->get_flow_action_flow: #{e}"
|
|
221
|
+
end
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
#### Using the get_flow_action_flow_with_http_info variant
|
|
225
|
+
|
|
226
|
+
This returns an Array which contains the response data, status code and headers.
|
|
227
|
+
|
|
228
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_action_flow_with_http_info(id, opts)
|
|
229
|
+
|
|
230
|
+
```ruby
|
|
231
|
+
begin
|
|
232
|
+
# Get Flow For Flow Action
|
|
233
|
+
data, status_code, headers = api_instance.get_flow_action_flow_with_http_info(id, opts)
|
|
234
|
+
p status_code # => 2xx
|
|
235
|
+
p headers # => { ... }
|
|
236
|
+
p data # => Hash<String, Object>
|
|
237
|
+
rescue KlaviyoAPI::ApiError => e
|
|
238
|
+
puts "Error when calling FlowsApi->get_flow_action_flow_with_http_info: #{e}"
|
|
239
|
+
end
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
### Parameters
|
|
243
|
+
|
|
244
|
+
| Name | Type | Description | Notes |
|
|
245
|
+
| ---- | ---- | ----------- | ----- |
|
|
246
|
+
| **id** | **String** | | |
|
|
247
|
+
| **fields_flow** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
248
|
+
|
|
249
|
+
### Return type
|
|
250
|
+
|
|
251
|
+
**Hash<String, Object>**
|
|
252
|
+
|
|
253
|
+
### Authorization
|
|
254
|
+
|
|
255
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
256
|
+
|
|
257
|
+
### HTTP request headers
|
|
258
|
+
|
|
259
|
+
- **Content-Type**: Not defined
|
|
260
|
+
- **Accept**: application/json
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
## get_flow_action_messages
|
|
264
|
+
|
|
265
|
+
> Hash<String, Object> get_flow_action_messages(id, opts)
|
|
266
|
+
|
|
267
|
+
Get Flow Action Messages
|
|
268
|
+
|
|
269
|
+
Get all flow messages associated with the given action ID. Flow messages can be sorted by the following fields, in ascending and descending order: ascending: `id`, `name`, `created`, `updated` descending: `-id`, `-name`, `-created`, `-updated` Returns a maximum of 50 flows 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`
|
|
270
|
+
|
|
271
|
+
### Examples
|
|
272
|
+
|
|
273
|
+
```ruby
|
|
274
|
+
require 'time'
|
|
275
|
+
require 'klaviyo-api-sdk'
|
|
276
|
+
# setup authorization
|
|
277
|
+
KlaviyoAPI.configure do |config|
|
|
278
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
279
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
280
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
281
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
285
|
+
id = 'id_example' # String |
|
|
286
|
+
opts = {
|
|
287
|
+
fields_flow_message: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
288
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-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`
|
|
289
|
+
page_size: 56, # Integer | Default: 50. Min: 1. Max: 100.
|
|
290
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
|
|
291
|
+
}
|
|
292
|
+
|
|
293
|
+
begin
|
|
294
|
+
# Get Flow Action Messages
|
|
295
|
+
result = api_instance.get_flow_action_messages(id, opts)
|
|
296
|
+
p result
|
|
297
|
+
rescue KlaviyoAPI::ApiError => e
|
|
298
|
+
puts "Error when calling FlowsApi->get_flow_action_messages: #{e}"
|
|
299
|
+
end
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
#### Using the get_flow_action_messages_with_http_info variant
|
|
303
|
+
|
|
304
|
+
This returns an Array which contains the response data, status code and headers.
|
|
305
|
+
|
|
306
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_action_messages_with_http_info(id, opts)
|
|
307
|
+
|
|
308
|
+
```ruby
|
|
309
|
+
begin
|
|
310
|
+
# Get Flow Action Messages
|
|
311
|
+
data, status_code, headers = api_instance.get_flow_action_messages_with_http_info(id, opts)
|
|
312
|
+
p status_code # => 2xx
|
|
313
|
+
p headers # => { ... }
|
|
314
|
+
p data # => Hash<String, Object>
|
|
315
|
+
rescue KlaviyoAPI::ApiError => e
|
|
316
|
+
puts "Error when calling FlowsApi->get_flow_action_messages_with_http_info: #{e}"
|
|
317
|
+
end
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### Parameters
|
|
321
|
+
|
|
322
|
+
| Name | Type | Description | Notes |
|
|
323
|
+
| ---- | ---- | ----------- | ----- |
|
|
324
|
+
| **id** | **String** | | |
|
|
325
|
+
| **fields_flow_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
326
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-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` | [optional] |
|
|
327
|
+
| **page_size** | **Integer** | Default: 50. Min: 1. Max: 100. | [optional][default to 50] |
|
|
328
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
|
|
329
|
+
|
|
330
|
+
### Return type
|
|
331
|
+
|
|
332
|
+
**Hash<String, Object>**
|
|
333
|
+
|
|
334
|
+
### Authorization
|
|
335
|
+
|
|
336
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
337
|
+
|
|
338
|
+
### HTTP request headers
|
|
339
|
+
|
|
340
|
+
- **Content-Type**: Not defined
|
|
341
|
+
- **Accept**: application/json
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
## get_flow_action_relationships_flow
|
|
345
|
+
|
|
346
|
+
> Hash<String, Object> get_flow_action_relationships_flow(id)
|
|
347
|
+
|
|
348
|
+
Get Flow Action Relationships Flow
|
|
349
|
+
|
|
350
|
+
Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
351
|
+
|
|
352
|
+
### Examples
|
|
353
|
+
|
|
354
|
+
```ruby
|
|
355
|
+
require 'time'
|
|
356
|
+
require 'klaviyo-api-sdk'
|
|
357
|
+
# setup authorization
|
|
358
|
+
KlaviyoAPI.configure do |config|
|
|
359
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
360
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
361
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
362
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
363
|
+
end
|
|
364
|
+
|
|
365
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
366
|
+
id = 'id_example' # String |
|
|
367
|
+
|
|
368
|
+
begin
|
|
369
|
+
# Get Flow Action Relationships Flow
|
|
370
|
+
result = api_instance.get_flow_action_relationships_flow(id)
|
|
371
|
+
p result
|
|
372
|
+
rescue KlaviyoAPI::ApiError => e
|
|
373
|
+
puts "Error when calling FlowsApi->get_flow_action_relationships_flow: #{e}"
|
|
374
|
+
end
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
#### Using the get_flow_action_relationships_flow_with_http_info variant
|
|
378
|
+
|
|
379
|
+
This returns an Array which contains the response data, status code and headers.
|
|
380
|
+
|
|
381
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_action_relationships_flow_with_http_info(id)
|
|
382
|
+
|
|
383
|
+
```ruby
|
|
384
|
+
begin
|
|
385
|
+
# Get Flow Action Relationships Flow
|
|
386
|
+
data, status_code, headers = api_instance.get_flow_action_relationships_flow_with_http_info(id)
|
|
387
|
+
p status_code # => 2xx
|
|
388
|
+
p headers # => { ... }
|
|
389
|
+
p data # => Hash<String, Object>
|
|
390
|
+
rescue KlaviyoAPI::ApiError => e
|
|
391
|
+
puts "Error when calling FlowsApi->get_flow_action_relationships_flow_with_http_info: #{e}"
|
|
392
|
+
end
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
### Parameters
|
|
396
|
+
|
|
397
|
+
| Name | Type | Description | Notes |
|
|
398
|
+
| ---- | ---- | ----------- | ----- |
|
|
399
|
+
| **id** | **String** | | |
|
|
400
|
+
|
|
401
|
+
### Return type
|
|
402
|
+
|
|
403
|
+
**Hash<String, Object>**
|
|
404
|
+
|
|
405
|
+
### Authorization
|
|
406
|
+
|
|
407
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
408
|
+
|
|
409
|
+
### HTTP request headers
|
|
410
|
+
|
|
411
|
+
- **Content-Type**: Not defined
|
|
412
|
+
- **Accept**: application/json
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
## get_flow_action_relationships_messages
|
|
416
|
+
|
|
417
|
+
> Hash<String, Object> get_flow_action_relationships_messages(id, opts)
|
|
418
|
+
|
|
419
|
+
Get Flow Action Relationships Messages
|
|
420
|
+
|
|
421
|
+
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`
|
|
422
|
+
|
|
423
|
+
### Examples
|
|
424
|
+
|
|
425
|
+
```ruby
|
|
426
|
+
require 'time'
|
|
427
|
+
require 'klaviyo-api-sdk'
|
|
428
|
+
# setup authorization
|
|
429
|
+
KlaviyoAPI.configure do |config|
|
|
430
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
431
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
432
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
433
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
434
|
+
end
|
|
435
|
+
|
|
436
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
437
|
+
id = 'id_example' # String |
|
|
438
|
+
opts = {
|
|
439
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-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`
|
|
440
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
|
|
441
|
+
page_size: 56, # Integer | Default: 50. Min: 1. Max: 50.
|
|
442
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
|
|
443
|
+
}
|
|
444
|
+
|
|
445
|
+
begin
|
|
446
|
+
# Get Flow Action Relationships Messages
|
|
447
|
+
result = api_instance.get_flow_action_relationships_messages(id, opts)
|
|
448
|
+
p result
|
|
449
|
+
rescue KlaviyoAPI::ApiError => e
|
|
450
|
+
puts "Error when calling FlowsApi->get_flow_action_relationships_messages: #{e}"
|
|
451
|
+
end
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
#### Using the get_flow_action_relationships_messages_with_http_info variant
|
|
455
|
+
|
|
456
|
+
This returns an Array which contains the response data, status code and headers.
|
|
457
|
+
|
|
458
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_action_relationships_messages_with_http_info(id, opts)
|
|
459
|
+
|
|
460
|
+
```ruby
|
|
461
|
+
begin
|
|
462
|
+
# Get Flow Action Relationships Messages
|
|
463
|
+
data, status_code, headers = api_instance.get_flow_action_relationships_messages_with_http_info(id, opts)
|
|
464
|
+
p status_code # => 2xx
|
|
465
|
+
p headers # => { ... }
|
|
466
|
+
p data # => Hash<String, Object>
|
|
467
|
+
rescue KlaviyoAPI::ApiError => e
|
|
468
|
+
puts "Error when calling FlowsApi->get_flow_action_relationships_messages_with_http_info: #{e}"
|
|
469
|
+
end
|
|
470
|
+
```
|
|
471
|
+
|
|
472
|
+
### Parameters
|
|
473
|
+
|
|
474
|
+
| Name | Type | Description | Notes |
|
|
475
|
+
| ---- | ---- | ----------- | ----- |
|
|
476
|
+
| **id** | **String** | | |
|
|
477
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-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` | [optional] |
|
|
478
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
|
|
479
|
+
| **page_size** | **Integer** | Default: 50. Min: 1. Max: 50. | [optional][default to 50] |
|
|
480
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
|
|
481
|
+
|
|
482
|
+
### Return type
|
|
483
|
+
|
|
484
|
+
**Hash<String, Object>**
|
|
485
|
+
|
|
486
|
+
### Authorization
|
|
487
|
+
|
|
488
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
489
|
+
|
|
490
|
+
### HTTP request headers
|
|
491
|
+
|
|
492
|
+
- **Content-Type**: Not defined
|
|
493
|
+
- **Accept**: application/json
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
## get_flow_flow_actions
|
|
497
|
+
|
|
498
|
+
> Hash<String, Object> get_flow_flow_actions(id, opts)
|
|
499
|
+
|
|
500
|
+
Get Flow Flow Actions
|
|
501
|
+
|
|
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:** `flows:read`
|
|
503
|
+
|
|
504
|
+
### Examples
|
|
505
|
+
|
|
506
|
+
```ruby
|
|
507
|
+
require 'time'
|
|
508
|
+
require 'klaviyo-api-sdk'
|
|
509
|
+
# setup authorization
|
|
510
|
+
KlaviyoAPI.configure do |config|
|
|
511
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
512
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
513
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
514
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
515
|
+
end
|
|
516
|
+
|
|
517
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
518
|
+
id = 'id_example' # String |
|
|
519
|
+
opts = {
|
|
520
|
+
fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
521
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-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`
|
|
522
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
|
|
523
|
+
page_size: 56, # Integer | Default: 50. Min: 1. Max: 50.
|
|
524
|
+
sort: 'action_type' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
|
|
525
|
+
}
|
|
526
|
+
|
|
527
|
+
begin
|
|
528
|
+
# Get Flow Flow Actions
|
|
529
|
+
result = api_instance.get_flow_flow_actions(id, opts)
|
|
530
|
+
p result
|
|
531
|
+
rescue KlaviyoAPI::ApiError => e
|
|
532
|
+
puts "Error when calling FlowsApi->get_flow_flow_actions: #{e}"
|
|
533
|
+
end
|
|
534
|
+
```
|
|
535
|
+
|
|
536
|
+
#### Using the get_flow_flow_actions_with_http_info variant
|
|
537
|
+
|
|
538
|
+
This returns an Array which contains the response data, status code and headers.
|
|
539
|
+
|
|
540
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_flow_actions_with_http_info(id, opts)
|
|
541
|
+
|
|
542
|
+
```ruby
|
|
543
|
+
begin
|
|
544
|
+
# Get Flow Flow Actions
|
|
545
|
+
data, status_code, headers = api_instance.get_flow_flow_actions_with_http_info(id, opts)
|
|
546
|
+
p status_code # => 2xx
|
|
547
|
+
p headers # => { ... }
|
|
548
|
+
p data # => Hash<String, Object>
|
|
549
|
+
rescue KlaviyoAPI::ApiError => e
|
|
550
|
+
puts "Error when calling FlowsApi->get_flow_flow_actions_with_http_info: #{e}"
|
|
551
|
+
end
|
|
552
|
+
```
|
|
553
|
+
|
|
554
|
+
### Parameters
|
|
555
|
+
|
|
556
|
+
| Name | Type | Description | Notes |
|
|
557
|
+
| ---- | ---- | ----------- | ----- |
|
|
558
|
+
| **id** | **String** | | |
|
|
559
|
+
| **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
560
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-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` | [optional] |
|
|
561
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
|
|
562
|
+
| **page_size** | **Integer** | Default: 50. Min: 1. Max: 50. | [optional][default to 50] |
|
|
563
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
|
|
564
|
+
|
|
565
|
+
### Return type
|
|
566
|
+
|
|
567
|
+
**Hash<String, Object>**
|
|
568
|
+
|
|
569
|
+
### Authorization
|
|
570
|
+
|
|
571
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
572
|
+
|
|
573
|
+
### HTTP request headers
|
|
574
|
+
|
|
575
|
+
- **Content-Type**: Not defined
|
|
576
|
+
- **Accept**: application/json
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
## get_flow_message
|
|
580
|
+
|
|
581
|
+
> Hash<String, Object> get_flow_message(id, opts)
|
|
582
|
+
|
|
583
|
+
Get Flow Message
|
|
584
|
+
|
|
585
|
+
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`
|
|
586
|
+
|
|
587
|
+
### Examples
|
|
588
|
+
|
|
589
|
+
```ruby
|
|
590
|
+
require 'time'
|
|
591
|
+
require 'klaviyo-api-sdk'
|
|
592
|
+
# setup authorization
|
|
593
|
+
KlaviyoAPI.configure do |config|
|
|
594
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
595
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
596
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
597
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
598
|
+
end
|
|
599
|
+
|
|
600
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
601
|
+
id = 'id_example' # String |
|
|
602
|
+
opts = {
|
|
603
|
+
fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
604
|
+
fields_flow_message: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
605
|
+
fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
606
|
+
include: ['flow-action'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
|
|
607
|
+
}
|
|
608
|
+
|
|
609
|
+
begin
|
|
610
|
+
# Get Flow Message
|
|
611
|
+
result = api_instance.get_flow_message(id, opts)
|
|
612
|
+
p result
|
|
613
|
+
rescue KlaviyoAPI::ApiError => e
|
|
614
|
+
puts "Error when calling FlowsApi->get_flow_message: #{e}"
|
|
615
|
+
end
|
|
616
|
+
```
|
|
617
|
+
|
|
618
|
+
#### Using the get_flow_message_with_http_info variant
|
|
619
|
+
|
|
620
|
+
This returns an Array which contains the response data, status code and headers.
|
|
621
|
+
|
|
622
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_message_with_http_info(id, opts)
|
|
623
|
+
|
|
624
|
+
```ruby
|
|
625
|
+
begin
|
|
626
|
+
# Get Flow Message
|
|
627
|
+
data, status_code, headers = api_instance.get_flow_message_with_http_info(id, opts)
|
|
628
|
+
p status_code # => 2xx
|
|
629
|
+
p headers # => { ... }
|
|
630
|
+
p data # => Hash<String, Object>
|
|
631
|
+
rescue KlaviyoAPI::ApiError => e
|
|
632
|
+
puts "Error when calling FlowsApi->get_flow_message_with_http_info: #{e}"
|
|
633
|
+
end
|
|
634
|
+
```
|
|
635
|
+
|
|
636
|
+
### Parameters
|
|
637
|
+
|
|
638
|
+
| Name | Type | Description | Notes |
|
|
639
|
+
| ---- | ---- | ----------- | ----- |
|
|
640
|
+
| **id** | **String** | | |
|
|
641
|
+
| **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
642
|
+
| **fields_flow_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
643
|
+
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
644
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships | [optional] |
|
|
645
|
+
|
|
646
|
+
### Return type
|
|
647
|
+
|
|
648
|
+
**Hash<String, Object>**
|
|
649
|
+
|
|
650
|
+
### Authorization
|
|
651
|
+
|
|
652
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
653
|
+
|
|
654
|
+
### HTTP request headers
|
|
655
|
+
|
|
656
|
+
- **Content-Type**: Not defined
|
|
657
|
+
- **Accept**: application/json
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
## get_flow_message_action
|
|
661
|
+
|
|
662
|
+
> Hash<String, Object> get_flow_message_action(id, opts)
|
|
663
|
+
|
|
664
|
+
Get Flow Action For Message
|
|
665
|
+
|
|
666
|
+
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`
|
|
667
|
+
|
|
668
|
+
### Examples
|
|
669
|
+
|
|
670
|
+
```ruby
|
|
671
|
+
require 'time'
|
|
672
|
+
require 'klaviyo-api-sdk'
|
|
673
|
+
# setup authorization
|
|
674
|
+
KlaviyoAPI.configure do |config|
|
|
675
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
676
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
677
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
678
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
679
|
+
end
|
|
680
|
+
|
|
681
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
682
|
+
id = 'id_example' # String |
|
|
683
|
+
opts = {
|
|
684
|
+
fields_flow_action: ['action_type'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
685
|
+
}
|
|
686
|
+
|
|
687
|
+
begin
|
|
688
|
+
# Get Flow Action For Message
|
|
689
|
+
result = api_instance.get_flow_message_action(id, opts)
|
|
690
|
+
p result
|
|
691
|
+
rescue KlaviyoAPI::ApiError => e
|
|
692
|
+
puts "Error when calling FlowsApi->get_flow_message_action: #{e}"
|
|
693
|
+
end
|
|
694
|
+
```
|
|
695
|
+
|
|
696
|
+
#### Using the get_flow_message_action_with_http_info variant
|
|
697
|
+
|
|
698
|
+
This returns an Array which contains the response data, status code and headers.
|
|
699
|
+
|
|
700
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_message_action_with_http_info(id, opts)
|
|
701
|
+
|
|
702
|
+
```ruby
|
|
703
|
+
begin
|
|
704
|
+
# Get Flow Action For Message
|
|
705
|
+
data, status_code, headers = api_instance.get_flow_message_action_with_http_info(id, opts)
|
|
706
|
+
p status_code # => 2xx
|
|
707
|
+
p headers # => { ... }
|
|
708
|
+
p data # => Hash<String, Object>
|
|
709
|
+
rescue KlaviyoAPI::ApiError => e
|
|
710
|
+
puts "Error when calling FlowsApi->get_flow_message_action_with_http_info: #{e}"
|
|
711
|
+
end
|
|
712
|
+
```
|
|
713
|
+
|
|
714
|
+
### Parameters
|
|
715
|
+
|
|
716
|
+
| Name | Type | Description | Notes |
|
|
717
|
+
| ---- | ---- | ----------- | ----- |
|
|
718
|
+
| **id** | **String** | | |
|
|
719
|
+
| **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
720
|
+
|
|
721
|
+
### Return type
|
|
722
|
+
|
|
723
|
+
**Hash<String, Object>**
|
|
724
|
+
|
|
725
|
+
### Authorization
|
|
726
|
+
|
|
727
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
728
|
+
|
|
729
|
+
### HTTP request headers
|
|
730
|
+
|
|
731
|
+
- **Content-Type**: Not defined
|
|
732
|
+
- **Accept**: application/json
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
## get_flow_message_relationships_action
|
|
736
|
+
|
|
737
|
+
> Hash<String, Object> get_flow_message_relationships_action(id)
|
|
738
|
+
|
|
739
|
+
Get Flow Message Relationships Action
|
|
740
|
+
|
|
741
|
+
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`
|
|
742
|
+
|
|
743
|
+
### Examples
|
|
744
|
+
|
|
745
|
+
```ruby
|
|
746
|
+
require 'time'
|
|
747
|
+
require 'klaviyo-api-sdk'
|
|
748
|
+
# setup authorization
|
|
749
|
+
KlaviyoAPI.configure do |config|
|
|
750
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
751
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
752
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
753
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
754
|
+
end
|
|
755
|
+
|
|
756
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
757
|
+
id = 'id_example' # String |
|
|
758
|
+
|
|
759
|
+
begin
|
|
760
|
+
# Get Flow Message Relationships Action
|
|
761
|
+
result = api_instance.get_flow_message_relationships_action(id)
|
|
762
|
+
p result
|
|
763
|
+
rescue KlaviyoAPI::ApiError => e
|
|
764
|
+
puts "Error when calling FlowsApi->get_flow_message_relationships_action: #{e}"
|
|
765
|
+
end
|
|
766
|
+
```
|
|
767
|
+
|
|
768
|
+
#### Using the get_flow_message_relationships_action_with_http_info variant
|
|
769
|
+
|
|
770
|
+
This returns an Array which contains the response data, status code and headers.
|
|
771
|
+
|
|
772
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_message_relationships_action_with_http_info(id)
|
|
773
|
+
|
|
774
|
+
```ruby
|
|
775
|
+
begin
|
|
776
|
+
# Get Flow Message Relationships Action
|
|
777
|
+
data, status_code, headers = api_instance.get_flow_message_relationships_action_with_http_info(id)
|
|
778
|
+
p status_code # => 2xx
|
|
779
|
+
p headers # => { ... }
|
|
780
|
+
p data # => Hash<String, Object>
|
|
781
|
+
rescue KlaviyoAPI::ApiError => e
|
|
782
|
+
puts "Error when calling FlowsApi->get_flow_message_relationships_action_with_http_info: #{e}"
|
|
783
|
+
end
|
|
784
|
+
```
|
|
785
|
+
|
|
786
|
+
### Parameters
|
|
787
|
+
|
|
788
|
+
| Name | Type | Description | Notes |
|
|
789
|
+
| ---- | ---- | ----------- | ----- |
|
|
790
|
+
| **id** | **String** | | |
|
|
791
|
+
|
|
792
|
+
### Return type
|
|
793
|
+
|
|
794
|
+
**Hash<String, Object>**
|
|
795
|
+
|
|
796
|
+
### Authorization
|
|
797
|
+
|
|
798
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
799
|
+
|
|
800
|
+
### HTTP request headers
|
|
801
|
+
|
|
802
|
+
- **Content-Type**: Not defined
|
|
803
|
+
- **Accept**: application/json
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
## get_flow_message_relationships_template
|
|
807
|
+
|
|
808
|
+
> Hash<String, Object> get_flow_message_relationships_template(id)
|
|
809
|
+
|
|
810
|
+
Get Flow Message Relationships Template
|
|
811
|
+
|
|
812
|
+
Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
|
813
|
+
|
|
814
|
+
### Examples
|
|
815
|
+
|
|
816
|
+
```ruby
|
|
817
|
+
require 'time'
|
|
818
|
+
require 'klaviyo-api-sdk'
|
|
819
|
+
# setup authorization
|
|
820
|
+
KlaviyoAPI.configure do |config|
|
|
821
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
822
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
823
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
824
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
825
|
+
end
|
|
826
|
+
|
|
827
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
828
|
+
id = 'id_example' # String |
|
|
829
|
+
|
|
830
|
+
begin
|
|
831
|
+
# Get Flow Message Relationships Template
|
|
832
|
+
result = api_instance.get_flow_message_relationships_template(id)
|
|
833
|
+
p result
|
|
834
|
+
rescue KlaviyoAPI::ApiError => e
|
|
835
|
+
puts "Error when calling FlowsApi->get_flow_message_relationships_template: #{e}"
|
|
836
|
+
end
|
|
837
|
+
```
|
|
838
|
+
|
|
839
|
+
#### Using the get_flow_message_relationships_template_with_http_info variant
|
|
840
|
+
|
|
841
|
+
This returns an Array which contains the response data, status code and headers.
|
|
842
|
+
|
|
843
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_message_relationships_template_with_http_info(id)
|
|
844
|
+
|
|
845
|
+
```ruby
|
|
846
|
+
begin
|
|
847
|
+
# Get Flow Message Relationships Template
|
|
848
|
+
data, status_code, headers = api_instance.get_flow_message_relationships_template_with_http_info(id)
|
|
849
|
+
p status_code # => 2xx
|
|
850
|
+
p headers # => { ... }
|
|
851
|
+
p data # => Hash<String, Object>
|
|
852
|
+
rescue KlaviyoAPI::ApiError => e
|
|
853
|
+
puts "Error when calling FlowsApi->get_flow_message_relationships_template_with_http_info: #{e}"
|
|
854
|
+
end
|
|
855
|
+
```
|
|
856
|
+
|
|
857
|
+
### Parameters
|
|
858
|
+
|
|
859
|
+
| Name | Type | Description | Notes |
|
|
860
|
+
| ---- | ---- | ----------- | ----- |
|
|
861
|
+
| **id** | **String** | | |
|
|
862
|
+
|
|
863
|
+
### Return type
|
|
864
|
+
|
|
865
|
+
**Hash<String, Object>**
|
|
866
|
+
|
|
867
|
+
### Authorization
|
|
868
|
+
|
|
869
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
870
|
+
|
|
871
|
+
### HTTP request headers
|
|
872
|
+
|
|
873
|
+
- **Content-Type**: Not defined
|
|
874
|
+
- **Accept**: application/json
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
## get_flow_message_template
|
|
878
|
+
|
|
879
|
+
> Hash<String, Object> get_flow_message_template(id, opts)
|
|
880
|
+
|
|
881
|
+
Get Flow Message Template
|
|
882
|
+
|
|
883
|
+
Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
|
884
|
+
|
|
885
|
+
### Examples
|
|
886
|
+
|
|
887
|
+
```ruby
|
|
888
|
+
require 'time'
|
|
889
|
+
require 'klaviyo-api-sdk'
|
|
890
|
+
# setup authorization
|
|
891
|
+
KlaviyoAPI.configure do |config|
|
|
892
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
893
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
894
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
895
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
896
|
+
end
|
|
897
|
+
|
|
898
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
899
|
+
id = 'id_example' # String |
|
|
900
|
+
opts = {
|
|
901
|
+
fields_template: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
902
|
+
}
|
|
903
|
+
|
|
904
|
+
begin
|
|
905
|
+
# Get Flow Message Template
|
|
906
|
+
result = api_instance.get_flow_message_template(id, opts)
|
|
907
|
+
p result
|
|
908
|
+
rescue KlaviyoAPI::ApiError => e
|
|
909
|
+
puts "Error when calling FlowsApi->get_flow_message_template: #{e}"
|
|
910
|
+
end
|
|
911
|
+
```
|
|
912
|
+
|
|
913
|
+
#### Using the get_flow_message_template_with_http_info variant
|
|
914
|
+
|
|
915
|
+
This returns an Array which contains the response data, status code and headers.
|
|
916
|
+
|
|
917
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_message_template_with_http_info(id, opts)
|
|
918
|
+
|
|
919
|
+
```ruby
|
|
920
|
+
begin
|
|
921
|
+
# Get Flow Message Template
|
|
922
|
+
data, status_code, headers = api_instance.get_flow_message_template_with_http_info(id, opts)
|
|
923
|
+
p status_code # => 2xx
|
|
924
|
+
p headers # => { ... }
|
|
925
|
+
p data # => Hash<String, Object>
|
|
926
|
+
rescue KlaviyoAPI::ApiError => e
|
|
927
|
+
puts "Error when calling FlowsApi->get_flow_message_template_with_http_info: #{e}"
|
|
928
|
+
end
|
|
929
|
+
```
|
|
930
|
+
|
|
931
|
+
### Parameters
|
|
932
|
+
|
|
933
|
+
| Name | Type | Description | Notes |
|
|
934
|
+
| ---- | ---- | ----------- | ----- |
|
|
935
|
+
| **id** | **String** | | |
|
|
936
|
+
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
937
|
+
|
|
938
|
+
### Return type
|
|
939
|
+
|
|
940
|
+
**Hash<String, Object>**
|
|
941
|
+
|
|
942
|
+
### Authorization
|
|
943
|
+
|
|
944
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
945
|
+
|
|
946
|
+
### HTTP request headers
|
|
947
|
+
|
|
948
|
+
- **Content-Type**: Not defined
|
|
949
|
+
- **Accept**: application/json
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
## get_flow_relationships_flow_actions
|
|
953
|
+
|
|
954
|
+
> Hash<String, Object> get_flow_relationships_flow_actions(id, opts)
|
|
955
|
+
|
|
956
|
+
Get Flow Relationships Flow Actions
|
|
957
|
+
|
|
958
|
+
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`
|
|
959
|
+
|
|
960
|
+
### Examples
|
|
961
|
+
|
|
962
|
+
```ruby
|
|
963
|
+
require 'time'
|
|
964
|
+
require 'klaviyo-api-sdk'
|
|
965
|
+
# setup authorization
|
|
966
|
+
KlaviyoAPI.configure do |config|
|
|
967
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
968
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
969
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
970
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
971
|
+
end
|
|
972
|
+
|
|
973
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
974
|
+
id = 'id_example' # String |
|
|
975
|
+
opts = {
|
|
976
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-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`
|
|
977
|
+
page_size: 56, # Integer | Default: 50. Min: 1. Max: 100.
|
|
978
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
|
|
979
|
+
}
|
|
980
|
+
|
|
981
|
+
begin
|
|
982
|
+
# Get Flow Relationships Flow Actions
|
|
983
|
+
result = api_instance.get_flow_relationships_flow_actions(id, opts)
|
|
984
|
+
p result
|
|
985
|
+
rescue KlaviyoAPI::ApiError => e
|
|
986
|
+
puts "Error when calling FlowsApi->get_flow_relationships_flow_actions: #{e}"
|
|
987
|
+
end
|
|
988
|
+
```
|
|
989
|
+
|
|
990
|
+
#### Using the get_flow_relationships_flow_actions_with_http_info variant
|
|
991
|
+
|
|
992
|
+
This returns an Array which contains the response data, status code and headers.
|
|
993
|
+
|
|
994
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_relationships_flow_actions_with_http_info(id, opts)
|
|
995
|
+
|
|
996
|
+
```ruby
|
|
997
|
+
begin
|
|
998
|
+
# Get Flow Relationships Flow Actions
|
|
999
|
+
data, status_code, headers = api_instance.get_flow_relationships_flow_actions_with_http_info(id, opts)
|
|
1000
|
+
p status_code # => 2xx
|
|
1001
|
+
p headers # => { ... }
|
|
1002
|
+
p data # => Hash<String, Object>
|
|
1003
|
+
rescue KlaviyoAPI::ApiError => e
|
|
1004
|
+
puts "Error when calling FlowsApi->get_flow_relationships_flow_actions_with_http_info: #{e}"
|
|
1005
|
+
end
|
|
1006
|
+
```
|
|
1007
|
+
|
|
1008
|
+
### Parameters
|
|
1009
|
+
|
|
1010
|
+
| Name | Type | Description | Notes |
|
|
1011
|
+
| ---- | ---- | ----------- | ----- |
|
|
1012
|
+
| **id** | **String** | | |
|
|
1013
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-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` | [optional] |
|
|
1014
|
+
| **page_size** | **Integer** | Default: 50. Min: 1. Max: 100. | [optional][default to 50] |
|
|
1015
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
|
|
1016
|
+
|
|
1017
|
+
### Return type
|
|
1018
|
+
|
|
1019
|
+
**Hash<String, Object>**
|
|
1020
|
+
|
|
1021
|
+
### Authorization
|
|
1022
|
+
|
|
1023
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
1024
|
+
|
|
1025
|
+
### HTTP request headers
|
|
1026
|
+
|
|
1027
|
+
- **Content-Type**: Not defined
|
|
1028
|
+
- **Accept**: application/json
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
## get_flow_relationships_tags
|
|
1032
|
+
|
|
1033
|
+
> Hash<String, Object> get_flow_relationships_tags(id)
|
|
1034
|
+
|
|
1035
|
+
Get Flow Relationships Tags
|
|
1036
|
+
|
|
1037
|
+
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`
|
|
1038
|
+
|
|
1039
|
+
### Examples
|
|
1040
|
+
|
|
1041
|
+
```ruby
|
|
1042
|
+
require 'time'
|
|
1043
|
+
require 'klaviyo-api-sdk'
|
|
1044
|
+
# setup authorization
|
|
1045
|
+
KlaviyoAPI.configure do |config|
|
|
1046
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
1047
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
1048
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1049
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
1050
|
+
end
|
|
1051
|
+
|
|
1052
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
1053
|
+
id = 'id_example' # String |
|
|
1054
|
+
|
|
1055
|
+
begin
|
|
1056
|
+
# Get Flow Relationships Tags
|
|
1057
|
+
result = api_instance.get_flow_relationships_tags(id)
|
|
1058
|
+
p result
|
|
1059
|
+
rescue KlaviyoAPI::ApiError => e
|
|
1060
|
+
puts "Error when calling FlowsApi->get_flow_relationships_tags: #{e}"
|
|
1061
|
+
end
|
|
1062
|
+
```
|
|
1063
|
+
|
|
1064
|
+
#### Using the get_flow_relationships_tags_with_http_info variant
|
|
1065
|
+
|
|
1066
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1067
|
+
|
|
1068
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_relationships_tags_with_http_info(id)
|
|
1069
|
+
|
|
1070
|
+
```ruby
|
|
1071
|
+
begin
|
|
1072
|
+
# Get Flow Relationships Tags
|
|
1073
|
+
data, status_code, headers = api_instance.get_flow_relationships_tags_with_http_info(id)
|
|
1074
|
+
p status_code # => 2xx
|
|
1075
|
+
p headers # => { ... }
|
|
1076
|
+
p data # => Hash<String, Object>
|
|
1077
|
+
rescue KlaviyoAPI::ApiError => e
|
|
1078
|
+
puts "Error when calling FlowsApi->get_flow_relationships_tags_with_http_info: #{e}"
|
|
1079
|
+
end
|
|
1080
|
+
```
|
|
1081
|
+
|
|
1082
|
+
### Parameters
|
|
1083
|
+
|
|
1084
|
+
| Name | Type | Description | Notes |
|
|
1085
|
+
| ---- | ---- | ----------- | ----- |
|
|
1086
|
+
| **id** | **String** | | |
|
|
1087
|
+
|
|
1088
|
+
### Return type
|
|
1089
|
+
|
|
1090
|
+
**Hash<String, Object>**
|
|
1091
|
+
|
|
1092
|
+
### Authorization
|
|
1093
|
+
|
|
1094
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
1095
|
+
|
|
1096
|
+
### HTTP request headers
|
|
1097
|
+
|
|
1098
|
+
- **Content-Type**: Not defined
|
|
1099
|
+
- **Accept**: application/json
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
## get_flow_tags
|
|
1103
|
+
|
|
1104
|
+
> Hash<String, Object> get_flow_tags(id, opts)
|
|
1105
|
+
|
|
1106
|
+
Get Flow Tags
|
|
1107
|
+
|
|
1108
|
+
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`
|
|
1109
|
+
|
|
1110
|
+
### Examples
|
|
1111
|
+
|
|
1112
|
+
```ruby
|
|
1113
|
+
require 'time'
|
|
1114
|
+
require 'klaviyo-api-sdk'
|
|
1115
|
+
# setup authorization
|
|
1116
|
+
KlaviyoAPI.configure do |config|
|
|
1117
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
1118
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
1119
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1120
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
1121
|
+
end
|
|
1122
|
+
|
|
1123
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
1124
|
+
id = 'id_example' # String |
|
|
1125
|
+
opts = {
|
|
1126
|
+
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1127
|
+
}
|
|
1128
|
+
|
|
1129
|
+
begin
|
|
1130
|
+
# Get Flow Tags
|
|
1131
|
+
result = api_instance.get_flow_tags(id, opts)
|
|
1132
|
+
p result
|
|
1133
|
+
rescue KlaviyoAPI::ApiError => e
|
|
1134
|
+
puts "Error when calling FlowsApi->get_flow_tags: #{e}"
|
|
1135
|
+
end
|
|
1136
|
+
```
|
|
1137
|
+
|
|
1138
|
+
#### Using the get_flow_tags_with_http_info variant
|
|
1139
|
+
|
|
1140
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1141
|
+
|
|
1142
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flow_tags_with_http_info(id, opts)
|
|
1143
|
+
|
|
1144
|
+
```ruby
|
|
1145
|
+
begin
|
|
1146
|
+
# Get Flow Tags
|
|
1147
|
+
data, status_code, headers = api_instance.get_flow_tags_with_http_info(id, opts)
|
|
1148
|
+
p status_code # => 2xx
|
|
1149
|
+
p headers # => { ... }
|
|
1150
|
+
p data # => Hash<String, Object>
|
|
1151
|
+
rescue KlaviyoAPI::ApiError => e
|
|
1152
|
+
puts "Error when calling FlowsApi->get_flow_tags_with_http_info: #{e}"
|
|
1153
|
+
end
|
|
1154
|
+
```
|
|
1155
|
+
|
|
1156
|
+
### Parameters
|
|
1157
|
+
|
|
1158
|
+
| Name | Type | Description | Notes |
|
|
1159
|
+
| ---- | ---- | ----------- | ----- |
|
|
1160
|
+
| **id** | **String** | | |
|
|
1161
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1162
|
+
|
|
1163
|
+
### Return type
|
|
1164
|
+
|
|
1165
|
+
**Hash<String, Object>**
|
|
1166
|
+
|
|
1167
|
+
### Authorization
|
|
1168
|
+
|
|
1169
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
1170
|
+
|
|
1171
|
+
### HTTP request headers
|
|
1172
|
+
|
|
1173
|
+
- **Content-Type**: Not defined
|
|
1174
|
+
- **Accept**: application/json
|
|
1175
|
+
|
|
1176
|
+
|
|
1177
|
+
## get_flows
|
|
1178
|
+
|
|
1179
|
+
> Hash<String, Object> get_flows(opts)
|
|
1180
|
+
|
|
1181
|
+
Get Flows
|
|
1182
|
+
|
|
1183
|
+
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`
|
|
1184
|
+
|
|
1185
|
+
### Examples
|
|
1186
|
+
|
|
1187
|
+
```ruby
|
|
1188
|
+
require 'time'
|
|
1189
|
+
require 'klaviyo-api-sdk'
|
|
1190
|
+
# setup authorization
|
|
1191
|
+
KlaviyoAPI.configure do |config|
|
|
1192
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
1193
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
1194
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1195
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
1196
|
+
end
|
|
1197
|
+
|
|
1198
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
1199
|
+
opts = {
|
|
1200
|
+
fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1201
|
+
fields_flow: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1202
|
+
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1203
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-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`
|
|
1204
|
+
include: ['flow-actions'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
|
|
1205
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
|
|
1206
|
+
page_size: 56, # Integer | Default: 50. Min: 1. Max: 50.
|
|
1207
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
|
|
1208
|
+
}
|
|
1209
|
+
|
|
1210
|
+
begin
|
|
1211
|
+
# Get Flows
|
|
1212
|
+
result = api_instance.get_flows(opts)
|
|
1213
|
+
p result
|
|
1214
|
+
rescue KlaviyoAPI::ApiError => e
|
|
1215
|
+
puts "Error when calling FlowsApi->get_flows: #{e}"
|
|
1216
|
+
end
|
|
1217
|
+
```
|
|
1218
|
+
|
|
1219
|
+
#### Using the get_flows_with_http_info variant
|
|
1220
|
+
|
|
1221
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1222
|
+
|
|
1223
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_flows_with_http_info(opts)
|
|
1224
|
+
|
|
1225
|
+
```ruby
|
|
1226
|
+
begin
|
|
1227
|
+
# Get Flows
|
|
1228
|
+
data, status_code, headers = api_instance.get_flows_with_http_info(opts)
|
|
1229
|
+
p status_code # => 2xx
|
|
1230
|
+
p headers # => { ... }
|
|
1231
|
+
p data # => Hash<String, Object>
|
|
1232
|
+
rescue KlaviyoAPI::ApiError => e
|
|
1233
|
+
puts "Error when calling FlowsApi->get_flows_with_http_info: #{e}"
|
|
1234
|
+
end
|
|
1235
|
+
```
|
|
1236
|
+
|
|
1237
|
+
### Parameters
|
|
1238
|
+
|
|
1239
|
+
| Name | Type | Description | Notes |
|
|
1240
|
+
| ---- | ---- | ----------- | ----- |
|
|
1241
|
+
| **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1242
|
+
| **fields_flow** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1243
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
|
|
1244
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-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` | [optional] |
|
|
1245
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships | [optional] |
|
|
1246
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
|
|
1247
|
+
| **page_size** | **Integer** | Default: 50. Min: 1. Max: 50. | [optional][default to 50] |
|
|
1248
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
|
|
1249
|
+
|
|
1250
|
+
### Return type
|
|
1251
|
+
|
|
1252
|
+
**Hash<String, Object>**
|
|
1253
|
+
|
|
1254
|
+
### Authorization
|
|
1255
|
+
|
|
1256
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
1257
|
+
|
|
1258
|
+
### HTTP request headers
|
|
1259
|
+
|
|
1260
|
+
- **Content-Type**: Not defined
|
|
1261
|
+
- **Accept**: application/json
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
## update_flow
|
|
1265
|
+
|
|
1266
|
+
> Hash<String, Object> update_flow(id, flow_update_query)
|
|
1267
|
+
|
|
1268
|
+
Update Flow Status
|
|
1269
|
+
|
|
1270
|
+
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`
|
|
1271
|
+
|
|
1272
|
+
### Examples
|
|
1273
|
+
|
|
1274
|
+
```ruby
|
|
1275
|
+
require 'time'
|
|
1276
|
+
require 'klaviyo-api-sdk'
|
|
1277
|
+
# setup authorization
|
|
1278
|
+
KlaviyoAPI.configure do |config|
|
|
1279
|
+
# Configure API key authorization: Klaviyo-API-Key
|
|
1280
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
|
1281
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1282
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
|
1283
|
+
end
|
|
1284
|
+
|
|
1285
|
+
api_instance = KlaviyoAPI::FlowsApi.new
|
|
1286
|
+
id = 'id_example' # String | ID of the Flow to update. Ex: XVTP5Q
|
|
1287
|
+
flow_update_query = KlaviyoAPI::FlowUpdateQuery.new({data: KlaviyoAPI::FlowUpdateQueryResourceObject.new({type: KlaviyoAPI::FlowEnum::FLOW, id: 'id_example', attributes: KlaviyoAPI::FlowUpdateQueryResourceObjectAttributes.new({status: 'status_example'})})}) # FlowUpdateQuery |
|
|
1288
|
+
|
|
1289
|
+
begin
|
|
1290
|
+
# Update Flow Status
|
|
1291
|
+
result = api_instance.update_flow(id, flow_update_query)
|
|
1292
|
+
p result
|
|
1293
|
+
rescue KlaviyoAPI::ApiError => e
|
|
1294
|
+
puts "Error when calling FlowsApi->update_flow: #{e}"
|
|
1295
|
+
end
|
|
1296
|
+
```
|
|
1297
|
+
|
|
1298
|
+
#### Using the update_flow_with_http_info variant
|
|
1299
|
+
|
|
1300
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1301
|
+
|
|
1302
|
+
> <Array(Hash<String, Object>, Integer, Hash)> update_flow_with_http_info(id, flow_update_query)
|
|
1303
|
+
|
|
1304
|
+
```ruby
|
|
1305
|
+
begin
|
|
1306
|
+
# Update Flow Status
|
|
1307
|
+
data, status_code, headers = api_instance.update_flow_with_http_info(id, flow_update_query)
|
|
1308
|
+
p status_code # => 2xx
|
|
1309
|
+
p headers # => { ... }
|
|
1310
|
+
p data # => Hash<String, Object>
|
|
1311
|
+
rescue KlaviyoAPI::ApiError => e
|
|
1312
|
+
puts "Error when calling FlowsApi->update_flow_with_http_info: #{e}"
|
|
1313
|
+
end
|
|
1314
|
+
```
|
|
1315
|
+
|
|
1316
|
+
### Parameters
|
|
1317
|
+
|
|
1318
|
+
| Name | Type | Description | Notes |
|
|
1319
|
+
| ---- | ---- | ----------- | ----- |
|
|
1320
|
+
| **id** | **String** | ID of the Flow to update. Ex: XVTP5Q | |
|
|
1321
|
+
| **flow_update_query** | [**FlowUpdateQuery**](FlowUpdateQuery.md) | | |
|
|
1322
|
+
|
|
1323
|
+
### Return type
|
|
1324
|
+
|
|
1325
|
+
**Hash<String, Object>**
|
|
1326
|
+
|
|
1327
|
+
### Authorization
|
|
1328
|
+
|
|
1329
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
|
1330
|
+
|
|
1331
|
+
### HTTP request headers
|
|
1332
|
+
|
|
1333
|
+
- **Content-Type**: application/json
|
|
1334
|
+
- **Accept**: application/json
|
|
1335
|
+
|