@profplum700/etsy-v3-api-client 2.4.3 → 2.5.0

package/dist/browser.esm.js

@@ -1939,6 +1939,376 @@ class EtsyClient {
         const response = await this.makeRequest(`/shops/${shopId}/production-partners`);
         return response.results;
     }
+    async createShopReadinessStateDefinition(shopId, params) {
+        const body = this.buildFormBody(params);
+        return this.makeRequest(`/shops/${shopId}/readiness-state-definitions`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: body.toString()
+        }, false);
+    }
+    async getShopReadinessStateDefinitions(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());
+        const query = searchParams.toString();
+        const suffix = query ? `?${query}` : '';
+        const response = await this.makeRequest(`/shops/${shopId}/readiness-state-definitions${suffix}`);
+        return response.results;
+    }
+    async getShopReadinessStateDefinition(shopId, definitionId) {
+        return this.makeRequest(`/shops/${shopId}/readiness-state-definitions/${definitionId}`);
+    }
+    async updateShopReadinessStateDefinition(shopId, definitionId, params) {
+        const body = this.buildFormBody(params);
+        return this.makeRequest(`/shops/${shopId}/readiness-state-definitions/${definitionId}`, {
+            method: 'PUT',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: body.toString()
+        }, false);
+    }
+    async deleteShopReadinessStateDefinition(shopId, definitionId) {
+        await this.makeRequest(`/shops/${shopId}/readiness-state-definitions/${definitionId}`, { method: 'DELETE' }, false);
+    }
+    async createShopReturnPolicy(shopId, params) {
+        const body = this.buildFormBody(params);
+        return this.makeRequest(`/shops/${shopId}/policies/return`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: body.toString()
+        }, false);
+    }
+    async getShopReturnPolicies(shopId) {
+        const response = await this.makeRequest(`/shops/${shopId}/policies/return`);
+        return response.results;
+    }
+    async getShopReturnPolicy(shopId, returnPolicyId) {
+        return this.makeRequest(`/shops/${shopId}/policies/return/${returnPolicyId}`);
+    }
+    async updateShopReturnPolicy(shopId, returnPolicyId, params) {
+        const body = this.buildFormBody(params);
+        return this.makeRequest(`/shops/${shopId}/policies/return/${returnPolicyId}`, {
+            method: 'PUT',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: body.toString()
+        }, false);
+    }
+    async deleteShopReturnPolicy(shopId, returnPolicyId) {
+        await this.makeRequest(`/shops/${shopId}/policies/return/${returnPolicyId}`, { method: 'DELETE' }, false);
+    }
+    async consolidateShopReturnPolicies(shopId, params) {
+        const body = this.buildFormBody(params);
+        return this.makeRequest(`/shops/${shopId}/policies/return/consolidate`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: body.toString()
+        }, false);
+    }
+    async getHolidayPreferences(shopId) {
+        const response = await this.makeRequest(`/shops/${shopId}/holiday-preferences`);
+        return response.results;
+    }
+    async updateHolidayPreferences(shopId, holidayId, params) {
+        const body = this.buildFormBody(params);
+        return this.makeRequest(`/shops/${shopId}/holiday-preferences/${holidayId}`, {
+            method: 'PUT',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: body.toString()
+        }, false);
+    }
+    async uploadListingFile(shopId, listingId, fileData, params) {
+        const formData = new FormData();
+        formData.append('file', fileData);
+        if (params?.name)
+            formData.append('name', params.name);
+        if (params?.rank !== undefined)
+            formData.append('rank', params.rank.toString());
+        if (params?.listing_file_id !== undefined)
+            formData.append('listing_file_id', params.listing_file_id.toString());
+        const url = `${this.baseUrl}/shops/${shopId}/listings/${listingId}/files`;
+        await this.rateLimiter.waitForRateLimit();
+        const accessToken = await this.tokenManager.getAccessToken();
+        const response = await this.fetch(url, {
+            method: 'POST',
+            headers: {
+                'Authorization': `Bearer ${accessToken}`,
+                'x-api-key': this.getApiKey(),
+            },
+            body: formData
+        });
+        if (!response.ok) {
+            const errorText = await response.text();
+            throw new EtsyApiError(`Failed to upload file: ${response.status} ${response.statusText}`, response.status, errorText);
+        }
+        return response.json();
+    }
+    async getAllListingFiles(shopId, listingId) {
+        const response = await this.makeRequest(`/shops/${shopId}/listings/${listingId}/files`);
+        return response.results;
+    }
+    async getListingFile(shopId, listingId, fileId) {
+        return this.makeRequest(`/shops/${shopId}/listings/${listingId}/files/${fileId}`);
+    }
+    async deleteListingFile(shopId, listingId, fileId) {
+        await this.makeRequest(`/shops/${shopId}/listings/${listingId}/files/${fileId}`, { method: 'DELETE' }, false);
+    }
+    async uploadListingVideo(shopId, listingId, videoData, params) {
+        const formData = new FormData();
+        formData.append('video', videoData);
+        if (params?.name)
+            formData.append('name', params.name);
+        if (params?.video_id !== undefined)
+            formData.append('video_id', params.video_id.toString());
+        const url = `${this.baseUrl}/shops/${shopId}/listings/${listingId}/videos`;
+        await this.rateLimiter.waitForRateLimit();
+        const accessToken = await this.tokenManager.getAccessToken();
+        const response = await this.fetch(url, {
+            method: 'POST',
+            headers: {
+                'Authorization': `Bearer ${accessToken}`,
+                'x-api-key': this.getApiKey(),
+            },
+            body: formData
+        });
+        if (!response.ok) {
+            const errorText = await response.text();
+            throw new EtsyApiError(`Failed to upload video: ${response.status} ${response.statusText}`, response.status, errorText);
+        }
+        return response.json();
+    }
+    async getListingVideos(listingId) {
+        const response = await this.makeRequest(`/listings/${listingId}/videos`);
+        return response.results;
+    }
+    async getListingVideo(listingId, videoId) {
+        return this.makeRequest(`/listings/${listingId}/videos/${videoId}`);
+    }
+    async deleteListingVideo(shopId, listingId, videoId) {
+        await this.makeRequest(`/shops/${shopId}/listings/${listingId}/videos/${videoId}`, { method: 'DELETE' }, false);
+    }
+    async createListingTranslation(shopId, listingId, language, params) {
+        const body = this.buildFormBody(params);
+        return this.makeRequest(`/shops/${shopId}/listings/${listingId}/translations/${language}`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: body.toString()
+        }, false);
+    }
+    async getListingTranslation(shopId, listingId, language) {
+        return this.makeRequest(`/shops/${shopId}/listings/${listingId}/translations/${language}`);
+    }
+    async updateListingTranslation(shopId, listingId, language, params) {
+        const body = this.buildFormBody(params);
+        return this.makeRequest(`/shops/${shopId}/listings/${listingId}/translations/${language}`, {
+            method: 'PUT',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: body.toString()
+        }, false);
+    }
+    async getListingVariationImages(shopId, listingId) {
+        const response = await this.makeRequest(`/shops/${shopId}/listings/${listingId}/variation-images`);
+        return response.results;
+    }
+    async updateVariationImages(shopId, listingId, params) {
+        const response = await this.makeRequest(`/shops/${shopId}/listings/${listingId}/variation-images`, {
+            method: 'POST',
+            body: JSON.stringify(params)
+        }, false);
+        return response.results;
+    }
+    async findAllActiveListingsByShop(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.sort_on)
+            searchParams.set('sort_on', params.sort_on);
+        if (params.sort_order)
+            searchParams.set('sort_order', params.sort_order);
+        if (params.keywords)
+            searchParams.set('keywords', params.keywords);
+        if (params.legacy !== undefined)
+            searchParams.set('legacy', params.legacy.toString());
+        const query = searchParams.toString();
+        const suffix = query ? `?${query}` : '';
+        const response = await this.makeRequest(`/shops/${shopId}/listings/active${suffix}`);
+        return response.results;
+    }
+    async getFeaturedListingsByShop(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.legacy !== undefined)
+            searchParams.set('legacy', params.legacy.toString());
+        const query = searchParams.toString();
+        const suffix = query ? `?${query}` : '';
+        const response = await this.makeRequest(`/shops/${shopId}/listings/featured${suffix}`);
+        return response.results;
+    }
+    async getListingsByListingIds(params) {
+        const searchParams = new URLSearchParams();
+        searchParams.set('listing_ids', params.listing_ids.join(','));
+        if (params.includes)
+            searchParams.set('includes', params.includes.join(','));
+        if (params.legacy !== undefined)
+            searchParams.set('legacy', params.legacy.toString());
+        const response = await this.makeRequest(`/listings/batch?${searchParams.toString()}`);
+        return response.results;
+    }
+    async getListingsByShopReceipt(shopId, receiptId, 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.legacy !== undefined)
+            searchParams.set('legacy', params.legacy.toString());
+        const query = searchParams.toString();
+        const suffix = query ? `?${query}` : '';
+        const response = await this.makeRequest(`/shops/${shopId}/receipts/${receiptId}/listings${suffix}`);
+        return response.results;
+    }
+    async getListingProperty(listingId, propertyId) {
+        return this.makeRequest(`/listings/${listingId}/properties/${propertyId}`);
+    }
+    async deleteListingProperty(shopId, listingId, propertyId) {
+        await this.makeRequest(`/shops/${shopId}/listings/${listingId}/properties/${propertyId}`, { method: 'DELETE' }, false);
+    }
+    async getListingProduct(listingId, productId) {
+        return this.makeRequest(`/listings/${listingId}/inventory/products/${productId}`);
+    }
+    async getListingOffering(listingId, productId, offeringId) {
+        return this.makeRequest(`/listings/${listingId}/products/${productId}/offerings/${offeringId}`);
+    }
+    async getListingsByShopSectionId(shopId, params) {
+        const searchParams = new URLSearchParams();
+        searchParams.set('shop_section_ids', params.shop_section_ids.join(','));
+        if (params.limit !== undefined)
+            searchParams.set('limit', params.limit.toString());
+        if (params.offset !== undefined)
+            searchParams.set('offset', params.offset.toString());
+        if (params.sort_on)
+            searchParams.set('sort_on', params.sort_on);
+        if (params.sort_order)
+            searchParams.set('sort_order', params.sort_order);
+        if (params.legacy !== undefined)
+            searchParams.set('legacy', params.legacy.toString());
+        const response = await this.makeRequest(`/shops/${shopId}/shop-sections/listings?${searchParams.toString()}`);
+        return response.results;
+    }
+    async getListingsByShopReturnPolicy(shopId, returnPolicyId, params = {}) {
+        const searchParams = new URLSearchParams();
+        if (params.legacy !== undefined)
+            searchParams.set('legacy', params.legacy.toString());
+        const query = searchParams.toString();
+        const suffix = query ? `?${query}` : '';
+        const response = await this.makeRequest(`/shops/${shopId}/policies/return/${returnPolicyId}/listings${suffix}`);
+        return response.results;
+    }
+    async findShops(params) {
+        const searchParams = new URLSearchParams();
+        searchParams.set('shop_name', params.shop_name);
+        if (params.limit !== undefined)
+            searchParams.set('limit', params.limit.toString());
+        if (params.offset !== undefined)
+            searchParams.set('offset', params.offset.toString());
+        const response = await this.makeRequest(`/shops?${searchParams.toString()}`);
+        return response.results;
+    }
+    async createShopShippingProfileUpgrade(shopId, profileId, params) {
+        const body = this.buildFormBody(params);
+        return this.makeRequest(`/shops/${shopId}/shipping-profiles/${profileId}/upgrades`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: body.toString()
+        }, false);
+    }
+    async updateShopShippingProfileUpgrade(shopId, profileId, upgradeId, params) {
+        const body = this.buildFormBody(params);
+        return this.makeRequest(`/shops/${shopId}/shipping-profiles/${profileId}/upgrades/${upgradeId}`, {
+            method: 'PUT',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: body.toString()
+        }, false);
+    }
+    async deleteShopShippingProfileUpgrade(shopId, profileId, upgradeId) {
+        await this.makeRequest(`/shops/${shopId}/shipping-profiles/${profileId}/upgrades/${upgradeId}`, { method: 'DELETE' }, false);
+    }
+    async getShippingCarriers(originCountryIso) {
+        const searchParams = new URLSearchParams();
+        searchParams.set('origin_country_iso', originCountryIso);
+        const response = await this.makeRequest(`/shipping-carriers?${searchParams.toString()}`);
+        return response.results;
+    }
+    async getShopReceiptTransactionsByListing(shopId, 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.legacy !== undefined)
+            searchParams.set('legacy', params.legacy.toString());
+        const query = searchParams.toString();
+        const suffix = query ? `?${query}` : '';
+        const response = await this.makeRequest(`/shops/${shopId}/listings/${listingId}/transactions${suffix}`);
+        return response.results;
+    }
+    async getShopReceiptTransactionsByShop(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.legacy !== undefined)
+            searchParams.set('legacy', params.legacy.toString());
+        const query = searchParams.toString();
+        const suffix = query ? `?${query}` : '';
+        const response = await this.makeRequest(`/shops/${shopId}/transactions${suffix}`);
+        return response.results;
+    }
+    async getPaymentAccountLedgerEntryPayments(shopId, params) {
+        const searchParams = new URLSearchParams();
+        searchParams.set('ledger_entry_ids', params.ledger_entry_ids.join(','));
+        const response = await this.makeRequest(`/shops/${shopId}/payment-account/ledger-entries/payments?${searchParams.toString()}`);
+        return response.results;
+    }
+    async getShopPaymentByReceiptId(shopId, receiptId) {
+        const response = await this.makeRequest(`/shops/${shopId}/receipts/${receiptId}/payments`);
+        return response.results;
+    }
+    async getMe() {
+        return this.makeRequest('/users/me');
+    }
+    async getUserAddresses() {
+        const response = await this.makeRequest('/user/addresses');
+        return response.results;
+    }
+    async getUserAddress(userAddressId) {
+        return this.makeRequest(`/user/addresses/${userAddressId}`);
+    }
+    async deleteUserAddress(userAddressId) {
+        await this.makeRequest(`/user/addresses/${userAddressId}`, { method: 'DELETE' }, false);
+    }
+    async getPropertiesByBuyerTaxonomyId(taxonomyId) {
+        const response = await this.makeRequest(`/buyer-taxonomy/nodes/${taxonomyId}/properties`);
+        return response.results;
+    }
+    async ping() {
+        return this.makeRequest('/openapi-ping', {}, false);
+    }
+    async tokenScopes(params) {
+        const body = this.buildFormBody(params);
+        return this.makeRequest('/scopes', {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: body.toString()
+        }, false);
+    }
     getRemainingRequests() {
         return this.rateLimiter.getRemainingRequests();
     }