klaviyo-api-sdk 4.0.0 → 4.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +9 -0
- data/README.md +457 -176
- data/Rakefile +10 -0
- data/docs/AccountsApi.md +157 -0
- data/docs/AudiencesSubObject.md +20 -0
- data/docs/BackInStockSubscriptionEnum.md +15 -0
- data/docs/CampaignCloneQuery.md +18 -0
- data/docs/CampaignCloneQueryResourceObject.md +22 -0
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignCreateQuery.md +18 -0
- data/docs/CampaignCreateQueryResourceObject.md +20 -0
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +28 -0
- data/docs/CampaignCreateQueryResourceObjectAttributesCampaignMessages.md +18 -0
- data/docs/CampaignCreateQueryResourceObjectAttributesSendOptions.md +49 -0
- data/docs/CampaignCreateQueryResourceObjectAttributesTrackingOptions.md +49 -0
- data/docs/CampaignEnum.md +15 -0
- data/docs/CampaignMessageAssignTemplateQuery.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +22 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationships.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate.md +18 -0
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplateData.md +20 -0
- data/docs/CampaignMessageCreateQueryResourceObject.md +20 -0
- data/docs/CampaignMessageCreateQueryResourceObjectAttributes.md +24 -0
- data/docs/CampaignMessageCreateQueryResourceObjectAttributesContent.md +49 -0
- data/docs/CampaignMessageEnum.md +15 -0
- data/docs/CampaignMessagePartialUpdateQuery.md +18 -0
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +22 -0
- data/docs/CampaignPartialUpdateQuery.md +18 -0
- data/docs/CampaignPartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +26 -0
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignRecipientEstimationJobEnum.md +15 -0
- data/docs/CampaignSendJobCreateQuery.md +18 -0
- data/docs/CampaignSendJobCreateQueryResourceObject.md +20 -0
- data/docs/CampaignSendJobEnum.md +15 -0
- data/docs/CampaignSendJobPartialUpdateQuery.md +18 -0
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +22 -0
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CampaignsApi.md +1735 -0
- data/docs/CatalogCategoryBulkCreateJobEnum.md +15 -0
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogCategoryCreateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributesCategories.md +18 -0
- data/docs/CatalogCategoryCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateQueryResourceObject.md +22 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +24 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItems.md +18 -0
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItemsDataInner.md +20 -0
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributesCategories.md +18 -0
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryEnum.md +15 -0
- data/docs/CatalogCategoryItemOp.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributesCategories.md +18 -0
- data/docs/CatalogCategoryUpdateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateQueryResourceObject.md +24 -0
- data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemBulkCreateJobEnum.md +15 -0
- data/docs/CatalogItemBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogItemBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogItemCategoryOp.md +18 -0
- data/docs/CatalogItemCreateJobCreateQuery.md +18 -0
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributesItems.md +18 -0
- data/docs/CatalogItemCreateQuery.md +18 -0
- data/docs/CatalogItemCreateQueryResourceObject.md +22 -0
- data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +40 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +18 -0
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributesItems.md +18 -0
- data/docs/CatalogItemDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogItemEnum.md +15 -0
- data/docs/CatalogItemUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributesItems.md +18 -0
- data/docs/CatalogItemUpdateQuery.md +18 -0
- data/docs/CatalogItemUpdateQueryResourceObject.md +24 -0
- data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +34 -0
- data/docs/CatalogVariantBulkCreateJobEnum.md +15 -0
- data/docs/CatalogVariantBulkDeleteJobEnum.md +15 -0
- data/docs/CatalogVariantBulkUpdateJobEnum.md +15 -0
- data/docs/CatalogVariantCreateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributesVariants.md +18 -0
- data/docs/CatalogVariantCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObject.md +22 -0
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +46 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItem.md +18 -0
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemData.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributesVariants.md +18 -0
- data/docs/CatalogVariantDeleteQueryResourceObject.md +20 -0
- data/docs/CatalogVariantEnum.md +15 -0
- data/docs/CatalogVariantUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributesVariants.md +18 -0
- data/docs/CatalogVariantUpdateQuery.md +18 -0
- data/docs/CatalogVariantUpdateQueryResourceObject.md +22 -0
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +40 -0
- data/docs/CatalogsApi.md +4103 -0
- data/docs/CouponCodeBulkCreateJobEnum.md +15 -0
- data/docs/CouponCodeCreateJobCreateQuery.md +18 -0
- data/docs/CouponCodeCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/CouponCodeCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/CouponCodeCreateJobCreateQueryResourceObjectAttributesCouponCodes.md +18 -0
- data/docs/CouponCodeCreateQuery.md +18 -0
- data/docs/CouponCodeCreateQueryResourceObject.md +22 -0
- data/docs/CouponCodeCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/CouponCodeCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/CouponCodeCreateQueryResourceObjectRelationshipsCoupon.md +18 -0
- data/docs/CouponCodeCreateQueryResourceObjectRelationshipsCouponData.md +20 -0
- data/docs/CouponCodeEnum.md +15 -0
- data/docs/CouponCodeUpdateQuery.md +18 -0
- data/docs/CouponCodeUpdateQueryResourceObject.md +22 -0
- data/docs/CouponCodeUpdateQueryResourceObjectAttributes.md +20 -0
- data/docs/CouponCreateQuery.md +18 -0
- data/docs/CouponCreateQueryResourceObject.md +20 -0
- data/docs/CouponCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/CouponEnum.md +15 -0
- data/docs/CouponUpdateQuery.md +18 -0
- data/docs/CouponUpdateQueryResourceObject.md +22 -0
- data/docs/CouponUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/CouponsApi.md +1277 -0
- data/docs/DataPrivacyApi.md +78 -0
- data/docs/DataPrivacyCreateDeletionJobQuery.md +18 -0
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +20 -0
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +18 -0
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributesProfile.md +18 -0
- data/docs/DataPrivacyDeletionJobEnum.md +15 -0
- data/docs/DataPrivacyProfileQueryResourceObject.md +22 -0
- data/docs/DataPrivacyProfileQueryResourceObjectAttributes.md +20 -0
- data/docs/DeviceMetadata.md +40 -0
- data/docs/EmailContentSubObject.md +30 -0
- data/docs/EmailSendOptionsSubObject.md +18 -0
- data/docs/EmailTrackingOptionsSubObject.md +24 -0
- data/docs/EventCreateQueryV2.md +18 -0
- data/docs/EventCreateQueryV2ResourceObject.md +20 -0
- data/docs/EventCreateQueryV2ResourceObjectAttributes.md +28 -0
- data/docs/EventCreateQueryV2ResourceObjectAttributesMetric.md +18 -0
- data/docs/EventCreateQueryV2ResourceObjectAttributesProfile.md +18 -0
- data/docs/EventEnum.md +15 -0
- data/docs/EventsApi.md +544 -0
- data/docs/FlowEnum.md +15 -0
- data/docs/FlowUpdateQuery.md +18 -0
- data/docs/FlowUpdateQueryResourceObject.md +22 -0
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/FlowsApi.md +1335 -0
- data/docs/GetAccounts4XXResponse.md +18 -0
- data/docs/GetAccounts4XXResponseErrorsInner.md +26 -0
- data/docs/GetAccounts4XXResponseErrorsInnerSource.md +20 -0
- data/docs/ImageCreateQuery.md +18 -0
- data/docs/ImageCreateQueryResourceObject.md +20 -0
- data/docs/ImageCreateQueryResourceObjectAttributes.md +22 -0
- data/docs/ImageEnum.md +15 -0
- data/docs/ImagePartialUpdateQuery.md +18 -0
- data/docs/ImagePartialUpdateQueryResourceObject.md +22 -0
- data/docs/ImagePartialUpdateQueryResourceObjectAttributes.md +20 -0
- data/docs/ImagesApi.md +389 -0
- data/docs/ListCreateQuery.md +18 -0
- data/docs/ListCreateQueryResourceObject.md +20 -0
- data/docs/ListCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/ListEnum.md +15 -0
- data/docs/ListMembersAddQuery.md +18 -0
- data/docs/ListMembersAddQueryDataInner.md +20 -0
- data/docs/ListMembersDeleteQuery.md +18 -0
- data/docs/ListPartialUpdateQuery.md +18 -0
- data/docs/ListPartialUpdateQueryResourceObject.md +22 -0
- data/docs/ListsApi.md +850 -0
- data/docs/MetricAggregateEnum.md +15 -0
- data/docs/MetricAggregateQuery.md +18 -0
- data/docs/MetricAggregateQueryResourceObject.md +20 -0
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +36 -0
- data/docs/MetricCreateQueryResourceObject.md +20 -0
- data/docs/MetricCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/MetricEnum.md +15 -0
- data/docs/MetricsApi.md +233 -0
- data/docs/OnsiteProfileCreateQueryResourceObject.md +24 -0
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +40 -0
- data/docs/OnsiteProfileMeta.md +18 -0
- data/docs/ProfileCreateQuery.md +18 -0
- data/docs/ProfileCreateQueryResourceObject.md +20 -0
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +36 -0
- data/docs/ProfileEnum.md +15 -0
- data/docs/ProfileIdentifierDTOResourceObject.md +22 -0
- data/docs/ProfileIdentifierDTOResourceObjectAttributes.md +24 -0
- data/docs/ProfileLocation.md +34 -0
- data/docs/ProfileLocationLatitude.md +49 -0
- data/docs/ProfileLocationLongitude.md +49 -0
- data/docs/ProfileMergeEnum.md +15 -0
- data/docs/ProfileMergeQuery.md +18 -0
- data/docs/ProfileMergeQueryResourceObject.md +22 -0
- data/docs/ProfileMergeQueryResourceObjectRelationships.md +18 -0
- data/docs/ProfileMergeQueryResourceObjectRelationshipsProfiles.md +18 -0
- data/docs/ProfileMergeQueryResourceObjectRelationshipsProfilesDataInner.md +20 -0
- data/docs/ProfileMeta.md +18 -0
- data/docs/ProfileMetaPatchProperties.md +22 -0
- data/docs/ProfileMetaPatchPropertiesUnset.md +49 -0
- data/docs/ProfilePartialUpdateQuery.md +18 -0
- data/docs/ProfilePartialUpdateQueryResourceObject.md +24 -0
- data/docs/ProfilePartialUpdateQueryResourceObjectAttributes.md +38 -0
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileSubscriptionBulkDeleteJobEnum.md +15 -0
- data/docs/ProfileSubscriptionCreateQueryResourceObject.md +22 -0
- data/docs/ProfileSubscriptionCreateQueryResourceObjectAttributes.md +22 -0
- data/docs/ProfileSubscriptionDeleteQueryResourceObject.md +20 -0
- data/docs/ProfileSubscriptionDeleteQueryResourceObjectAttributes.md +20 -0
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +15 -0
- data/docs/ProfileSuppressionBulkDeleteJobEnum.md +15 -0
- data/docs/ProfileSuppressionCreateQueryResourceObject.md +20 -0
- data/docs/ProfileSuppressionCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/ProfileSuppressionDeleteQueryResourceObject.md +20 -0
- data/docs/ProfileSuppressionDeleteQueryResourceObjectAttributes.md +18 -0
- data/docs/ProfileUpsertQueryResourceObject.md +22 -0
- data/docs/ProfileUpsertQueryResourceObjectAttributes.md +40 -0
- data/docs/ProfilesApi.md +1044 -0
- data/docs/PushTokenCreateQuery.md +18 -0
- data/docs/PushTokenCreateQueryResourceObject.md +20 -0
- data/docs/PushTokenCreateQueryResourceObjectAttributes.md +30 -0
- data/docs/PushTokenCreateQueryResourceObjectAttributesProfile.md +18 -0
- data/docs/PushTokenEnum.md +15 -0
- data/docs/RenderOptionsSubObject.md +24 -0
- data/docs/SMSContentSubObjectCreate.md +18 -0
- data/docs/SMSSendOptionsSubObject.md +18 -0
- data/docs/SMSTrackingOptionsSubObject.md +20 -0
- data/docs/STOScheduleOptions.md +18 -0
- data/docs/SegmentEnum.md +15 -0
- data/docs/SegmentPartialUpdateQuery.md +18 -0
- data/docs/SegmentPartialUpdateQueryResourceObject.md +22 -0
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +18 -0
- data/docs/SegmentsApi.md +561 -0
- data/docs/SendStrategySubObject.md +24 -0
- data/docs/ServerBISSubscriptionCreateQuery.md +18 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObject.md +22 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributesProfile.md +18 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant.md +18 -0
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariantData.md +20 -0
- data/docs/StaticScheduleOptions.md +22 -0
- data/docs/SubscriptionChannels.md +20 -0
- data/docs/SubscriptionCreateJobCreateQuery.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +22 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
- data/docs/SubscriptionDeleteJobCreateQuery.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObject.md +22 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsList.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
- data/docs/SuppressionCreateJobCreateQuery.md +18 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +20 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/SuppressionDeleteJobCreateQuery.md +18 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObject.md +20 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
- data/docs/TagCampaignOp.md +18 -0
- data/docs/TagCampaignOpDataInner.md +20 -0
- data/docs/TagCreateQuery.md +18 -0
- data/docs/TagCreateQueryResourceObject.md +22 -0
- data/docs/TagCreateQueryResourceObjectAttributes.md +18 -0
- data/docs/TagCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/TagCreateQueryResourceObjectRelationshipsTagGroup.md +18 -0
- data/docs/TagCreateQueryResourceObjectRelationshipsTagGroupData.md +20 -0
- data/docs/TagEnum.md +15 -0
- data/docs/TagFlowOp.md +18 -0
- data/docs/TagFlowOpDataInner.md +20 -0
- data/docs/TagGroupCreateQuery.md +18 -0
- data/docs/TagGroupCreateQueryResourceObject.md +20 -0
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagGroupEnum.md +15 -0
- data/docs/TagGroupUpdateQuery.md +18 -0
- data/docs/TagGroupUpdateQueryResourceObject.md +22 -0
- data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +20 -0
- data/docs/TagListOp.md +18 -0
- data/docs/TagListOpDataInner.md +20 -0
- data/docs/TagSegmentOp.md +18 -0
- data/docs/TagSegmentOpDataInner.md +20 -0
- data/docs/TagUpdateQuery.md +18 -0
- data/docs/TagUpdateQueryResourceObject.md +22 -0
- data/docs/TagsApi.md +1929 -0
- data/docs/TemplateCloneQuery.md +18 -0
- data/docs/TemplateCloneQueryResourceObject.md +22 -0
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +18 -0
- data/docs/TemplateCreateQuery.md +18 -0
- data/docs/TemplateCreateQueryResourceObject.md +20 -0
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +30 -0
- data/docs/TemplateEnum.md +15 -0
- data/docs/TemplateRenderQuery.md +18 -0
- data/docs/TemplateRenderQueryResourceObject.md +22 -0
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +18 -0
- data/docs/TemplateUpdateQuery.md +18 -0
- data/docs/TemplateUpdateQueryResourceObject.md +22 -0
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +28 -0
- data/docs/TemplatesApi.md +524 -0
- data/docs/ThrottledScheduleOptions.md +20 -0
- data/docs/UTMParamsSubObject.md +20 -0
- data/git_push.sh +57 -0
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +9 -9
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +85 -85
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +309 -309
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +1226 -0
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +40 -40
- data/lib/klaviyo-api-sdk/api/flows_api.rb +235 -91
- data/lib/klaviyo-api-sdk/api/images_api.rb +407 -0
- data/lib/klaviyo-api-sdk/api/lists_api.rb +77 -49
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +189 -49
- data/lib/klaviyo-api-sdk/api/segments_api.rb +69 -41
- data/lib/klaviyo-api-sdk/api/tags_api.rb +89 -89
- data/lib/klaviyo-api-sdk/api/templates_api.rb +24 -24
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +34 -19
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +5 -20
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +28 -28
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +26 -25
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +3 -36
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +23 -23
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +20 -19
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +20 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +17 -17
- data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships.rb → catalog_category_create_query_resource_object_relationships.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships_items.rb → catalog_category_create_query_resource_object_relationships_items.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships_items_data_inner.rb → catalog_category_create_query_resource_object_relationships_items_data_inner.rb} +6 -39
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +72 -72
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +43 -43
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +118 -116
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +58 -58
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/{campaign_send_job_create_query_resource_object_attributes.rb → coupon_code_create_job_create_query.rb} +14 -15
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +227 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +247 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +224 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_assign_template_query_resource_object_attributes.rb → coupon_code_create_query_resource_object_relationships_coupon_data.rb} +19 -6
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/{catalog_item_category_op_data_inner.rb → coupon_code_update_query_resource_object.rb} +23 -42
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +264 -0
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +220 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +388 -0
- data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +39 -9
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +22 -22
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +41 -41
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response.rb → get_accounts4_xx_response.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response_errors_inner.rb → get_accounts4_xx_response_errors_inner.rb} +40 -40
- data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response_errors_inner_source.rb → get_accounts4_xx_response_errors_inner_source.rb} +17 -17
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +247 -0
- data/lib/klaviyo-api-sdk/models/image_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +2 -36
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +63 -63
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +55 -55
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +39 -39
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +12 -12
- data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +226 -0
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +239 -0
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +15 -15
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +45 -45
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +12 -12
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +248 -0
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +328 -0
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +372 -0
- data/lib/klaviyo-api-sdk/models/{campaign_recipient_estimation_job_create_query_resource_object_attributes.rb → push_token_create_query_resource_object_attributes_profile.rb} +15 -15
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +17 -24
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +3 -36
- data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +15 -15
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +3 -36
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +3 -36
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +20 -20
- data/lib/klaviyo-api-sdk/models/{tag_update_query_resource_object_attributes.rb → tag_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +3 -36
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +3 -36
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +16 -14
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +3 -36
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +3 -36
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +34 -19
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +2 -17
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +25 -25
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +34 -19
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +3 -18
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -16
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +58 -12
- data/spec/api/accounts_api_spec.rb +60 -0
- data/spec/api/campaigns_api_spec.rb +338 -0
- data/spec/api/catalogs_api_spec.rb +763 -0
- data/spec/api/coupons_api_spec.rb +254 -0
- data/spec/api/data_privacy_api_spec.rb +47 -0
- data/spec/api/events_api_spec.rb +132 -0
- data/spec/api/flows_api_spec.rb +279 -0
- data/spec/api/images_api_spec.rb +103 -0
- data/spec/api/lists_api_spec.rb +189 -0
- data/spec/api/metrics_api_spec.rb +74 -0
- data/spec/api/profiles_api_spec.rb +216 -0
- data/spec/api/segments_api_spec.rb +139 -0
- data/spec/api/tags_api_spec.rb +371 -0
- data/spec/api/templates_api_spec.rb +124 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/audiences_sub_object_spec.rb +40 -0
- data/spec/models/back_in_stock_subscription_enum_spec.rb +28 -0
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_clone_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_clone_query_spec.rb +34 -0
- data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +34 -0
- data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +31 -0
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +64 -0
- data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +31 -0
- data/spec/models/campaign_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_create_query_spec.rb +34 -0
- data/spec/models/campaign_enum_spec.rb +28 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +40 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +34 -0
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_message_assign_template_query_spec.rb +34 -0
- data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +31 -0
- data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +52 -0
- data/spec/models/campaign_message_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_message_enum_spec.rb +28 -0
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_message_partial_update_query_spec.rb +34 -0
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +58 -0
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_partial_update_query_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +28 -0
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/campaign_send_job_create_query_spec.rb +34 -0
- data/spec/models/campaign_send_job_enum_spec.rb +28 -0
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +34 -0
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +56 -0
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_data_inner_spec.rb +40 -0
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +34 -0
- data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_category_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_enum_spec.rb +28 -0
- data/spec/models/catalog_category_item_op_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_category_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +52 -0
- data/spec/models/catalog_category_update_query_spec.rb +34 -0
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_item_category_op_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +40 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_item_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_enum_spec.rb +28 -0
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +34 -0
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_item_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +82 -0
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +52 -0
- data/spec/models/catalog_item_update_query_spec.rb +34 -0
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +34 -0
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +126 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +40 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_variant_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_enum_spec.rb +28 -0
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +34 -0
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +46 -0
- data/spec/models/catalog_variant_update_query_spec.rb +34 -0
- data/spec/models/coupon_code_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes_spec.rb +34 -0
- data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/coupon_code_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/coupon_code_create_job_create_query_spec.rb +34 -0
- data/spec/models/coupon_code_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_data_spec.rb +40 -0
- data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_spec.rb +34 -0
- data/spec/models/coupon_code_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/coupon_code_create_query_resource_object_spec.rb +46 -0
- data/spec/models/coupon_code_create_query_spec.rb +34 -0
- data/spec/models/coupon_code_enum_spec.rb +28 -0
- data/spec/models/coupon_code_update_query_resource_object_attributes_spec.rb +44 -0
- data/spec/models/coupon_code_update_query_resource_object_spec.rb +46 -0
- data/spec/models/coupon_code_update_query_spec.rb +34 -0
- data/spec/models/coupon_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/coupon_create_query_resource_object_spec.rb +40 -0
- data/spec/models/coupon_create_query_spec.rb +34 -0
- data/spec/models/coupon_enum_spec.rb +28 -0
- data/spec/models/coupon_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/coupon_update_query_resource_object_spec.rb +46 -0
- data/spec/models/coupon_update_query_spec.rb +34 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +40 -0
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +34 -0
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +28 -0
- data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/data_privacy_profile_query_resource_object_spec.rb +46 -0
- data/spec/models/device_metadata_spec.rb +112 -0
- data/spec/models/email_content_sub_object_spec.rb +70 -0
- data/spec/models/email_send_options_sub_object_spec.rb +34 -0
- data/spec/models/email_tracking_options_sub_object_spec.rb +52 -0
- data/spec/models/event_create_query_v2_resource_object_attributes_metric_spec.rb +34 -0
- data/spec/models/event_create_query_v2_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/event_create_query_v2_resource_object_attributes_spec.rb +64 -0
- data/spec/models/event_create_query_v2_resource_object_spec.rb +40 -0
- data/spec/models/event_create_query_v2_spec.rb +34 -0
- data/spec/models/event_enum_spec.rb +28 -0
- data/spec/models/flow_enum_spec.rb +28 -0
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/flow_update_query_resource_object_spec.rb +46 -0
- data/spec/models/flow_update_query_spec.rb +34 -0
- data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +40 -0
- data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +58 -0
- data/spec/models/get_accounts4_xx_response_spec.rb +34 -0
- data/spec/models/image_create_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/image_create_query_resource_object_spec.rb +40 -0
- data/spec/models/image_create_query_spec.rb +34 -0
- data/spec/models/image_enum_spec.rb +28 -0
- data/spec/models/image_partial_update_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/image_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/image_partial_update_query_spec.rb +34 -0
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/list_create_query_resource_object_spec.rb +40 -0
- data/spec/models/list_create_query_spec.rb +34 -0
- data/spec/models/list_enum_spec.rb +28 -0
- data/spec/models/list_members_add_query_data_inner_spec.rb +40 -0
- data/spec/models/list_members_add_query_spec.rb +34 -0
- data/spec/models/list_members_delete_query_spec.rb +34 -0
- data/spec/models/list_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/list_partial_update_query_spec.rb +34 -0
- data/spec/models/metric_aggregate_enum_spec.rb +28 -0
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +104 -0
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +40 -0
- data/spec/models/metric_aggregate_query_spec.rb +34 -0
- data/spec/models/metric_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/metric_create_query_resource_object_spec.rb +40 -0
- data/spec/models/metric_enum_spec.rb +28 -0
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +100 -0
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +52 -0
- data/spec/models/onsite_profile_meta_spec.rb +34 -0
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +88 -0
- data/spec/models/profile_create_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_create_query_spec.rb +34 -0
- data/spec/models/profile_enum_spec.rb +28 -0
- data/spec/models/profile_identifier_dto_resource_object_attributes_spec.rb +52 -0
- data/spec/models/profile_identifier_dto_resource_object_spec.rb +46 -0
- data/spec/models/profile_location_latitude_spec.rb +31 -0
- data/spec/models/profile_location_longitude_spec.rb +31 -0
- data/spec/models/profile_location_spec.rb +82 -0
- data/spec/models/profile_merge_enum_spec.rb +28 -0
- data/spec/models/profile_merge_query_resource_object_relationships_profiles_data_inner_spec.rb +40 -0
- data/spec/models/profile_merge_query_resource_object_relationships_profiles_spec.rb +34 -0
- data/spec/models/profile_merge_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/profile_merge_query_resource_object_spec.rb +46 -0
- data/spec/models/profile_merge_query_spec.rb +34 -0
- data/spec/models/profile_meta_patch_properties_spec.rb +46 -0
- data/spec/models/profile_meta_patch_properties_unset_spec.rb +31 -0
- data/spec/models/profile_meta_spec.rb +34 -0
- data/spec/models/profile_partial_update_query_resource_object_attributes_spec.rb +94 -0
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +52 -0
- data/spec/models/profile_partial_update_query_spec.rb +34 -0
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/profile_subscription_create_query_resource_object_spec.rb +46 -0
- data/spec/models/profile_subscription_delete_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/profile_subscription_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +28 -0
- data/spec/models/profile_suppression_bulk_delete_job_enum_spec.rb +28 -0
- data/spec/models/profile_suppression_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/profile_suppression_create_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_suppression_delete_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/profile_suppression_delete_query_resource_object_spec.rb +40 -0
- data/spec/models/profile_upsert_query_resource_object_attributes_spec.rb +100 -0
- data/spec/models/profile_upsert_query_resource_object_spec.rb +46 -0
- data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +86 -0
- data/spec/models/push_token_create_query_resource_object_spec.rb +40 -0
- data/spec/models/push_token_create_query_spec.rb +34 -0
- data/spec/models/push_token_enum_spec.rb +28 -0
- data/spec/models/render_options_sub_object_spec.rb +52 -0
- data/spec/models/segment_enum_spec.rb +28 -0
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +46 -0
- data/spec/models/segment_partial_update_query_spec.rb +34 -0
- data/spec/models/send_strategy_sub_object_spec.rb +52 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +34 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +44 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +40 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +34 -0
- data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +46 -0
- data/spec/models/server_bis_subscription_create_query_spec.rb +34 -0
- data/spec/models/sms_content_sub_object_create_spec.rb +34 -0
- data/spec/models/sms_send_options_sub_object_spec.rb +34 -0
- data/spec/models/sms_tracking_options_sub_object_spec.rb +40 -0
- data/spec/models/static_schedule_options_spec.rb +46 -0
- data/spec/models/sto_schedule_options_spec.rb +34 -0
- data/spec/models/subscription_channels_spec.rb +48 -0
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +34 -0
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_data_spec.rb +40 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/subscription_delete_job_create_query_resource_object_spec.rb +46 -0
- data/spec/models/subscription_delete_job_create_query_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_spec.rb +34 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/suppression_delete_job_create_query_resource_object_spec.rb +40 -0
- data/spec/models/suppression_delete_job_create_query_spec.rb +34 -0
- data/spec/models/tag_campaign_op_data_inner_spec.rb +40 -0
- data/spec/models/tag_campaign_op_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_relationships_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_relationships_tag_group_data_spec.rb +40 -0
- data/spec/models/tag_create_query_resource_object_relationships_tag_group_spec.rb +34 -0
- data/spec/models/tag_create_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_create_query_spec.rb +34 -0
- data/spec/models/tag_enum_spec.rb +28 -0
- data/spec/models/tag_flow_op_data_inner_spec.rb +40 -0
- data/spec/models/tag_flow_op_spec.rb +34 -0
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_group_create_query_resource_object_spec.rb +40 -0
- data/spec/models/tag_group_create_query_spec.rb +34 -0
- data/spec/models/tag_group_enum_spec.rb +28 -0
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +40 -0
- data/spec/models/tag_group_update_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_group_update_query_spec.rb +34 -0
- data/spec/models/tag_list_op_data_inner_spec.rb +40 -0
- data/spec/models/tag_list_op_spec.rb +34 -0
- data/spec/models/tag_segment_op_data_inner_spec.rb +40 -0
- data/spec/models/tag_segment_op_spec.rb +34 -0
- data/spec/models/tag_update_query_resource_object_spec.rb +46 -0
- data/spec/models/tag_update_query_spec.rb +34 -0
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/template_clone_query_resource_object_spec.rb +46 -0
- data/spec/models/template_clone_query_spec.rb +34 -0
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +52 -0
- data/spec/models/template_create_query_resource_object_spec.rb +40 -0
- data/spec/models/template_create_query_spec.rb +34 -0
- data/spec/models/template_enum_spec.rb +28 -0
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +34 -0
- data/spec/models/template_render_query_resource_object_spec.rb +46 -0
- data/spec/models/template_render_query_spec.rb +34 -0
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +46 -0
- data/spec/models/template_update_query_resource_object_spec.rb +46 -0
- data/spec/models/template_update_query_spec.rb +34 -0
- data/spec/models/throttled_schedule_options_spec.rb +40 -0
- data/spec/models/utm_params_sub_object_spec.rb +40 -0
- data/spec/spec_helper.rb +111 -0
- metadata +714 -18
- data/CHANGELOG.md +0 -91
|
@@ -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-09-15
|
|
7
7
|
Contact: developers@klaviyo.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.2.1
|
|
@@ -23,7 +23,7 @@ module KlaviyoAPI
|
|
|
23
23
|
# Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
|
|
24
24
|
# @param id [String] The ID of the account
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
|
-
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
26
|
+
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
27
27
|
# @return [Hash<String, Object>]
|
|
28
28
|
def get_account(id, opts = {})
|
|
29
29
|
data, _status_code, _headers = get_account_with_http_info(id, opts)
|
|
@@ -34,7 +34,7 @@ module KlaviyoAPI
|
|
|
34
34
|
# Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
|
|
35
35
|
# @param id [String] The ID of the account
|
|
36
36
|
# @param [Hash] opts the optional parameters
|
|
37
|
-
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
37
|
+
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
38
38
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
39
39
|
def get_account_with_http_info(id, opts = {})
|
|
40
40
|
if @api_client.config.debugging
|
|
@@ -58,7 +58,7 @@ module KlaviyoAPI
|
|
|
58
58
|
# header parameters
|
|
59
59
|
header_params = opts[:header_params] || {}
|
|
60
60
|
# klaviyo api revision
|
|
61
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
61
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
62
62
|
# HTTP header 'Accept' (if needed)
|
|
63
63
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
64
64
|
|
|
@@ -92,9 +92,9 @@ module KlaviyoAPI
|
|
|
92
92
|
end
|
|
93
93
|
|
|
94
94
|
# Get Accounts
|
|
95
|
-
# Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.
|
|
95
|
+
# Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
|
|
96
96
|
# @param [Hash] opts the optional parameters
|
|
97
|
-
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
97
|
+
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
98
98
|
# @return [Hash<String, Object>]
|
|
99
99
|
def get_accounts(opts = {})
|
|
100
100
|
data, _status_code, _headers = get_accounts_with_http_info(opts)
|
|
@@ -102,9 +102,9 @@ module KlaviyoAPI
|
|
|
102
102
|
end
|
|
103
103
|
|
|
104
104
|
# Get Accounts
|
|
105
|
-
# Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.
|
|
105
|
+
# Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
|
|
106
106
|
# @param [Hash] opts the optional parameters
|
|
107
|
-
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
107
|
+
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
108
108
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
109
109
|
def get_accounts_with_http_info(opts = {})
|
|
110
110
|
if @api_client.config.debugging
|
|
@@ -124,7 +124,7 @@ module KlaviyoAPI
|
|
|
124
124
|
# header parameters
|
|
125
125
|
header_params = opts[:header_params] || {}
|
|
126
126
|
# klaviyo api revision
|
|
127
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
127
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
128
128
|
# HTTP header 'Accept' (if needed)
|
|
129
129
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
130
130
|
|
|
@@ -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-09-15
|
|
7
7
|
Contact: developers@klaviyo.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.2.1
|
|
@@ -51,7 +51,7 @@ module KlaviyoAPI
|
|
|
51
51
|
# header parameters
|
|
52
52
|
header_params = opts[:header_params] || {}
|
|
53
53
|
# klaviyo api revision
|
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
54
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
55
55
|
# HTTP header 'Accept' (if needed)
|
|
56
56
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
57
57
|
# HTTP header 'Content-Type'
|
|
@@ -121,7 +121,7 @@ module KlaviyoAPI
|
|
|
121
121
|
# header parameters
|
|
122
122
|
header_params = opts[:header_params] || {}
|
|
123
123
|
# klaviyo api revision
|
|
124
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
124
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
125
125
|
# HTTP header 'Accept' (if needed)
|
|
126
126
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
127
127
|
# HTTP header 'Content-Type'
|
|
@@ -191,7 +191,7 @@ module KlaviyoAPI
|
|
|
191
191
|
# header parameters
|
|
192
192
|
header_params = opts[:header_params] || {}
|
|
193
193
|
# klaviyo api revision
|
|
194
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
194
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
195
195
|
# HTTP header 'Accept' (if needed)
|
|
196
196
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
197
197
|
# HTTP header 'Content-Type'
|
|
@@ -261,7 +261,7 @@ module KlaviyoAPI
|
|
|
261
261
|
# header parameters
|
|
262
262
|
header_params = opts[:header_params] || {}
|
|
263
263
|
# klaviyo api revision
|
|
264
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
264
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
265
265
|
# HTTP header 'Accept' (if needed)
|
|
266
266
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
267
267
|
# HTTP header 'Content-Type'
|
|
@@ -331,7 +331,7 @@ module KlaviyoAPI
|
|
|
331
331
|
# header parameters
|
|
332
332
|
header_params = opts[:header_params] || {}
|
|
333
333
|
# klaviyo api revision
|
|
334
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
334
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
335
335
|
# HTTP header 'Accept' (if needed)
|
|
336
336
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
337
337
|
# HTTP header 'Content-Type'
|
|
@@ -401,7 +401,7 @@ module KlaviyoAPI
|
|
|
401
401
|
# header parameters
|
|
402
402
|
header_params = opts[:header_params] || {}
|
|
403
403
|
# klaviyo api revision
|
|
404
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
404
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
405
405
|
# HTTP header 'Accept' (if needed)
|
|
406
406
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
407
407
|
|
|
@@ -438,10 +438,10 @@ module KlaviyoAPI
|
|
|
438
438
|
# Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
439
439
|
# @param id [String] The campaign ID to be retrieved
|
|
440
440
|
# @param [Hash] opts the optional parameters
|
|
441
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
442
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
443
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
444
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
441
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
442
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
443
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
444
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
|
|
445
445
|
# @return [Hash<String, Object>]
|
|
446
446
|
def get_campaign(id, opts = {})
|
|
447
447
|
data, _status_code, _headers = get_campaign_with_http_info(id, opts)
|
|
@@ -452,10 +452,10 @@ module KlaviyoAPI
|
|
|
452
452
|
# Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
453
453
|
# @param id [String] The campaign ID to be retrieved
|
|
454
454
|
# @param [Hash] opts the optional parameters
|
|
455
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
456
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
457
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
458
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
455
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
456
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
457
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
458
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
|
|
459
459
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
460
460
|
def get_campaign_with_http_info(id, opts = {})
|
|
461
461
|
if @api_client.config.debugging
|
|
@@ -465,7 +465,7 @@ module KlaviyoAPI
|
|
|
465
465
|
if @api_client.config.client_side_validation && id.nil?
|
|
466
466
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign"
|
|
467
467
|
end
|
|
468
|
-
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "
|
|
468
|
+
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "created_at", "updated_at"]
|
|
469
469
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
|
470
470
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
|
471
471
|
end
|
|
@@ -494,7 +494,7 @@ module KlaviyoAPI
|
|
|
494
494
|
# header parameters
|
|
495
495
|
header_params = opts[:header_params] || {}
|
|
496
496
|
# klaviyo api revision
|
|
497
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
497
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
498
498
|
# HTTP header 'Accept' (if needed)
|
|
499
499
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
500
500
|
|
|
@@ -531,10 +531,10 @@ module KlaviyoAPI
|
|
|
531
531
|
# Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
532
532
|
# @param id [String]
|
|
533
533
|
# @param [Hash] opts the optional parameters
|
|
534
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
535
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
536
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
537
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
534
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
535
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
536
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
537
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
|
|
538
538
|
# @return [Hash<String, Object>]
|
|
539
539
|
def get_campaign_campaign_messages(id, opts = {})
|
|
540
540
|
data, _status_code, _headers = get_campaign_campaign_messages_with_http_info(id, opts)
|
|
@@ -545,10 +545,10 @@ module KlaviyoAPI
|
|
|
545
545
|
# Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
546
546
|
# @param id [String]
|
|
547
547
|
# @param [Hash] opts the optional parameters
|
|
548
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
549
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
550
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
551
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
548
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
549
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
550
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
551
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
|
|
552
552
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
553
553
|
def get_campaign_campaign_messages_with_http_info(id, opts = {})
|
|
554
554
|
if @api_client.config.debugging
|
|
@@ -558,7 +558,7 @@ module KlaviyoAPI
|
|
|
558
558
|
if @api_client.config.client_side_validation && id.nil?
|
|
559
559
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_campaign_messages"
|
|
560
560
|
end
|
|
561
|
-
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "
|
|
561
|
+
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "created_at", "updated_at"]
|
|
562
562
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
|
563
563
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
|
564
564
|
end
|
|
@@ -587,7 +587,7 @@ module KlaviyoAPI
|
|
|
587
587
|
# header parameters
|
|
588
588
|
header_params = opts[:header_params] || {}
|
|
589
589
|
# klaviyo api revision
|
|
590
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
590
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
591
591
|
# HTTP header 'Accept' (if needed)
|
|
592
592
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
593
593
|
|
|
@@ -624,10 +624,10 @@ module KlaviyoAPI
|
|
|
624
624
|
# Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
625
625
|
# @param id [String] The message ID to be retrieved
|
|
626
626
|
# @param [Hash] opts the optional parameters
|
|
627
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
628
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
629
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
630
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
627
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
628
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
629
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
630
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
|
|
631
631
|
# @return [Hash<String, Object>]
|
|
632
632
|
def get_campaign_message(id, opts = {})
|
|
633
633
|
data, _status_code, _headers = get_campaign_message_with_http_info(id, opts)
|
|
@@ -638,10 +638,10 @@ module KlaviyoAPI
|
|
|
638
638
|
# Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
639
639
|
# @param id [String] The message ID to be retrieved
|
|
640
640
|
# @param [Hash] opts the optional parameters
|
|
641
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
642
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
643
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
644
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
641
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
642
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
643
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
644
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
|
|
645
645
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
646
646
|
def get_campaign_message_with_http_info(id, opts = {})
|
|
647
647
|
if @api_client.config.debugging
|
|
@@ -651,7 +651,7 @@ module KlaviyoAPI
|
|
|
651
651
|
if @api_client.config.client_side_validation && id.nil?
|
|
652
652
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message"
|
|
653
653
|
end
|
|
654
|
-
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "
|
|
654
|
+
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "created_at", "updated_at"]
|
|
655
655
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
|
656
656
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
|
657
657
|
end
|
|
@@ -680,7 +680,7 @@ module KlaviyoAPI
|
|
|
680
680
|
# header parameters
|
|
681
681
|
header_params = opts[:header_params] || {}
|
|
682
682
|
# klaviyo api revision
|
|
683
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
683
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
684
684
|
# HTTP header 'Accept' (if needed)
|
|
685
685
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
686
686
|
|
|
@@ -717,7 +717,7 @@ module KlaviyoAPI
|
|
|
717
717
|
# Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
718
718
|
# @param id [String]
|
|
719
719
|
# @param [Hash] opts the optional parameters
|
|
720
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
720
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
721
721
|
# @return [Hash<String, Object>]
|
|
722
722
|
def get_campaign_message_campaign(id, opts = {})
|
|
723
723
|
data, _status_code, _headers = get_campaign_message_campaign_with_http_info(id, opts)
|
|
@@ -728,7 +728,7 @@ module KlaviyoAPI
|
|
|
728
728
|
# Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
729
729
|
# @param id [String]
|
|
730
730
|
# @param [Hash] opts the optional parameters
|
|
731
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
731
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
732
732
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
733
733
|
def get_campaign_message_campaign_with_http_info(id, opts = {})
|
|
734
734
|
if @api_client.config.debugging
|
|
@@ -738,7 +738,7 @@ module KlaviyoAPI
|
|
|
738
738
|
if @api_client.config.client_side_validation && id.nil?
|
|
739
739
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message_campaign"
|
|
740
740
|
end
|
|
741
|
-
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "
|
|
741
|
+
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "created_at", "updated_at"]
|
|
742
742
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
|
743
743
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
|
744
744
|
end
|
|
@@ -752,7 +752,7 @@ module KlaviyoAPI
|
|
|
752
752
|
# header parameters
|
|
753
753
|
header_params = opts[:header_params] || {}
|
|
754
754
|
# klaviyo api revision
|
|
755
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
755
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
756
756
|
# HTTP header 'Accept' (if needed)
|
|
757
757
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
758
758
|
|
|
@@ -817,7 +817,7 @@ module KlaviyoAPI
|
|
|
817
817
|
# header parameters
|
|
818
818
|
header_params = opts[:header_params] || {}
|
|
819
819
|
# klaviyo api revision
|
|
820
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
820
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
821
821
|
# HTTP header 'Accept' (if needed)
|
|
822
822
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
823
823
|
|
|
@@ -882,7 +882,7 @@ module KlaviyoAPI
|
|
|
882
882
|
# header parameters
|
|
883
883
|
header_params = opts[:header_params] || {}
|
|
884
884
|
# klaviyo api revision
|
|
885
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
885
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
886
886
|
# HTTP header 'Accept' (if needed)
|
|
887
887
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
888
888
|
|
|
@@ -919,7 +919,7 @@ module KlaviyoAPI
|
|
|
919
919
|
# Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
|
920
920
|
# @param id [String]
|
|
921
921
|
# @param [Hash] opts the optional parameters
|
|
922
|
-
# @option opts [Array<String>] :
|
|
922
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
923
923
|
# @return [Hash<String, Object>]
|
|
924
924
|
def get_campaign_message_template(id, opts = {})
|
|
925
925
|
data, _status_code, _headers = get_campaign_message_template_with_http_info(id, opts)
|
|
@@ -930,7 +930,7 @@ module KlaviyoAPI
|
|
|
930
930
|
# Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
|
931
931
|
# @param id [String]
|
|
932
932
|
# @param [Hash] opts the optional parameters
|
|
933
|
-
# @option opts [Array<String>] :
|
|
933
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
934
934
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
935
935
|
def get_campaign_message_template_with_http_info(id, opts = {})
|
|
936
936
|
if @api_client.config.debugging
|
|
@@ -940,21 +940,21 @@ module KlaviyoAPI
|
|
|
940
940
|
if @api_client.config.client_side_validation && id.nil?
|
|
941
941
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message_template"
|
|
942
942
|
end
|
|
943
|
-
allowable_values = ["
|
|
944
|
-
if @api_client.config.client_side_validation && opts[:'
|
|
945
|
-
fail ArgumentError, "invalid value for \"
|
|
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
946
|
end
|
|
947
947
|
# resource path
|
|
948
948
|
local_var_path = '/api/campaign-messages/{id}/template/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
949
949
|
|
|
950
950
|
# query parameters
|
|
951
951
|
query_params = opts[:query_params] || {}
|
|
952
|
-
query_params[:'fields[
|
|
952
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
|
953
953
|
|
|
954
954
|
# header parameters
|
|
955
955
|
header_params = opts[:header_params] || {}
|
|
956
956
|
# klaviyo api revision
|
|
957
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
957
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
958
958
|
# HTTP header 'Accept' (if needed)
|
|
959
959
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
960
960
|
|
|
@@ -991,7 +991,7 @@ module KlaviyoAPI
|
|
|
991
991
|
# Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
992
992
|
# @param id [String] The ID of the campaign for which to get the estimated number of recipients
|
|
993
993
|
# @param [Hash] opts the optional parameters
|
|
994
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
994
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
995
995
|
# @return [Hash<String, Object>]
|
|
996
996
|
def get_campaign_recipient_estimation(id, opts = {})
|
|
997
997
|
data, _status_code, _headers = get_campaign_recipient_estimation_with_http_info(id, opts)
|
|
@@ -1002,7 +1002,7 @@ module KlaviyoAPI
|
|
|
1002
1002
|
# Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
1003
1003
|
# @param id [String] The ID of the campaign for which to get the estimated number of recipients
|
|
1004
1004
|
# @param [Hash] opts the optional parameters
|
|
1005
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1005
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1006
1006
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1007
1007
|
def get_campaign_recipient_estimation_with_http_info(id, opts = {})
|
|
1008
1008
|
if @api_client.config.debugging
|
|
@@ -1026,7 +1026,7 @@ module KlaviyoAPI
|
|
|
1026
1026
|
# header parameters
|
|
1027
1027
|
header_params = opts[:header_params] || {}
|
|
1028
1028
|
# klaviyo api revision
|
|
1029
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1029
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
1030
1030
|
# HTTP header 'Accept' (if needed)
|
|
1031
1031
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1032
1032
|
|
|
@@ -1063,7 +1063,7 @@ module KlaviyoAPI
|
|
|
1063
1063
|
# Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
1064
1064
|
# @param id [String] The ID of the campaign to get recipient estimation status
|
|
1065
1065
|
# @param [Hash] opts the optional parameters
|
|
1066
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1066
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1067
1067
|
# @return [Hash<String, Object>]
|
|
1068
1068
|
def get_campaign_recipient_estimation_job(id, opts = {})
|
|
1069
1069
|
data, _status_code, _headers = get_campaign_recipient_estimation_job_with_http_info(id, opts)
|
|
@@ -1074,7 +1074,7 @@ module KlaviyoAPI
|
|
|
1074
1074
|
# Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
1075
1075
|
# @param id [String] The ID of the campaign to get recipient estimation status
|
|
1076
1076
|
# @param [Hash] opts the optional parameters
|
|
1077
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1077
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1078
1078
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1079
1079
|
def get_campaign_recipient_estimation_job_with_http_info(id, opts = {})
|
|
1080
1080
|
if @api_client.config.debugging
|
|
@@ -1098,7 +1098,7 @@ module KlaviyoAPI
|
|
|
1098
1098
|
# header parameters
|
|
1099
1099
|
header_params = opts[:header_params] || {}
|
|
1100
1100
|
# klaviyo api revision
|
|
1101
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1101
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
1102
1102
|
# HTTP header 'Accept' (if needed)
|
|
1103
1103
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1104
1104
|
|
|
@@ -1163,7 +1163,7 @@ module KlaviyoAPI
|
|
|
1163
1163
|
# header parameters
|
|
1164
1164
|
header_params = opts[:header_params] || {}
|
|
1165
1165
|
# klaviyo api revision
|
|
1166
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1166
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
1167
1167
|
# HTTP header 'Accept' (if needed)
|
|
1168
1168
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1169
1169
|
|
|
@@ -1228,7 +1228,7 @@ module KlaviyoAPI
|
|
|
1228
1228
|
# header parameters
|
|
1229
1229
|
header_params = opts[:header_params] || {}
|
|
1230
1230
|
# klaviyo api revision
|
|
1231
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1231
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
1232
1232
|
# HTTP header 'Accept' (if needed)
|
|
1233
1233
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1234
1234
|
|
|
@@ -1265,7 +1265,7 @@ module KlaviyoAPI
|
|
|
1265
1265
|
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
1266
1266
|
# @param id [String] The ID of the campaign to send
|
|
1267
1267
|
# @param [Hash] opts the optional parameters
|
|
1268
|
-
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1268
|
+
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1269
1269
|
# @return [Hash<String, Object>]
|
|
1270
1270
|
def get_campaign_send_job(id, opts = {})
|
|
1271
1271
|
data, _status_code, _headers = get_campaign_send_job_with_http_info(id, opts)
|
|
@@ -1276,7 +1276,7 @@ module KlaviyoAPI
|
|
|
1276
1276
|
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
1277
1277
|
# @param id [String] The ID of the campaign to send
|
|
1278
1278
|
# @param [Hash] opts the optional parameters
|
|
1279
|
-
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1279
|
+
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1280
1280
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1281
1281
|
def get_campaign_send_job_with_http_info(id, opts = {})
|
|
1282
1282
|
if @api_client.config.debugging
|
|
@@ -1300,7 +1300,7 @@ module KlaviyoAPI
|
|
|
1300
1300
|
# header parameters
|
|
1301
1301
|
header_params = opts[:header_params] || {}
|
|
1302
1302
|
# klaviyo api revision
|
|
1303
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1303
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
1304
1304
|
# HTTP header 'Accept' (if needed)
|
|
1305
1305
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1306
1306
|
|
|
@@ -1337,7 +1337,7 @@ module KlaviyoAPI
|
|
|
1337
1337
|
# Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
|
1338
1338
|
# @param id [String]
|
|
1339
1339
|
# @param [Hash] opts the optional parameters
|
|
1340
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1340
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1341
1341
|
# @return [Hash<String, Object>]
|
|
1342
1342
|
def get_campaign_tags(id, opts = {})
|
|
1343
1343
|
data, _status_code, _headers = get_campaign_tags_with_http_info(id, opts)
|
|
@@ -1348,7 +1348,7 @@ module KlaviyoAPI
|
|
|
1348
1348
|
# Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
|
1349
1349
|
# @param id [String]
|
|
1350
1350
|
# @param [Hash] opts the optional parameters
|
|
1351
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1351
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1352
1352
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1353
1353
|
def get_campaign_tags_with_http_info(id, opts = {})
|
|
1354
1354
|
if @api_client.config.debugging
|
|
@@ -1372,7 +1372,7 @@ module KlaviyoAPI
|
|
|
1372
1372
|
# header parameters
|
|
1373
1373
|
header_params = opts[:header_params] || {}
|
|
1374
1374
|
# klaviyo api revision
|
|
1375
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1375
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
1376
1376
|
# HTTP header 'Accept' (if needed)
|
|
1377
1377
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1378
1378
|
|
|
@@ -1406,15 +1406,15 @@ module KlaviyoAPI
|
|
|
1406
1406
|
end
|
|
1407
1407
|
|
|
1408
1408
|
# Get Campaigns
|
|
1409
|
-
# Returns some or all campaigns based on filters.
|
|
1410
|
-
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1409
|
+
# Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
1410
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
1411
1411
|
# @param [Hash] opts the optional parameters
|
|
1412
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1413
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1414
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1415
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1416
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1417
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1412
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1413
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1414
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1415
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
|
|
1416
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
|
|
1417
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
|
|
1418
1418
|
# @return [Hash<String, Object>]
|
|
1419
1419
|
def get_campaigns(filter, opts = {})
|
|
1420
1420
|
data, _status_code, _headers = get_campaigns_with_http_info(filter, opts)
|
|
@@ -1422,15 +1422,15 @@ module KlaviyoAPI
|
|
|
1422
1422
|
end
|
|
1423
1423
|
|
|
1424
1424
|
# Get Campaigns
|
|
1425
|
-
# Returns some or all campaigns based on filters.
|
|
1426
|
-
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1425
|
+
# Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
|
1426
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
1427
1427
|
# @param [Hash] opts the optional parameters
|
|
1428
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1429
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1430
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1431
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1432
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1433
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
|
1428
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1429
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1430
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
|
|
1431
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
|
|
1432
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
|
|
1433
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
|
|
1434
1434
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1435
1435
|
def get_campaigns_with_http_info(filter, opts = {})
|
|
1436
1436
|
if @api_client.config.debugging
|
|
@@ -1440,7 +1440,7 @@ module KlaviyoAPI
|
|
|
1440
1440
|
if @api_client.config.client_side_validation && filter.nil?
|
|
1441
1441
|
fail ArgumentError, "Missing the required parameter 'filter' when calling CampaignsApi.get_campaigns"
|
|
1442
1442
|
end
|
|
1443
|
-
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "
|
|
1443
|
+
allowable_values = ["label", "channel", "content", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "created_at", "updated_at"]
|
|
1444
1444
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
|
1445
1445
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
|
1446
1446
|
end
|
|
@@ -1476,7 +1476,7 @@ module KlaviyoAPI
|
|
|
1476
1476
|
# header parameters
|
|
1477
1477
|
header_params = opts[:header_params] || {}
|
|
1478
1478
|
# klaviyo api revision
|
|
1479
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1479
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
1480
1480
|
# HTTP header 'Accept' (if needed)
|
|
1481
1481
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1482
1482
|
|
|
@@ -1547,7 +1547,7 @@ module KlaviyoAPI
|
|
|
1547
1547
|
# header parameters
|
|
1548
1548
|
header_params = opts[:header_params] || {}
|
|
1549
1549
|
# klaviyo api revision
|
|
1550
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1550
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
1551
1551
|
# HTTP header 'Accept' (if needed)
|
|
1552
1552
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1553
1553
|
# HTTP header 'Content-Type'
|
|
@@ -1623,7 +1623,7 @@ module KlaviyoAPI
|
|
|
1623
1623
|
# header parameters
|
|
1624
1624
|
header_params = opts[:header_params] || {}
|
|
1625
1625
|
# klaviyo api revision
|
|
1626
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1626
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
1627
1627
|
# HTTP header 'Accept' (if needed)
|
|
1628
1628
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1629
1629
|
# HTTP header 'Content-Type'
|
|
@@ -1699,7 +1699,7 @@ module KlaviyoAPI
|
|
|
1699
1699
|
# header parameters
|
|
1700
1700
|
header_params = opts[:header_params] || {}
|
|
1701
1701
|
# klaviyo api revision
|
|
1702
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
|
1702
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
|
|
1703
1703
|
# HTTP header 'Accept' (if needed)
|
|
1704
1704
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1705
1705
|
# HTTP header 'Content-Type'
|