klaviyo-api-sdk 3.0.0 → 4.1.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 +273 -173
- 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 +20 -0
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +20 -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/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +18 -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/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignRecipientEstimationJobEnum.md +15 -0
- data/docs/CampaignSendJobCreateQuery.md +18 -0
- data/docs/CampaignSendJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +18 -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/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/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/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 +842 -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 +38 -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/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/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 +972 -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 +553 -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/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 +20 -0
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +20 -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 +20 -0
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +20 -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 +528 -57
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +376 -306
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +96 -96
- data/lib/klaviyo-api-sdk/api/flows_api.rb +258 -103
- data/lib/klaviyo-api-sdk/api/lists_api.rb +79 -44
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +141 -71
- data/lib/klaviyo-api-sdk/api/segments_api.rb +71 -36
- data/lib/klaviyo-api-sdk/api/tags_api.rb +121 -93
- data/lib/klaviyo-api-sdk/api/templates_api.rb +31 -31
- 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/{profile_unsuppression_bulk_create_job_enum.rb → back_in_stock_subscription_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +32 -38
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +227 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +106 -0
- 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 +22 -13
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +5 -20
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object.rb → campaign_message_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +253 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +106 -0
- 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 +19 -10
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +227 -0
- 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 +19 -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_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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +227 -0
- 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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +227 -0
- 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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +227 -0
- 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 +73 -71
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +238 -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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +227 -0
- 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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +227 -0
- 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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +227 -0
- 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 +117 -115
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +238 -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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +227 -0
- 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 +3 -6
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +227 -0
- 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/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 +13 -29
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +224 -0
- 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 +248 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +388 -0
- data/lib/klaviyo-api-sdk/models/{content_sub_object.rb → email_content_sub_object.rb} +50 -40
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +220 -0
- data/lib/klaviyo-api-sdk/models/{tracking_options_sub_object.rb → email_tracking_options_sub_object.rb} +15 -15
- data/lib/klaviyo-api-sdk/models/{event_create_query.rb → event_create_query_v2.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object.rb → event_create_query_v2_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object_attributes.rb → event_create_query_v2_resource_object_attributes.rb} +44 -45
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +224 -0
- 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/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 +65 -68
- data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object.rb → metric_create_query_resource_object.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{metric_create_query.rb → metric_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{profile_unsubscription_bulk_create_job_enum.rb → metric_enum.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +257 -0
- data/lib/klaviyo-api-sdk/models/{profile_partial_update_query_resource_object_attributes.rb → onsite_profile_create_query_resource_object_attributes.rb} +48 -48
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +219 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +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 +248 -0
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +249 -0
- 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_meta.rb +219 -0
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +239 -0
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +106 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +28 -19
- 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 +36 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/{subscription.rb → profile_subscription_create_query_resource_object_attributes.rb} +18 -28
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +230 -0
- 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 +36 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{suppression.rb → profile_suppression_create_query_resource_object_attributes.rb} +5 -10
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +220 -0
- 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/{unsuppression_create_job_create_query.rb → push_token_create_query.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships_items_data_inner.rb → push_token_create_query_resource_object_attributes.rb} +131 -31
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +225 -0
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +252 -0
- 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/{unsubscription_create_job_create_query.rb → server_bis_subscription_create_query.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/{catalog_item_category_op_data_inner.rb → server_bis_subscription_create_query_resource_object_attributes.rb} +23 -37
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +224 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +224 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +220 -0
- data/lib/klaviyo-api-sdk/models/{send_options_sub_object.rb → sms_send_options_sub_object.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object_attributes.rb → sms_tracking_options_sub_object.rb} +23 -18
- 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 +22 -13
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +11 -29
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
- 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 +238 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
- 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 +11 -14
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{tag_update_query_resource_object_attributes.rb → suppression_delete_job_create_query_resource_object_attributes.rb} +14 -15
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +2 -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 +22 -13
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +2 -12
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +238 -0
- 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 +2 -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 +14 -14
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +2 -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 +2 -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 +19 -19
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +2 -14
- 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 -37
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +3 -15
- 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 -28
- 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 +96 -27
- 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/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/lists_api_spec.rb +185 -0
- data/spec/api/metrics_api_spec.rb +74 -0
- data/spec/api/profiles_api_spec.rb +204 -0
- data/spec/api/segments_api_spec.rb +135 -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 +40 -0
- data/spec/models/campaign_clone_query_resource_object_spec.rb +40 -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_attributes_spec.rb +34 -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_attributes_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_attributes_spec.rb +34 -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_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/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/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 +94 -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_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_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_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 +40 -0
- data/spec/models/template_clone_query_resource_object_spec.rb +40 -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 +40 -0
- data/spec/models/template_render_query_resource_object_spec.rb +40 -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 +674 -33
- data/CHANGELOG.md +0 -65
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object_attributes.rb +0 -244
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2023-
|
|
6
|
+
The version of the OpenAPI document: 2023-08-15
|
|
7
7
|
Contact: developers@klaviyo.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.2.1
|
|
@@ -20,12 +20,13 @@ module KlaviyoAPI
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Get Flow
|
|
23
|
-
# Get a flow with the given flow ID.
|
|
23
|
+
# Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
24
24
|
# @param id [String]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
27
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
28
|
-
# @option opts [Array<String>] :
|
|
26
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
27
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
28
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
29
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
|
|
29
30
|
# @return [Hash<String, Object>]
|
|
30
31
|
def get_flow(id, opts = {})
|
|
31
32
|
data, _status_code, _headers = get_flow_with_http_info(id, opts)
|
|
@@ -33,12 +34,13 @@ module KlaviyoAPI
|
|
|
33
34
|
end
|
|
34
35
|
|
|
35
36
|
# Get Flow
|
|
36
|
-
# Get a flow with the given flow ID.
|
|
37
|
+
# Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
37
38
|
# @param id [String]
|
|
38
39
|
# @param [Hash] opts the optional parameters
|
|
39
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
40
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
41
|
-
# @option opts [Array<String>] :
|
|
40
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
41
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
42
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
43
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
|
|
42
44
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
43
45
|
def get_flow_with_http_info(id, opts = {})
|
|
44
46
|
if @api_client.config.debugging
|
|
@@ -56,7 +58,11 @@ module KlaviyoAPI
|
|
|
56
58
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
57
59
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
58
60
|
end
|
|
59
|
-
allowable_values = ["
|
|
61
|
+
allowable_values = ["name"]
|
|
62
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
63
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
64
|
+
end
|
|
65
|
+
allowable_values = ["flow-actions", "tags"]
|
|
60
66
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
61
67
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
62
68
|
end
|
|
@@ -67,12 +73,13 @@ module KlaviyoAPI
|
|
|
67
73
|
query_params = opts[:query_params] || {}
|
|
68
74
|
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
|
69
75
|
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
|
76
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
|
70
77
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
71
78
|
|
|
72
79
|
# header parameters
|
|
73
80
|
header_params = opts[:header_params] || {}
|
|
74
81
|
# klaviyo api revision
|
|
75
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
82
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
76
83
|
# HTTP header 'Accept' (if needed)
|
|
77
84
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
78
85
|
|
|
@@ -106,13 +113,13 @@ module KlaviyoAPI
|
|
|
106
113
|
end
|
|
107
114
|
|
|
108
115
|
# Get Flow Action
|
|
109
|
-
# Get a flow action from a flow with the given flow action ID.
|
|
116
|
+
# 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`
|
|
110
117
|
# @param id [String]
|
|
111
118
|
# @param [Hash] opts the optional parameters
|
|
112
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
113
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
114
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
115
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
119
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
120
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
121
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
122
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
|
|
116
123
|
# @return [Hash<String, Object>]
|
|
117
124
|
def get_flow_action(id, opts = {})
|
|
118
125
|
data, _status_code, _headers = get_flow_action_with_http_info(id, opts)
|
|
@@ -120,13 +127,13 @@ module KlaviyoAPI
|
|
|
120
127
|
end
|
|
121
128
|
|
|
122
129
|
# Get Flow Action
|
|
123
|
-
# Get a flow action from a flow with the given flow action ID.
|
|
130
|
+
# 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`
|
|
124
131
|
# @param id [String]
|
|
125
132
|
# @param [Hash] opts the optional parameters
|
|
126
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
127
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
128
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
129
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
133
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
134
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
135
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
136
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
|
|
130
137
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
131
138
|
def get_flow_action_with_http_info(id, opts = {})
|
|
132
139
|
if @api_client.config.debugging
|
|
@@ -148,7 +155,7 @@ module KlaviyoAPI
|
|
|
148
155
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
149
156
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
150
157
|
end
|
|
151
|
-
allowable_values = ["flow
|
|
158
|
+
allowable_values = ["flow", "flow-messages"]
|
|
152
159
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
153
160
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
154
161
|
end
|
|
@@ -165,7 +172,7 @@ module KlaviyoAPI
|
|
|
165
172
|
# header parameters
|
|
166
173
|
header_params = opts[:header_params] || {}
|
|
167
174
|
# klaviyo api revision
|
|
168
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
175
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
169
176
|
# HTTP header 'Accept' (if needed)
|
|
170
177
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
171
178
|
|
|
@@ -202,7 +209,7 @@ module KlaviyoAPI
|
|
|
202
209
|
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
203
210
|
# @param id [String]
|
|
204
211
|
# @param [Hash] opts the optional parameters
|
|
205
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
212
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
206
213
|
# @return [Hash<String, Object>]
|
|
207
214
|
def get_flow_action_flow(id, opts = {})
|
|
208
215
|
data, _status_code, _headers = get_flow_action_flow_with_http_info(id, opts)
|
|
@@ -213,7 +220,7 @@ module KlaviyoAPI
|
|
|
213
220
|
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
214
221
|
# @param id [String]
|
|
215
222
|
# @param [Hash] opts the optional parameters
|
|
216
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
223
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
217
224
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
218
225
|
def get_flow_action_flow_with_http_info(id, opts = {})
|
|
219
226
|
if @api_client.config.debugging
|
|
@@ -237,7 +244,7 @@ module KlaviyoAPI
|
|
|
237
244
|
# header parameters
|
|
238
245
|
header_params = opts[:header_params] || {}
|
|
239
246
|
# klaviyo api revision
|
|
240
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
247
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
241
248
|
# HTTP header 'Accept' (if needed)
|
|
242
249
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
243
250
|
|
|
@@ -270,30 +277,28 @@ module KlaviyoAPI
|
|
|
270
277
|
return data, status_code, headers
|
|
271
278
|
end
|
|
272
279
|
|
|
273
|
-
# Get
|
|
274
|
-
# Get all flow messages associated with the given
|
|
280
|
+
# Get Flow Action Messages
|
|
281
|
+
# 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`
|
|
275
282
|
# @param id [String]
|
|
276
283
|
# @param [Hash] opts the optional parameters
|
|
277
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
278
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
279
|
-
# @option opts [
|
|
280
|
-
# @option opts [
|
|
281
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
|
284
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
285
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-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`
|
|
286
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
|
287
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
|
282
288
|
# @return [Hash<String, Object>]
|
|
283
289
|
def get_flow_action_messages(id, opts = {})
|
|
284
290
|
data, _status_code, _headers = get_flow_action_messages_with_http_info(id, opts)
|
|
285
291
|
data
|
|
286
292
|
end
|
|
287
293
|
|
|
288
|
-
# Get
|
|
289
|
-
# Get all flow messages associated with the given
|
|
294
|
+
# Get Flow Action Messages
|
|
295
|
+
# 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`
|
|
290
296
|
# @param id [String]
|
|
291
297
|
# @param [Hash] opts the optional parameters
|
|
292
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
293
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
294
|
-
# @option opts [
|
|
295
|
-
# @option opts [
|
|
296
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
|
298
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
299
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-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`
|
|
300
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
|
301
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
|
297
302
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
298
303
|
def get_flow_action_messages_with_http_info(id, opts = {})
|
|
299
304
|
if @api_client.config.debugging
|
|
@@ -307,8 +312,8 @@ module KlaviyoAPI
|
|
|
307
312
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
308
313
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
309
314
|
end
|
|
310
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] >
|
|
311
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_messages, must be smaller than or equal to
|
|
315
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
316
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_messages, must be smaller than or equal to 100.'
|
|
312
317
|
end
|
|
313
318
|
|
|
314
319
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
@@ -326,14 +331,13 @@ module KlaviyoAPI
|
|
|
326
331
|
query_params = opts[:query_params] || {}
|
|
327
332
|
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
|
328
333
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
329
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
330
334
|
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
331
335
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
332
336
|
|
|
333
337
|
# header parameters
|
|
334
338
|
header_params = opts[:header_params] || {}
|
|
335
339
|
# klaviyo api revision
|
|
336
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
340
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
337
341
|
# HTTP header 'Accept' (if needed)
|
|
338
342
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
339
343
|
|
|
@@ -398,7 +402,7 @@ module KlaviyoAPI
|
|
|
398
402
|
# header parameters
|
|
399
403
|
header_params = opts[:header_params] || {}
|
|
400
404
|
# klaviyo api revision
|
|
401
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
405
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
402
406
|
# HTTP header 'Accept' (if needed)
|
|
403
407
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
404
408
|
|
|
@@ -435,10 +439,10 @@ module KlaviyoAPI
|
|
|
435
439
|
# 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`
|
|
436
440
|
# @param id [String]
|
|
437
441
|
# @param [Hash] opts the optional parameters
|
|
438
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
439
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
442
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-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`
|
|
443
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
|
|
440
444
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
441
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
445
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
|
442
446
|
# @return [Hash<String, Object>]
|
|
443
447
|
def get_flow_action_relationships_messages(id, opts = {})
|
|
444
448
|
data, _status_code, _headers = get_flow_action_relationships_messages_with_http_info(id, opts)
|
|
@@ -449,10 +453,10 @@ module KlaviyoAPI
|
|
|
449
453
|
# 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`
|
|
450
454
|
# @param id [String]
|
|
451
455
|
# @param [Hash] opts the optional parameters
|
|
452
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
453
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
456
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-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`
|
|
457
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
|
|
454
458
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
455
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
459
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
|
456
460
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
457
461
|
def get_flow_action_relationships_messages_with_http_info(id, opts = {})
|
|
458
462
|
if @api_client.config.debugging
|
|
@@ -487,7 +491,7 @@ module KlaviyoAPI
|
|
|
487
491
|
# header parameters
|
|
488
492
|
header_params = opts[:header_params] || {}
|
|
489
493
|
# klaviyo api revision
|
|
490
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
494
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
491
495
|
# HTTP header 'Accept' (if needed)
|
|
492
496
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
493
497
|
|
|
@@ -520,30 +524,30 @@ module KlaviyoAPI
|
|
|
520
524
|
return data, status_code, headers
|
|
521
525
|
end
|
|
522
526
|
|
|
523
|
-
# Get Flow Actions
|
|
527
|
+
# Get Flow Flow Actions
|
|
524
528
|
# Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
525
529
|
# @param id [String]
|
|
526
530
|
# @param [Hash] opts the optional parameters
|
|
527
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
528
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
529
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
531
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
532
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-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`
|
|
533
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
|
|
530
534
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
531
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
535
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
|
532
536
|
# @return [Hash<String, Object>]
|
|
533
537
|
def get_flow_flow_actions(id, opts = {})
|
|
534
538
|
data, _status_code, _headers = get_flow_flow_actions_with_http_info(id, opts)
|
|
535
539
|
data
|
|
536
540
|
end
|
|
537
541
|
|
|
538
|
-
# Get Flow Actions
|
|
542
|
+
# Get Flow Flow Actions
|
|
539
543
|
# Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
540
544
|
# @param id [String]
|
|
541
545
|
# @param [Hash] opts the optional parameters
|
|
542
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
543
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
544
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
546
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
547
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-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`
|
|
548
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
|
|
545
549
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
546
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
550
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
|
547
551
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
548
552
|
def get_flow_flow_actions_with_http_info(id, opts = {})
|
|
549
553
|
if @api_client.config.debugging
|
|
@@ -583,7 +587,7 @@ module KlaviyoAPI
|
|
|
583
587
|
# header parameters
|
|
584
588
|
header_params = opts[:header_params] || {}
|
|
585
589
|
# klaviyo api revision
|
|
586
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
590
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
587
591
|
# HTTP header 'Accept' (if needed)
|
|
588
592
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
589
593
|
|
|
@@ -617,12 +621,13 @@ module KlaviyoAPI
|
|
|
617
621
|
end
|
|
618
622
|
|
|
619
623
|
# Get Flow Message
|
|
620
|
-
# Get the flow message of a flow with the given message ID.
|
|
624
|
+
# 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`
|
|
621
625
|
# @param id [String]
|
|
622
626
|
# @param [Hash] opts the optional parameters
|
|
623
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
624
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
625
|
-
# @option opts [Array<String>] :
|
|
627
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
628
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
629
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
630
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
|
|
626
631
|
# @return [Hash<String, Object>]
|
|
627
632
|
def get_flow_message(id, opts = {})
|
|
628
633
|
data, _status_code, _headers = get_flow_message_with_http_info(id, opts)
|
|
@@ -630,12 +635,13 @@ module KlaviyoAPI
|
|
|
630
635
|
end
|
|
631
636
|
|
|
632
637
|
# Get Flow Message
|
|
633
|
-
# Get the flow message of a flow with the given message ID.
|
|
638
|
+
# 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`
|
|
634
639
|
# @param id [String]
|
|
635
640
|
# @param [Hash] opts the optional parameters
|
|
636
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
637
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
638
|
-
# @option opts [Array<String>] :
|
|
641
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
642
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
643
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
644
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
|
|
639
645
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
640
646
|
def get_flow_message_with_http_info(id, opts = {})
|
|
641
647
|
if @api_client.config.debugging
|
|
@@ -653,7 +659,11 @@ module KlaviyoAPI
|
|
|
653
659
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
654
660
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
655
661
|
end
|
|
656
|
-
allowable_values = ["
|
|
662
|
+
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
|
663
|
+
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
|
664
|
+
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
|
665
|
+
end
|
|
666
|
+
allowable_values = ["flow-action", "template"]
|
|
657
667
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
658
668
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
659
669
|
end
|
|
@@ -664,12 +674,13 @@ module KlaviyoAPI
|
|
|
664
674
|
query_params = opts[:query_params] || {}
|
|
665
675
|
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
|
666
676
|
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
|
677
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
|
667
678
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
668
679
|
|
|
669
680
|
# header parameters
|
|
670
681
|
header_params = opts[:header_params] || {}
|
|
671
682
|
# klaviyo api revision
|
|
672
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
683
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
673
684
|
# HTTP header 'Accept' (if needed)
|
|
674
685
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
675
686
|
|
|
@@ -706,7 +717,7 @@ module KlaviyoAPI
|
|
|
706
717
|
# Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
707
718
|
# @param id [String]
|
|
708
719
|
# @param [Hash] opts the optional parameters
|
|
709
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
720
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
710
721
|
# @return [Hash<String, Object>]
|
|
711
722
|
def get_flow_message_action(id, opts = {})
|
|
712
723
|
data, _status_code, _headers = get_flow_message_action_with_http_info(id, opts)
|
|
@@ -717,7 +728,7 @@ module KlaviyoAPI
|
|
|
717
728
|
# Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
718
729
|
# @param id [String]
|
|
719
730
|
# @param [Hash] opts the optional parameters
|
|
720
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
731
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
721
732
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
722
733
|
def get_flow_message_action_with_http_info(id, opts = {})
|
|
723
734
|
if @api_client.config.debugging
|
|
@@ -741,7 +752,7 @@ module KlaviyoAPI
|
|
|
741
752
|
# header parameters
|
|
742
753
|
header_params = opts[:header_params] || {}
|
|
743
754
|
# klaviyo api revision
|
|
744
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
755
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
745
756
|
# HTTP header 'Accept' (if needed)
|
|
746
757
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
747
758
|
|
|
@@ -806,7 +817,7 @@ module KlaviyoAPI
|
|
|
806
817
|
# header parameters
|
|
807
818
|
header_params = opts[:header_params] || {}
|
|
808
819
|
# klaviyo api revision
|
|
809
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
820
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
810
821
|
# HTTP header 'Accept' (if needed)
|
|
811
822
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
812
823
|
|
|
@@ -839,13 +850,150 @@ module KlaviyoAPI
|
|
|
839
850
|
return data, status_code, headers
|
|
840
851
|
end
|
|
841
852
|
|
|
853
|
+
# Get Flow Message Relationships Template
|
|
854
|
+
# Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
|
855
|
+
# @param id [String]
|
|
856
|
+
# @param [Hash] opts the optional parameters
|
|
857
|
+
# @return [Hash<String, Object>]
|
|
858
|
+
def get_flow_message_relationships_template(id, opts = {})
|
|
859
|
+
data, _status_code, _headers = get_flow_message_relationships_template_with_http_info(id, opts)
|
|
860
|
+
data
|
|
861
|
+
end
|
|
862
|
+
|
|
863
|
+
# Get Flow Message Relationships Template
|
|
864
|
+
# Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
|
865
|
+
# @param id [String]
|
|
866
|
+
# @param [Hash] opts the optional parameters
|
|
867
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
868
|
+
def get_flow_message_relationships_template_with_http_info(id, opts = {})
|
|
869
|
+
if @api_client.config.debugging
|
|
870
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_message_relationships_template ...'
|
|
871
|
+
end
|
|
872
|
+
# verify the required parameter 'id' is set
|
|
873
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
874
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_message_relationships_template"
|
|
875
|
+
end
|
|
876
|
+
# resource path
|
|
877
|
+
local_var_path = '/api/flow-messages/{id}/relationships/template/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
878
|
+
|
|
879
|
+
# query parameters
|
|
880
|
+
query_params = opts[:query_params] || {}
|
|
881
|
+
|
|
882
|
+
# header parameters
|
|
883
|
+
header_params = opts[:header_params] || {}
|
|
884
|
+
# klaviyo api revision
|
|
885
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
886
|
+
# HTTP header 'Accept' (if needed)
|
|
887
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
888
|
+
|
|
889
|
+
# form parameters
|
|
890
|
+
form_params = opts[:form_params] || {}
|
|
891
|
+
|
|
892
|
+
# http body (model)
|
|
893
|
+
post_body = opts[:debug_body]
|
|
894
|
+
|
|
895
|
+
# return_type
|
|
896
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
897
|
+
|
|
898
|
+
# auth_names
|
|
899
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
|
900
|
+
|
|
901
|
+
new_options = opts.merge(
|
|
902
|
+
:operation => :"FlowsApi.get_flow_message_relationships_template",
|
|
903
|
+
:header_params => header_params,
|
|
904
|
+
:query_params => query_params,
|
|
905
|
+
:form_params => form_params,
|
|
906
|
+
:body => post_body,
|
|
907
|
+
:auth_names => auth_names,
|
|
908
|
+
:return_type => return_type
|
|
909
|
+
)
|
|
910
|
+
|
|
911
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
912
|
+
if @api_client.config.debugging
|
|
913
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_flow_message_relationships_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
914
|
+
end
|
|
915
|
+
return data, status_code, headers
|
|
916
|
+
end
|
|
917
|
+
|
|
918
|
+
# Get Flow Message Template
|
|
919
|
+
# Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
|
920
|
+
# @param id [String]
|
|
921
|
+
# @param [Hash] opts the optional parameters
|
|
922
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
923
|
+
# @return [Hash<String, Object>]
|
|
924
|
+
def get_flow_message_template(id, opts = {})
|
|
925
|
+
data, _status_code, _headers = get_flow_message_template_with_http_info(id, opts)
|
|
926
|
+
data
|
|
927
|
+
end
|
|
928
|
+
|
|
929
|
+
# Get Flow Message Template
|
|
930
|
+
# Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
|
931
|
+
# @param id [String]
|
|
932
|
+
# @param [Hash] opts the optional parameters
|
|
933
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
934
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
935
|
+
def get_flow_message_template_with_http_info(id, opts = {})
|
|
936
|
+
if @api_client.config.debugging
|
|
937
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_message_template ...'
|
|
938
|
+
end
|
|
939
|
+
# verify the required parameter 'id' is set
|
|
940
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
941
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_message_template"
|
|
942
|
+
end
|
|
943
|
+
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
|
944
|
+
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
|
945
|
+
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
|
946
|
+
end
|
|
947
|
+
# resource path
|
|
948
|
+
local_var_path = '/api/flow-messages/{id}/template/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
949
|
+
|
|
950
|
+
# query parameters
|
|
951
|
+
query_params = opts[:query_params] || {}
|
|
952
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
|
953
|
+
|
|
954
|
+
# header parameters
|
|
955
|
+
header_params = opts[:header_params] || {}
|
|
956
|
+
# klaviyo api revision
|
|
957
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
958
|
+
# HTTP header 'Accept' (if needed)
|
|
959
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
960
|
+
|
|
961
|
+
# form parameters
|
|
962
|
+
form_params = opts[:form_params] || {}
|
|
963
|
+
|
|
964
|
+
# http body (model)
|
|
965
|
+
post_body = opts[:debug_body]
|
|
966
|
+
|
|
967
|
+
# return_type
|
|
968
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
969
|
+
|
|
970
|
+
# auth_names
|
|
971
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
|
972
|
+
|
|
973
|
+
new_options = opts.merge(
|
|
974
|
+
:operation => :"FlowsApi.get_flow_message_template",
|
|
975
|
+
:header_params => header_params,
|
|
976
|
+
:query_params => query_params,
|
|
977
|
+
:form_params => form_params,
|
|
978
|
+
:body => post_body,
|
|
979
|
+
:auth_names => auth_names,
|
|
980
|
+
:return_type => return_type
|
|
981
|
+
)
|
|
982
|
+
|
|
983
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
984
|
+
if @api_client.config.debugging
|
|
985
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_flow_message_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
986
|
+
end
|
|
987
|
+
return data, status_code, headers
|
|
988
|
+
end
|
|
989
|
+
|
|
842
990
|
# Get Flow Relationships Flow Actions
|
|
843
|
-
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID.
|
|
991
|
+
# 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`
|
|
844
992
|
# @param id [String]
|
|
845
993
|
# @param [Hash] opts the optional parameters
|
|
846
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
994
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`action_type`: `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
847
995
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
|
848
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
996
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
|
849
997
|
# @return [Hash<String, Object>]
|
|
850
998
|
def get_flow_relationships_flow_actions(id, opts = {})
|
|
851
999
|
data, _status_code, _headers = get_flow_relationships_flow_actions_with_http_info(id, opts)
|
|
@@ -853,12 +1001,12 @@ module KlaviyoAPI
|
|
|
853
1001
|
end
|
|
854
1002
|
|
|
855
1003
|
# Get Flow Relationships Flow Actions
|
|
856
|
-
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID.
|
|
1004
|
+
# 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`
|
|
857
1005
|
# @param id [String]
|
|
858
1006
|
# @param [Hash] opts the optional parameters
|
|
859
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1007
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`action_type`: `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
860
1008
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
|
861
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1009
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
|
862
1010
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
863
1011
|
def get_flow_relationships_flow_actions_with_http_info(id, opts = {})
|
|
864
1012
|
if @api_client.config.debugging
|
|
@@ -892,7 +1040,7 @@ module KlaviyoAPI
|
|
|
892
1040
|
# header parameters
|
|
893
1041
|
header_params = opts[:header_params] || {}
|
|
894
1042
|
# klaviyo api revision
|
|
895
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1043
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
896
1044
|
# HTTP header 'Accept' (if needed)
|
|
897
1045
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
898
1046
|
|
|
@@ -957,7 +1105,7 @@ module KlaviyoAPI
|
|
|
957
1105
|
# header parameters
|
|
958
1106
|
header_params = opts[:header_params] || {}
|
|
959
1107
|
# klaviyo api revision
|
|
960
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1108
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
961
1109
|
# HTTP header 'Accept' (if needed)
|
|
962
1110
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
963
1111
|
|
|
@@ -994,7 +1142,7 @@ module KlaviyoAPI
|
|
|
994
1142
|
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
|
995
1143
|
# @param id [String]
|
|
996
1144
|
# @param [Hash] opts the optional parameters
|
|
997
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1145
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
998
1146
|
# @return [Hash<String, Object>]
|
|
999
1147
|
def get_flow_tags(id, opts = {})
|
|
1000
1148
|
data, _status_code, _headers = get_flow_tags_with_http_info(id, opts)
|
|
@@ -1005,7 +1153,7 @@ module KlaviyoAPI
|
|
|
1005
1153
|
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
|
1006
1154
|
# @param id [String]
|
|
1007
1155
|
# @param [Hash] opts the optional parameters
|
|
1008
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1156
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
1009
1157
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1010
1158
|
def get_flow_tags_with_http_info(id, opts = {})
|
|
1011
1159
|
if @api_client.config.debugging
|
|
@@ -1029,7 +1177,7 @@ module KlaviyoAPI
|
|
|
1029
1177
|
# header parameters
|
|
1030
1178
|
header_params = opts[:header_params] || {}
|
|
1031
1179
|
# klaviyo api revision
|
|
1032
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1180
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
1033
1181
|
# HTTP header 'Accept' (if needed)
|
|
1034
1182
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1035
1183
|
|
|
@@ -1065,13 +1213,14 @@ module KlaviyoAPI
|
|
|
1065
1213
|
# Get Flows
|
|
1066
1214
|
# 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`
|
|
1067
1215
|
# @param [Hash] opts the optional parameters
|
|
1068
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1069
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1070
|
-
# @option opts [String] :
|
|
1071
|
-
# @option opts [
|
|
1072
|
-
# @option opts [String] :
|
|
1216
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
1217
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
1218
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
1219
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-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`
|
|
1220
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
|
|
1221
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
|
|
1073
1222
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
1074
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1223
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
|
1075
1224
|
# @return [Hash<String, Object>]
|
|
1076
1225
|
def get_flows(opts = {})
|
|
1077
1226
|
data, _status_code, _headers = get_flows_with_http_info(opts)
|
|
@@ -1081,13 +1230,14 @@ module KlaviyoAPI
|
|
|
1081
1230
|
# Get Flows
|
|
1082
1231
|
# 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`
|
|
1083
1232
|
# @param [Hash] opts the optional parameters
|
|
1084
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1085
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1086
|
-
# @option opts [String] :
|
|
1087
|
-
# @option opts [
|
|
1088
|
-
# @option opts [String] :
|
|
1233
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
1234
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
1235
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
|
|
1236
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-08-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`
|
|
1237
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
|
|
1238
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
|
|
1089
1239
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
1090
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1240
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
|
|
1091
1241
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1092
1242
|
def get_flows_with_http_info(opts = {})
|
|
1093
1243
|
if @api_client.config.debugging
|
|
@@ -1101,7 +1251,11 @@ module KlaviyoAPI
|
|
|
1101
1251
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
1102
1252
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
1103
1253
|
end
|
|
1104
|
-
allowable_values = ["
|
|
1254
|
+
allowable_values = ["name"]
|
|
1255
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
1256
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
1257
|
+
end
|
|
1258
|
+
allowable_values = ["flow-actions", "tags"]
|
|
1105
1259
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
1106
1260
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
1107
1261
|
end
|
|
@@ -1124,6 +1278,7 @@ module KlaviyoAPI
|
|
|
1124
1278
|
query_params = opts[:query_params] || {}
|
|
1125
1279
|
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
|
1126
1280
|
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
|
1281
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
|
1127
1282
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
1128
1283
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
1129
1284
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
@@ -1133,7 +1288,7 @@ module KlaviyoAPI
|
|
|
1133
1288
|
# header parameters
|
|
1134
1289
|
header_params = opts[:header_params] || {}
|
|
1135
1290
|
# klaviyo api revision
|
|
1136
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1291
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
1137
1292
|
# HTTP header 'Accept' (if needed)
|
|
1138
1293
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1139
1294
|
|
|
@@ -1204,7 +1359,7 @@ module KlaviyoAPI
|
|
|
1204
1359
|
# header parameters
|
|
1205
1360
|
header_params = opts[:header_params] || {}
|
|
1206
1361
|
# klaviyo api revision
|
|
1207
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1362
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
|
|
1208
1363
|
# HTTP header 'Accept' (if needed)
|
|
1209
1364
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1210
1365
|
# HTTP header 'Content-Type'
|