klaviyo-api-sdk 2.0.0 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +65 -0
- data/README.md +487 -230
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +160 -0
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +89 -89
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +357 -357
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
- data/lib/klaviyo-api-sdk/api/events_api.rb +52 -52
- data/lib/klaviyo-api-sdk/api/flows_api.rb +210 -155
- data/lib/klaviyo-api-sdk/api/lists_api.rb +80 -72
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +18 -18
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +86 -92
- data/lib/klaviyo-api-sdk/api/segments_api.rb +68 -60
- data/lib/klaviyo-api-sdk/api/tags_api.rb +107 -107
- data/lib/klaviyo-api-sdk/api/templates_api.rb +32 -32
- 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/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +35 -35
- 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 +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +17 -17
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships.rb → catalog_category_update_query_resource_object_relationships.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items.rb → catalog_category_update_query_resource_object_relationships_items.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_update_query_resource_object_relationships_items_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_resource_object_relationships_categories_data_inner.rb → catalog_item_category_op_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +71 -71
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +28 -28
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +43 -43
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +114 -114
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +57 -57
- data/lib/klaviyo-api-sdk/models/content_sub_object.rb +30 -30
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +15 -15
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/event_create_query_resource_object_attributes.rb +16 -16
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response.rb → get_create_variants_jobs5_xx_response.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner.rb → get_create_variants_jobs5_xx_response_errors_inner.rb} +40 -40
- data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner_source.rb → get_create_variants_jobs5_xx_response_errors_inner_source.rb} +17 -17
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +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 +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +67 -67
- data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +39 -39
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/{onsite_profile_create_query_resource_object_attributes.rb → profile_partial_update_query_resource_object_attributes.rb} +48 -48
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.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_unsubscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +1 -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 +19 -19
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription.rb +15 -15
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +23 -23
- data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -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 +19 -19
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +15 -15
- 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 +1 -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 +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -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 +1 -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 +19 -19
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.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 +19 -19
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +17 -17
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +32 -32
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +17 -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 +19 -19
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -16
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
- data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +15 -15
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object_attributes.rb +18 -18
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object_attributes.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 +10 -46
- metadata +16 -558
- data/Gemfile +0 -9
- data/Rakefile +0 -10
- data/docs/AudiencesSubObject.md +0 -20
- data/docs/CampaignCloneQuery.md +0 -18
- data/docs/CampaignCloneQueryResourceObject.md +0 -20
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignCreateQuery.md +0 -18
- data/docs/CampaignCreateQueryResourceObject.md +0 -20
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/CampaignEnum.md +0 -15
- data/docs/CampaignMessageAssignTemplateQuery.md +0 -18
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +0 -20
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignMessageEnum.md +0 -15
- data/docs/CampaignMessagePartialUpdateQuery.md +0 -18
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/CampaignPartialUpdateQuery.md +0 -18
- data/docs/CampaignPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +0 -26
- data/docs/CampaignRecipientEstimationEnum.md +0 -15
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +0 -18
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignRecipientEstimationJobEnum.md +0 -15
- data/docs/CampaignSendJobCreateQuery.md +0 -18
- data/docs/CampaignSendJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignSendJobEnum.md +0 -15
- data/docs/CampaignSendJobPartialUpdateQuery.md +0 -18
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignsApi.md +0 -1275
- data/docs/CatalogCategoryBulkCreateJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogCategoryCreateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateQueryResourceObject.md +0 -22
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +0 -24
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryEnum.md +0 -15
- data/docs/CatalogCategoryItemOp.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryUpdateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemBulkCreateJobEnum.md +0 -15
- data/docs/CatalogItemBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogItemBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogItemCategoryOp.md +0 -18
- data/docs/CatalogItemCreateJobCreateQuery.md +0 -18
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemCreateQuery.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObject.md +0 -22
- data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogItemEnum.md +0 -15
- data/docs/CatalogItemUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemUpdateQuery.md +0 -18
- data/docs/CatalogItemUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +0 -34
- data/docs/CatalogJobErrorPayload.md +0 -26
- data/docs/CatalogVariantBulkCreateJobEnum.md +0 -15
- data/docs/CatalogVariantBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogVariantBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogVariantCreateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +0 -46
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItems.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogVariantEnum.md +0 -15
- data/docs/CatalogVariantUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantUpdateQuery.md +0 -18
- data/docs/CatalogVariantUpdateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogsApi.md +0 -4032
- data/docs/ClientApi.md +0 -205
- data/docs/CollectionLinks.md +0 -26
- data/docs/ContentSubObject.md +0 -28
- data/docs/DataPrivacyApi.md +0 -78
- data/docs/DataPrivacyCreateDeletionJobQuery.md +0 -18
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +0 -20
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +0 -22
- data/docs/DataPrivacyDeletionJobEnum.md +0 -15
- data/docs/EmailChannel.md +0 -18
- data/docs/EmailMarketing.md +0 -32
- data/docs/EmailMarketingListSuppression.md +0 -22
- data/docs/EmailMarketingSuppression.md +0 -20
- data/docs/EmailMessageContent.md +0 -24
- data/docs/EmailTrackingOptions.md +0 -24
- data/docs/ErrorSource.md +0 -18
- data/docs/EventCreateQuery.md +0 -18
- data/docs/EventCreateQueryResourceObject.md +0 -20
- data/docs/EventCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/EventEnum.md +0 -15
- data/docs/EventsApi.md +0 -544
- data/docs/FlowActionEnum.md +0 -15
- data/docs/FlowEnum.md +0 -15
- data/docs/FlowMessageEnum.md +0 -15
- data/docs/FlowUpdateQuery.md +0 -18
- data/docs/FlowUpdateQueryResourceObject.md +0 -22
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/FlowsApi.md +0 -1173
- data/docs/GetCampaigns4XXResponse.md +0 -18
- data/docs/GetCampaigns4XXResponseErrorsInner.md +0 -26
- data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +0 -20
- data/docs/ListCreateQuery.md +0 -18
- data/docs/ListCreateQueryResourceObject.md +0 -20
- data/docs/ListCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/ListEnum.md +0 -15
- data/docs/ListMembersAddQuery.md +0 -18
- data/docs/ListMembersAddQueryDataInner.md +0 -20
- data/docs/ListMembersDeleteQuery.md +0 -18
- data/docs/ListPartialUpdateQuery.md +0 -18
- data/docs/ListPartialUpdateQueryResourceObject.md +0 -22
- data/docs/ListsApi.md +0 -832
- data/docs/MetricAggregateEnum.md +0 -15
- data/docs/MetricAggregateQuery.md +0 -18
- data/docs/MetricAggregateQueryResourceObject.md +0 -20
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +0 -36
- data/docs/MetricAggregateRowDTO.md +0 -20
- data/docs/MetricCreateQuery.md +0 -20
- data/docs/MetricEnum.md +0 -15
- data/docs/MetricsApi.md +0 -233
- data/docs/ObjectLinks.md +0 -18
- data/docs/OnsiteProfileCreateQuery.md +0 -18
- data/docs/OnsiteProfileCreateQueryResourceObject.md +0 -22
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +0 -38
- data/docs/OnsiteProfileMeta.md +0 -18
- data/docs/OnsiteProfileMetaIdentifiers.md +0 -28
- data/docs/OnsiteSubscriptionCreateQuery.md +0 -18
- data/docs/OnsiteSubscriptionCreateQueryResourceObject.md +0 -20
- data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md +0 -26
- data/docs/PredictiveAnalytics.md +0 -34
- data/docs/ProfileAggregateEnum.md +0 -15
- data/docs/ProfileCreateQuery.md +0 -18
- data/docs/ProfileCreateQueryResourceObject.md +0 -20
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +0 -36
- data/docs/ProfileEnum.md +0 -15
- data/docs/ProfileLocation.md +0 -34
- data/docs/ProfileLocationLatitude.md +0 -49
- data/docs/ProfileLocationLongitude.md +0 -49
- data/docs/ProfilePartialUpdateQuery.md +0 -18
- data/docs/ProfilePartialUpdateQueryResourceObject.md +0 -22
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileUnsubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileUnsuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfilesApi.md +0 -909
- data/docs/SMSChannel.md +0 -18
- data/docs/SMSMarketing.md +0 -24
- data/docs/SMSMessageContent.md +0 -20
- data/docs/SMSRenderOptions.md +0 -24
- data/docs/SMSTrackingOptions.md +0 -20
- data/docs/STOScheduleOptions.md +0 -18
- data/docs/SegmentEnum.md +0 -15
- data/docs/SegmentPartialUpdateQuery.md +0 -18
- data/docs/SegmentPartialUpdateQueryResourceObject.md +0 -22
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/SegmentsApi.md +0 -543
- data/docs/SendOptions.md +0 -20
- data/docs/SendOptionsSubObject.md +0 -18
- data/docs/SendStrategySubObject.md +0 -24
- data/docs/SendTimeSubObject.md +0 -20
- data/docs/StaticScheduleOptions.md +0 -22
- data/docs/Subscription.md +0 -24
- data/docs/SubscriptionChannels.md +0 -20
- data/docs/SubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/SubscriptionEnum.md +0 -15
- data/docs/Subscriptions.md +0 -20
- data/docs/Suppression.md +0 -18
- data/docs/SuppressionCreateJobCreateQuery.md +0 -18
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagCampaignOp.md +0 -18
- data/docs/TagCampaignOpDataInner.md +0 -20
- data/docs/TagCreateQuery.md +0 -18
- data/docs/TagCreateQueryResourceObject.md +0 -20
- data/docs/TagCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagEnum.md +0 -15
- data/docs/TagFlowOp.md +0 -18
- data/docs/TagFlowOpDataInner.md +0 -20
- data/docs/TagGroupCreateQuery.md +0 -18
- data/docs/TagGroupCreateQueryResourceObject.md +0 -20
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagGroupEnum.md +0 -15
- data/docs/TagGroupUpdateQuery.md +0 -18
- data/docs/TagGroupUpdateQueryResourceObject.md +0 -22
- data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagListOp.md +0 -18
- data/docs/TagListOpDataInner.md +0 -20
- data/docs/TagSegmentOp.md +0 -18
- data/docs/TagSegmentOpDataInner.md +0 -20
- data/docs/TagUpdateQuery.md +0 -18
- data/docs/TagUpdateQueryResourceObject.md +0 -22
- data/docs/TagUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagsApi.md +0 -1923
- data/docs/TemplateCloneQuery.md +0 -18
- data/docs/TemplateCloneQueryResourceObject.md +0 -20
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +0 -22
- data/docs/TemplateCreateQuery.md +0 -18
- data/docs/TemplateCreateQueryResourceObject.md +0 -20
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +0 -32
- data/docs/TemplateEnum.md +0 -15
- data/docs/TemplateRenderQuery.md +0 -18
- data/docs/TemplateRenderQueryResourceObject.md +0 -20
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +0 -22
- data/docs/TemplateUpdateQuery.md +0 -18
- data/docs/TemplateUpdateQueryResourceObject.md +0 -22
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +0 -30
- data/docs/TemplatesApi.md +0 -525
- data/docs/TestApiAnalyticsSampleEnum.md +0 -15
- data/docs/TestListEnum.md +0 -15
- data/docs/ThrottledScheduleOptions.md +0 -20
- data/docs/TrackingOptionsSubObject.md +0 -24
- data/docs/UTMParamsSubObject.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/UnsuppressionCreateJobCreateQuery.md +0 -18
- data/docs/UnsuppressionCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/UnsuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/UtmParamInfo.md +0 -20
- data/git_push.sh +0 -57
- data/lib/klaviyo-api-sdk/api/client_api.rb +0 -249
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +0 -284
- data/lib/klaviyo-api-sdk/models/collection_links.rb +0 -260
- data/lib/klaviyo-api-sdk/models/email_channel.rb +0 -219
- data/lib/klaviyo-api-sdk/models/email_marketing.rb +0 -298
- data/lib/klaviyo-api-sdk/models/email_marketing_list_suppression.rb +0 -255
- data/lib/klaviyo-api-sdk/models/email_marketing_suppression.rb +0 -240
- data/lib/klaviyo-api-sdk/models/email_message_content.rb +0 -266
- data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +0 -268
- data/lib/klaviyo-api-sdk/models/error_source.rb +0 -227
- data/lib/klaviyo-api-sdk/models/flow_action_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +0 -242
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/object_links.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +0 -247
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +0 -269
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +0 -224
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object.rb +0 -238
- data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object_attributes.rb +0 -265
- data/lib/klaviyo-api-sdk/models/predictive_analytics.rb +0 -300
- data/lib/klaviyo-api-sdk/models/profile_aggregate_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/send_options.rb +0 -238
- data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +0 -240
- data/lib/klaviyo-api-sdk/models/sms_channel.rb +0 -219
- data/lib/klaviyo-api-sdk/models/sms_marketing.rb +0 -270
- data/lib/klaviyo-api-sdk/models/sms_message_content.rb +0 -238
- data/lib/klaviyo-api-sdk/models/sms_render_options.rb +0 -266
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +0 -240
- data/lib/klaviyo-api-sdk/models/subscription_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/subscriptions.rb +0 -228
- data/lib/klaviyo-api-sdk/models/test_api_analytics_sample_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/test_list_enum.rb +0 -36
- data/lib/klaviyo-api-sdk/models/utm_param_info.rb +0 -238
- data/spec/api/campaigns_api_spec.rb +0 -255
- data/spec/api/catalogs_api_spec.rb +0 -751
- data/spec/api/client_api_spec.rb +0 -74
- data/spec/api/data_privacy_api_spec.rb +0 -47
- data/spec/api/events_api_spec.rb +0 -132
- data/spec/api/flows_api_spec.rb +0 -247
- data/spec/api/lists_api_spec.rb +0 -180
- data/spec/api/metrics_api_spec.rb +0 -74
- data/spec/api/profiles_api_spec.rb +0 -194
- data/spec/api/segments_api_spec.rb +0 -130
- data/spec/api/tags_api_spec.rb +0 -367
- data/spec/api/templates_api_spec.rb +0 -124
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/audiences_sub_object_spec.rb +0 -40
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_clone_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_clone_query_spec.rb +0 -34
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/campaign_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_create_query_spec.rb +0 -34
- data/spec/models/campaign_enum_spec.rb +0 -28
- data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_spec.rb +0 -34
- data/spec/models/campaign_message_enum_spec.rb +0 -28
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_message_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_enum_spec.rb +0 -28
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_send_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_send_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +0 -34
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +0 -56
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_category_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_enum_spec.rb +0 -28
- data/spec/models/catalog_category_item_op_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_category_update_query_spec.rb +0 -34
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_category_op_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +0 -44
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_item_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_enum_spec.rb +0 -28
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +0 -82
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_item_update_query_spec.rb +0 -34
- data/spec/models/catalog_job_error_payload_spec.rb +0 -58
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +0 -126
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_data_inner_spec.rb +0 -44
- data/spec/models/catalog_variant_create_query_resource_object_relationships_items_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_update_query_spec.rb +0 -34
- data/spec/models/collection_links_spec.rb +0 -58
- data/spec/models/content_sub_object_spec.rb +0 -64
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +0 -40
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +0 -34
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +0 -28
- data/spec/models/email_channel_spec.rb +0 -34
- data/spec/models/email_marketing_list_suppression_spec.rb +0 -46
- data/spec/models/email_marketing_spec.rb +0 -76
- data/spec/models/email_marketing_suppression_spec.rb +0 -40
- data/spec/models/email_message_content_spec.rb +0 -52
- data/spec/models/email_tracking_options_spec.rb +0 -52
- data/spec/models/error_source_spec.rb +0 -34
- data/spec/models/event_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/event_create_query_resource_object_spec.rb +0 -40
- data/spec/models/event_create_query_spec.rb +0 -34
- data/spec/models/event_enum_spec.rb +0 -28
- data/spec/models/flow_action_enum_spec.rb +0 -28
- data/spec/models/flow_enum_spec.rb +0 -28
- data/spec/models/flow_message_enum_spec.rb +0 -28
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/flow_update_query_resource_object_spec.rb +0 -46
- data/spec/models/flow_update_query_spec.rb +0 -34
- data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +0 -40
- data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +0 -58
- data/spec/models/get_campaigns4_xx_response_spec.rb +0 -34
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/list_create_query_resource_object_spec.rb +0 -40
- data/spec/models/list_create_query_spec.rb +0 -34
- data/spec/models/list_enum_spec.rb +0 -28
- data/spec/models/list_members_add_query_data_inner_spec.rb +0 -44
- data/spec/models/list_members_add_query_spec.rb +0 -34
- data/spec/models/list_members_delete_query_spec.rb +0 -34
- data/spec/models/list_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/list_partial_update_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_enum_spec.rb +0 -28
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +0 -40
- data/spec/models/metric_aggregate_query_spec.rb +0 -34
- data/spec/models/metric_aggregate_row_dto_spec.rb +0 -40
- data/spec/models/metric_create_query_spec.rb +0 -40
- data/spec/models/metric_enum_spec.rb +0 -28
- data/spec/models/object_links_spec.rb +0 -34
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +0 -94
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +0 -46
- data/spec/models/onsite_profile_create_query_spec.rb +0 -34
- data/spec/models/onsite_profile_meta_identifiers_spec.rb +0 -64
- data/spec/models/onsite_profile_meta_spec.rb +0 -34
- data/spec/models/onsite_subscription_create_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/onsite_subscription_create_query_resource_object_spec.rb +0 -40
- data/spec/models/onsite_subscription_create_query_spec.rb +0 -34
- data/spec/models/predictive_analytics_spec.rb +0 -82
- data/spec/models/profile_aggregate_enum_spec.rb +0 -28
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +0 -88
- data/spec/models/profile_create_query_resource_object_spec.rb +0 -40
- data/spec/models/profile_create_query_spec.rb +0 -34
- data/spec/models/profile_enum_spec.rb +0 -28
- data/spec/models/profile_location_latitude_spec.rb +0 -31
- data/spec/models/profile_location_longitude_spec.rb +0 -31
- data/spec/models/profile_location_spec.rb +0 -82
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/profile_partial_update_query_spec.rb +0 -34
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_unsubscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_unsuppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/segment_enum_spec.rb +0 -28
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/segment_partial_update_query_spec.rb +0 -34
- data/spec/models/send_options_spec.rb +0 -40
- data/spec/models/send_options_sub_object_spec.rb +0 -34
- data/spec/models/send_strategy_sub_object_spec.rb +0 -52
- data/spec/models/send_time_sub_object_spec.rb +0 -40
- data/spec/models/sms_channel_spec.rb +0 -34
- data/spec/models/sms_marketing_spec.rb +0 -52
- data/spec/models/sms_message_content_spec.rb +0 -40
- data/spec/models/sms_render_options_spec.rb +0 -52
- data/spec/models/sms_tracking_options_spec.rb +0 -40
- data/spec/models/static_schedule_options_spec.rb +0 -46
- data/spec/models/sto_schedule_options_spec.rb +0 -34
- data/spec/models/subscription_channels_spec.rb +0 -48
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/subscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/subscription_enum_spec.rb +0 -28
- data/spec/models/subscription_spec.rb +0 -52
- data/spec/models/subscriptions_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/suppression_spec.rb +0 -34
- data/spec/models/tag_campaign_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_campaign_op_spec.rb +0 -34
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_create_query_spec.rb +0 -34
- data/spec/models/tag_enum_spec.rb +0 -28
- data/spec/models/tag_flow_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_flow_op_spec.rb +0 -34
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_group_create_query_spec.rb +0 -34
- data/spec/models/tag_group_enum_spec.rb +0 -28
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_group_update_query_spec.rb +0 -34
- data/spec/models/tag_list_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_list_op_spec.rb +0 -34
- data/spec/models/tag_segment_op_data_inner_spec.rb +0 -44
- data/spec/models/tag_segment_op_spec.rb +0 -34
- data/spec/models/tag_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/tag_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_update_query_spec.rb +0 -34
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_clone_query_resource_object_spec.rb +0 -40
- data/spec/models/template_clone_query_spec.rb +0 -34
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/template_create_query_resource_object_spec.rb +0 -40
- data/spec/models/template_create_query_spec.rb +0 -34
- data/spec/models/template_enum_spec.rb +0 -28
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_render_query_resource_object_spec.rb +0 -40
- data/spec/models/template_render_query_spec.rb +0 -34
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +0 -52
- data/spec/models/template_update_query_resource_object_spec.rb +0 -46
- data/spec/models/template_update_query_spec.rb +0 -34
- data/spec/models/test_api_analytics_sample_enum_spec.rb +0 -28
- data/spec/models/test_list_enum_spec.rb +0 -28
- data/spec/models/throttled_schedule_options_spec.rb +0 -40
- data/spec/models/tracking_options_sub_object_spec.rb +0 -52
- data/spec/models/unsubscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/unsubscription_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/unsubscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/unsuppression_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/unsuppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/utm_param_info_spec.rb +0 -40
- data/spec/models/utm_params_sub_object_spec.rb +0 -40
- data/spec/spec_helper.rb +0 -111
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2023-
|
6
|
+
The version of the OpenAPI document: 2023-06-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -20,7 +20,7 @@ module KlaviyoAPI
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Create Catalog Category
|
23
|
-
# Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
23
|
+
# Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
24
24
|
# @param catalog_category_create_query [CatalogCategoryCreateQuery]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [Hash<String, Object>]
|
@@ -30,7 +30,7 @@ module KlaviyoAPI
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Create Catalog Category
|
33
|
-
# Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
33
|
+
# Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
34
34
|
# @param catalog_category_create_query [CatalogCategoryCreateQuery]
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -51,7 +51,7 @@ module KlaviyoAPI
|
|
51
51
|
# header parameters
|
52
52
|
header_params = opts[:header_params] || {}
|
53
53
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
54
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
55
55
|
# HTTP header 'Accept' (if needed)
|
56
56
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
57
|
# HTTP header 'Content-Type'
|
@@ -90,7 +90,7 @@ module KlaviyoAPI
|
|
90
90
|
end
|
91
91
|
|
92
92
|
# Create Catalog Category Relationships Items
|
93
|
-
# Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
93
|
+
# Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
94
94
|
# @param id [String]
|
95
95
|
# @param catalog_category_item_op [CatalogCategoryItemOp]
|
96
96
|
# @param [Hash] opts the optional parameters
|
@@ -101,7 +101,7 @@ module KlaviyoAPI
|
|
101
101
|
end
|
102
102
|
|
103
103
|
# Create Catalog Category Relationships Items
|
104
|
-
# Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
104
|
+
# Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
105
105
|
# @param id [String]
|
106
106
|
# @param catalog_category_item_op [CatalogCategoryItemOp]
|
107
107
|
# @param [Hash] opts the optional parameters
|
@@ -127,7 +127,7 @@ module KlaviyoAPI
|
|
127
127
|
# header parameters
|
128
128
|
header_params = opts[:header_params] || {}
|
129
129
|
# klaviyo api revision
|
130
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
130
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
131
131
|
# HTTP header 'Accept' (if needed)
|
132
132
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
133
133
|
# HTTP header 'Content-Type'
|
@@ -166,7 +166,7 @@ module KlaviyoAPI
|
|
166
166
|
end
|
167
167
|
|
168
168
|
# Create Catalog Item
|
169
|
-
# Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
169
|
+
# Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
170
170
|
# @param catalog_item_create_query [CatalogItemCreateQuery]
|
171
171
|
# @param [Hash] opts the optional parameters
|
172
172
|
# @return [Hash<String, Object>]
|
@@ -176,7 +176,7 @@ module KlaviyoAPI
|
|
176
176
|
end
|
177
177
|
|
178
178
|
# Create Catalog Item
|
179
|
-
# Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
179
|
+
# Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
180
180
|
# @param catalog_item_create_query [CatalogItemCreateQuery]
|
181
181
|
# @param [Hash] opts the optional parameters
|
182
182
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -197,7 +197,7 @@ module KlaviyoAPI
|
|
197
197
|
# header parameters
|
198
198
|
header_params = opts[:header_params] || {}
|
199
199
|
# klaviyo api revision
|
200
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
200
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
201
201
|
# HTTP header 'Accept' (if needed)
|
202
202
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
203
203
|
# HTTP header 'Content-Type'
|
@@ -236,7 +236,7 @@ module KlaviyoAPI
|
|
236
236
|
end
|
237
237
|
|
238
238
|
# Create Catalog Item Relationships Categories
|
239
|
-
# Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
239
|
+
# Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
240
240
|
# @param id [String]
|
241
241
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
242
242
|
# @param [Hash] opts the optional parameters
|
@@ -247,7 +247,7 @@ module KlaviyoAPI
|
|
247
247
|
end
|
248
248
|
|
249
249
|
# Create Catalog Item Relationships Categories
|
250
|
-
# Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
250
|
+
# Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
251
251
|
# @param id [String]
|
252
252
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
253
253
|
# @param [Hash] opts the optional parameters
|
@@ -273,7 +273,7 @@ module KlaviyoAPI
|
|
273
273
|
# header parameters
|
274
274
|
header_params = opts[:header_params] || {}
|
275
275
|
# klaviyo api revision
|
276
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
276
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
277
277
|
# HTTP header 'Accept' (if needed)
|
278
278
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
279
279
|
# HTTP header 'Content-Type'
|
@@ -312,7 +312,7 @@ module KlaviyoAPI
|
|
312
312
|
end
|
313
313
|
|
314
314
|
# Create Catalog Variant
|
315
|
-
# Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
315
|
+
# Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
316
316
|
# @param catalog_variant_create_query [CatalogVariantCreateQuery]
|
317
317
|
# @param [Hash] opts the optional parameters
|
318
318
|
# @return [Hash<String, Object>]
|
@@ -322,7 +322,7 @@ module KlaviyoAPI
|
|
322
322
|
end
|
323
323
|
|
324
324
|
# Create Catalog Variant
|
325
|
-
# Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
325
|
+
# Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
326
326
|
# @param catalog_variant_create_query [CatalogVariantCreateQuery]
|
327
327
|
# @param [Hash] opts the optional parameters
|
328
328
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -343,7 +343,7 @@ module KlaviyoAPI
|
|
343
343
|
# header parameters
|
344
344
|
header_params = opts[:header_params] || {}
|
345
345
|
# klaviyo api revision
|
346
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
346
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
347
347
|
# HTTP header 'Accept' (if needed)
|
348
348
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
349
349
|
# HTTP header 'Content-Type'
|
@@ -382,7 +382,7 @@ module KlaviyoAPI
|
|
382
382
|
end
|
383
383
|
|
384
384
|
# Delete Catalog Category
|
385
|
-
# Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
385
|
+
# Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
386
386
|
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
387
387
|
# @param [Hash] opts the optional parameters
|
388
388
|
# @return [nil]
|
@@ -392,7 +392,7 @@ module KlaviyoAPI
|
|
392
392
|
end
|
393
393
|
|
394
394
|
# Delete Catalog Category
|
395
|
-
# Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
395
|
+
# Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
396
396
|
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
397
397
|
# @param [Hash] opts the optional parameters
|
398
398
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -413,7 +413,7 @@ module KlaviyoAPI
|
|
413
413
|
# header parameters
|
414
414
|
header_params = opts[:header_params] || {}
|
415
415
|
# klaviyo api revision
|
416
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
416
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
417
417
|
# HTTP header 'Accept' (if needed)
|
418
418
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
419
419
|
|
@@ -447,7 +447,7 @@ module KlaviyoAPI
|
|
447
447
|
end
|
448
448
|
|
449
449
|
# Delete Catalog Category Relationships Items
|
450
|
-
# Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
450
|
+
# Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
451
451
|
# @param id [String]
|
452
452
|
# @param catalog_category_item_op [CatalogCategoryItemOp]
|
453
453
|
# @param [Hash] opts the optional parameters
|
@@ -458,7 +458,7 @@ module KlaviyoAPI
|
|
458
458
|
end
|
459
459
|
|
460
460
|
# Delete Catalog Category Relationships Items
|
461
|
-
# Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
461
|
+
# Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
462
462
|
# @param id [String]
|
463
463
|
# @param catalog_category_item_op [CatalogCategoryItemOp]
|
464
464
|
# @param [Hash] opts the optional parameters
|
@@ -484,7 +484,7 @@ module KlaviyoAPI
|
|
484
484
|
# header parameters
|
485
485
|
header_params = opts[:header_params] || {}
|
486
486
|
# klaviyo api revision
|
487
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
487
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
488
488
|
# HTTP header 'Accept' (if needed)
|
489
489
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
490
490
|
# HTTP header 'Content-Type'
|
@@ -523,7 +523,7 @@ module KlaviyoAPI
|
|
523
523
|
end
|
524
524
|
|
525
525
|
# Delete Catalog Item
|
526
|
-
# Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
526
|
+
# Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
527
527
|
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
528
528
|
# @param [Hash] opts the optional parameters
|
529
529
|
# @return [nil]
|
@@ -533,7 +533,7 @@ module KlaviyoAPI
|
|
533
533
|
end
|
534
534
|
|
535
535
|
# Delete Catalog Item
|
536
|
-
# Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
536
|
+
# Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
537
537
|
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
538
538
|
# @param [Hash] opts the optional parameters
|
539
539
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -554,7 +554,7 @@ module KlaviyoAPI
|
|
554
554
|
# header parameters
|
555
555
|
header_params = opts[:header_params] || {}
|
556
556
|
# klaviyo api revision
|
557
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
557
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
558
558
|
# HTTP header 'Accept' (if needed)
|
559
559
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
560
560
|
|
@@ -588,7 +588,7 @@ module KlaviyoAPI
|
|
588
588
|
end
|
589
589
|
|
590
590
|
# Delete Catalog Item Relationships Categories
|
591
|
-
# Delete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
591
|
+
# Delete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
592
592
|
# @param id [String]
|
593
593
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
594
594
|
# @param [Hash] opts the optional parameters
|
@@ -599,7 +599,7 @@ module KlaviyoAPI
|
|
599
599
|
end
|
600
600
|
|
601
601
|
# Delete Catalog Item Relationships Categories
|
602
|
-
# Delete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
602
|
+
# Delete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
603
603
|
# @param id [String]
|
604
604
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
605
605
|
# @param [Hash] opts the optional parameters
|
@@ -625,7 +625,7 @@ module KlaviyoAPI
|
|
625
625
|
# header parameters
|
626
626
|
header_params = opts[:header_params] || {}
|
627
627
|
# klaviyo api revision
|
628
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
628
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
629
629
|
# HTTP header 'Accept' (if needed)
|
630
630
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
631
631
|
# HTTP header 'Content-Type'
|
@@ -664,7 +664,7 @@ module KlaviyoAPI
|
|
664
664
|
end
|
665
665
|
|
666
666
|
# Delete Catalog Variant
|
667
|
-
# Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
667
|
+
# Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
668
668
|
# @param id [String] The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
669
669
|
# @param [Hash] opts the optional parameters
|
670
670
|
# @return [nil]
|
@@ -674,7 +674,7 @@ module KlaviyoAPI
|
|
674
674
|
end
|
675
675
|
|
676
676
|
# Delete Catalog Variant
|
677
|
-
# Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
677
|
+
# Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
678
678
|
# @param id [String] The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
679
679
|
# @param [Hash] opts the optional parameters
|
680
680
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -695,7 +695,7 @@ module KlaviyoAPI
|
|
695
695
|
# header parameters
|
696
696
|
header_params = opts[:header_params] || {}
|
697
697
|
# klaviyo api revision
|
698
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
698
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
699
699
|
# HTTP header 'Accept' (if needed)
|
700
700
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
701
701
|
|
@@ -729,12 +729,12 @@ module KlaviyoAPI
|
|
729
729
|
end
|
730
730
|
|
731
731
|
# Get Catalog Categories
|
732
|
-
# Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
732
|
+
# Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
733
733
|
# @param [Hash] opts the optional parameters
|
734
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
735
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
736
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
737
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
734
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
735
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
736
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
737
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
738
738
|
# @return [Hash<String, Object>]
|
739
739
|
def get_catalog_categories(opts = {})
|
740
740
|
data, _status_code, _headers = get_catalog_categories_with_http_info(opts)
|
@@ -742,12 +742,12 @@ module KlaviyoAPI
|
|
742
742
|
end
|
743
743
|
|
744
744
|
# Get Catalog Categories
|
745
|
-
# Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
745
|
+
# Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
746
746
|
# @param [Hash] opts the optional parameters
|
747
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
748
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
749
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
750
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
747
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
748
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
749
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
750
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
751
751
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
752
752
|
def get_catalog_categories_with_http_info(opts = {})
|
753
753
|
if @api_client.config.debugging
|
@@ -774,7 +774,7 @@ module KlaviyoAPI
|
|
774
774
|
# header parameters
|
775
775
|
header_params = opts[:header_params] || {}
|
776
776
|
# klaviyo api revision
|
777
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
777
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
778
778
|
# HTTP header 'Accept' (if needed)
|
779
779
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
780
780
|
|
@@ -808,10 +808,10 @@ module KlaviyoAPI
|
|
808
808
|
end
|
809
809
|
|
810
810
|
# Get Catalog Category
|
811
|
-
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
811
|
+
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
812
812
|
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
813
813
|
# @param [Hash] opts the optional parameters
|
814
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
814
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
815
815
|
# @return [Hash<String, Object>]
|
816
816
|
def get_catalog_category(id, opts = {})
|
817
817
|
data, _status_code, _headers = get_catalog_category_with_http_info(id, opts)
|
@@ -819,10 +819,10 @@ module KlaviyoAPI
|
|
819
819
|
end
|
820
820
|
|
821
821
|
# Get Catalog Category
|
822
|
-
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
822
|
+
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
823
823
|
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
824
824
|
# @param [Hash] opts the optional parameters
|
825
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
825
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
826
826
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
827
827
|
def get_catalog_category_with_http_info(id, opts = {})
|
828
828
|
if @api_client.config.debugging
|
@@ -846,7 +846,7 @@ module KlaviyoAPI
|
|
846
846
|
# header parameters
|
847
847
|
header_params = opts[:header_params] || {}
|
848
848
|
# klaviyo api revision
|
849
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
849
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
850
850
|
# HTTP header 'Accept' (if needed)
|
851
851
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
852
852
|
|
@@ -880,39 +880,39 @@ module KlaviyoAPI
|
|
880
880
|
end
|
881
881
|
|
882
882
|
# Get Catalog Category Items
|
883
|
-
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
884
|
-
# @param
|
885
|
-
# @param [Hash] opts the optional parameters
|
886
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
887
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
888
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
889
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
890
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
891
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
883
|
+
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
884
|
+
# @param id [String]
|
885
|
+
# @param [Hash] opts the optional parameters
|
886
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
887
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
888
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
889
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
890
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
891
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
892
892
|
# @return [Hash<String, Object>]
|
893
|
-
def get_catalog_category_items(
|
894
|
-
data, _status_code, _headers = get_catalog_category_items_with_http_info(
|
893
|
+
def get_catalog_category_items(id, opts = {})
|
894
|
+
data, _status_code, _headers = get_catalog_category_items_with_http_info(id, opts)
|
895
895
|
data
|
896
896
|
end
|
897
897
|
|
898
898
|
# Get Catalog Category Items
|
899
|
-
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
900
|
-
# @param
|
901
|
-
# @param [Hash] opts the optional parameters
|
902
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
903
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
904
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
905
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
906
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
907
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
899
|
+
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
900
|
+
# @param id [String]
|
901
|
+
# @param [Hash] opts the optional parameters
|
902
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
903
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
904
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
905
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
906
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
907
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
908
908
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
909
|
-
def get_catalog_category_items_with_http_info(
|
909
|
+
def get_catalog_category_items_with_http_info(id, opts = {})
|
910
910
|
if @api_client.config.debugging
|
911
911
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_category_items ...'
|
912
912
|
end
|
913
|
-
# verify the required parameter '
|
914
|
-
if @api_client.config.client_side_validation &&
|
915
|
-
fail ArgumentError, "Missing the required parameter '
|
913
|
+
# verify the required parameter 'id' is set
|
914
|
+
if @api_client.config.client_side_validation && id.nil?
|
915
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.get_catalog_category_items"
|
916
916
|
end
|
917
917
|
allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
918
918
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
@@ -931,7 +931,7 @@ module KlaviyoAPI
|
|
931
931
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
932
932
|
end
|
933
933
|
# resource path
|
934
|
-
local_var_path = '/api/catalog-categories/{
|
934
|
+
local_var_path = '/api/catalog-categories/{id}/items/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
935
935
|
|
936
936
|
# query parameters
|
937
937
|
query_params = opts[:query_params] || {}
|
@@ -945,7 +945,7 @@ module KlaviyoAPI
|
|
945
945
|
# header parameters
|
946
946
|
header_params = opts[:header_params] || {}
|
947
947
|
# klaviyo api revision
|
948
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
948
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
949
949
|
# HTTP header 'Accept' (if needed)
|
950
950
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
951
951
|
|
@@ -979,10 +979,10 @@ module KlaviyoAPI
|
|
979
979
|
end
|
980
980
|
|
981
981
|
# Get Catalog Category Relationships Items
|
982
|
-
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
982
|
+
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
983
983
|
# @param id [String]
|
984
984
|
# @param [Hash] opts the optional parameters
|
985
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
985
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
986
986
|
# @return [Hash<String, Object>]
|
987
987
|
def get_catalog_category_relationships_items(id, opts = {})
|
988
988
|
data, _status_code, _headers = get_catalog_category_relationships_items_with_http_info(id, opts)
|
@@ -990,10 +990,10 @@ module KlaviyoAPI
|
|
990
990
|
end
|
991
991
|
|
992
992
|
# Get Catalog Category Relationships Items
|
993
|
-
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
993
|
+
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
994
994
|
# @param id [String]
|
995
995
|
# @param [Hash] opts the optional parameters
|
996
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
996
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
997
997
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
998
998
|
def get_catalog_category_relationships_items_with_http_info(id, opts = {})
|
999
999
|
if @api_client.config.debugging
|
@@ -1013,7 +1013,7 @@ module KlaviyoAPI
|
|
1013
1013
|
# header parameters
|
1014
1014
|
header_params = opts[:header_params] || {}
|
1015
1015
|
# klaviyo api revision
|
1016
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1016
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1017
1017
|
# HTTP header 'Accept' (if needed)
|
1018
1018
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1019
1019
|
|
@@ -1047,12 +1047,12 @@ module KlaviyoAPI
|
|
1047
1047
|
end
|
1048
1048
|
|
1049
1049
|
# Get Catalog Item
|
1050
|
-
# Get a specific catalog item with the given item ID. Include parameters can be provided to get the following related resource data: `variants`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1050
|
+
# Get a specific catalog item with the given item ID. Include parameters can be provided to get the following related resource data: `variants`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1051
1051
|
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
1052
1052
|
# @param [Hash] opts the optional parameters
|
1053
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
1054
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1055
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1053
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1054
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1055
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
1056
1056
|
# @return [Hash<String, Object>]
|
1057
1057
|
def get_catalog_item(id, opts = {})
|
1058
1058
|
data, _status_code, _headers = get_catalog_item_with_http_info(id, opts)
|
@@ -1060,12 +1060,12 @@ module KlaviyoAPI
|
|
1060
1060
|
end
|
1061
1061
|
|
1062
1062
|
# Get Catalog Item
|
1063
|
-
# Get a specific catalog item with the given item ID. Include parameters can be provided to get the following related resource data: `variants`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1063
|
+
# Get a specific catalog item with the given item ID. Include parameters can be provided to get the following related resource data: `variants`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1064
1064
|
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
1065
1065
|
# @param [Hash] opts the optional parameters
|
1066
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
1067
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1068
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1066
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1067
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1068
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
1069
1069
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1070
1070
|
def get_catalog_item_with_http_info(id, opts = {})
|
1071
1071
|
if @api_client.config.debugging
|
@@ -1099,7 +1099,7 @@ module KlaviyoAPI
|
|
1099
1099
|
# header parameters
|
1100
1100
|
header_params = opts[:header_params] || {}
|
1101
1101
|
# klaviyo api revision
|
1102
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1102
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1103
1103
|
# HTTP header 'Accept' (if needed)
|
1104
1104
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1105
1105
|
|
@@ -1133,35 +1133,35 @@ module KlaviyoAPI
|
|
1133
1133
|
end
|
1134
1134
|
|
1135
1135
|
# Get Catalog Item Categories
|
1136
|
-
# Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1137
|
-
# @param
|
1136
|
+
# Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1137
|
+
# @param id [String]
|
1138
1138
|
# @param [Hash] opts the optional parameters
|
1139
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
1140
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1141
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1142
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1139
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1140
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
1141
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1142
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
1143
1143
|
# @return [Hash<String, Object>]
|
1144
|
-
def get_catalog_item_categories(
|
1145
|
-
data, _status_code, _headers = get_catalog_item_categories_with_http_info(
|
1144
|
+
def get_catalog_item_categories(id, opts = {})
|
1145
|
+
data, _status_code, _headers = get_catalog_item_categories_with_http_info(id, opts)
|
1146
1146
|
data
|
1147
1147
|
end
|
1148
1148
|
|
1149
1149
|
# Get Catalog Item Categories
|
1150
|
-
# Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1151
|
-
# @param
|
1150
|
+
# Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1151
|
+
# @param id [String]
|
1152
1152
|
# @param [Hash] opts the optional parameters
|
1153
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
1154
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1155
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1156
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1153
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1154
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
|
1155
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1156
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
1157
1157
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1158
|
-
def get_catalog_item_categories_with_http_info(
|
1158
|
+
def get_catalog_item_categories_with_http_info(id, opts = {})
|
1159
1159
|
if @api_client.config.debugging
|
1160
1160
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_item_categories ...'
|
1161
1161
|
end
|
1162
|
-
# verify the required parameter '
|
1163
|
-
if @api_client.config.client_side_validation &&
|
1164
|
-
fail ArgumentError, "Missing the required parameter '
|
1162
|
+
# verify the required parameter 'id' is set
|
1163
|
+
if @api_client.config.client_side_validation && id.nil?
|
1164
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.get_catalog_item_categories"
|
1165
1165
|
end
|
1166
1166
|
allowable_values = ["external_id", "name", "updated"]
|
1167
1167
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
@@ -1172,7 +1172,7 @@ module KlaviyoAPI
|
|
1172
1172
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1173
1173
|
end
|
1174
1174
|
# resource path
|
1175
|
-
local_var_path = '/api/catalog-items/{
|
1175
|
+
local_var_path = '/api/catalog-items/{id}/categories/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1176
1176
|
|
1177
1177
|
# query parameters
|
1178
1178
|
query_params = opts[:query_params] || {}
|
@@ -1184,7 +1184,7 @@ module KlaviyoAPI
|
|
1184
1184
|
# header parameters
|
1185
1185
|
header_params = opts[:header_params] || {}
|
1186
1186
|
# klaviyo api revision
|
1187
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1187
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1188
1188
|
# HTTP header 'Accept' (if needed)
|
1189
1189
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1190
1190
|
|
@@ -1218,10 +1218,10 @@ module KlaviyoAPI
|
|
1218
1218
|
end
|
1219
1219
|
|
1220
1220
|
# Get Catalog Item Relationships Categories
|
1221
|
-
# Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1221
|
+
# Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1222
1222
|
# @param id [String]
|
1223
1223
|
# @param [Hash] opts the optional parameters
|
1224
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1224
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1225
1225
|
# @return [Hash<String, Object>]
|
1226
1226
|
def get_catalog_item_relationships_categories(id, opts = {})
|
1227
1227
|
data, _status_code, _headers = get_catalog_item_relationships_categories_with_http_info(id, opts)
|
@@ -1229,10 +1229,10 @@ module KlaviyoAPI
|
|
1229
1229
|
end
|
1230
1230
|
|
1231
1231
|
# Get Catalog Item Relationships Categories
|
1232
|
-
# Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1232
|
+
# Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1233
1233
|
# @param id [String]
|
1234
1234
|
# @param [Hash] opts the optional parameters
|
1235
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1235
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1236
1236
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1237
1237
|
def get_catalog_item_relationships_categories_with_http_info(id, opts = {})
|
1238
1238
|
if @api_client.config.debugging
|
@@ -1252,7 +1252,7 @@ module KlaviyoAPI
|
|
1252
1252
|
# header parameters
|
1253
1253
|
header_params = opts[:header_params] || {}
|
1254
1254
|
# klaviyo api revision
|
1255
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1255
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1256
1256
|
# HTTP header 'Accept' (if needed)
|
1257
1257
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1258
1258
|
|
@@ -1286,35 +1286,35 @@ module KlaviyoAPI
|
|
1286
1286
|
end
|
1287
1287
|
|
1288
1288
|
# Get Catalog Item Variants
|
1289
|
-
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1290
|
-
# @param
|
1289
|
+
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1290
|
+
# @param id [String]
|
1291
1291
|
# @param [Hash] opts the optional parameters
|
1292
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1293
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1294
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1295
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1292
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1293
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1294
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1295
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
1296
1296
|
# @return [Hash<String, Object>]
|
1297
|
-
def get_catalog_item_variants(
|
1298
|
-
data, _status_code, _headers = get_catalog_item_variants_with_http_info(
|
1297
|
+
def get_catalog_item_variants(id, opts = {})
|
1298
|
+
data, _status_code, _headers = get_catalog_item_variants_with_http_info(id, opts)
|
1299
1299
|
data
|
1300
1300
|
end
|
1301
1301
|
|
1302
1302
|
# Get Catalog Item Variants
|
1303
|
-
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1304
|
-
# @param
|
1303
|
+
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1304
|
+
# @param id [String]
|
1305
1305
|
# @param [Hash] opts the optional parameters
|
1306
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1307
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1308
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1309
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1306
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1307
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1308
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1309
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
1310
1310
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1311
|
-
def get_catalog_item_variants_with_http_info(
|
1311
|
+
def get_catalog_item_variants_with_http_info(id, opts = {})
|
1312
1312
|
if @api_client.config.debugging
|
1313
1313
|
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_item_variants ...'
|
1314
1314
|
end
|
1315
|
-
# verify the required parameter '
|
1316
|
-
if @api_client.config.client_side_validation &&
|
1317
|
-
fail ArgumentError, "Missing the required parameter '
|
1315
|
+
# verify the required parameter 'id' is set
|
1316
|
+
if @api_client.config.client_side_validation && id.nil?
|
1317
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.get_catalog_item_variants"
|
1318
1318
|
end
|
1319
1319
|
allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
1320
1320
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
@@ -1325,7 +1325,7 @@ module KlaviyoAPI
|
|
1325
1325
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1326
1326
|
end
|
1327
1327
|
# resource path
|
1328
|
-
local_var_path = '/api/catalog-items/{
|
1328
|
+
local_var_path = '/api/catalog-items/{id}/variants/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1329
1329
|
|
1330
1330
|
# query parameters
|
1331
1331
|
query_params = opts[:query_params] || {}
|
@@ -1337,7 +1337,7 @@ module KlaviyoAPI
|
|
1337
1337
|
# header parameters
|
1338
1338
|
header_params = opts[:header_params] || {}
|
1339
1339
|
# klaviyo api revision
|
1340
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1340
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1341
1341
|
# HTTP header 'Accept' (if needed)
|
1342
1342
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1343
1343
|
|
@@ -1371,14 +1371,14 @@ module KlaviyoAPI
|
|
1371
1371
|
end
|
1372
1372
|
|
1373
1373
|
# Get Catalog Items
|
1374
|
-
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1375
|
-
# @param [Hash] opts the optional parameters
|
1376
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
1377
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1378
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1379
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1380
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1381
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1374
|
+
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1375
|
+
# @param [Hash] opts the optional parameters
|
1376
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1377
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1378
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1379
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
1380
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1381
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
1382
1382
|
# @return [Hash<String, Object>]
|
1383
1383
|
def get_catalog_items(opts = {})
|
1384
1384
|
data, _status_code, _headers = get_catalog_items_with_http_info(opts)
|
@@ -1386,14 +1386,14 @@ module KlaviyoAPI
|
|
1386
1386
|
end
|
1387
1387
|
|
1388
1388
|
# Get Catalog Items
|
1389
|
-
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1390
|
-
# @param [Hash] opts the optional parameters
|
1391
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
1392
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1393
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1394
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1395
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1396
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1389
|
+
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1390
|
+
# @param [Hash] opts the optional parameters
|
1391
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1392
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1393
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1394
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
1395
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1396
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
1397
1397
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1398
1398
|
def get_catalog_items_with_http_info(opts = {})
|
1399
1399
|
if @api_client.config.debugging
|
@@ -1430,7 +1430,7 @@ module KlaviyoAPI
|
|
1430
1430
|
# header parameters
|
1431
1431
|
header_params = opts[:header_params] || {}
|
1432
1432
|
# klaviyo api revision
|
1433
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1433
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1434
1434
|
# HTTP header 'Accept' (if needed)
|
1435
1435
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1436
1436
|
|
@@ -1464,10 +1464,10 @@ module KlaviyoAPI
|
|
1464
1464
|
end
|
1465
1465
|
|
1466
1466
|
# Get Catalog Variant
|
1467
|
-
# Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1467
|
+
# Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1468
1468
|
# @param id [String] The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
1469
1469
|
# @param [Hash] opts the optional parameters
|
1470
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1470
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1471
1471
|
# @return [Hash<String, Object>]
|
1472
1472
|
def get_catalog_variant(id, opts = {})
|
1473
1473
|
data, _status_code, _headers = get_catalog_variant_with_http_info(id, opts)
|
@@ -1475,10 +1475,10 @@ module KlaviyoAPI
|
|
1475
1475
|
end
|
1476
1476
|
|
1477
1477
|
# Get Catalog Variant
|
1478
|
-
# Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1478
|
+
# Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1479
1479
|
# @param id [String] The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
1480
1480
|
# @param [Hash] opts the optional parameters
|
1481
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1481
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1482
1482
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1483
1483
|
def get_catalog_variant_with_http_info(id, opts = {})
|
1484
1484
|
if @api_client.config.debugging
|
@@ -1502,7 +1502,7 @@ module KlaviyoAPI
|
|
1502
1502
|
# header parameters
|
1503
1503
|
header_params = opts[:header_params] || {}
|
1504
1504
|
# klaviyo api revision
|
1505
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1505
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1506
1506
|
# HTTP header 'Accept' (if needed)
|
1507
1507
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1508
1508
|
|
@@ -1536,12 +1536,12 @@ module KlaviyoAPI
|
|
1536
1536
|
end
|
1537
1537
|
|
1538
1538
|
# Get Catalog Variants
|
1539
|
-
# Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1539
|
+
# Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1540
1540
|
# @param [Hash] opts the optional parameters
|
1541
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1542
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1543
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1544
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1541
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1542
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1543
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1544
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
1545
1545
|
# @return [Hash<String, Object>]
|
1546
1546
|
def get_catalog_variants(opts = {})
|
1547
1547
|
data, _status_code, _headers = get_catalog_variants_with_http_info(opts)
|
@@ -1549,12 +1549,12 @@ module KlaviyoAPI
|
|
1549
1549
|
end
|
1550
1550
|
|
1551
1551
|
# Get Catalog Variants
|
1552
|
-
# Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1552
|
+
# Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1553
1553
|
# @param [Hash] opts the optional parameters
|
1554
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1555
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1556
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1557
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-
|
1554
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1555
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
1556
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1557
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
|
1558
1558
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1559
1559
|
def get_catalog_variants_with_http_info(opts = {})
|
1560
1560
|
if @api_client.config.debugging
|
@@ -1581,7 +1581,7 @@ module KlaviyoAPI
|
|
1581
1581
|
# header parameters
|
1582
1582
|
header_params = opts[:header_params] || {}
|
1583
1583
|
# klaviyo api revision
|
1584
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1584
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1585
1585
|
# HTTP header 'Accept' (if needed)
|
1586
1586
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1587
1587
|
|
@@ -1615,12 +1615,12 @@ module KlaviyoAPI
|
|
1615
1615
|
end
|
1616
1616
|
|
1617
1617
|
# Get Create Categories Job
|
1618
|
-
# Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1618
|
+
# Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1619
1619
|
# @param job_id [String] ID of the job to retrieve.
|
1620
1620
|
# @param [Hash] opts the optional parameters
|
1621
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1622
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
1623
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1621
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1622
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1623
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
1624
1624
|
# @return [Hash<String, Object>]
|
1625
1625
|
def get_create_categories_job(job_id, opts = {})
|
1626
1626
|
data, _status_code, _headers = get_create_categories_job_with_http_info(job_id, opts)
|
@@ -1628,12 +1628,12 @@ module KlaviyoAPI
|
|
1628
1628
|
end
|
1629
1629
|
|
1630
1630
|
# Get Create Categories Job
|
1631
|
-
# Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1631
|
+
# Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1632
1632
|
# @param job_id [String] ID of the job to retrieve.
|
1633
1633
|
# @param [Hash] opts the optional parameters
|
1634
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1635
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
1636
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1634
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1635
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1636
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
1637
1637
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1638
1638
|
def get_create_categories_job_with_http_info(job_id, opts = {})
|
1639
1639
|
if @api_client.config.debugging
|
@@ -1667,7 +1667,7 @@ module KlaviyoAPI
|
|
1667
1667
|
# header parameters
|
1668
1668
|
header_params = opts[:header_params] || {}
|
1669
1669
|
# klaviyo api revision
|
1670
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1670
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1671
1671
|
# HTTP header 'Accept' (if needed)
|
1672
1672
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1673
1673
|
|
@@ -1701,11 +1701,11 @@ module KlaviyoAPI
|
|
1701
1701
|
end
|
1702
1702
|
|
1703
1703
|
# Get Create Categories Jobs
|
1704
|
-
# Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1704
|
+
# Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1705
1705
|
# @param [Hash] opts the optional parameters
|
1706
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1707
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1708
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1706
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1707
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1708
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1709
1709
|
# @return [Hash<String, Object>]
|
1710
1710
|
def get_create_categories_jobs(opts = {})
|
1711
1711
|
data, _status_code, _headers = get_create_categories_jobs_with_http_info(opts)
|
@@ -1713,11 +1713,11 @@ module KlaviyoAPI
|
|
1713
1713
|
end
|
1714
1714
|
|
1715
1715
|
# Get Create Categories Jobs
|
1716
|
-
# Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1716
|
+
# Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1717
1717
|
# @param [Hash] opts the optional parameters
|
1718
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1719
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1720
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1718
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1719
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1720
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1721
1721
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1722
1722
|
def get_create_categories_jobs_with_http_info(opts = {})
|
1723
1723
|
if @api_client.config.debugging
|
@@ -1739,7 +1739,7 @@ module KlaviyoAPI
|
|
1739
1739
|
# header parameters
|
1740
1740
|
header_params = opts[:header_params] || {}
|
1741
1741
|
# klaviyo api revision
|
1742
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1742
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1743
1743
|
# HTTP header 'Accept' (if needed)
|
1744
1744
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1745
1745
|
|
@@ -1773,12 +1773,12 @@ module KlaviyoAPI
|
|
1773
1773
|
end
|
1774
1774
|
|
1775
1775
|
# Get Create Items Job
|
1776
|
-
# Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1776
|
+
# Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1777
1777
|
# @param job_id [String] ID of the job to retrieve.
|
1778
1778
|
# @param [Hash] opts the optional parameters
|
1779
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1780
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
1781
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1779
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1780
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1781
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
1782
1782
|
# @return [Hash<String, Object>]
|
1783
1783
|
def get_create_items_job(job_id, opts = {})
|
1784
1784
|
data, _status_code, _headers = get_create_items_job_with_http_info(job_id, opts)
|
@@ -1786,12 +1786,12 @@ module KlaviyoAPI
|
|
1786
1786
|
end
|
1787
1787
|
|
1788
1788
|
# Get Create Items Job
|
1789
|
-
# Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1789
|
+
# Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1790
1790
|
# @param job_id [String] ID of the job to retrieve.
|
1791
1791
|
# @param [Hash] opts the optional parameters
|
1792
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1793
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
1794
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1792
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1793
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1794
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
1795
1795
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1796
1796
|
def get_create_items_job_with_http_info(job_id, opts = {})
|
1797
1797
|
if @api_client.config.debugging
|
@@ -1825,7 +1825,7 @@ module KlaviyoAPI
|
|
1825
1825
|
# header parameters
|
1826
1826
|
header_params = opts[:header_params] || {}
|
1827
1827
|
# klaviyo api revision
|
1828
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1828
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1829
1829
|
# HTTP header 'Accept' (if needed)
|
1830
1830
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1831
1831
|
|
@@ -1859,11 +1859,11 @@ module KlaviyoAPI
|
|
1859
1859
|
end
|
1860
1860
|
|
1861
1861
|
# Get Create Items Jobs
|
1862
|
-
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1862
|
+
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1863
1863
|
# @param [Hash] opts the optional parameters
|
1864
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1865
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1866
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1864
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1865
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1866
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1867
1867
|
# @return [Hash<String, Object>]
|
1868
1868
|
def get_create_items_jobs(opts = {})
|
1869
1869
|
data, _status_code, _headers = get_create_items_jobs_with_http_info(opts)
|
@@ -1871,11 +1871,11 @@ module KlaviyoAPI
|
|
1871
1871
|
end
|
1872
1872
|
|
1873
1873
|
# Get Create Items Jobs
|
1874
|
-
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1874
|
+
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1875
1875
|
# @param [Hash] opts the optional parameters
|
1876
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1877
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
1878
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
1876
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1877
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1878
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
1879
1879
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1880
1880
|
def get_create_items_jobs_with_http_info(opts = {})
|
1881
1881
|
if @api_client.config.debugging
|
@@ -1897,7 +1897,7 @@ module KlaviyoAPI
|
|
1897
1897
|
# header parameters
|
1898
1898
|
header_params = opts[:header_params] || {}
|
1899
1899
|
# klaviyo api revision
|
1900
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1900
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1901
1901
|
# HTTP header 'Accept' (if needed)
|
1902
1902
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1903
1903
|
|
@@ -1931,12 +1931,12 @@ module KlaviyoAPI
|
|
1931
1931
|
end
|
1932
1932
|
|
1933
1933
|
# Get Create Variants Job
|
1934
|
-
# Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1934
|
+
# Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1935
1935
|
# @param job_id [String] ID of the job to retrieve.
|
1936
1936
|
# @param [Hash] opts the optional parameters
|
1937
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1938
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1939
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1937
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1938
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1939
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
1940
1940
|
# @return [Hash<String, Object>]
|
1941
1941
|
def get_create_variants_job(job_id, opts = {})
|
1942
1942
|
data, _status_code, _headers = get_create_variants_job_with_http_info(job_id, opts)
|
@@ -1944,12 +1944,12 @@ module KlaviyoAPI
|
|
1944
1944
|
end
|
1945
1945
|
|
1946
1946
|
# Get Create Variants Job
|
1947
|
-
# Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
1947
|
+
# Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1948
1948
|
# @param job_id [String] ID of the job to retrieve.
|
1949
1949
|
# @param [Hash] opts the optional parameters
|
1950
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
1951
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
1952
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
1950
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1951
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
1952
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
1953
1953
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1954
1954
|
def get_create_variants_job_with_http_info(job_id, opts = {})
|
1955
1955
|
if @api_client.config.debugging
|
@@ -1983,7 +1983,7 @@ module KlaviyoAPI
|
|
1983
1983
|
# header parameters
|
1984
1984
|
header_params = opts[:header_params] || {}
|
1985
1985
|
# klaviyo api revision
|
1986
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
1986
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
1987
1987
|
# HTTP header 'Accept' (if needed)
|
1988
1988
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1989
1989
|
|
@@ -2017,11 +2017,11 @@ module KlaviyoAPI
|
|
2017
2017
|
end
|
2018
2018
|
|
2019
2019
|
# Get Create Variants Jobs
|
2020
|
-
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2020
|
+
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2021
2021
|
# @param [Hash] opts the optional parameters
|
2022
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2023
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2024
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2022
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2023
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2024
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2025
2025
|
# @return [Hash<String, Object>]
|
2026
2026
|
def get_create_variants_jobs(opts = {})
|
2027
2027
|
data, _status_code, _headers = get_create_variants_jobs_with_http_info(opts)
|
@@ -2029,11 +2029,11 @@ module KlaviyoAPI
|
|
2029
2029
|
end
|
2030
2030
|
|
2031
2031
|
# Get Create Variants Jobs
|
2032
|
-
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2032
|
+
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2033
2033
|
# @param [Hash] opts the optional parameters
|
2034
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2035
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2036
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2034
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2035
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2036
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2037
2037
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2038
2038
|
def get_create_variants_jobs_with_http_info(opts = {})
|
2039
2039
|
if @api_client.config.debugging
|
@@ -2055,7 +2055,7 @@ module KlaviyoAPI
|
|
2055
2055
|
# header parameters
|
2056
2056
|
header_params = opts[:header_params] || {}
|
2057
2057
|
# klaviyo api revision
|
2058
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2058
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2059
2059
|
# HTTP header 'Accept' (if needed)
|
2060
2060
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2061
2061
|
|
@@ -2089,10 +2089,10 @@ module KlaviyoAPI
|
|
2089
2089
|
end
|
2090
2090
|
|
2091
2091
|
# Get Delete Categories Job
|
2092
|
-
# Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2092
|
+
# Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2093
2093
|
# @param job_id [String] ID of the job to retrieve.
|
2094
2094
|
# @param [Hash] opts the optional parameters
|
2095
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2095
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2096
2096
|
# @return [Hash<String, Object>]
|
2097
2097
|
def get_delete_categories_job(job_id, opts = {})
|
2098
2098
|
data, _status_code, _headers = get_delete_categories_job_with_http_info(job_id, opts)
|
@@ -2100,10 +2100,10 @@ module KlaviyoAPI
|
|
2100
2100
|
end
|
2101
2101
|
|
2102
2102
|
# Get Delete Categories Job
|
2103
|
-
# Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2103
|
+
# Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2104
2104
|
# @param job_id [String] ID of the job to retrieve.
|
2105
2105
|
# @param [Hash] opts the optional parameters
|
2106
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2106
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2107
2107
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2108
2108
|
def get_delete_categories_job_with_http_info(job_id, opts = {})
|
2109
2109
|
if @api_client.config.debugging
|
@@ -2127,7 +2127,7 @@ module KlaviyoAPI
|
|
2127
2127
|
# header parameters
|
2128
2128
|
header_params = opts[:header_params] || {}
|
2129
2129
|
# klaviyo api revision
|
2130
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2130
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2131
2131
|
# HTTP header 'Accept' (if needed)
|
2132
2132
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2133
2133
|
|
@@ -2161,11 +2161,11 @@ module KlaviyoAPI
|
|
2161
2161
|
end
|
2162
2162
|
|
2163
2163
|
# Get Delete Categories Jobs
|
2164
|
-
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2164
|
+
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2165
2165
|
# @param [Hash] opts the optional parameters
|
2166
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2167
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2168
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2166
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2167
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2168
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2169
2169
|
# @return [Hash<String, Object>]
|
2170
2170
|
def get_delete_categories_jobs(opts = {})
|
2171
2171
|
data, _status_code, _headers = get_delete_categories_jobs_with_http_info(opts)
|
@@ -2173,11 +2173,11 @@ module KlaviyoAPI
|
|
2173
2173
|
end
|
2174
2174
|
|
2175
2175
|
# Get Delete Categories Jobs
|
2176
|
-
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2176
|
+
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2177
2177
|
# @param [Hash] opts the optional parameters
|
2178
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2179
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2180
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2178
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2179
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2180
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2181
2181
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2182
2182
|
def get_delete_categories_jobs_with_http_info(opts = {})
|
2183
2183
|
if @api_client.config.debugging
|
@@ -2199,7 +2199,7 @@ module KlaviyoAPI
|
|
2199
2199
|
# header parameters
|
2200
2200
|
header_params = opts[:header_params] || {}
|
2201
2201
|
# klaviyo api revision
|
2202
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2202
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2203
2203
|
# HTTP header 'Accept' (if needed)
|
2204
2204
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2205
2205
|
|
@@ -2233,10 +2233,10 @@ module KlaviyoAPI
|
|
2233
2233
|
end
|
2234
2234
|
|
2235
2235
|
# Get Delete Items Job
|
2236
|
-
# Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2236
|
+
# Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2237
2237
|
# @param job_id [String] ID of the job to retrieve.
|
2238
2238
|
# @param [Hash] opts the optional parameters
|
2239
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2239
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2240
2240
|
# @return [Hash<String, Object>]
|
2241
2241
|
def get_delete_items_job(job_id, opts = {})
|
2242
2242
|
data, _status_code, _headers = get_delete_items_job_with_http_info(job_id, opts)
|
@@ -2244,10 +2244,10 @@ module KlaviyoAPI
|
|
2244
2244
|
end
|
2245
2245
|
|
2246
2246
|
# Get Delete Items Job
|
2247
|
-
# Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2247
|
+
# Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2248
2248
|
# @param job_id [String] ID of the job to retrieve.
|
2249
2249
|
# @param [Hash] opts the optional parameters
|
2250
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2250
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2251
2251
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2252
2252
|
def get_delete_items_job_with_http_info(job_id, opts = {})
|
2253
2253
|
if @api_client.config.debugging
|
@@ -2271,7 +2271,7 @@ module KlaviyoAPI
|
|
2271
2271
|
# header parameters
|
2272
2272
|
header_params = opts[:header_params] || {}
|
2273
2273
|
# klaviyo api revision
|
2274
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2274
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2275
2275
|
# HTTP header 'Accept' (if needed)
|
2276
2276
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2277
2277
|
|
@@ -2305,11 +2305,11 @@ module KlaviyoAPI
|
|
2305
2305
|
end
|
2306
2306
|
|
2307
2307
|
# Get Delete Items Jobs
|
2308
|
-
# Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2308
|
+
# Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2309
2309
|
# @param [Hash] opts the optional parameters
|
2310
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2311
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2312
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2310
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2311
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2312
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2313
2313
|
# @return [Hash<String, Object>]
|
2314
2314
|
def get_delete_items_jobs(opts = {})
|
2315
2315
|
data, _status_code, _headers = get_delete_items_jobs_with_http_info(opts)
|
@@ -2317,11 +2317,11 @@ module KlaviyoAPI
|
|
2317
2317
|
end
|
2318
2318
|
|
2319
2319
|
# Get Delete Items Jobs
|
2320
|
-
# Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2320
|
+
# Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2321
2321
|
# @param [Hash] opts the optional parameters
|
2322
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2323
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2324
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2322
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2323
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2324
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2325
2325
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2326
2326
|
def get_delete_items_jobs_with_http_info(opts = {})
|
2327
2327
|
if @api_client.config.debugging
|
@@ -2343,7 +2343,7 @@ module KlaviyoAPI
|
|
2343
2343
|
# header parameters
|
2344
2344
|
header_params = opts[:header_params] || {}
|
2345
2345
|
# klaviyo api revision
|
2346
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2346
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2347
2347
|
# HTTP header 'Accept' (if needed)
|
2348
2348
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2349
2349
|
|
@@ -2377,10 +2377,10 @@ module KlaviyoAPI
|
|
2377
2377
|
end
|
2378
2378
|
|
2379
2379
|
# Get Delete Variants Job
|
2380
|
-
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2380
|
+
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2381
2381
|
# @param job_id [String] ID of the job to retrieve.
|
2382
2382
|
# @param [Hash] opts the optional parameters
|
2383
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2383
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2384
2384
|
# @return [Hash<String, Object>]
|
2385
2385
|
def get_delete_variants_job(job_id, opts = {})
|
2386
2386
|
data, _status_code, _headers = get_delete_variants_job_with_http_info(job_id, opts)
|
@@ -2388,10 +2388,10 @@ module KlaviyoAPI
|
|
2388
2388
|
end
|
2389
2389
|
|
2390
2390
|
# Get Delete Variants Job
|
2391
|
-
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2391
|
+
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2392
2392
|
# @param job_id [String] ID of the job to retrieve.
|
2393
2393
|
# @param [Hash] opts the optional parameters
|
2394
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2394
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2395
2395
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2396
2396
|
def get_delete_variants_job_with_http_info(job_id, opts = {})
|
2397
2397
|
if @api_client.config.debugging
|
@@ -2415,7 +2415,7 @@ module KlaviyoAPI
|
|
2415
2415
|
# header parameters
|
2416
2416
|
header_params = opts[:header_params] || {}
|
2417
2417
|
# klaviyo api revision
|
2418
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2418
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2419
2419
|
# HTTP header 'Accept' (if needed)
|
2420
2420
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2421
2421
|
|
@@ -2449,11 +2449,11 @@ module KlaviyoAPI
|
|
2449
2449
|
end
|
2450
2450
|
|
2451
2451
|
# Get Delete Variants Jobs
|
2452
|
-
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2452
|
+
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2453
2453
|
# @param [Hash] opts the optional parameters
|
2454
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2455
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2456
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2454
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2455
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2456
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2457
2457
|
# @return [Hash<String, Object>]
|
2458
2458
|
def get_delete_variants_jobs(opts = {})
|
2459
2459
|
data, _status_code, _headers = get_delete_variants_jobs_with_http_info(opts)
|
@@ -2461,11 +2461,11 @@ module KlaviyoAPI
|
|
2461
2461
|
end
|
2462
2462
|
|
2463
2463
|
# Get Delete Variants Jobs
|
2464
|
-
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2464
|
+
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2465
2465
|
# @param [Hash] opts the optional parameters
|
2466
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2467
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2468
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2466
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2467
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2468
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2469
2469
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2470
2470
|
def get_delete_variants_jobs_with_http_info(opts = {})
|
2471
2471
|
if @api_client.config.debugging
|
@@ -2487,7 +2487,7 @@ module KlaviyoAPI
|
|
2487
2487
|
# header parameters
|
2488
2488
|
header_params = opts[:header_params] || {}
|
2489
2489
|
# klaviyo api revision
|
2490
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2490
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2491
2491
|
# HTTP header 'Accept' (if needed)
|
2492
2492
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2493
2493
|
|
@@ -2521,12 +2521,12 @@ module KlaviyoAPI
|
|
2521
2521
|
end
|
2522
2522
|
|
2523
2523
|
# Get Update Categories Job
|
2524
|
-
# Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2524
|
+
# Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2525
2525
|
# @param job_id [String] ID of the job to retrieve.
|
2526
2526
|
# @param [Hash] opts the optional parameters
|
2527
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2528
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
2529
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2527
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2528
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2529
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
2530
2530
|
# @return [Hash<String, Object>]
|
2531
2531
|
def get_update_categories_job(job_id, opts = {})
|
2532
2532
|
data, _status_code, _headers = get_update_categories_job_with_http_info(job_id, opts)
|
@@ -2534,12 +2534,12 @@ module KlaviyoAPI
|
|
2534
2534
|
end
|
2535
2535
|
|
2536
2536
|
# Get Update Categories Job
|
2537
|
-
# Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2537
|
+
# Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2538
2538
|
# @param job_id [String] ID of the job to retrieve.
|
2539
2539
|
# @param [Hash] opts the optional parameters
|
2540
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2541
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-
|
2542
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2540
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2541
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2542
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
2543
2543
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2544
2544
|
def get_update_categories_job_with_http_info(job_id, opts = {})
|
2545
2545
|
if @api_client.config.debugging
|
@@ -2573,7 +2573,7 @@ module KlaviyoAPI
|
|
2573
2573
|
# header parameters
|
2574
2574
|
header_params = opts[:header_params] || {}
|
2575
2575
|
# klaviyo api revision
|
2576
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2576
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2577
2577
|
# HTTP header 'Accept' (if needed)
|
2578
2578
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2579
2579
|
|
@@ -2607,11 +2607,11 @@ module KlaviyoAPI
|
|
2607
2607
|
end
|
2608
2608
|
|
2609
2609
|
# Get Update Categories Jobs
|
2610
|
-
# Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2610
|
+
# Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2611
2611
|
# @param [Hash] opts the optional parameters
|
2612
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2613
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2614
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2612
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2613
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2614
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2615
2615
|
# @return [Hash<String, Object>]
|
2616
2616
|
def get_update_categories_jobs(opts = {})
|
2617
2617
|
data, _status_code, _headers = get_update_categories_jobs_with_http_info(opts)
|
@@ -2619,11 +2619,11 @@ module KlaviyoAPI
|
|
2619
2619
|
end
|
2620
2620
|
|
2621
2621
|
# Get Update Categories Jobs
|
2622
|
-
# Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2622
|
+
# Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2623
2623
|
# @param [Hash] opts the optional parameters
|
2624
|
-
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2625
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2626
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2624
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2625
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2626
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2627
2627
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2628
2628
|
def get_update_categories_jobs_with_http_info(opts = {})
|
2629
2629
|
if @api_client.config.debugging
|
@@ -2645,7 +2645,7 @@ module KlaviyoAPI
|
|
2645
2645
|
# header parameters
|
2646
2646
|
header_params = opts[:header_params] || {}
|
2647
2647
|
# klaviyo api revision
|
2648
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2648
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2649
2649
|
# HTTP header 'Accept' (if needed)
|
2650
2650
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2651
2651
|
|
@@ -2679,12 +2679,12 @@ module KlaviyoAPI
|
|
2679
2679
|
end
|
2680
2680
|
|
2681
2681
|
# Get Update Items Job
|
2682
|
-
# Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2682
|
+
# Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2683
2683
|
# @param job_id [String] ID of the job to retrieve.
|
2684
2684
|
# @param [Hash] opts the optional parameters
|
2685
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2686
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
2687
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2685
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2686
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2687
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
2688
2688
|
# @return [Hash<String, Object>]
|
2689
2689
|
def get_update_items_job(job_id, opts = {})
|
2690
2690
|
data, _status_code, _headers = get_update_items_job_with_http_info(job_id, opts)
|
@@ -2692,12 +2692,12 @@ module KlaviyoAPI
|
|
2692
2692
|
end
|
2693
2693
|
|
2694
2694
|
# Get Update Items Job
|
2695
|
-
# Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2695
|
+
# Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2696
2696
|
# @param job_id [String] ID of the job to retrieve.
|
2697
2697
|
# @param [Hash] opts the optional parameters
|
2698
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2699
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-
|
2700
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2698
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2699
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2700
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
2701
2701
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2702
2702
|
def get_update_items_job_with_http_info(job_id, opts = {})
|
2703
2703
|
if @api_client.config.debugging
|
@@ -2731,7 +2731,7 @@ module KlaviyoAPI
|
|
2731
2731
|
# header parameters
|
2732
2732
|
header_params = opts[:header_params] || {}
|
2733
2733
|
# klaviyo api revision
|
2734
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2734
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2735
2735
|
# HTTP header 'Accept' (if needed)
|
2736
2736
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2737
2737
|
|
@@ -2765,11 +2765,11 @@ module KlaviyoAPI
|
|
2765
2765
|
end
|
2766
2766
|
|
2767
2767
|
# Get Update Items Jobs
|
2768
|
-
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2768
|
+
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2769
2769
|
# @param [Hash] opts the optional parameters
|
2770
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2771
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2772
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2770
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2771
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2772
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2773
2773
|
# @return [Hash<String, Object>]
|
2774
2774
|
def get_update_items_jobs(opts = {})
|
2775
2775
|
data, _status_code, _headers = get_update_items_jobs_with_http_info(opts)
|
@@ -2777,11 +2777,11 @@ module KlaviyoAPI
|
|
2777
2777
|
end
|
2778
2778
|
|
2779
2779
|
# Get Update Items Jobs
|
2780
|
-
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2780
|
+
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2781
2781
|
# @param [Hash] opts the optional parameters
|
2782
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2783
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2784
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2782
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2783
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2784
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2785
2785
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2786
2786
|
def get_update_items_jobs_with_http_info(opts = {})
|
2787
2787
|
if @api_client.config.debugging
|
@@ -2803,7 +2803,7 @@ module KlaviyoAPI
|
|
2803
2803
|
# header parameters
|
2804
2804
|
header_params = opts[:header_params] || {}
|
2805
2805
|
# klaviyo api revision
|
2806
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2806
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2807
2807
|
# HTTP header 'Accept' (if needed)
|
2808
2808
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2809
2809
|
|
@@ -2837,12 +2837,12 @@ module KlaviyoAPI
|
|
2837
2837
|
end
|
2838
2838
|
|
2839
2839
|
# Get Update Variants Job
|
2840
|
-
# Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2840
|
+
# Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2841
2841
|
# @param job_id [String] ID of the job to retrieve.
|
2842
2842
|
# @param [Hash] opts the optional parameters
|
2843
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2844
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
2845
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2843
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2844
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2845
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
2846
2846
|
# @return [Hash<String, Object>]
|
2847
2847
|
def get_update_variants_job(job_id, opts = {})
|
2848
2848
|
data, _status_code, _headers = get_update_variants_job_with_http_info(job_id, opts)
|
@@ -2850,12 +2850,12 @@ module KlaviyoAPI
|
|
2850
2850
|
end
|
2851
2851
|
|
2852
2852
|
# Get Update Variants Job
|
2853
|
-
# Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2853
|
+
# Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2854
2854
|
# @param job_id [String] ID of the job to retrieve.
|
2855
2855
|
# @param [Hash] opts the optional parameters
|
2856
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2857
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-
|
2858
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-
|
2856
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2857
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2858
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
|
2859
2859
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2860
2860
|
def get_update_variants_job_with_http_info(job_id, opts = {})
|
2861
2861
|
if @api_client.config.debugging
|
@@ -2889,7 +2889,7 @@ module KlaviyoAPI
|
|
2889
2889
|
# header parameters
|
2890
2890
|
header_params = opts[:header_params] || {}
|
2891
2891
|
# klaviyo api revision
|
2892
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2892
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2893
2893
|
# HTTP header 'Accept' (if needed)
|
2894
2894
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2895
2895
|
|
@@ -2923,11 +2923,11 @@ module KlaviyoAPI
|
|
2923
2923
|
end
|
2924
2924
|
|
2925
2925
|
# Get Update Variants Jobs
|
2926
|
-
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2926
|
+
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2927
2927
|
# @param [Hash] opts the optional parameters
|
2928
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2929
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2930
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2928
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2929
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2930
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2931
2931
|
# @return [Hash<String, Object>]
|
2932
2932
|
def get_update_variants_jobs(opts = {})
|
2933
2933
|
data, _status_code, _headers = get_update_variants_jobs_with_http_info(opts)
|
@@ -2935,11 +2935,11 @@ module KlaviyoAPI
|
|
2935
2935
|
end
|
2936
2936
|
|
2937
2937
|
# Get Update Variants Jobs
|
2938
|
-
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `
|
2938
|
+
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2939
2939
|
# @param [Hash] opts the optional parameters
|
2940
|
-
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-
|
2941
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-
|
2942
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-
|
2940
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
|
2941
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2942
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
|
2943
2943
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2944
2944
|
def get_update_variants_jobs_with_http_info(opts = {})
|
2945
2945
|
if @api_client.config.debugging
|
@@ -2961,7 +2961,7 @@ module KlaviyoAPI
|
|
2961
2961
|
# header parameters
|
2962
2962
|
header_params = opts[:header_params] || {}
|
2963
2963
|
# klaviyo api revision
|
2964
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
2964
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
2965
2965
|
# HTTP header 'Accept' (if needed)
|
2966
2966
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2967
2967
|
|
@@ -2995,7 +2995,7 @@ module KlaviyoAPI
|
|
2995
2995
|
end
|
2996
2996
|
|
2997
2997
|
# Spawn Create Categories Job
|
2998
|
-
# Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
2998
|
+
# Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
2999
2999
|
# @param catalog_category_create_job_create_query [CatalogCategoryCreateJobCreateQuery]
|
3000
3000
|
# @param [Hash] opts the optional parameters
|
3001
3001
|
# @return [Hash<String, Object>]
|
@@ -3005,7 +3005,7 @@ module KlaviyoAPI
|
|
3005
3005
|
end
|
3006
3006
|
|
3007
3007
|
# Spawn Create Categories Job
|
3008
|
-
# Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3008
|
+
# Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3009
3009
|
# @param catalog_category_create_job_create_query [CatalogCategoryCreateJobCreateQuery]
|
3010
3010
|
# @param [Hash] opts the optional parameters
|
3011
3011
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -3026,7 +3026,7 @@ module KlaviyoAPI
|
|
3026
3026
|
# header parameters
|
3027
3027
|
header_params = opts[:header_params] || {}
|
3028
3028
|
# klaviyo api revision
|
3029
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3029
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3030
3030
|
# HTTP header 'Accept' (if needed)
|
3031
3031
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3032
3032
|
# HTTP header 'Content-Type'
|
@@ -3065,7 +3065,7 @@ module KlaviyoAPI
|
|
3065
3065
|
end
|
3066
3066
|
|
3067
3067
|
# Spawn Create Items Job
|
3068
|
-
# Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3068
|
+
# Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3069
3069
|
# @param catalog_item_create_job_create_query [CatalogItemCreateJobCreateQuery]
|
3070
3070
|
# @param [Hash] opts the optional parameters
|
3071
3071
|
# @return [Hash<String, Object>]
|
@@ -3075,7 +3075,7 @@ module KlaviyoAPI
|
|
3075
3075
|
end
|
3076
3076
|
|
3077
3077
|
# Spawn Create Items Job
|
3078
|
-
# Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3078
|
+
# Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3079
3079
|
# @param catalog_item_create_job_create_query [CatalogItemCreateJobCreateQuery]
|
3080
3080
|
# @param [Hash] opts the optional parameters
|
3081
3081
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -3096,7 +3096,7 @@ module KlaviyoAPI
|
|
3096
3096
|
# header parameters
|
3097
3097
|
header_params = opts[:header_params] || {}
|
3098
3098
|
# klaviyo api revision
|
3099
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3099
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3100
3100
|
# HTTP header 'Accept' (if needed)
|
3101
3101
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3102
3102
|
# HTTP header 'Content-Type'
|
@@ -3135,7 +3135,7 @@ module KlaviyoAPI
|
|
3135
3135
|
end
|
3136
3136
|
|
3137
3137
|
# Spawn Create Variants Job
|
3138
|
-
# Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3138
|
+
# Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3139
3139
|
# @param catalog_variant_create_job_create_query [CatalogVariantCreateJobCreateQuery]
|
3140
3140
|
# @param [Hash] opts the optional parameters
|
3141
3141
|
# @return [Hash<String, Object>]
|
@@ -3145,7 +3145,7 @@ module KlaviyoAPI
|
|
3145
3145
|
end
|
3146
3146
|
|
3147
3147
|
# Spawn Create Variants Job
|
3148
|
-
# Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3148
|
+
# Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3149
3149
|
# @param catalog_variant_create_job_create_query [CatalogVariantCreateJobCreateQuery]
|
3150
3150
|
# @param [Hash] opts the optional parameters
|
3151
3151
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -3166,7 +3166,7 @@ module KlaviyoAPI
|
|
3166
3166
|
# header parameters
|
3167
3167
|
header_params = opts[:header_params] || {}
|
3168
3168
|
# klaviyo api revision
|
3169
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3169
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3170
3170
|
# HTTP header 'Accept' (if needed)
|
3171
3171
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3172
3172
|
# HTTP header 'Content-Type'
|
@@ -3205,7 +3205,7 @@ module KlaviyoAPI
|
|
3205
3205
|
end
|
3206
3206
|
|
3207
3207
|
# Spawn Delete Categories Job
|
3208
|
-
# Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3208
|
+
# Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3209
3209
|
# @param catalog_category_delete_job_create_query [CatalogCategoryDeleteJobCreateQuery]
|
3210
3210
|
# @param [Hash] opts the optional parameters
|
3211
3211
|
# @return [Hash<String, Object>]
|
@@ -3215,7 +3215,7 @@ module KlaviyoAPI
|
|
3215
3215
|
end
|
3216
3216
|
|
3217
3217
|
# Spawn Delete Categories Job
|
3218
|
-
# Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3218
|
+
# Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3219
3219
|
# @param catalog_category_delete_job_create_query [CatalogCategoryDeleteJobCreateQuery]
|
3220
3220
|
# @param [Hash] opts the optional parameters
|
3221
3221
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -3236,7 +3236,7 @@ module KlaviyoAPI
|
|
3236
3236
|
# header parameters
|
3237
3237
|
header_params = opts[:header_params] || {}
|
3238
3238
|
# klaviyo api revision
|
3239
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3239
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3240
3240
|
# HTTP header 'Accept' (if needed)
|
3241
3241
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3242
3242
|
# HTTP header 'Content-Type'
|
@@ -3275,7 +3275,7 @@ module KlaviyoAPI
|
|
3275
3275
|
end
|
3276
3276
|
|
3277
3277
|
# Spawn Delete Items Job
|
3278
|
-
# Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3278
|
+
# Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3279
3279
|
# @param catalog_item_delete_job_create_query [CatalogItemDeleteJobCreateQuery]
|
3280
3280
|
# @param [Hash] opts the optional parameters
|
3281
3281
|
# @return [Hash<String, Object>]
|
@@ -3285,7 +3285,7 @@ module KlaviyoAPI
|
|
3285
3285
|
end
|
3286
3286
|
|
3287
3287
|
# Spawn Delete Items Job
|
3288
|
-
# Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3288
|
+
# Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3289
3289
|
# @param catalog_item_delete_job_create_query [CatalogItemDeleteJobCreateQuery]
|
3290
3290
|
# @param [Hash] opts the optional parameters
|
3291
3291
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -3306,7 +3306,7 @@ module KlaviyoAPI
|
|
3306
3306
|
# header parameters
|
3307
3307
|
header_params = opts[:header_params] || {}
|
3308
3308
|
# klaviyo api revision
|
3309
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3309
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3310
3310
|
# HTTP header 'Accept' (if needed)
|
3311
3311
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3312
3312
|
# HTTP header 'Content-Type'
|
@@ -3345,7 +3345,7 @@ module KlaviyoAPI
|
|
3345
3345
|
end
|
3346
3346
|
|
3347
3347
|
# Spawn Delete Variants Job
|
3348
|
-
# Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3348
|
+
# Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3349
3349
|
# @param catalog_variant_delete_job_create_query [CatalogVariantDeleteJobCreateQuery]
|
3350
3350
|
# @param [Hash] opts the optional parameters
|
3351
3351
|
# @return [Hash<String, Object>]
|
@@ -3355,7 +3355,7 @@ module KlaviyoAPI
|
|
3355
3355
|
end
|
3356
3356
|
|
3357
3357
|
# Spawn Delete Variants Job
|
3358
|
-
# Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3358
|
+
# Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3359
3359
|
# @param catalog_variant_delete_job_create_query [CatalogVariantDeleteJobCreateQuery]
|
3360
3360
|
# @param [Hash] opts the optional parameters
|
3361
3361
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -3376,7 +3376,7 @@ module KlaviyoAPI
|
|
3376
3376
|
# header parameters
|
3377
3377
|
header_params = opts[:header_params] || {}
|
3378
3378
|
# klaviyo api revision
|
3379
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3379
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3380
3380
|
# HTTP header 'Accept' (if needed)
|
3381
3381
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3382
3382
|
# HTTP header 'Content-Type'
|
@@ -3415,7 +3415,7 @@ module KlaviyoAPI
|
|
3415
3415
|
end
|
3416
3416
|
|
3417
3417
|
# Spawn Update Categories Job
|
3418
|
-
# Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3418
|
+
# Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3419
3419
|
# @param catalog_category_update_job_create_query [CatalogCategoryUpdateJobCreateQuery]
|
3420
3420
|
# @param [Hash] opts the optional parameters
|
3421
3421
|
# @return [Hash<String, Object>]
|
@@ -3425,7 +3425,7 @@ module KlaviyoAPI
|
|
3425
3425
|
end
|
3426
3426
|
|
3427
3427
|
# Spawn Update Categories Job
|
3428
|
-
# Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3428
|
+
# Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3429
3429
|
# @param catalog_category_update_job_create_query [CatalogCategoryUpdateJobCreateQuery]
|
3430
3430
|
# @param [Hash] opts the optional parameters
|
3431
3431
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -3446,7 +3446,7 @@ module KlaviyoAPI
|
|
3446
3446
|
# header parameters
|
3447
3447
|
header_params = opts[:header_params] || {}
|
3448
3448
|
# klaviyo api revision
|
3449
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3449
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3450
3450
|
# HTTP header 'Accept' (if needed)
|
3451
3451
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3452
3452
|
# HTTP header 'Content-Type'
|
@@ -3485,7 +3485,7 @@ module KlaviyoAPI
|
|
3485
3485
|
end
|
3486
3486
|
|
3487
3487
|
# Spawn Update Items Job
|
3488
|
-
# Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3488
|
+
# Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3489
3489
|
# @param catalog_item_update_job_create_query [CatalogItemUpdateJobCreateQuery]
|
3490
3490
|
# @param [Hash] opts the optional parameters
|
3491
3491
|
# @return [Hash<String, Object>]
|
@@ -3495,7 +3495,7 @@ module KlaviyoAPI
|
|
3495
3495
|
end
|
3496
3496
|
|
3497
3497
|
# Spawn Update Items Job
|
3498
|
-
# Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3498
|
+
# Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3499
3499
|
# @param catalog_item_update_job_create_query [CatalogItemUpdateJobCreateQuery]
|
3500
3500
|
# @param [Hash] opts the optional parameters
|
3501
3501
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -3516,7 +3516,7 @@ module KlaviyoAPI
|
|
3516
3516
|
# header parameters
|
3517
3517
|
header_params = opts[:header_params] || {}
|
3518
3518
|
# klaviyo api revision
|
3519
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3519
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3520
3520
|
# HTTP header 'Accept' (if needed)
|
3521
3521
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3522
3522
|
# HTTP header 'Content-Type'
|
@@ -3555,7 +3555,7 @@ module KlaviyoAPI
|
|
3555
3555
|
end
|
3556
3556
|
|
3557
3557
|
# Spawn Update Variants Job
|
3558
|
-
# Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3558
|
+
# Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3559
3559
|
# @param catalog_variant_update_job_create_query [CatalogVariantUpdateJobCreateQuery]
|
3560
3560
|
# @param [Hash] opts the optional parameters
|
3561
3561
|
# @return [Hash<String, Object>]
|
@@ -3565,7 +3565,7 @@ module KlaviyoAPI
|
|
3565
3565
|
end
|
3566
3566
|
|
3567
3567
|
# Spawn Update Variants Job
|
3568
|
-
# Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3568
|
+
# Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3569
3569
|
# @param catalog_variant_update_job_create_query [CatalogVariantUpdateJobCreateQuery]
|
3570
3570
|
# @param [Hash] opts the optional parameters
|
3571
3571
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -3586,7 +3586,7 @@ module KlaviyoAPI
|
|
3586
3586
|
# header parameters
|
3587
3587
|
header_params = opts[:header_params] || {}
|
3588
3588
|
# klaviyo api revision
|
3589
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3589
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3590
3590
|
# HTTP header 'Accept' (if needed)
|
3591
3591
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3592
3592
|
# HTTP header 'Content-Type'
|
@@ -3625,7 +3625,7 @@ module KlaviyoAPI
|
|
3625
3625
|
end
|
3626
3626
|
|
3627
3627
|
# Update Catalog Category
|
3628
|
-
# Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3628
|
+
# Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3629
3629
|
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3630
3630
|
# @param catalog_category_update_query [CatalogCategoryUpdateQuery]
|
3631
3631
|
# @param [Hash] opts the optional parameters
|
@@ -3636,7 +3636,7 @@ module KlaviyoAPI
|
|
3636
3636
|
end
|
3637
3637
|
|
3638
3638
|
# Update Catalog Category
|
3639
|
-
# Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3639
|
+
# Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3640
3640
|
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3641
3641
|
# @param catalog_category_update_query [CatalogCategoryUpdateQuery]
|
3642
3642
|
# @param [Hash] opts the optional parameters
|
@@ -3662,7 +3662,7 @@ module KlaviyoAPI
|
|
3662
3662
|
# header parameters
|
3663
3663
|
header_params = opts[:header_params] || {}
|
3664
3664
|
# klaviyo api revision
|
3665
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3665
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3666
3666
|
# HTTP header 'Accept' (if needed)
|
3667
3667
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3668
3668
|
# HTTP header 'Content-Type'
|
@@ -3701,7 +3701,7 @@ module KlaviyoAPI
|
|
3701
3701
|
end
|
3702
3702
|
|
3703
3703
|
# Update Catalog Category Relationships Items
|
3704
|
-
# Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3704
|
+
# Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3705
3705
|
# @param id [String]
|
3706
3706
|
# @param catalog_category_item_op [CatalogCategoryItemOp]
|
3707
3707
|
# @param [Hash] opts the optional parameters
|
@@ -3712,7 +3712,7 @@ module KlaviyoAPI
|
|
3712
3712
|
end
|
3713
3713
|
|
3714
3714
|
# Update Catalog Category Relationships Items
|
3715
|
-
# Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3715
|
+
# Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3716
3716
|
# @param id [String]
|
3717
3717
|
# @param catalog_category_item_op [CatalogCategoryItemOp]
|
3718
3718
|
# @param [Hash] opts the optional parameters
|
@@ -3738,7 +3738,7 @@ module KlaviyoAPI
|
|
3738
3738
|
# header parameters
|
3739
3739
|
header_params = opts[:header_params] || {}
|
3740
3740
|
# klaviyo api revision
|
3741
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3741
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3742
3742
|
# HTTP header 'Accept' (if needed)
|
3743
3743
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3744
3744
|
# HTTP header 'Content-Type'
|
@@ -3777,7 +3777,7 @@ module KlaviyoAPI
|
|
3777
3777
|
end
|
3778
3778
|
|
3779
3779
|
# Update Catalog Item
|
3780
|
-
# Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3780
|
+
# Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3781
3781
|
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3782
3782
|
# @param catalog_item_update_query [CatalogItemUpdateQuery]
|
3783
3783
|
# @param [Hash] opts the optional parameters
|
@@ -3788,7 +3788,7 @@ module KlaviyoAPI
|
|
3788
3788
|
end
|
3789
3789
|
|
3790
3790
|
# Update Catalog Item
|
3791
|
-
# Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3791
|
+
# Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3792
3792
|
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3793
3793
|
# @param catalog_item_update_query [CatalogItemUpdateQuery]
|
3794
3794
|
# @param [Hash] opts the optional parameters
|
@@ -3814,7 +3814,7 @@ module KlaviyoAPI
|
|
3814
3814
|
# header parameters
|
3815
3815
|
header_params = opts[:header_params] || {}
|
3816
3816
|
# klaviyo api revision
|
3817
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3817
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3818
3818
|
# HTTP header 'Accept' (if needed)
|
3819
3819
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3820
3820
|
# HTTP header 'Content-Type'
|
@@ -3853,7 +3853,7 @@ module KlaviyoAPI
|
|
3853
3853
|
end
|
3854
3854
|
|
3855
3855
|
# Update Catalog Item Relationships Categories
|
3856
|
-
# Update catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3856
|
+
# Update catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3857
3857
|
# @param id [String]
|
3858
3858
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
3859
3859
|
# @param [Hash] opts the optional parameters
|
@@ -3864,7 +3864,7 @@ module KlaviyoAPI
|
|
3864
3864
|
end
|
3865
3865
|
|
3866
3866
|
# Update Catalog Item Relationships Categories
|
3867
|
-
# Update catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3867
|
+
# Update catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3868
3868
|
# @param id [String]
|
3869
3869
|
# @param catalog_item_category_op [CatalogItemCategoryOp]
|
3870
3870
|
# @param [Hash] opts the optional parameters
|
@@ -3890,7 +3890,7 @@ module KlaviyoAPI
|
|
3890
3890
|
# header parameters
|
3891
3891
|
header_params = opts[:header_params] || {}
|
3892
3892
|
# klaviyo api revision
|
3893
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3893
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3894
3894
|
# HTTP header 'Accept' (if needed)
|
3895
3895
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3896
3896
|
# HTTP header 'Content-Type'
|
@@ -3929,7 +3929,7 @@ module KlaviyoAPI
|
|
3929
3929
|
end
|
3930
3930
|
|
3931
3931
|
# Update Catalog Variant
|
3932
|
-
# Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3932
|
+
# Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3933
3933
|
# @param id [String] The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3934
3934
|
# @param catalog_variant_update_query [CatalogVariantUpdateQuery]
|
3935
3935
|
# @param [Hash] opts the optional parameters
|
@@ -3940,7 +3940,7 @@ module KlaviyoAPI
|
|
3940
3940
|
end
|
3941
3941
|
|
3942
3942
|
# Update Catalog Variant
|
3943
|
-
# Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `
|
3943
|
+
# Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
|
3944
3944
|
# @param id [String] The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3945
3945
|
# @param catalog_variant_update_query [CatalogVariantUpdateQuery]
|
3946
3946
|
# @param [Hash] opts the optional parameters
|
@@ -3966,7 +3966,7 @@ module KlaviyoAPI
|
|
3966
3966
|
# header parameters
|
3967
3967
|
header_params = opts[:header_params] || {}
|
3968
3968
|
# klaviyo api revision
|
3969
|
-
header_params['revision'] = ENV['API_REVISION'] || "2023-
|
3969
|
+
header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
|
3970
3970
|
# HTTP header 'Accept' (if needed)
|
3971
3971
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3972
3972
|
# HTTP header 'Content-Type'
|