@profplum700/etsy-v3-api-client 2.4.0 → 2.4.2

package/dist/index.d.ts

@@ -201,6 +201,17 @@ interface EtsyListing {
     skus?: string[];
     used_manufacturer?: boolean;
 }
+interface EtsyReview {
+    review_id?: number;
+    rating?: number;
+    review?: string;
+    language?: string;
+    created_timestamp?: number;
+    created_tsz?: number;
+    listing_id?: number;
+    shop_id?: number;
+    [key: string]: unknown;
+}
 interface EtsyListingImage {
     listing_image_id: number;
     hex_code?: string;
@@ -283,6 +294,12 @@ interface SearchParams {
     location?: string;
     shop_location?: string;
 }
+interface GetReviewsParams {
+    limit?: number;
+    offset?: number;
+    min_created?: number;
+    max_created?: number;
+}
 interface EtsyRateLimitHeaders {
     limitPerSecond?: number;
     remainingThisSecond?: number;
@@ -874,6 +891,14 @@ interface EtsyListingPropertyScale {
     display_name: string;
     description?: string;
 }
+interface UpdateListingPropertyParams {
+    shopId: string | number;
+    listingId: string | number;
+    propertyId: number;
+    valueIds: number[];
+    values: string[];
+    scaleId?: number;
+}
 interface EtsyBuyerTaxonomyNode {
     id: number;
     level: number;
@@ -1066,6 +1091,8 @@ declare class EtsyClient {
     findAllListingsActive(params?: SearchParams): Promise<EtsyListing[]>;
     getListingImages(listingId: string): Promise<EtsyListingImage[]>;
     getListingInventory(listingId: string): Promise<EtsyListingInventory>;
+    getReviewsByListing(listingId: string, params?: GetReviewsParams): Promise<EtsyReview[]>;
+    getReviewsByShop(shopId: string, params?: GetReviewsParams): Promise<EtsyReview[]>;
     getSellerTaxonomyNodes(): Promise<EtsySellerTaxonomyNode[]>;
     getUserShops(): Promise<EtsyShop[]>;
     updateShop(shopId: string, params: UpdateShopParams, options?: ValidationOptions): Promise<EtsyShop>;
@@ -1110,6 +1137,7 @@ declare class EtsyClient {
     getBuyerTaxonomyNodes(): Promise<EtsyBuyerTaxonomyNode[]>;
     getPropertiesByTaxonomyId(taxonomyId: number): Promise<EtsyBuyerTaxonomyProperty[]>;
     getListingProperties(shopId: string, listingId: string): Promise<EtsyListingProperty[]>;
+    updateListingProperty(params: UpdateListingPropertyParams): Promise<EtsyListingProperty>;
     getShopProductionPartners(shopId: string): Promise<EtsyShopProductionPartner[]>;
     getRemainingRequests(): number;
     getRateLimitStatus(): RateLimitStatus;
@@ -1750,4 +1778,4 @@ declare function getLibraryInfo(): {
 };
 
 export { AuthHelper, BatchQueryExecutor, BulkOperationManager, COMMON_SCOPE_COMBINATIONS, CacheWithInvalidation, CreateListingSchema, DEFAULT_RETRY_CONFIG, ETSY_SCOPES, EncryptedFileTokenStorage, EtsyApiError, EtsyAuthError, EtsyClient, EtsyRateLimitError, EtsyRateLimiter, EtsyWebhookHandler, FieldValidator, FileTokenStorage, GlobalRequestQueue, LFUCache, LIBRARY_NAME, LRUCache, ListingQueryBuilder, LocalStorageTokenStorage, MemoryTokenStorage, PaginatedResults, PluginManager, ReceiptQueryBuilder, RedisCacheStorage, RetryManager, SecureTokenStorage, SessionStorageTokenStorage, TokenManager, UpdateListingSchema, UpdateShopSchema, VERSION, ValidationException, Validator, WebhookSecurity, combineValidators, createAnalyticsPlugin, createAuthHelper, createBatchQuery, createBulkOperationManager, createCacheStorage, createCacheWithInvalidation, createCachingPlugin, createCodeChallenge, createDefaultTokenStorage, createEtsyClient, createListingQuery, createLoggingPlugin, createPaginatedResults, createRateLimitPlugin, createRateLimiter, createReceiptQuery, createRedisCacheStorage, createRetryPlugin, createTokenManager, createValidator, createWebhookHandler, createWebhookSecurity, decryptAES256GCM, EtsyClient as default, defaultRateLimiter, deriveKeyFromPassword, encryptAES256GCM, executeBulkOperation, field, generateCodeVerifier, generateEncryptionKey, generateRandomBase64Url, generateState, getAvailableStorage, getEnvironmentInfo, getGlobalQueue, getLibraryInfo, hasLocalStorage, hasSessionStorage, isBrowser, isNode, isSecureStorageSupported, sha256, sha256Base64Url, validate, validateEncryptionKey, validateOrThrow, withQueryBuilder, withQueue, withRetry };
-export type { AdvancedCachingConfig, AnalyticsPluginConfig, ApproachingLimitCallback, AuthHelperConfig, BulkImageUploadOperation, BulkOperationConfig, BulkOperationError, BulkOperationResult, BulkOperationSummary, BulkUpdateListingOperation, CacheEntry, CacheStats, CacheStorage, CacheStrategy, CachingPluginConfig, CreateDraftListingParams, CreateReceiptShipmentParams, CreateShippingProfileDestinationParams, CreateShippingProfileParams, CreateShopSectionParams, EncryptedData, EncryptedStorageConfig, EtsyApiResponse, EtsyBuyerTaxonomyNode, EtsyBuyerTaxonomyProperty, EtsyBuyerTaxonomyPropertyScale, EtsyBuyerTaxonomyPropertyValue, EtsyClientConfig, EtsyClientWithQueryBuilder, EtsyErrorDetails, EtsyListing, EtsyListingImage, EtsyListingInventory, EtsyListingOffering, EtsyListingProduct, EtsyListingProperty, EtsyListingPropertyScale, EtsyListingPropertyValue, EtsyPagination, EtsyPayment, EtsyPaymentAccountLedgerEntry, EtsyPaymentAdjustment, EtsyPlugin, EtsyRateLimitHeaders, EtsySellerTaxonomyNode, EtsyShippingProfile, EtsyShippingProfileDestination, EtsyShippingProfileUpgrade, EtsyShop, EtsyShopProductionPartner, EtsyShopReceipt, EtsyShopReceiptShipment, EtsyShopReceiptTransaction, EtsyShopRefund, EtsyShopSection, EtsyTokenResponse, EtsyTokens, EtsyTransactionVariation, EtsyUser, EtsyWebhookEvent, EtsyWebhookEventType, GetPaymentAccountLedgerEntriesParams, GetShopReceiptsParams, ListingParams, ListingSortOn, ListingState, LoggerInterface, LoggingPluginConfig, PageFetcher, PaginationOptions, PluginRequestConfig, PluginResponse, QueueOptions, RateLimitConfig, RateLimitErrorType, RateLimitPluginConfig, RateLimitStatus, RedisClientLike, RedisConfig, RequestPriority, RetryConfig, RetryOptions, RetryPluginConfig, SearchParams, SecureTokenStorageConfig, SortOrder, TokenRefreshCallback, TokenRotationCallback, TokenRotationConfig, TokenStorage, UpdateListingInventoryParams, UpdateListingParams, UpdateShippingProfileDestinationParams, UpdateShippingProfileParams, UpdateShopParams, UpdateShopReceiptParams, UpdateShopSectionParams, UploadListingFileParams, UploadListingImageParams, ValidationError, ValidationOptions, ValidationResult, ValidationSchema, ValidatorFunction, WebhookConfig, WebhookEventHandler, WebhookSecurityConfig };
+export type { AdvancedCachingConfig, AnalyticsPluginConfig, ApproachingLimitCallback, AuthHelperConfig, BulkImageUploadOperation, BulkOperationConfig, BulkOperationError, BulkOperationResult, BulkOperationSummary, BulkUpdateListingOperation, CacheEntry, CacheStats, CacheStorage, CacheStrategy, CachingPluginConfig, CreateDraftListingParams, CreateReceiptShipmentParams, CreateShippingProfileDestinationParams, CreateShippingProfileParams, CreateShopSectionParams, EncryptedData, EncryptedStorageConfig, EtsyApiResponse, EtsyBuyerTaxonomyNode, EtsyBuyerTaxonomyProperty, EtsyBuyerTaxonomyPropertyScale, EtsyBuyerTaxonomyPropertyValue, EtsyClientConfig, EtsyClientWithQueryBuilder, EtsyErrorDetails, EtsyListing, EtsyListingImage, EtsyListingInventory, EtsyListingOffering, EtsyListingProduct, EtsyListingProperty, EtsyListingPropertyScale, EtsyListingPropertyValue, EtsyPagination, EtsyPayment, EtsyPaymentAccountLedgerEntry, EtsyPaymentAdjustment, EtsyPlugin, EtsyRateLimitHeaders, EtsyReview, EtsySellerTaxonomyNode, EtsyShippingProfile, EtsyShippingProfileDestination, EtsyShippingProfileUpgrade, EtsyShop, EtsyShopProductionPartner, EtsyShopReceipt, EtsyShopReceiptShipment, EtsyShopReceiptTransaction, EtsyShopRefund, EtsyShopSection, EtsyTokenResponse, EtsyTokens, EtsyTransactionVariation, EtsyUser, EtsyWebhookEvent, EtsyWebhookEventType, GetPaymentAccountLedgerEntriesParams, GetReviewsParams, GetShopReceiptsParams, ListingParams, ListingSortOn, ListingState, LoggerInterface, LoggingPluginConfig, PageFetcher, PaginationOptions, PluginRequestConfig, PluginResponse, QueueOptions, RateLimitConfig, RateLimitErrorType, RateLimitPluginConfig, RateLimitStatus, RedisClientLike, RedisConfig, RequestPriority, RetryConfig, RetryOptions, RetryPluginConfig, SearchParams, SecureTokenStorageConfig, SortOrder, TokenRefreshCallback, TokenRotationCallback, TokenRotationConfig, TokenStorage, UpdateListingInventoryParams, UpdateListingParams, UpdateListingPropertyParams, UpdateShippingProfileDestinationParams, UpdateShippingProfileParams, UpdateShopParams, UpdateShopReceiptParams, UpdateShopSectionParams, UploadListingFileParams, UploadListingImageParams, ValidationError, ValidationOptions, ValidationResult, ValidationSchema, ValidatorFunction, WebhookConfig, WebhookEventHandler, WebhookSecurityConfig };

package/dist/index.esm.js

@@ -1531,6 +1531,36 @@ class EtsyClient {
     async getListingInventory(listingId) {
         return this.makeRequest(`/listings/${listingId}/inventory`);
     }
+    async getReviewsByListing(listingId, params = {}) {
+        const searchParams = new URLSearchParams();
+        if (params.limit !== undefined)
+            searchParams.set('limit', params.limit.toString());
+        if (params.offset !== undefined)
+            searchParams.set('offset', params.offset.toString());
+        if (params.min_created !== undefined) {
+            searchParams.set('min_created', params.min_created.toString());
+        }
+        if (params.max_created !== undefined) {
+            searchParams.set('max_created', params.max_created.toString());
+        }
+        const response = await this.makeRequest(`/listings/${listingId}/reviews?${searchParams.toString()}`);
+        return response.results;
+    }
+    async getReviewsByShop(shopId, params = {}) {
+        const searchParams = new URLSearchParams();
+        if (params.limit !== undefined)
+            searchParams.set('limit', params.limit.toString());
+        if (params.offset !== undefined)
+            searchParams.set('offset', params.offset.toString());
+        if (params.min_created !== undefined) {
+            searchParams.set('min_created', params.min_created.toString());
+        }
+        if (params.max_created !== undefined) {
+            searchParams.set('max_created', params.max_created.toString());
+        }
+        const response = await this.makeRequest(`/shops/${shopId}/reviews?${searchParams.toString()}`);
+        return response.results;
+    }
     async getSellerTaxonomyNodes() {
         const response = await this.makeRequest('/seller-taxonomy/nodes');
         return response.results;
@@ -1799,6 +1829,34 @@ class EtsyClient {
         const response = await this.makeRequest(`/shops/${shopId}/listings/${listingId}/properties`);
         return response.results;
     }
+    async updateListingProperty(params) {
+        const { shopId, listingId, propertyId, valueIds, values, scaleId } = params;
+        const body = new URLSearchParams();
+        valueIds.forEach(id => body.append('value_ids[]', id.toString()));
+        values.forEach(val => body.append('values[]', val));
+        if (scaleId !== undefined) {
+            body.append('scale_id', scaleId.toString());
+        }
+        const url = `${this.baseUrl}/shops/${shopId}/listings/${listingId}/properties/${propertyId}`;
+        await this.rateLimiter.waitForRateLimit();
+        const accessToken = await this.tokenManager.getAccessToken();
+        const response = await this.fetch(url, {
+            method: 'PUT',
+            headers: {
+                'Authorization': `Bearer ${accessToken}`,
+                'x-api-key': this.getApiKey(),
+                'Content-Type': 'application/x-www-form-urlencoded'
+            },
+            body: body.toString()
+        });
+        this.rateLimiter.updateFromHeaders(response.headers);
+        this.rateLimiter.resetRetryCount();
+        if (!response.ok) {
+            const errorText = await response.text();
+            throw new EtsyApiError(`Failed to update listing property: ${response.status} ${response.statusText}`, response.status, errorText);
+        }
+        return response.json();
+    }
     async getShopProductionPartners(shopId) {
         const response = await this.makeRequest(`/shops/${shopId}/production-partners`);
         return response.results;
@@ -2152,12 +2210,23 @@ class GlobalRequestQueue {
                     let result;
                     if (item.timeout) {
                         const remainingTimeout = item.timeout - elapsed;
+                        let timeoutId;
                         const timeoutPromise = new Promise((_, reject) => {
-                            setTimeout(() => {
+                            timeoutId = setTimeout(() => {
                                 reject(new Error(`Request timeout after ${item.timeout}ms (exceeded during execution)`));
                             }, remainingTimeout);
+                            if (timeoutId && typeof timeoutId.unref === 'function') {
+                                timeoutId.unref();
+                            }
                         });
-                        result = await Promise.race([item.request(), timeoutPromise]);
+                        try {
+                            result = await Promise.race([item.request(), timeoutPromise]);
+                        }
+                        finally {
+                            if (timeoutId) {
+                                clearTimeout(timeoutId);
+                            }
+                        }
                     }
                     else {
                         result = await item.request();