klaviyo-api-sdk 4.1.0 → 5.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +430 -179
- data/docs/AccountsApi.md +4 -4
- data/docs/CampaignCloneQueryResourceObject.md +2 -0
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +0 -2
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +3 -3
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationships.md +1 -1
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplateData.md +1 -1
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +2 -2
- data/docs/CampaignSendJobCreateQueryResourceObject.md +2 -2
- data/docs/CampaignsApi.md +54 -54
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItems.md +1 -1
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItemsDataInner.md +20 -0
- data/docs/CatalogCategoryItemOp.md +1 -1
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +1 -1
- data/docs/CatalogVariantCreateQueryResourceObject.md +1 -1
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +2 -2
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +1 -1
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemData.md +1 -1
- data/docs/CatalogsApi.md +177 -177
- 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 +1289 -0
- data/docs/EmailSubscriptionParameters.md +18 -0
- data/docs/EventCreateQueryV2ResourceObjectAttributes.md +1 -1
- data/docs/EventsApi.md +30 -30
- data/docs/FlowsApi.md +73 -73
- 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/ListsApi.md +40 -32
- data/docs/MarketingSubscriptionParameters.md +18 -0
- data/docs/MetricsApi.md +8 -8
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +2 -0
- data/docs/ProfileLocation.md +3 -1
- 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/ProfilePartialUpdateQueryResourceObject.md +1 -1
- data/docs/ProfilePartialUpdateQueryResourceObjectAttributes.md +38 -0
- data/docs/ProfileUpsertQueryResourceObjectAttributes.md +2 -0
- data/docs/ProfilesApi.md +100 -28
- data/docs/RenderOptionsSubObject.md +1 -1
- data/docs/SMSSubscriptionParameters.md +18 -0
- data/docs/SegmentsApi.md +39 -31
- data/docs/ServerBISSubscriptionCreateQueryResourceObject.md +1 -1
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md +1 -1
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariantData.md +1 -1
- data/docs/SubscriptionChannels.md +4 -4
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +1 -1
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationships.md +1 -1
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsListData.md +1 -1
- data/docs/SubscriptionDeleteJobCreateQueryResourceObject.md +1 -1
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationships.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsList.md +18 -0
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
- data/docs/TagCampaignOpDataInner.md +1 -1
- data/docs/TagCreateQueryResourceObjectRelationshipsTagGroupData.md +1 -1
- data/docs/TagFlowOpDataInner.md +1 -1
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +1 -1
- data/docs/TagListOpDataInner.md +1 -1
- data/docs/TagSegmentOpDataInner.md +1 -1
- data/docs/TagsApi.md +32 -32
- data/docs/TemplateCloneQueryResourceObject.md +2 -0
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +0 -2
- data/docs/TemplateRenderQueryResourceObject.md +2 -0
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +0 -2
- data/docs/TemplatesApi.md +12 -12
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +7 -7
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +74 -74
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +233 -233
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +1268 -0
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/events_api.rb +44 -44
- data/lib/klaviyo-api-sdk/api/flows_api.rb +94 -94
- data/lib/klaviyo-api-sdk/api/images_api.rb +407 -0
- data/lib/klaviyo-api-sdk/api/lists_api.rb +76 -48
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +117 -47
- data/lib/klaviyo-api-sdk/api/segments_api.rb +70 -42
- data/lib/klaviyo-api-sdk/api/tags_api.rb +59 -59
- data/lib/klaviyo-api-sdk/api/templates_api.rb +18 -18
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/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 +17 -2
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +2 -17
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +1 -1
- 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 +17 -11
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +6 -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 +2 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +1 -1
- 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 +12 -11
- 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 +12 -11
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +239 -0
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
- 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 +1 -1
- 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 +6 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +3 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +2 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
- 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/{campaign_recipient_estimation_job_create_query_resource_object_attributes.rb → coupon_code_create_query.rb} +14 -15
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +252 -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 +224 -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/coupon_code_update_query_resource_object.rb +253 -0
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +224 -0
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +2 -2
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/marketing_subscription_parameters.rb +259 -0
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +12 -2
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +15 -5
- 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 +253 -0
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +224 -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 +1 -1
- 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 +2 -2
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +318 -0
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +12 -2
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +3 -1
- 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 +1 -1
- 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 +1 -1
- 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 +6 -1
- 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 +6 -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 +2 -1
- 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_subscription_parameters.rb +224 -0
- data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +5 -33
- 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 +6 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
- 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 +6 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +2 -1
- 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 +2 -2
- 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 +219 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +224 -0
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
- 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 +1 -1
- 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 +2 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
- 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 +2 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +2 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +3 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +2 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +2 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +17 -2
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
- 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 +17 -2
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +2 -17
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +46 -4
- data/spec/api/accounts_api_spec.rb +3 -3
- data/spec/api/campaigns_api_spec.rb +26 -26
- data/spec/api/catalogs_api_spec.rb +89 -89
- data/spec/api/coupons_api_spec.rb +260 -0
- data/spec/api/data_privacy_api_spec.rb +1 -1
- data/spec/api/events_api_spec.rb +17 -17
- data/spec/api/flows_api_spec.rb +39 -39
- data/spec/api/images_api_spec.rb +103 -0
- data/spec/api/lists_api_spec.rb +22 -18
- data/spec/api/metrics_api_spec.rb +5 -5
- data/spec/api/profiles_api_spec.rb +27 -15
- data/spec/api/segments_api_spec.rb +21 -17
- data/spec/api/tags_api_spec.rb +17 -17
- data/spec/api/templates_api_spec.rb +6 -6
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/audiences_sub_object_spec.rb +1 -1
- data/spec/models/back_in_stock_subscription_enum_spec.rb +1 -1
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +1 -7
- data/spec/models/campaign_clone_query_resource_object_spec.rb +7 -1
- data/spec/models/campaign_clone_query_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +1 -1
- data/spec/models/campaign_create_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_create_query_spec.rb +1 -1
- data/spec/models/campaign_enum_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +1 -1
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +2 -2
- data/spec/models/campaign_message_assign_template_query_spec.rb +1 -1
- data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +1 -1
- data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_message_create_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_message_enum_spec.rb +1 -1
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_message_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_partial_update_query_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +2 -2
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +1 -1
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +1 -1
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +2 -2
- data/spec/models/campaign_send_job_create_query_spec.rb +1 -1
- data/spec/models/campaign_send_job_enum_spec.rb +1 -1
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_enum_spec.rb +1 -1
- data/spec/models/catalog_category_item_op_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_category_update_query_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +1 -1
- data/spec/models/catalog_item_category_op_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_enum_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_item_update_query_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_enum_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +1 -1
- data/spec/models/catalog_variant_update_query_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +1 -1
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +1 -1
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +1 -1
- data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/data_privacy_profile_query_resource_object_spec.rb +1 -1
- data/spec/models/device_metadata_spec.rb +1 -1
- data/spec/models/email_content_sub_object_spec.rb +1 -1
- data/spec/models/email_send_options_sub_object_spec.rb +1 -1
- data/spec/models/email_subscription_parameters_spec.rb +34 -0
- data/spec/models/email_tracking_options_sub_object_spec.rb +1 -1
- data/spec/models/event_create_query_v2_resource_object_attributes_metric_spec.rb +1 -1
- data/spec/models/event_create_query_v2_resource_object_attributes_profile_spec.rb +1 -1
- data/spec/models/event_create_query_v2_resource_object_attributes_spec.rb +1 -1
- data/spec/models/event_create_query_v2_resource_object_spec.rb +1 -1
- data/spec/models/event_create_query_v2_spec.rb +1 -1
- data/spec/models/event_enum_spec.rb +1 -1
- data/spec/models/flow_enum_spec.rb +1 -1
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/flow_update_query_resource_object_spec.rb +1 -1
- data/spec/models/flow_update_query_spec.rb +1 -1
- data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +1 -1
- data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +1 -1
- data/spec/models/get_accounts4_xx_response_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/list_create_query_resource_object_spec.rb +1 -1
- data/spec/models/list_create_query_spec.rb +1 -1
- data/spec/models/list_enum_spec.rb +1 -1
- data/spec/models/list_members_add_query_data_inner_spec.rb +1 -1
- data/spec/models/list_members_add_query_spec.rb +1 -1
- data/spec/models/list_members_delete_query_spec.rb +1 -1
- data/spec/models/list_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/list_partial_update_query_spec.rb +1 -1
- data/spec/models/marketing_subscription_parameters_spec.rb +38 -0
- data/spec/models/metric_aggregate_enum_spec.rb +1 -1
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +1 -1
- data/spec/models/metric_aggregate_query_spec.rb +1 -1
- data/spec/models/metric_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/metric_create_query_resource_object_spec.rb +1 -1
- data/spec/models/metric_enum_spec.rb +1 -1
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +7 -1
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +1 -1
- data/spec/models/onsite_profile_meta_spec.rb +1 -1
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_create_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_create_query_spec.rb +1 -1
- data/spec/models/profile_enum_spec.rb +1 -1
- data/spec/models/profile_identifier_dto_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_identifier_dto_resource_object_spec.rb +1 -1
- data/spec/models/profile_location_latitude_spec.rb +1 -1
- data/spec/models/profile_location_longitude_spec.rb +1 -1
- data/spec/models/profile_location_spec.rb +7 -1
- 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 +1 -1
- data/spec/models/profile_meta_patch_properties_unset_spec.rb +1 -1
- data/spec/models/profile_meta_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/profile_partial_update_query_spec.rb +1 -1
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_subscription_create_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_subscription_delete_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_subscription_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +1 -1
- data/spec/models/profile_suppression_bulk_delete_job_enum_spec.rb +1 -1
- data/spec/models/profile_suppression_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_suppression_create_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_suppression_delete_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/profile_suppression_delete_query_resource_object_spec.rb +1 -1
- data/spec/models/profile_upsert_query_resource_object_attributes_spec.rb +7 -1
- data/spec/models/profile_upsert_query_resource_object_spec.rb +1 -1
- data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +1 -1
- data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/push_token_create_query_resource_object_spec.rb +1 -1
- data/spec/models/push_token_create_query_spec.rb +1 -1
- data/spec/models/push_token_enum_spec.rb +1 -1
- data/spec/models/render_options_sub_object_spec.rb +1 -1
- data/spec/models/segment_enum_spec.rb +1 -1
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +1 -1
- data/spec/models/segment_partial_update_query_spec.rb +1 -1
- data/spec/models/send_strategy_sub_object_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +1 -1
- data/spec/models/server_bis_subscription_create_query_spec.rb +1 -1
- data/spec/models/sms_content_sub_object_create_spec.rb +1 -1
- data/spec/models/sms_send_options_sub_object_spec.rb +1 -1
- data/spec/models/sms_subscription_parameters_spec.rb +34 -0
- data/spec/models/sms_tracking_options_sub_object_spec.rb +1 -1
- data/spec/models/static_schedule_options_spec.rb +1 -1
- data/spec/models/sto_schedule_options_spec.rb +1 -1
- data/spec/models/subscription_channels_spec.rb +1 -9
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/subscription_create_job_create_query_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/subscription_delete_job_create_query_spec.rb +1 -1
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/suppression_create_job_create_query_spec.rb +1 -1
- data/spec/models/suppression_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
- data/spec/models/suppression_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/suppression_delete_job_create_query_resource_object_spec.rb +1 -1
- data/spec/models/suppression_delete_job_create_query_spec.rb +1 -1
- data/spec/models/tag_campaign_op_data_inner_spec.rb +1 -1
- data/spec/models/tag_campaign_op_spec.rb +1 -1
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/tag_create_query_resource_object_relationships_spec.rb +1 -1
- data/spec/models/tag_create_query_resource_object_relationships_tag_group_data_spec.rb +1 -1
- data/spec/models/tag_create_query_resource_object_relationships_tag_group_spec.rb +1 -1
- data/spec/models/tag_create_query_resource_object_spec.rb +1 -1
- data/spec/models/tag_create_query_spec.rb +1 -1
- data/spec/models/tag_enum_spec.rb +1 -1
- data/spec/models/tag_flow_op_data_inner_spec.rb +1 -1
- data/spec/models/tag_flow_op_spec.rb +1 -1
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/tag_group_create_query_resource_object_spec.rb +1 -1
- data/spec/models/tag_group_create_query_spec.rb +1 -1
- data/spec/models/tag_group_enum_spec.rb +1 -1
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/tag_group_update_query_resource_object_spec.rb +1 -1
- data/spec/models/tag_group_update_query_spec.rb +1 -1
- data/spec/models/tag_list_op_data_inner_spec.rb +1 -1
- data/spec/models/tag_list_op_spec.rb +1 -1
- data/spec/models/tag_segment_op_data_inner_spec.rb +1 -1
- data/spec/models/tag_segment_op_spec.rb +1 -1
- data/spec/models/tag_update_query_resource_object_spec.rb +1 -1
- data/spec/models/tag_update_query_spec.rb +1 -1
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +1 -7
- data/spec/models/template_clone_query_resource_object_spec.rb +7 -1
- data/spec/models/template_clone_query_spec.rb +1 -1
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/template_create_query_resource_object_spec.rb +1 -1
- data/spec/models/template_create_query_spec.rb +1 -1
- data/spec/models/template_enum_spec.rb +1 -1
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +1 -7
- data/spec/models/template_render_query_resource_object_spec.rb +7 -1
- data/spec/models/template_render_query_spec.rb +1 -1
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +1 -1
- data/spec/models/template_update_query_resource_object_spec.rb +1 -1
- data/spec/models/template_update_query_spec.rb +1 -1
- data/spec/models/throttled_schedule_options_spec.rb +1 -1
- data/spec/models/utm_params_sub_object_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +137 -11
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +0 -18
- data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +0 -34
data/docs/AccountsApi.md
CHANGED
@@ -32,7 +32,7 @@ end
|
|
32
32
|
api_instance = KlaviyoAPI::AccountsApi.new
|
33
33
|
id = 'AbC123' # String | The ID of the account
|
34
34
|
opts = {
|
35
|
-
fields_account: ['contact_information'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
35
|
+
fields_account: ['contact_information'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
36
36
|
}
|
37
37
|
|
38
38
|
begin
|
@@ -67,7 +67,7 @@ end
|
|
67
67
|
| Name | Type | Description | Notes |
|
68
68
|
| ---- | ---- | ----------- | ----- |
|
69
69
|
| **id** | **String** | The ID of the account | |
|
70
|
-
| **fields_account** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
70
|
+
| **fields_account** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
71
71
|
|
72
72
|
### Return type
|
73
73
|
|
@@ -106,7 +106,7 @@ end
|
|
106
106
|
|
107
107
|
api_instance = KlaviyoAPI::AccountsApi.new
|
108
108
|
opts = {
|
109
|
-
fields_account: ['contact_information'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
109
|
+
fields_account: ['contact_information'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
110
110
|
}
|
111
111
|
|
112
112
|
begin
|
@@ -140,7 +140,7 @@ end
|
|
140
140
|
|
141
141
|
| Name | Type | Description | Notes |
|
142
142
|
| ---- | ---- | ----------- | ----- |
|
143
|
-
| **fields_account** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
143
|
+
| **fields_account** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
144
144
|
|
145
145
|
### Return type
|
146
146
|
|
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**CampaignEnum**](CampaignEnum.md) | | |
|
8
|
+
| **id** | **String** | The campaign ID to be cloned | |
|
8
9
|
| **attributes** | [**CampaignCloneQueryResourceObjectAttributes**](CampaignCloneQueryResourceObjectAttributes.md) | | |
|
9
10
|
|
10
11
|
## Example
|
@@ -14,6 +15,7 @@ require 'klaviyo-api-sdk'
|
|
14
15
|
|
15
16
|
instance = KlaviyoAPI::CampaignCloneQueryResourceObject.new(
|
16
17
|
type: null,
|
18
|
+
id: null,
|
17
19
|
attributes: null
|
18
20
|
)
|
19
21
|
```
|
@@ -4,7 +4,6 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | The campaign ID to be cloned | |
|
8
7
|
| **new_name** | **String** | The name for the new cloned campaign | [optional] |
|
9
8
|
|
10
9
|
## Example
|
@@ -13,7 +12,6 @@
|
|
13
12
|
require 'klaviyo-api-sdk'
|
14
13
|
|
15
14
|
instance = KlaviyoAPI::CampaignCloneQueryResourceObjectAttributes.new(
|
16
|
-
id: null,
|
17
15
|
new_name: My cloned campaign's new name
|
18
16
|
)
|
19
17
|
```
|
@@ -5,8 +5,8 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**CampaignMessageEnum**](CampaignMessageEnum.md) | | |
|
8
|
-
| **
|
9
|
-
| **relationships** | [**CampaignMessageAssignTemplateQueryResourceObjectRelationships**](CampaignMessageAssignTemplateQueryResourceObjectRelationships.md) | |
|
8
|
+
| **id** | **String** | The message ID to be assigned to | |
|
9
|
+
| **relationships** | [**CampaignMessageAssignTemplateQueryResourceObjectRelationships**](CampaignMessageAssignTemplateQueryResourceObjectRelationships.md) | | |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
@@ -15,7 +15,7 @@ require 'klaviyo-api-sdk'
|
|
15
15
|
|
16
16
|
instance = KlaviyoAPI::CampaignMessageAssignTemplateQueryResourceObject.new(
|
17
17
|
type: null,
|
18
|
-
|
18
|
+
id: null,
|
19
19
|
relationships: null
|
20
20
|
)
|
21
21
|
```
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **template** | [**CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate**](CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate.md) | |
|
7
|
+
| **template** | [**CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate**](CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate.md) | | |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**CampaignRecipientEstimationJobEnum**](CampaignRecipientEstimationJobEnum.md) | | |
|
8
|
-
| **
|
8
|
+
| **id** | **String** | The ID of the campaign to perform recipient estimation | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -14,7 +14,7 @@ require 'klaviyo-api-sdk'
|
|
14
14
|
|
15
15
|
instance = KlaviyoAPI::CampaignRecipientEstimationJobCreateQueryResourceObject.new(
|
16
16
|
type: null,
|
17
|
-
|
17
|
+
id: null
|
18
18
|
)
|
19
19
|
```
|
20
20
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**CampaignSendJobEnum**](CampaignSendJobEnum.md) | | |
|
8
|
-
| **
|
8
|
+
| **id** | **String** | The ID of the campaign to send | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -14,7 +14,7 @@ require 'klaviyo-api-sdk'
|
|
14
14
|
|
15
15
|
instance = KlaviyoAPI::CampaignSendJobCreateQueryResourceObject.new(
|
16
16
|
type: null,
|
17
|
-
|
17
|
+
id: null
|
18
18
|
)
|
19
19
|
```
|
20
20
|
|
data/docs/CampaignsApi.md
CHANGED
@@ -122,7 +122,7 @@ KlaviyoAPI.configure do |config|
|
|
122
122
|
end
|
123
123
|
|
124
124
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
125
|
-
campaign_clone_query = KlaviyoAPI::CampaignCloneQuery.new({data: KlaviyoAPI::CampaignCloneQueryResourceObject.new({type: KlaviyoAPI::CampaignEnum::CAMPAIGN, attributes: KlaviyoAPI::CampaignCloneQueryResourceObjectAttributes.new
|
125
|
+
campaign_clone_query = KlaviyoAPI::CampaignCloneQuery.new({data: KlaviyoAPI::CampaignCloneQueryResourceObject.new({type: KlaviyoAPI::CampaignEnum::CAMPAIGN, id: 'id_example', attributes: KlaviyoAPI::CampaignCloneQueryResourceObjectAttributes.new})}) # CampaignCloneQuery | Clones a campaign from an existing campaign
|
126
126
|
|
127
127
|
begin
|
128
128
|
# Create Campaign Clone
|
@@ -193,7 +193,7 @@ KlaviyoAPI.configure do |config|
|
|
193
193
|
end
|
194
194
|
|
195
195
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
196
|
-
campaign_message_assign_template_query = KlaviyoAPI::CampaignMessageAssignTemplateQuery.new({data: KlaviyoAPI::CampaignMessageAssignTemplateQueryResourceObject.new({type: KlaviyoAPI::CampaignMessageEnum::CAMPAIGN_MESSAGE,
|
196
|
+
campaign_message_assign_template_query = KlaviyoAPI::CampaignMessageAssignTemplateQuery.new({data: KlaviyoAPI::CampaignMessageAssignTemplateQueryResourceObject.new({type: KlaviyoAPI::CampaignMessageEnum::CAMPAIGN_MESSAGE, id: 'id_example', relationships: KlaviyoAPI::CampaignMessageAssignTemplateQueryResourceObjectRelationships.new({template: KlaviyoAPI::CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate.new({data: KlaviyoAPI::CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplateData.new({type: KlaviyoAPI::TemplateEnum::TEMPLATE, id: 'RipRmi'})})})})}) # CampaignMessageAssignTemplateQuery | Takes a reusable template, clones it, and assigns the non-reusable clone to the message.
|
197
197
|
|
198
198
|
begin
|
199
199
|
# Assign Campaign Message Template
|
@@ -264,7 +264,7 @@ KlaviyoAPI.configure do |config|
|
|
264
264
|
end
|
265
265
|
|
266
266
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
267
|
-
campaign_recipient_estimation_job_create_query = KlaviyoAPI::CampaignRecipientEstimationJobCreateQuery.new({data: KlaviyoAPI::CampaignRecipientEstimationJobCreateQueryResourceObject.new({type: KlaviyoAPI::CampaignRecipientEstimationJobEnum::CAMPAIGN_RECIPIENT_ESTIMATION_JOB,
|
267
|
+
campaign_recipient_estimation_job_create_query = KlaviyoAPI::CampaignRecipientEstimationJobCreateQuery.new({data: KlaviyoAPI::CampaignRecipientEstimationJobCreateQueryResourceObject.new({type: KlaviyoAPI::CampaignRecipientEstimationJobEnum::CAMPAIGN_RECIPIENT_ESTIMATION_JOB, id: 'id_example'})}) # CampaignRecipientEstimationJobCreateQuery | Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.
|
268
268
|
|
269
269
|
begin
|
270
270
|
# Create Campaign Recipient Estimation Job
|
@@ -335,7 +335,7 @@ KlaviyoAPI.configure do |config|
|
|
335
335
|
end
|
336
336
|
|
337
337
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
338
|
-
campaign_send_job_create_query = KlaviyoAPI::CampaignSendJobCreateQuery.new({data: KlaviyoAPI::CampaignSendJobCreateQueryResourceObject.new({type: KlaviyoAPI::CampaignSendJobEnum::CAMPAIGN_SEND_JOB,
|
338
|
+
campaign_send_job_create_query = KlaviyoAPI::CampaignSendJobCreateQuery.new({data: KlaviyoAPI::CampaignSendJobCreateQueryResourceObject.new({type: KlaviyoAPI::CampaignSendJobEnum::CAMPAIGN_SEND_JOB, id: 'id_example'})}) # CampaignSendJobCreateQuery | Trigger the campaign to send asynchronously
|
339
339
|
|
340
340
|
begin
|
341
341
|
# Create Campaign Send Job
|
@@ -478,10 +478,10 @@ end
|
|
478
478
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
479
479
|
id = 'id_example' # String | The campaign ID to be retrieved
|
480
480
|
opts = {
|
481
|
-
fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
482
|
-
fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
483
|
-
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
484
|
-
include: ['campaign-messages'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
481
|
+
fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
482
|
+
fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
483
|
+
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
484
|
+
include: ['campaign-messages'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships
|
485
485
|
}
|
486
486
|
|
487
487
|
begin
|
@@ -516,10 +516,10 @@ end
|
|
516
516
|
| Name | Type | Description | Notes |
|
517
517
|
| ---- | ---- | ----------- | ----- |
|
518
518
|
| **id** | **String** | The campaign ID to be retrieved | |
|
519
|
-
| **fields_campaign_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
520
|
-
| **fields_campaign** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
521
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
522
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
519
|
+
| **fields_campaign_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
520
|
+
| **fields_campaign** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
521
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
522
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships | [optional] |
|
523
523
|
|
524
524
|
### Return type
|
525
525
|
|
@@ -559,10 +559,10 @@ end
|
|
559
559
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
560
560
|
id = 'id_example' # String |
|
561
561
|
opts = {
|
562
|
-
fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
563
|
-
fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
564
|
-
fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
565
|
-
include: ['campaign'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
562
|
+
fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
563
|
+
fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
564
|
+
fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
565
|
+
include: ['campaign'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships
|
566
566
|
}
|
567
567
|
|
568
568
|
begin
|
@@ -597,10 +597,10 @@ end
|
|
597
597
|
| Name | Type | Description | Notes |
|
598
598
|
| ---- | ---- | ----------- | ----- |
|
599
599
|
| **id** | **String** | | |
|
600
|
-
| **fields_campaign_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
601
|
-
| **fields_campaign** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
602
|
-
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
603
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
600
|
+
| **fields_campaign_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
601
|
+
| **fields_campaign** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
602
|
+
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
603
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships | [optional] |
|
604
604
|
|
605
605
|
### Return type
|
606
606
|
|
@@ -640,10 +640,10 @@ end
|
|
640
640
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
641
641
|
id = 'id_example' # String | The message ID to be retrieved
|
642
642
|
opts = {
|
643
|
-
fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
644
|
-
fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
645
|
-
fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
646
|
-
include: ['campaign'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
643
|
+
fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
644
|
+
fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
645
|
+
fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
646
|
+
include: ['campaign'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships
|
647
647
|
}
|
648
648
|
|
649
649
|
begin
|
@@ -678,10 +678,10 @@ end
|
|
678
678
|
| Name | Type | Description | Notes |
|
679
679
|
| ---- | ---- | ----------- | ----- |
|
680
680
|
| **id** | **String** | The message ID to be retrieved | |
|
681
|
-
| **fields_campaign_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
682
|
-
| **fields_campaign** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
683
|
-
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
684
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
681
|
+
| **fields_campaign_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
682
|
+
| **fields_campaign** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
683
|
+
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
684
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships | [optional] |
|
685
685
|
|
686
686
|
### Return type
|
687
687
|
|
@@ -721,7 +721,7 @@ end
|
|
721
721
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
722
722
|
id = 'id_example' # String |
|
723
723
|
opts = {
|
724
|
-
fields_campaign_message: ['label'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
724
|
+
fields_campaign_message: ['label'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
725
725
|
}
|
726
726
|
|
727
727
|
begin
|
@@ -756,7 +756,7 @@ end
|
|
756
756
|
| Name | Type | Description | Notes |
|
757
757
|
| ---- | ---- | ----------- | ----- |
|
758
758
|
| **id** | **String** | | |
|
759
|
-
| **fields_campaign_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
759
|
+
| **fields_campaign_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
760
760
|
|
761
761
|
### Return type
|
762
762
|
|
@@ -938,7 +938,7 @@ end
|
|
938
938
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
939
939
|
id = 'id_example' # String |
|
940
940
|
opts = {
|
941
|
-
fields_template: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
941
|
+
fields_template: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
942
942
|
}
|
943
943
|
|
944
944
|
begin
|
@@ -973,7 +973,7 @@ end
|
|
973
973
|
| Name | Type | Description | Notes |
|
974
974
|
| ---- | ---- | ----------- | ----- |
|
975
975
|
| **id** | **String** | | |
|
976
|
-
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
976
|
+
| **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
977
977
|
|
978
978
|
### Return type
|
979
979
|
|
@@ -1013,7 +1013,7 @@ end
|
|
1013
1013
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
1014
1014
|
id = 'id_example' # String | The ID of the campaign for which to get the estimated number of recipients
|
1015
1015
|
opts = {
|
1016
|
-
fields_campaign_recipient_estimation: ['estimated_recipient_count'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1016
|
+
fields_campaign_recipient_estimation: ['estimated_recipient_count'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
1017
1017
|
}
|
1018
1018
|
|
1019
1019
|
begin
|
@@ -1048,7 +1048,7 @@ end
|
|
1048
1048
|
| Name | Type | Description | Notes |
|
1049
1049
|
| ---- | ---- | ----------- | ----- |
|
1050
1050
|
| **id** | **String** | The ID of the campaign for which to get the estimated number of recipients | |
|
1051
|
-
| **fields_campaign_recipient_estimation** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1051
|
+
| **fields_campaign_recipient_estimation** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1052
1052
|
|
1053
1053
|
### Return type
|
1054
1054
|
|
@@ -1088,7 +1088,7 @@ end
|
|
1088
1088
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
1089
1089
|
id = 'id_example' # String | The ID of the campaign to get recipient estimation status
|
1090
1090
|
opts = {
|
1091
|
-
fields_campaign_recipient_estimation_job: ['status'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1091
|
+
fields_campaign_recipient_estimation_job: ['status'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
1092
1092
|
}
|
1093
1093
|
|
1094
1094
|
begin
|
@@ -1123,7 +1123,7 @@ end
|
|
1123
1123
|
| Name | Type | Description | Notes |
|
1124
1124
|
| ---- | ---- | ----------- | ----- |
|
1125
1125
|
| **id** | **String** | The ID of the campaign to get recipient estimation status | |
|
1126
|
-
| **fields_campaign_recipient_estimation_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1126
|
+
| **fields_campaign_recipient_estimation_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1127
1127
|
|
1128
1128
|
### Return type
|
1129
1129
|
|
@@ -1305,7 +1305,7 @@ end
|
|
1305
1305
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
1306
1306
|
id = 'id_example' # String | The ID of the campaign to send
|
1307
1307
|
opts = {
|
1308
|
-
fields_campaign_send_job: ['status'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1308
|
+
fields_campaign_send_job: ['status'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
1309
1309
|
}
|
1310
1310
|
|
1311
1311
|
begin
|
@@ -1340,7 +1340,7 @@ end
|
|
1340
1340
|
| Name | Type | Description | Notes |
|
1341
1341
|
| ---- | ---- | ----------- | ----- |
|
1342
1342
|
| **id** | **String** | The ID of the campaign to send | |
|
1343
|
-
| **fields_campaign_send_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1343
|
+
| **fields_campaign_send_job** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1344
1344
|
|
1345
1345
|
### Return type
|
1346
1346
|
|
@@ -1380,7 +1380,7 @@ end
|
|
1380
1380
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
1381
1381
|
id = 'id_example' # String |
|
1382
1382
|
opts = {
|
1383
|
-
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1383
|
+
fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
1384
1384
|
}
|
1385
1385
|
|
1386
1386
|
begin
|
@@ -1415,7 +1415,7 @@ end
|
|
1415
1415
|
| Name | Type | Description | Notes |
|
1416
1416
|
| ---- | ---- | ----------- | ----- |
|
1417
1417
|
| **id** | **String** | | |
|
1418
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1418
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1419
1419
|
|
1420
1420
|
### Return type
|
1421
1421
|
|
@@ -1453,14 +1453,14 @@ KlaviyoAPI.configure do |config|
|
|
1453
1453
|
end
|
1454
1454
|
|
1455
1455
|
api_instance = KlaviyoAPI::CampaignsApi.new
|
1456
|
-
filter = 'equals(messages.channel,'sms')' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1456
|
+
filter = 'equals(messages.channel,'sms')' # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-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`
|
1457
1457
|
opts = {
|
1458
|
-
fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1459
|
-
fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1460
|
-
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1461
|
-
include: ['campaign-messages'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1462
|
-
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1463
|
-
sort: 'created_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1458
|
+
fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
1459
|
+
fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
1460
|
+
fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
|
1461
|
+
include: ['campaign-messages'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships
|
1462
|
+
page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination
|
1463
|
+
sort: 'created_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting
|
1464
1464
|
}
|
1465
1465
|
|
1466
1466
|
begin
|
@@ -1494,13 +1494,13 @@ end
|
|
1494
1494
|
|
1495
1495
|
| Name | Type | Description | Notes |
|
1496
1496
|
| ---- | ---- | ----------- | ----- |
|
1497
|
-
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1498
|
-
| **fields_campaign_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1499
|
-
| **fields_campaign** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1500
|
-
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1501
|
-
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1502
|
-
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1503
|
-
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-
|
1497
|
+
| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-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` | |
|
1498
|
+
| **fields_campaign_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1499
|
+
| **fields_campaign** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1500
|
+
| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
|
1501
|
+
| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships | [optional] |
|
1502
|
+
| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination | [optional] |
|
1503
|
+
| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting | [optional] |
|
1504
1504
|
|
1505
1505
|
### Return type
|
1506
1506
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**Array<
|
7
|
+
| **data** | [**Array<CatalogCategoryCreateQueryResourceObjectRelationshipsItemsDataInner>**](CatalogCategoryCreateQueryResourceObjectRelationshipsItemsDataInner.md) | | |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# KlaviyoAPI::CatalogCategoryCreateQueryResourceObjectRelationshipsItemsDataInner
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**CatalogItemEnum**](CatalogItemEnum.md) | | |
|
8
|
+
| **id** | **String** | A list of catalog item IDs that are in the given category. | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'klaviyo-api-sdk'
|
14
|
+
|
15
|
+
instance = KlaviyoAPI::CatalogCategoryCreateQueryResourceObjectRelationshipsItemsDataInner.new(
|
16
|
+
type: null,
|
17
|
+
id: $custom:::$default:::SAMPLE-DATA-ITEM-1
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**Array<
|
7
|
+
| **data** | [**Array<CatalogCategoryCreateQueryResourceObjectRelationshipsItemsDataInner>**](CatalogCategoryCreateQueryResourceObjectRelationshipsItemsDataInner.md) | | |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**CatalogCategoryEnum**](CatalogCategoryEnum.md) | | |
|
8
|
-
| **id** | **String** |
|
8
|
+
| **id** | **String** | A list of catalog category IDs representing the categories the item is in | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**CatalogVariantEnum**](CatalogVariantEnum.md) | | |
|
8
8
|
| **attributes** | [**CatalogVariantCreateQueryResourceObjectAttributes**](CatalogVariantCreateQueryResourceObjectAttributes.md) | | |
|
9
|
-
| **relationships** | [**CatalogVariantCreateQueryResourceObjectRelationships**](CatalogVariantCreateQueryResourceObjectRelationships.md) | |
|
9
|
+
| **relationships** | [**CatalogVariantCreateQueryResourceObjectRelationships**](CatalogVariantCreateQueryResourceObjectRelationships.md) | | |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
@@ -10,7 +10,7 @@
|
|
10
10
|
| **title** | **String** | The title of the catalog item variant. | |
|
11
11
|
| **description** | **String** | A description of the catalog item variant. | |
|
12
12
|
| **sku** | **String** | The SKU of the catalog item variant. | |
|
13
|
-
| **inventory_policy** | **Integer** | This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity. | [optional] |
|
13
|
+
| **inventory_policy** | **Integer** | This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity. | [optional][default to INVENTORY_POLICY::N0] |
|
14
14
|
| **inventory_quantity** | **Float** | The quantity of the catalog item variant currently in stock. | |
|
15
15
|
| **price** | **Float** | This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item). | |
|
16
16
|
| **url** | **String** | URL pointing to the location of the catalog item variant on your website. | |
|
@@ -32,7 +32,7 @@ instance = KlaviyoAPI::CatalogVariantCreateQueryResourceObjectAttributes.new(
|
|
32
32
|
title: Ocean Blue Shirt (Sample) Variant Medium,
|
33
33
|
description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
|
34
34
|
sku: OBS-MD,
|
35
|
-
inventory_policy:
|
35
|
+
inventory_policy: 2,
|
36
36
|
inventory_quantity: 25,
|
37
37
|
price: 42,
|
38
38
|
url: https://via.placeholder.com/150,
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **item** | [**CatalogVariantCreateQueryResourceObjectRelationshipsItem**](CatalogVariantCreateQueryResourceObjectRelationshipsItem.md) | |
|
7
|
+
| **item** | [**CatalogVariantCreateQueryResourceObjectRelationshipsItem**](CatalogVariantCreateQueryResourceObjectRelationshipsItem.md) | | |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**CatalogItemEnum**](CatalogItemEnum.md) | | |
|
8
|
-
| **id** | **String** |
|
8
|
+
| **id** | **String** | The original catalog item ID for which this is a variant. | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|