chore: deprecate ProductImageService and its related factories/interf…

…aces
nozzlegear · Jan 15, 2025 · 9ca3445 · 9ca3445
1 parent 4f96b16
commit 9ca3445
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/ShopifySharp/Factories/ProductImageServiceFactory.cs b/ShopifySharp/Factories/ProductImageServiceFactory.cs
@@ -9,8 +9,10 @@
 
 namespace ShopifySharp.Factories;
 
+[Obsolete("Shopify has deprecated the REST API for product images. This service is deprecated and will be removed in a future version of ShopifySharp. Use ShopifySharp's GraphService to manage product images via the GraphQL API, and check https://github.com/nozzlegear/shopifysharp for a migration guide.")]
 public interface IProductImageServiceFactory : IServiceFactory<IProductImageService>;
 
+[Obsolete("Shopify has deprecated the REST API for product images. This service is deprecated and will be removed in a future version of ShopifySharp. Use ShopifySharp's GraphService to manage product images via the GraphQL API, and check https://github.com/nozzlegear/shopifysharp for a migration guide.")]
 public class ProductImageServiceFactory : IProductImageServiceFactory
 {
     private readonly IShopifyDomainUtility? _shopifyDomainUtility;

diff --git a/ShopifySharp/Services/ProductImage/IProductImageService.cs b/ShopifySharp/Services/ProductImage/IProductImageService.cs
@@ -1,10 +1,12 @@
+using System;
 using ShopifySharp.Filters;
 using ShopifySharp.Lists;
 using System.Threading.Tasks;
 using System.Threading;
 
 namespace ShopifySharp;
 
+[Obsolete("Shopify has deprecated the REST API for product images. This service is deprecated and will be removed in a future version of ShopifySharp. Use ShopifySharp's GraphService to manage product images via the GraphQL API, and check https://github.com/nozzlegear/shopifysharp for a migration guide.")]
 public interface IProductImageService : IShopifyService
 {
     /// <summary>
@@ -58,4 +60,4 @@ public interface IProductImageService : IShopifyService
     /// <param name="imageId">The ProductImage object's Id.</param>
     /// <param name="cancellationToken">Cancellation Token</param>
     Task DeleteAsync(long productId, long imageId, CancellationToken cancellationToken = default);
-}
+}
diff --git a/ShopifySharp/Services/ProductImage/ProductImageService.cs b/ShopifySharp/Services/ProductImage/ProductImageService.cs
@@ -1,3 +1,4 @@
+using System;
 using ShopifySharp.Filters;
 using ShopifySharp.Infrastructure;
 using ShopifySharp.Lists;
@@ -12,6 +13,7 @@ namespace ShopifySharp;
 /// <summary>
 /// A service for manipulating Shopify ProductImages.
 /// </summary>
+[Obsolete("Shopify has deprecated the REST API for product images. This service is deprecated and will be removed in a future version of ShopifySharp. Use ShopifySharp's GraphService to manage product images via the GraphQL API, and check https://github.com/nozzlegear/shopifysharp for a migration guide.")]
 public class ProductImageService : ShopifyService, IProductImageService
 {
     /// <summary>
@@ -76,4 +78,4 @@ public virtual async Task DeleteAsync(long productId, long imageId, Cancellation
 
         await ExecuteRequestAsync(req, HttpMethod.Delete, cancellationToken);
     }
-}
+}