klaviyo-api-sdk 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +17 -0
- data/Gemfile +9 -0
- data/LICENSE.md +21 -0
- data/README.md +1316 -0
- data/Rakefile +10 -0
- data/docs/CatalogCategoryCreateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryCreateQuery.md +18 -0
- data/docs/CatalogCategoryCreateQueryAsSubResource.md +22 -0
- data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +24 -0
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryDeleteQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryItemOp.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogCategoryUpdateQuery.md +18 -0
- data/docs/CatalogCategoryUpdateQueryAsSubResource.md +24 -0
- data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemCategoryOp.md +18 -0
- data/docs/CatalogItemCreateJobCreateQuery.md +18 -0
- data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemCreateQuery.md +18 -0
- data/docs/CatalogItemCreateQueryAsSubResource.md +22 -0
- data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +38 -0
- data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md +18 -0
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md +18 -0
- data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemDeleteQueryAsSubResource.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogItemUpdateQuery.md +18 -0
- data/docs/CatalogItemUpdateQueryAsSubResource.md +24 -0
- data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +32 -0
- data/docs/CatalogJobErrorPayload.md +26 -0
- data/docs/CatalogVariantCreateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogVariantCreateQuery.md +18 -0
- data/docs/CatalogVariantCreateQueryAsSubResource.md +22 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +46 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md +18 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md +18 -0
- data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQuery.md +18 -0
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogVariantDeleteQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQuery.md +18 -0
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md +20 -0
- data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/CatalogVariantUpdateQuery.md +18 -0
- data/docs/CatalogVariantUpdateQueryAsSubResource.md +22 -0
- data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +38 -0
- data/docs/CatalogsApi.md +4048 -0
- data/docs/ClientApi.md +205 -0
- data/docs/EmailMessageContent.md +24 -0
- data/docs/EmailTrackingOptions.md +24 -0
- data/docs/ErrorSource.md +18 -0
- data/docs/EventCreateQuery.md +18 -0
- data/docs/EventCreateQueryAsSubResource.md +20 -0
- data/docs/EventCreateQueryAsSubResourceAttributes.md +28 -0
- data/docs/EventsApi.md +472 -0
- data/docs/FlowUpdateQuery.md +18 -0
- data/docs/FlowUpdateQueryAsSubResource.md +22 -0
- data/docs/FlowUpdateQueryAsSubResourceAttributes.md +18 -0
- data/docs/FlowsApi.md +951 -0
- data/docs/GetCatalogItems4XXResponse.md +18 -0
- data/docs/GetCatalogItems4XXResponseErrorsInner.md +26 -0
- data/docs/GetCatalogItems4XXResponseErrorsInnerSource.md +20 -0
- data/docs/IncludedCategories.md +24 -0
- data/docs/IncludedCategoriesAttributes.md +22 -0
- data/docs/IncludedFlowAction.md +24 -0
- data/docs/IncludedFlowActions.md +24 -0
- data/docs/IncludedFlowActionsAttributes.md +32 -0
- data/docs/IncludedFlowActionsAttributesTrackingOptions.md +49 -0
- data/docs/IncludedFlowMessages.md +24 -0
- data/docs/IncludedFlowMessagesAttributes.md +26 -0
- data/docs/IncludedFlowMessagesAttributesContent.md +49 -0
- data/docs/IncludedFlows.md +24 -0
- data/docs/IncludedFlowsAttributes.md +28 -0
- data/docs/IncludedItems.md +24 -0
- data/docs/IncludedItemsAttributes.md +38 -0
- data/docs/IncludedLists.md +24 -0
- data/docs/IncludedListsAttributes.md +22 -0
- data/docs/IncludedMetrics.md +24 -0
- data/docs/IncludedMetricsAttributes.md +24 -0
- data/docs/IncludedProfile.md +24 -0
- data/docs/IncludedProfiles.md +24 -0
- data/docs/IncludedProfilesAttributes.md +44 -0
- data/docs/IncludedSegments.md +24 -0
- data/docs/IncludedVariants.md +24 -0
- data/docs/IncludedVariantsAttributes.md +46 -0
- data/docs/IncludedVariantsLinks.md +18 -0
- data/docs/ListCreateQuery.md +18 -0
- data/docs/ListCreateQueryAsSubResource.md +20 -0
- data/docs/ListCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/ListDeleteQueryAsSubResource.md +20 -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/ListPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/ListsApi.md +686 -0
- data/docs/MetricAggregateQuery.md +18 -0
- data/docs/MetricAggregateQueryAsSubResource.md +20 -0
- data/docs/MetricAggregateQueryAsSubResourceAttributes.md +36 -0
- data/docs/MetricAggregateRowDTO.md +20 -0
- data/docs/MetricCreateQuery.md +20 -0
- data/docs/MetricsApi.md +233 -0
- data/docs/OnsiteProfileCreateQuery.md +18 -0
- data/docs/OnsiteProfileCreateQueryAsSubResource.md +22 -0
- data/docs/OnsiteProfileMeta.md +18 -0
- data/docs/OnsiteProfileMetaIdentifiers.md +28 -0
- data/docs/OnsiteSubscriptionCreateQuery.md +18 -0
- data/docs/OnsiteSubscriptionCreateQueryAsSubResource.md +20 -0
- data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +26 -0
- data/docs/ProfileCreateQuery.md +18 -0
- data/docs/ProfileCreateQueryAsSubResource.md +20 -0
- data/docs/ProfileCreateQueryAsSubResourceAttributes.md +38 -0
- data/docs/ProfileLocation.md +34 -0
- data/docs/ProfileLocationLatitude.md +49 -0
- data/docs/ProfilePartialUpdateQuery.md +18 -0
- data/docs/ProfilePartialUpdateQueryAsSubResource.md +22 -0
- data/docs/ProfilesApi.md +825 -0
- data/docs/SMSMessageContent.md +20 -0
- data/docs/SMSRenderOptions.md +24 -0
- data/docs/SMSTrackingOptions.md +20 -0
- data/docs/SegmentPartialUpdateQuery.md +18 -0
- data/docs/SegmentPartialUpdateQueryAsSubResource.md +22 -0
- data/docs/SegmentsApi.md +390 -0
- data/docs/SendOptions.md +20 -0
- data/docs/Subscription.md +20 -0
- data/docs/SubscriptionCreateJobCreateQuery.md +18 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +22 -0
- data/docs/Suppression.md +18 -0
- data/docs/SuppressionCreateJobCreateQuery.md +18 -0
- data/docs/SuppressionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
- data/docs/TemplateCloneQuery.md +18 -0
- data/docs/TemplateCloneQueryAsSubResource.md +20 -0
- data/docs/TemplateCloneQueryAsSubResourceAttributes.md +20 -0
- data/docs/TemplateCreateQuery.md +18 -0
- data/docs/TemplateCreateQueryAsSubResource.md +20 -0
- data/docs/TemplateCreateQueryAsSubResourceAttributes.md +26 -0
- data/docs/TemplateDeleteQueryAsSubResource.md +20 -0
- data/docs/TemplateUpdateQuery.md +18 -0
- data/docs/TemplateUpdateQueryAsSubResource.md +22 -0
- data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +24 -0
- data/docs/TemplatesApi.md +529 -0
- data/docs/UnsubscriptionCreateJobCreateQuery.md +18 -0
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +22 -0
- data/docs/UnsuppressionCreateJobCreateQuery.md +18 -0
- data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +20 -0
- data/docs/UtmParamInfo.md +20 -0
- data/docs/V2TemplateRenderQuery.md +18 -0
- data/docs/V2TemplateRenderQueryAsSubResource.md +20 -0
- data/docs/V2TemplateRenderQueryAsSubResourceAttributes.md +20 -0
- data/git_push.sh +57 -0
- data/klaviyo-api-sdk.gemspec +40 -0
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +4095 -0
- data/lib/klaviyo-api-sdk/api/client_api.rb +249 -0
- data/lib/klaviyo-api-sdk/api/events_api.rb +505 -0
- data/lib/klaviyo-api-sdk/api/flows_api.rb +1009 -0
- data/lib/klaviyo-api-sdk/api/lists_api.rb +708 -0
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +236 -0
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +840 -0
- data/lib/klaviyo-api-sdk/api/segments_api.rb +392 -0
- data/lib/klaviyo-api-sdk/api/templates_api.rb +536 -0
- data/lib/klaviyo-api-sdk/api_client.rb +390 -0
- data/lib/klaviyo-api-sdk/api_error.rb +57 -0
- data/lib/klaviyo-api-sdk/configuration.rb +283 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +291 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +295 -0
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +366 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +295 -0
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +284 -0
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +280 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +435 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +346 -0
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +266 -0
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +268 -0
- data/lib/klaviyo-api-sdk/models/error_source.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +279 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +226 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +275 -0
- data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +228 -0
- data/lib/klaviyo-api-sdk/models/included_categories.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/included_flow_action.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +282 -0
- data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +105 -0
- data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +270 -0
- data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +105 -0
- data/lib/klaviyo-api-sdk/models/included_flows.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +264 -0
- data/lib/klaviyo-api-sdk/models/included_items.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +311 -0
- data/lib/klaviyo-api-sdk/models/included_lists.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/included_metrics.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +246 -0
- data/lib/klaviyo-api-sdk/models/included_profile.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_profiles.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +336 -0
- data/lib/klaviyo-api-sdk/models/included_segments.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_variants.rb +300 -0
- data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +382 -0
- data/lib/klaviyo-api-sdk/models/included_variants_links.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +226 -0
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +272 -0
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +226 -0
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +380 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +240 -0
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +233 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +281 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +264 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +260 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +309 -0
- data/lib/klaviyo-api-sdk/models/profile_location.rb +291 -0
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +105 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/send_options.rb +238 -0
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +238 -0
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +266 -0
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +240 -0
- data/lib/klaviyo-api-sdk/models/subscription.rb +228 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +249 -0
- data/lib/klaviyo-api-sdk/models/suppression.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +230 -0
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +267 -0
- data/lib/klaviyo-api-sdk/models/template_delete_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +286 -0
- data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +248 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +246 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +238 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +272 -0
- data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/version.rb +15 -0
- data/lib/klaviyo-api-sdk.rb +253 -0
- data/spec/api/catalogs_api_spec.rb +759 -0
- data/spec/api/client_api_spec.rb +74 -0
- data/spec/api/events_api_spec.rb +120 -0
- data/spec/api/flows_api_spec.rb +209 -0
- data/spec/api/lists_api_spec.rb +156 -0
- data/spec/api/metrics_api_spec.rb +74 -0
- data/spec/api/profiles_api_spec.rb +178 -0
- data/spec/api/segments_api_spec.rb +103 -0
- data/spec/api/templates_api_spec.rb +126 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +56 -0
- data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_category_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_item_op_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_category_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +56 -0
- data/spec/models/catalog_category_update_query_spec.rb +34 -0
- data/spec/models/catalog_item_category_op_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +98 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +44 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +34 -0
- data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_item_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_item_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +76 -0
- data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +56 -0
- data/spec/models/catalog_item_update_query_spec.rb +34 -0
- data/spec/models/catalog_job_error_payload_spec.rb +58 -0
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +126 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +44 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +34 -0
- data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_variant_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +34 -0
- data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +98 -0
- data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/catalog_variant_update_query_spec.rb +34 -0
- data/spec/models/email_message_content_spec.rb +52 -0
- data/spec/models/email_tracking_options_spec.rb +52 -0
- data/spec/models/error_source_spec.rb +34 -0
- data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +64 -0
- data/spec/models/event_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/event_create_query_spec.rb +34 -0
- data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/flow_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/flow_update_query_spec.rb +34 -0
- data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +40 -0
- data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +58 -0
- data/spec/models/get_catalog_items4_xx_response_spec.rb +34 -0
- data/spec/models/included_categories_attributes_spec.rb +46 -0
- data/spec/models/included_categories_spec.rb +56 -0
- data/spec/models/included_flow_action_spec.rb +56 -0
- data/spec/models/included_flow_actions_attributes_spec.rb +76 -0
- data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +31 -0
- data/spec/models/included_flow_actions_spec.rb +56 -0
- data/spec/models/included_flow_messages_attributes_content_spec.rb +31 -0
- data/spec/models/included_flow_messages_attributes_spec.rb +58 -0
- data/spec/models/included_flow_messages_spec.rb +56 -0
- data/spec/models/included_flows_attributes_spec.rb +64 -0
- data/spec/models/included_flows_spec.rb +56 -0
- data/spec/models/included_items_attributes_spec.rb +94 -0
- data/spec/models/included_items_spec.rb +56 -0
- data/spec/models/included_lists_attributes_spec.rb +46 -0
- data/spec/models/included_lists_spec.rb +56 -0
- data/spec/models/included_metrics_attributes_spec.rb +52 -0
- data/spec/models/included_metrics_spec.rb +56 -0
- data/spec/models/included_profile_spec.rb +56 -0
- data/spec/models/included_profiles_attributes_spec.rb +112 -0
- data/spec/models/included_profiles_spec.rb +56 -0
- data/spec/models/included_segments_spec.rb +56 -0
- data/spec/models/included_variants_attributes_spec.rb +122 -0
- data/spec/models/included_variants_links_spec.rb +34 -0
- data/spec/models/included_variants_spec.rb +56 -0
- data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/list_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/list_create_query_spec.rb +34 -0
- data/spec/models/list_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/list_members_add_query_data_inner_spec.rb +44 -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_as_sub_resource_spec.rb +50 -0
- data/spec/models/list_partial_update_query_spec.rb +34 -0
- data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +104 -0
- data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/metric_aggregate_query_spec.rb +34 -0
- data/spec/models/metric_aggregate_row_dto_spec.rb +40 -0
- data/spec/models/metric_create_query_spec.rb +40 -0
- data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/onsite_profile_create_query_spec.rb +34 -0
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +64 -0
- data/spec/models/onsite_profile_meta_spec.rb +34 -0
- data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +58 -0
- data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/onsite_subscription_create_query_spec.rb +34 -0
- data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +94 -0
- data/spec/models/profile_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/profile_create_query_spec.rb +34 -0
- data/spec/models/profile_location_latitude_spec.rb +31 -0
- data/spec/models/profile_location_spec.rb +82 -0
- data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/profile_partial_update_query_spec.rb +34 -0
- data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/segment_partial_update_query_spec.rb +34 -0
- data/spec/models/send_options_spec.rb +40 -0
- data/spec/models/sms_message_content_spec.rb +40 -0
- data/spec/models/sms_render_options_spec.rb +52 -0
- data/spec/models/sms_tracking_options_spec.rb +40 -0
- data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/subscription_create_job_create_query_spec.rb +34 -0
- data/spec/models/subscription_spec.rb +40 -0
- data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
- data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/suppression_create_job_create_query_spec.rb +34 -0
- data/spec/models/suppression_spec.rb +34 -0
- data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/template_clone_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/template_clone_query_spec.rb +34 -0
- data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +58 -0
- data/spec/models/template_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/template_create_query_spec.rb +34 -0
- data/spec/models/template_delete_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +52 -0
- data/spec/models/template_update_query_as_sub_resource_spec.rb +50 -0
- data/spec/models/template_update_query_spec.rb +34 -0
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +46 -0
- data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/unsubscription_create_job_create_query_spec.rb +34 -0
- data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/unsuppression_create_job_create_query_spec.rb +34 -0
- data/spec/models/utm_param_info_spec.rb +40 -0
- data/spec/models/v2_template_render_query_as_sub_resource_attributes_spec.rb +40 -0
- data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +44 -0
- data/spec/models/v2_template_render_query_spec.rb +34 -0
- data/spec/spec_helper.rb +111 -0
- metadata +583 -0
@@ -0,0 +1,529 @@
|
|
1
|
+
# KlaviyoAPI::TemplatesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://a.klaviyo.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_template**](TemplatesApi.md#create_template) | **POST** /api/templates/ | Create Template |
|
8
|
+
| [**create_template_clone**](TemplatesApi.md#create_template_clone) | **POST** /api/templates/{id}/clone/ | Create Template Clone |
|
9
|
+
| [**create_template_render**](TemplatesApi.md#create_template_render) | **POST** /api/templates/{id}/render/ | Create Template Render |
|
10
|
+
| [**delete_template**](TemplatesApi.md#delete_template) | **DELETE** /api/templates/{id}/ | Delete Template |
|
11
|
+
| [**get_template**](TemplatesApi.md#get_template) | **GET** /api/templates/{id}/ | Get Template |
|
12
|
+
| [**get_templates**](TemplatesApi.md#get_templates) | **GET** /api/templates/ | Get Templates |
|
13
|
+
| [**update_template**](TemplatesApi.md#update_template) | **PATCH** /api/templates/{id}/ | Update Template |
|
14
|
+
|
15
|
+
|
16
|
+
## create_template
|
17
|
+
|
18
|
+
> Hash<String, Object> create_template(template_create_query)
|
19
|
+
|
20
|
+
Create Template
|
21
|
+
|
22
|
+
Create a new custom HTML template. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Templates Write`
|
23
|
+
|
24
|
+
### Examples
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
require 'time'
|
28
|
+
require 'klaviyo-api-sdk'
|
29
|
+
# setup authorization
|
30
|
+
KlaviyoAPI.configure do |config|
|
31
|
+
# Configure API key authorization: Klaviyo-API-Key
|
32
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
34
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
35
|
+
end
|
36
|
+
|
37
|
+
api_instance = KlaviyoAPI::TemplatesApi.new
|
38
|
+
template_create_query = KlaviyoAPI::TemplateCreateQuery.new({data: KlaviyoAPI::TemplateCreateQueryAsSubResource.new({type: 'template', attributes: KlaviyoAPI::TemplateCreateQueryAsSubResourceAttributes.new({name: 'name_example', editor_type: 'editor_type_example'})})}) # TemplateCreateQuery | Query for creating a CODE template
|
39
|
+
|
40
|
+
begin
|
41
|
+
# Create Template
|
42
|
+
result = api_instance.create_template(template_create_query)
|
43
|
+
p result
|
44
|
+
rescue KlaviyoAPI::ApiError => e
|
45
|
+
puts "Error when calling TemplatesApi->create_template: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
#### Using the create_template_with_http_info variant
|
50
|
+
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
52
|
+
|
53
|
+
> <Array(Hash<String, Object>, Integer, Hash)> create_template_with_http_info(template_create_query)
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
begin
|
57
|
+
# Create Template
|
58
|
+
data, status_code, headers = api_instance.create_template_with_http_info(template_create_query)
|
59
|
+
p status_code # => 2xx
|
60
|
+
p headers # => { ... }
|
61
|
+
p data # => Hash<String, Object>
|
62
|
+
rescue KlaviyoAPI::ApiError => e
|
63
|
+
puts "Error when calling TemplatesApi->create_template_with_http_info: #{e}"
|
64
|
+
end
|
65
|
+
```
|
66
|
+
|
67
|
+
### Parameters
|
68
|
+
|
69
|
+
| Name | Type | Description | Notes |
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
71
|
+
| **template_create_query** | [**TemplateCreateQuery**](TemplateCreateQuery.md) | Query for creating a CODE template | |
|
72
|
+
|
73
|
+
### Return type
|
74
|
+
|
75
|
+
**Hash<String, Object>**
|
76
|
+
|
77
|
+
### Authorization
|
78
|
+
|
79
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
80
|
+
|
81
|
+
### HTTP request headers
|
82
|
+
|
83
|
+
- **Content-Type**: application/json
|
84
|
+
- **Accept**: application/json
|
85
|
+
|
86
|
+
|
87
|
+
## create_template_clone
|
88
|
+
|
89
|
+
> Hash<String, Object> create_template_clone(id, template_clone_query)
|
90
|
+
|
91
|
+
Create Template Clone
|
92
|
+
|
93
|
+
Create a clone of a template with the given template ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Templates Write`
|
94
|
+
|
95
|
+
### Examples
|
96
|
+
|
97
|
+
```ruby
|
98
|
+
require 'time'
|
99
|
+
require 'klaviyo-api-sdk'
|
100
|
+
# setup authorization
|
101
|
+
KlaviyoAPI.configure do |config|
|
102
|
+
# Configure API key authorization: Klaviyo-API-Key
|
103
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
104
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
105
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
106
|
+
end
|
107
|
+
|
108
|
+
api_instance = KlaviyoAPI::TemplatesApi.new
|
109
|
+
id = 'id_example' # String |
|
110
|
+
template_clone_query = KlaviyoAPI::TemplateCloneQuery.new({data: KlaviyoAPI::TemplateCloneQueryAsSubResource.new({type: 'template', attributes: KlaviyoAPI::TemplateCloneQueryAsSubResourceAttributes.new})}) # TemplateCloneQuery | Query for cloning a template
|
111
|
+
|
112
|
+
begin
|
113
|
+
# Create Template Clone
|
114
|
+
result = api_instance.create_template_clone(id, template_clone_query)
|
115
|
+
p result
|
116
|
+
rescue KlaviyoAPI::ApiError => e
|
117
|
+
puts "Error when calling TemplatesApi->create_template_clone: #{e}"
|
118
|
+
end
|
119
|
+
```
|
120
|
+
|
121
|
+
#### Using the create_template_clone_with_http_info variant
|
122
|
+
|
123
|
+
This returns an Array which contains the response data, status code and headers.
|
124
|
+
|
125
|
+
> <Array(Hash<String, Object>, Integer, Hash)> create_template_clone_with_http_info(id, template_clone_query)
|
126
|
+
|
127
|
+
```ruby
|
128
|
+
begin
|
129
|
+
# Create Template Clone
|
130
|
+
data, status_code, headers = api_instance.create_template_clone_with_http_info(id, template_clone_query)
|
131
|
+
p status_code # => 2xx
|
132
|
+
p headers # => { ... }
|
133
|
+
p data # => Hash<String, Object>
|
134
|
+
rescue KlaviyoAPI::ApiError => e
|
135
|
+
puts "Error when calling TemplatesApi->create_template_clone_with_http_info: #{e}"
|
136
|
+
end
|
137
|
+
```
|
138
|
+
|
139
|
+
### Parameters
|
140
|
+
|
141
|
+
| Name | Type | Description | Notes |
|
142
|
+
| ---- | ---- | ----------- | ----- |
|
143
|
+
| **id** | **String** | | |
|
144
|
+
| **template_clone_query** | [**TemplateCloneQuery**](TemplateCloneQuery.md) | Query for cloning a template | |
|
145
|
+
|
146
|
+
### Return type
|
147
|
+
|
148
|
+
**Hash<String, Object>**
|
149
|
+
|
150
|
+
### Authorization
|
151
|
+
|
152
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
153
|
+
|
154
|
+
### HTTP request headers
|
155
|
+
|
156
|
+
- **Content-Type**: application/json
|
157
|
+
- **Accept**: application/json
|
158
|
+
|
159
|
+
|
160
|
+
## create_template_render
|
161
|
+
|
162
|
+
> Hash<String, Object> create_template_render(id, v2_template_render_query)
|
163
|
+
|
164
|
+
Create Template Render
|
165
|
+
|
166
|
+
Render a template with the given template ID and context attribute. Returns the HTML and plain text versions of the email template. **Request body parameters** (nested under `attributes`): * `return_fields`: Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). * `context`: This is the context your email template will be rendered with. You must pass in a `context` object as a JSON object. Email templates are rendered with contexts in a similar manner to Django templates. Nested template variables can be referenced via dot notation. Template variables without corresponding `context` values are treated as `FALSE` and output nothing. Ex. `{ \"name\" : \"George Washington\", \"state\" : \"VA\" }`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Templates Read`
|
167
|
+
|
168
|
+
### Examples
|
169
|
+
|
170
|
+
```ruby
|
171
|
+
require 'time'
|
172
|
+
require 'klaviyo-api-sdk'
|
173
|
+
# setup authorization
|
174
|
+
KlaviyoAPI.configure do |config|
|
175
|
+
# Configure API key authorization: Klaviyo-API-Key
|
176
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
177
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
178
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
179
|
+
end
|
180
|
+
|
181
|
+
api_instance = KlaviyoAPI::TemplatesApi.new
|
182
|
+
id = 'id_example' # String |
|
183
|
+
v2_template_render_query = KlaviyoAPI::V2TemplateRenderQuery.new({data: KlaviyoAPI::V2TemplateRenderQueryAsSubResource.new({type: 'template', attributes: KlaviyoAPI::V2TemplateRenderQueryAsSubResourceAttributes.new({context: 3.56})})}) # V2TemplateRenderQuery | Query for rendering a template
|
184
|
+
|
185
|
+
begin
|
186
|
+
# Create Template Render
|
187
|
+
result = api_instance.create_template_render(id, v2_template_render_query)
|
188
|
+
p result
|
189
|
+
rescue KlaviyoAPI::ApiError => e
|
190
|
+
puts "Error when calling TemplatesApi->create_template_render: #{e}"
|
191
|
+
end
|
192
|
+
```
|
193
|
+
|
194
|
+
#### Using the create_template_render_with_http_info variant
|
195
|
+
|
196
|
+
This returns an Array which contains the response data, status code and headers.
|
197
|
+
|
198
|
+
> <Array(Hash<String, Object>, Integer, Hash)> create_template_render_with_http_info(id, v2_template_render_query)
|
199
|
+
|
200
|
+
```ruby
|
201
|
+
begin
|
202
|
+
# Create Template Render
|
203
|
+
data, status_code, headers = api_instance.create_template_render_with_http_info(id, v2_template_render_query)
|
204
|
+
p status_code # => 2xx
|
205
|
+
p headers # => { ... }
|
206
|
+
p data # => Hash<String, Object>
|
207
|
+
rescue KlaviyoAPI::ApiError => e
|
208
|
+
puts "Error when calling TemplatesApi->create_template_render_with_http_info: #{e}"
|
209
|
+
end
|
210
|
+
```
|
211
|
+
|
212
|
+
### Parameters
|
213
|
+
|
214
|
+
| Name | Type | Description | Notes |
|
215
|
+
| ---- | ---- | ----------- | ----- |
|
216
|
+
| **id** | **String** | | |
|
217
|
+
| **v2_template_render_query** | [**V2TemplateRenderQuery**](V2TemplateRenderQuery.md) | Query for rendering a template | |
|
218
|
+
|
219
|
+
### Return type
|
220
|
+
|
221
|
+
**Hash<String, Object>**
|
222
|
+
|
223
|
+
### Authorization
|
224
|
+
|
225
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
226
|
+
|
227
|
+
### HTTP request headers
|
228
|
+
|
229
|
+
- **Content-Type**: application/json
|
230
|
+
- **Accept**: application/json
|
231
|
+
|
232
|
+
|
233
|
+
## delete_template
|
234
|
+
|
235
|
+
> Hash<String, Object> delete_template(id)
|
236
|
+
|
237
|
+
Delete Template
|
238
|
+
|
239
|
+
Delete a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Templates Write`
|
240
|
+
|
241
|
+
### Examples
|
242
|
+
|
243
|
+
```ruby
|
244
|
+
require 'time'
|
245
|
+
require 'klaviyo-api-sdk'
|
246
|
+
# setup authorization
|
247
|
+
KlaviyoAPI.configure do |config|
|
248
|
+
# Configure API key authorization: Klaviyo-API-Key
|
249
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
250
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
251
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
252
|
+
end
|
253
|
+
|
254
|
+
api_instance = KlaviyoAPI::TemplatesApi.new
|
255
|
+
id = 'id_example' # String |
|
256
|
+
|
257
|
+
begin
|
258
|
+
# Delete Template
|
259
|
+
result = api_instance.delete_template(id)
|
260
|
+
p result
|
261
|
+
rescue KlaviyoAPI::ApiError => e
|
262
|
+
puts "Error when calling TemplatesApi->delete_template: #{e}"
|
263
|
+
end
|
264
|
+
```
|
265
|
+
|
266
|
+
#### Using the delete_template_with_http_info variant
|
267
|
+
|
268
|
+
This returns an Array which contains the response data, status code and headers.
|
269
|
+
|
270
|
+
> <Array(Hash<String, Object>, Integer, Hash)> delete_template_with_http_info(id)
|
271
|
+
|
272
|
+
```ruby
|
273
|
+
begin
|
274
|
+
# Delete Template
|
275
|
+
data, status_code, headers = api_instance.delete_template_with_http_info(id)
|
276
|
+
p status_code # => 2xx
|
277
|
+
p headers # => { ... }
|
278
|
+
p data # => Hash<String, Object>
|
279
|
+
rescue KlaviyoAPI::ApiError => e
|
280
|
+
puts "Error when calling TemplatesApi->delete_template_with_http_info: #{e}"
|
281
|
+
end
|
282
|
+
```
|
283
|
+
|
284
|
+
### Parameters
|
285
|
+
|
286
|
+
| Name | Type | Description | Notes |
|
287
|
+
| ---- | ---- | ----------- | ----- |
|
288
|
+
| **id** | **String** | | |
|
289
|
+
|
290
|
+
### Return type
|
291
|
+
|
292
|
+
**Hash<String, Object>**
|
293
|
+
|
294
|
+
### Authorization
|
295
|
+
|
296
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
297
|
+
|
298
|
+
### HTTP request headers
|
299
|
+
|
300
|
+
- **Content-Type**: Not defined
|
301
|
+
- **Accept**: application/json
|
302
|
+
|
303
|
+
|
304
|
+
## get_template
|
305
|
+
|
306
|
+
> Hash<String, Object> get_template(id, opts)
|
307
|
+
|
308
|
+
Get Template
|
309
|
+
|
310
|
+
Get a template with the given template ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Templates Read`
|
311
|
+
|
312
|
+
### Examples
|
313
|
+
|
314
|
+
```ruby
|
315
|
+
require 'time'
|
316
|
+
require 'klaviyo-api-sdk'
|
317
|
+
# setup authorization
|
318
|
+
KlaviyoAPI.configure do |config|
|
319
|
+
# Configure API key authorization: Klaviyo-API-Key
|
320
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
321
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
322
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
323
|
+
end
|
324
|
+
|
325
|
+
api_instance = KlaviyoAPI::TemplatesApi.new
|
326
|
+
id = 'id_example' # String |
|
327
|
+
opts = {
|
328
|
+
fields_template: ['company_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
329
|
+
}
|
330
|
+
|
331
|
+
begin
|
332
|
+
# Get Template
|
333
|
+
result = api_instance.get_template(id, opts)
|
334
|
+
p result
|
335
|
+
rescue KlaviyoAPI::ApiError => e
|
336
|
+
puts "Error when calling TemplatesApi->get_template: #{e}"
|
337
|
+
end
|
338
|
+
```
|
339
|
+
|
340
|
+
#### Using the get_template_with_http_info variant
|
341
|
+
|
342
|
+
This returns an Array which contains the response data, status code and headers.
|
343
|
+
|
344
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_template_with_http_info(id, opts)
|
345
|
+
|
346
|
+
```ruby
|
347
|
+
begin
|
348
|
+
# Get Template
|
349
|
+
data, status_code, headers = api_instance.get_template_with_http_info(id, opts)
|
350
|
+
p status_code # => 2xx
|
351
|
+
p headers # => { ... }
|
352
|
+
p data # => Hash<String, Object>
|
353
|
+
rescue KlaviyoAPI::ApiError => e
|
354
|
+
puts "Error when calling TemplatesApi->get_template_with_http_info: #{e}"
|
355
|
+
end
|
356
|
+
```
|
357
|
+
|
358
|
+
### Parameters
|
359
|
+
|
360
|
+
| Name | Type | Description | Notes |
|
361
|
+
| ---- | ---- | ----------- | ----- |
|
362
|
+
| **id** | **String** | | |
|
363
|
+
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
364
|
+
|
365
|
+
### Return type
|
366
|
+
|
367
|
+
**Hash<String, Object>**
|
368
|
+
|
369
|
+
### Authorization
|
370
|
+
|
371
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
372
|
+
|
373
|
+
### HTTP request headers
|
374
|
+
|
375
|
+
- **Content-Type**: Not defined
|
376
|
+
- **Accept**: application/json
|
377
|
+
|
378
|
+
|
379
|
+
## get_templates
|
380
|
+
|
381
|
+
> Hash<String, Object> get_templates(opts)
|
382
|
+
|
383
|
+
Get Templates
|
384
|
+
|
385
|
+
Get all templates in an account. Filter to request a subset of all templates. Templates can be sorted by the following fields, in ascending and descending order: `id`, `name`, `created`, `updated` Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 20 results per page. Results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Templates Read`
|
386
|
+
|
387
|
+
### Examples
|
388
|
+
|
389
|
+
```ruby
|
390
|
+
require 'time'
|
391
|
+
require 'klaviyo-api-sdk'
|
392
|
+
# setup authorization
|
393
|
+
KlaviyoAPI.configure do |config|
|
394
|
+
# Configure API key authorization: Klaviyo-API-Key
|
395
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
396
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
397
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
398
|
+
end
|
399
|
+
|
400
|
+
api_instance = KlaviyoAPI::TemplatesApi.new
|
401
|
+
opts = {
|
402
|
+
fields_template: ['company_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
|
403
|
+
filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
404
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
|
405
|
+
sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
|
406
|
+
}
|
407
|
+
|
408
|
+
begin
|
409
|
+
# Get Templates
|
410
|
+
result = api_instance.get_templates(opts)
|
411
|
+
p result
|
412
|
+
rescue KlaviyoAPI::ApiError => e
|
413
|
+
puts "Error when calling TemplatesApi->get_templates: #{e}"
|
414
|
+
end
|
415
|
+
```
|
416
|
+
|
417
|
+
#### Using the get_templates_with_http_info variant
|
418
|
+
|
419
|
+
This returns an Array which contains the response data, status code and headers.
|
420
|
+
|
421
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_templates_with_http_info(opts)
|
422
|
+
|
423
|
+
```ruby
|
424
|
+
begin
|
425
|
+
# Get Templates
|
426
|
+
data, status_code, headers = api_instance.get_templates_with_http_info(opts)
|
427
|
+
p status_code # => 2xx
|
428
|
+
p headers # => { ... }
|
429
|
+
p data # => Hash<String, Object>
|
430
|
+
rescue KlaviyoAPI::ApiError => e
|
431
|
+
puts "Error when calling TemplatesApi->get_templates_with_http_info: #{e}"
|
432
|
+
end
|
433
|
+
```
|
434
|
+
|
435
|
+
### Parameters
|
436
|
+
|
437
|
+
| Name | Type | Description | Notes |
|
438
|
+
| ---- | ---- | ----------- | ----- |
|
439
|
+
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
|
440
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` | [optional] |
|
441
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
|
442
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
|
443
|
+
|
444
|
+
### Return type
|
445
|
+
|
446
|
+
**Hash<String, Object>**
|
447
|
+
|
448
|
+
### Authorization
|
449
|
+
|
450
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
451
|
+
|
452
|
+
### HTTP request headers
|
453
|
+
|
454
|
+
- **Content-Type**: Not defined
|
455
|
+
- **Accept**: application/json
|
456
|
+
|
457
|
+
|
458
|
+
## update_template
|
459
|
+
|
460
|
+
> Hash<String, Object> update_template(id, template_update_query)
|
461
|
+
|
462
|
+
Update Template
|
463
|
+
|
464
|
+
Update a template with the given template ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Templates Write`
|
465
|
+
|
466
|
+
### Examples
|
467
|
+
|
468
|
+
```ruby
|
469
|
+
require 'time'
|
470
|
+
require 'klaviyo-api-sdk'
|
471
|
+
# setup authorization
|
472
|
+
KlaviyoAPI.configure do |config|
|
473
|
+
# Configure API key authorization: Klaviyo-API-Key
|
474
|
+
config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
|
475
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
476
|
+
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
|
477
|
+
end
|
478
|
+
|
479
|
+
api_instance = KlaviyoAPI::TemplatesApi.new
|
480
|
+
id = 'id_example' # String |
|
481
|
+
template_update_query = KlaviyoAPI::TemplateUpdateQuery.new({data: KlaviyoAPI::TemplateUpdateQueryAsSubResource.new({type: 'template', id: 'id_example', attributes: KlaviyoAPI::TemplateUpdateQueryAsSubResourceAttributes.new})}) # TemplateUpdateQuery | Query for updating a CODE template
|
482
|
+
|
483
|
+
begin
|
484
|
+
# Update Template
|
485
|
+
result = api_instance.update_template(id, template_update_query)
|
486
|
+
p result
|
487
|
+
rescue KlaviyoAPI::ApiError => e
|
488
|
+
puts "Error when calling TemplatesApi->update_template: #{e}"
|
489
|
+
end
|
490
|
+
```
|
491
|
+
|
492
|
+
#### Using the update_template_with_http_info variant
|
493
|
+
|
494
|
+
This returns an Array which contains the response data, status code and headers.
|
495
|
+
|
496
|
+
> <Array(Hash<String, Object>, Integer, Hash)> update_template_with_http_info(id, template_update_query)
|
497
|
+
|
498
|
+
```ruby
|
499
|
+
begin
|
500
|
+
# Update Template
|
501
|
+
data, status_code, headers = api_instance.update_template_with_http_info(id, template_update_query)
|
502
|
+
p status_code # => 2xx
|
503
|
+
p headers # => { ... }
|
504
|
+
p data # => Hash<String, Object>
|
505
|
+
rescue KlaviyoAPI::ApiError => e
|
506
|
+
puts "Error when calling TemplatesApi->update_template_with_http_info: #{e}"
|
507
|
+
end
|
508
|
+
```
|
509
|
+
|
510
|
+
### Parameters
|
511
|
+
|
512
|
+
| Name | Type | Description | Notes |
|
513
|
+
| ---- | ---- | ----------- | ----- |
|
514
|
+
| **id** | **String** | | |
|
515
|
+
| **template_update_query** | [**TemplateUpdateQuery**](TemplateUpdateQuery.md) | Query for updating a CODE template | |
|
516
|
+
|
517
|
+
### Return type
|
518
|
+
|
519
|
+
**Hash<String, Object>**
|
520
|
+
|
521
|
+
### Authorization
|
522
|
+
|
523
|
+
[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
|
524
|
+
|
525
|
+
### HTTP request headers
|
526
|
+
|
527
|
+
- **Content-Type**: application/json
|
528
|
+
- **Accept**: application/json
|
529
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# KlaviyoAPI::UnsubscriptionCreateJobCreateQuery
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**UnsubscriptionCreateJobCreateQueryAsSubResource**](UnsubscriptionCreateJobCreateQueryAsSubResource.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'klaviyo-api-sdk'
|
13
|
+
|
14
|
+
instance = KlaviyoAPI::UnsubscriptionCreateJobCreateQuery.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# KlaviyoAPI::UnsubscriptionCreateJobCreateQueryAsSubResource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | | |
|
8
|
+
| **attributes** | [**UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes**](UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'klaviyo-api-sdk'
|
14
|
+
|
15
|
+
instance = KlaviyoAPI::UnsubscriptionCreateJobCreateQueryAsSubResource.new(
|
16
|
+
type: null,
|
17
|
+
attributes: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# KlaviyoAPI::UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **list_id** | **String** | | |
|
8
|
+
| **emails** | **Array<String>** | | [optional] |
|
9
|
+
| **phone_numbers** | **Array<String>** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'klaviyo-api-sdk'
|
15
|
+
|
16
|
+
instance = KlaviyoAPI::UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.new(
|
17
|
+
list_id: null,
|
18
|
+
emails: null,
|
19
|
+
phone_numbers: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# KlaviyoAPI::UnsuppressionCreateJobCreateQuery
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**UnsuppressionCreateJobCreateQueryAsSubResource**](UnsuppressionCreateJobCreateQueryAsSubResource.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'klaviyo-api-sdk'
|
13
|
+
|
14
|
+
instance = KlaviyoAPI::UnsuppressionCreateJobCreateQuery.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# KlaviyoAPI::UnsuppressionCreateJobCreateQueryAsSubResource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | | |
|
8
|
+
| **attributes** | [**SuppressionCreateJobCreateQueryAsSubResourceAttributes**](SuppressionCreateJobCreateQueryAsSubResourceAttributes.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'klaviyo-api-sdk'
|
14
|
+
|
15
|
+
instance = KlaviyoAPI::UnsuppressionCreateJobCreateQueryAsSubResource.new(
|
16
|
+
type: null,
|
17
|
+
attributes: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# KlaviyoAPI::UtmParamInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | |
|
8
|
+
| **value** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'klaviyo-api-sdk'
|
14
|
+
|
15
|
+
instance = KlaviyoAPI::UtmParamInfo.new(
|
16
|
+
name: null,
|
17
|
+
value: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# KlaviyoAPI::V2TemplateRenderQuery
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**V2TemplateRenderQueryAsSubResource**](V2TemplateRenderQueryAsSubResource.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'klaviyo-api-sdk'
|
13
|
+
|
14
|
+
instance = KlaviyoAPI::V2TemplateRenderQuery.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# KlaviyoAPI::V2TemplateRenderQueryAsSubResource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | | |
|
8
|
+
| **attributes** | [**V2TemplateRenderQueryAsSubResourceAttributes**](V2TemplateRenderQueryAsSubResourceAttributes.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'klaviyo-api-sdk'
|
14
|
+
|
15
|
+
instance = KlaviyoAPI::V2TemplateRenderQueryAsSubResource.new(
|
16
|
+
type: null,
|
17
|
+
attributes: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|