ebay-api 9.1.1 → 9.2.0

package/README.md

@@ -22,7 +22,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 
 ## Changelog
 
-* `v9.1.1` is the latest release.
+* `v9.2.0-RC.0` is the latest release.
 * See [here](https://github.com/hendt/ebay-api/blob/master/CHANGELOG.md) for the full changelog.
 
 ## Implementation status
@@ -35,7 +35,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 | **Commerce API**   | ✔ Catalog API `v1_beta.3.1`<br>✔ Charity API `v1.2.0`<br>✔ Identity API `v1.0.0`<br>✔ Notification API `v1.2.0`<br>✔ Taxonomy API `v1.0.0`<br>✔ Translation API `v1_beta.1.4`<br>✔ Media API `v1_beta.1.0`                                                                                                                                                                   |
 | **Developer API**  | ✔ Analytics API                                                                                                                                                                                                                                                                                                                                                              |
 | **Post Order API** | ✔ Cancellation API<br>✔ Case Management API<br>✔ Inquiry API<br>✔ Return API                                                                                                                                                                                                                                                                                                 |
-| **Sell API**       | ✔ Account API `v1.9.0`<br>✔ Analytics API `v1.3.0`<br>✔ Compliance API `v1.4.1`<br>✔ Feed API `v1.3.1`<br>✔ Finance API `v1.9.0`<br>✔ Fulfillment API `v1.19.10`<br>✔ Inventory API `v1.14.0`<br>✔ Listing API `v1_beta.2.1`<br>✔ Logistics API `v1_beta.0.0`<br>✔ Marketing API `v1.17.0`<br>✔ Metadata API `v1.7.1`<br>✔ Negotiation API `v1.1.0`<br>✔ Recommendation API `v1.1.0` |
+| **Sell API**       | ✔ Account API `v1.9.0`<br>✔ Analytics API `v1.3.0`<br>✔ Compliance API `v1.4.1`<br>✔ Feed API `v1.3.1`<br>✔ Finance API `v1.9.0`<br>✔ Fulfillment API `v1.19.10`<br>✔ Inventory API `v1.18.0`<br>✔ Listing API `v1_beta.2.1`<br>✔ Logistics API `v1_beta.0.0`<br>✔ Marketing API `v1.17.0`<br>✔ Metadata API `v1.7.1`<br>✔ Negotiation API `v1.1.0`<br>✔ Recommendation API `v1.1.0` |
 
 ### Traditional API
 
@@ -219,7 +219,7 @@ See the full Documentation [here](https://developer.ebay.com/api-docs/static/oau
 If no other token is set, this token will be obtained *automatically* in the process of calling an RESTful API.
 
 ### Auth'N'Auth
-
+In the Single User Model, the application supports only a single user. In this model, you need only one Auth'n'Auth token.
 👉 The "old" way. Only works with Traditional API.
 Checkout the [Auth'N'Auth example](https://github.com/hendt/ebay-api/tree/master/examples/traditional/authNAuth.ts).
 

package/dist/api/apiFactory.js

@@ -3,7 +3,7 @@ import { Browse, Deal, Feed, Marketing as BuyMarketing, MarketplaceInsights, Off
 import { Catalog, Charity, Identity, Media, Notification, Taxonomy, Translation } from './restful/commerce/index.js';
 import { Analytics as DeveloperAnalytics, KeyManagement } from './restful/developer/index.js';
 import { Cancellation, Case, Inquiry, Return, } from './restful/postOrder/index.js';
-import { Account, Analytics as SellAnalytics, Compliance, Feed as SellFeed, Finances, Fulfillment, Inventory, Listing, Logistics, Marketing as SellMarketing, Metadata, Negotiation, Recommendation } from './restful/sell/index.js';
+import { AccountV1, AccountV2, Analytics as SellAnalytics, Compliance, Feed as SellFeed, Finances, Fulfillment, Inventory, Listing, Logistics, Marketing as SellMarketing, Metadata, Negotiation, Recommendation } from './restful/sell/index.js';
 import Traditional from './traditional/index.js';
 export default class ApiFactory extends Api {
     constructor() {
@@ -48,7 +48,8 @@ export default class ApiFactory extends Api {
     }
     createSellApi() {
         return {
-            account: this.createRestfulApi(Account),
+            account: this.createRestfulApi(AccountV1),
+            accountV2: this.createRestfulApi(AccountV2),
             analytics: this.createRestfulApi(SellAnalytics),
             compliance: this.createRestfulApi(Compliance),
             fulfillment: this.createRestfulApi(Fulfillment),

package/dist/api/restful/developer/analytics/index.d.ts

@@ -3,6 +3,6 @@ import Restful, { OpenApi } from '../../index.js';
 export default class Analytics extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    getRateLimits(apiContext: string, apiName: string): Promise<any>;
+    getRateLimits(apiContext?: string, apiName?: string): Promise<any>;
     getUserRateLimits(apiContext: string, apiName: string): Promise<any>;
 }

package/dist/api/restful/sell/account/{index.d.ts → v1.d.ts}

@@ -2,7 +2,7 @@ import { PaymentsProgramType } from '../../../../enums/index.js';
 import { CustomPolicyCreateRequest, CustomPolicyRequest, FulfillmentPolicyRequest, FulfillmentSellAccountProgram, InventoryLocation, InventoryLocationFull, PaymentPolicyRequest, ReturnPolicyRequest, SalesTaxBase } from '../../../../types/index.js';
 import { operations } from '../../../../types/restful/specs/sell_account_v1_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-export default class Account extends Restful implements OpenApi<operations> {
+export default class AccountV1 extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
     getCustomPolicies(policyTypes: string): Promise<any>;

package/dist/api/restful/sell/account/{index.js → v1.js}

@@ -1,5 +1,5 @@
 import Restful from '../../index.js';
-class Account extends Restful {
+class AccountV1 extends Restful {
     get basePath() {
         return '/sell/account/v1';
     }
@@ -216,5 +216,5 @@ class Account extends Restful {
         return this.get(`/country/${countryCode}/sales_tax_jurisdiction`);
     }
 }
-Account.id = 'Account';
-export default Account;
+AccountV1.id = 'AccountV1';
+export default AccountV1;

package/dist/api/restful/sell/account/v2.d.ts

@@ -0,0 +1,11 @@
+import { RateTableUpdate, UpdatePayoutPercentageRequest } from '../../../../types/index.js';
+import { operations } from '../../../../types/restful/specs/sell_account_v2_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+export default class AccountV2 extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    getRateTable(rateTableId: string): Promise<any>;
+    updateShippingCost(rateTableId: string, body: RateTableUpdate): Promise<any>;
+    getPayoutSettings(): Promise<any>;
+    updatePayoutPercentage(body: UpdatePayoutPercentageRequest): Promise<any>;
+}

package/dist/api/restful/sell/account/v2.js

@@ -0,0 +1,22 @@
+import Restful from '../../index.js';
+class AccountV2 extends Restful {
+    get basePath() {
+        return '/sell/account/v2';
+    }
+    getRateTable(rateTableId) {
+        rateTableId = encodeURIComponent(rateTableId);
+        return this.get(`/rate_table/${rateTableId}`);
+    }
+    updateShippingCost(rateTableId, body) {
+        rateTableId = encodeURIComponent(rateTableId);
+        return this.post(`/rate_table/${rateTableId}/update_shipping_cost`, body);
+    }
+    getPayoutSettings() {
+        return this.get('/payout_settings');
+    }
+    updatePayoutPercentage(body) {
+        return this.post(`/payout_settings/update_percentage`, body);
+    }
+}
+AccountV2.id = 'AccountV2';
+export default AccountV2;

package/dist/api/restful/sell/feed/index.js

@@ -68,7 +68,10 @@ class Feed extends Restful {
     }
     getLatestResultFile(scheduleId) {
         scheduleId = encodeURIComponent(scheduleId);
-        return this.get(`/schedule/${scheduleId}/download_result_file`);
+        return this.get(`/schedule/${scheduleId}/download_result_file`, {
+            responseType: 'arraybuffer',
+            responseEncoding: 'binary',
+        });
     }
     getScheduleTemplate(scheduleTemplateId) {
         scheduleTemplateId = encodeURIComponent(scheduleTemplateId);
@@ -104,7 +107,10 @@ class Feed extends Restful {
     }
     getResultFile(taskId) {
         taskId = encodeURIComponent(taskId);
-        return this.get(`/task/${taskId}/download_result_file`);
+        return this.get(`/task/${taskId}/download_result_file`, {
+            responseType: 'arraybuffer',
+            responseEncoding: 'binary',
+        });
     }
     getTask(taskId) {
         taskId = encodeURIComponent(taskId);

package/dist/api/restful/sell/fulfillment/index.d.ts

@@ -12,7 +12,7 @@ export default class Fulfillment extends Restful implements OpenApi<operations>
         limit?: number;
         offset?: number;
         orderIds?: string | string[];
-        fieldGroups?: string[];
+        fieldGroups?: string;
     }): Promise<any>;
     issueRefund(orderId: string, body?: IssueRefundRequest): Promise<any>;
     getShippingFulfillments(orderId: string): Promise<any>;

package/dist/api/restful/sell/index.d.ts

@@ -1,4 +1,5 @@
-import Account from './account/index.js';
+import AccountV1 from './account/v1.js';
+import AccountV2 from './account/v2.js';
 import Analytics from './analytics/index.js';
 import Compliance from './compliance/index.js';
 import Finances from './finances/index.js';
@@ -12,7 +13,8 @@ import Logistics from './logistics/index.js';
 import Negotiation from './negotiation/index.js';
 import Listing from './listing/index.js';
 export type Sell = {
-    account: Account;
+    account: AccountV1;
+    accountV2: AccountV2;
     analytics: Analytics;
     compliance: Compliance;
     fulfillment: Fulfillment;
@@ -26,4 +28,4 @@ export type Sell = {
     negotiation: Negotiation;
     listing: Listing;
 };
-export { Account, Compliance, Analytics, Fulfillment, Inventory, Marketing, Metadata, Recommendation, Finances, Feed, Logistics, Negotiation, Listing };
+export { AccountV1, AccountV2, Compliance, Analytics, Fulfillment, Inventory, Marketing, Metadata, Recommendation, Finances, Feed, Logistics, Negotiation, Listing };

package/dist/api/restful/sell/index.js

@@ -1,4 +1,5 @@
-import Account from './account/index.js';
+import AccountV1 from './account/v1.js';
+import AccountV2 from './account/v2.js';
 import Analytics from './analytics/index.js';
 import Compliance from './compliance/index.js';
 import Finances from './finances/index.js';
@@ -11,4 +12,4 @@ import Feed from './feed/index.js';
 import Logistics from './logistics/index.js';
 import Negotiation from './negotiation/index.js';
 import Listing from './listing/index.js';
-export { Account, Compliance, Analytics, Fulfillment, Inventory, Marketing, Metadata, Recommendation, Finances, Feed, Logistics, Negotiation, Listing };
+export { AccountV1, AccountV2, Compliance, Analytics, Fulfillment, Inventory, Marketing, Metadata, Recommendation, Finances, Feed, Logistics, Negotiation, Listing };

package/dist/api/restful/sell/inventory/index.d.ts

@@ -1,4 +1,4 @@
-import { BulkEbayOfferDetailsWithKeys, BulkInventoryItem, BulkMigrateListing, BulkOffer, BulkPriceQuantity, Compatibility, EbayOfferDetailsWithId, EbayOfferDetailsWithKeys, InventoryItem, InventoryItemGroup, InventoryLocation, InventoryLocationFull, OfferKeysWithId, PublishByInventoryItemGroupRequest, WithdrawByInventoryItemGroupRequest } from '../../../../types/index.js';
+import { BulkEbayOfferDetailsWithKeys, BulkInventoryItem, BulkMigrateListing, BulkOffer, BulkPriceQuantity, Compatibility, EbayOfferDetailsWithId, EbayOfferDetailsWithKeys, InventoryItem, InventoryItemGroup, InventoryLocation, InventoryLocationFull, LocationMapping, OfferKeysWithId, PublishByInventoryItemGroupRequest, WithdrawByInventoryItemGroupRequest } from '../../../../types/index.js';
 import { operations } from '../../../../types/restful/specs/sell_inventory_v1_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
 export default class Inventory extends Restful implements OpenApi<operations> {
@@ -49,4 +49,7 @@ export default class Inventory extends Restful implements OpenApi<operations> {
     createOrReplaceInventoryItemGroup(inventoryItemGroupKey: string, body: InventoryItemGroup): Promise<any>;
     deleteInventoryItemGroup(inventoryItemGroupKey: string): Promise<any>;
     bulkMigrateListing(body: BulkMigrateListing): Promise<any>;
+    getSkuLocationMapping(listingId: string, sku: string): Promise<any>;
+    createOrReplaceSkuLocationMapping(listingId: string, sku: string, body: LocationMapping): Promise<any>;
+    deleteSkuLocationMapping(listingId: string, sku: string): Promise<any>;
 }

package/dist/api/restful/sell/inventory/index.js

@@ -103,10 +103,10 @@ class Inventory extends Restful {
     }
     publishOffer(offerId) {
         const id = encodeURIComponent(offerId);
-        return this.post(`/offer/${id}/publish/`);
+        return this.post(`/offer/${id}/publish`);
     }
     publishOfferByInventoryItemGroup(body) {
-        return this.post(`/offer/publish_by_inventory_item_group/`, body);
+        return this.post(`/offer/publish_by_inventory_item_group`, body);
     }
     withdrawOfferByInventoryItemGroup(body) {
         return this.post(`/offer/withdraw_by_inventory_item_group`, body);
@@ -138,6 +138,21 @@ class Inventory extends Restful {
     bulkMigrateListing(body) {
         return this.post(`/bulk_migrate_listing`, body);
     }
+    getSkuLocationMapping(listingId, sku) {
+        sku = encodeURIComponent(sku);
+        listingId = encodeURIComponent(listingId);
+        return this.get(`/listing/${listingId}/sku/${sku}/locations`);
+    }
+    createOrReplaceSkuLocationMapping(listingId, sku, body) {
+        sku = encodeURIComponent(sku);
+        listingId = encodeURIComponent(listingId);
+        return this.put(`/listing/${listingId}/sku/${sku}/locations`, body);
+    }
+    deleteSkuLocationMapping(listingId, sku) {
+        sku = encodeURIComponent(sku);
+        listingId = encodeURIComponent(listingId);
+        return this.delete(`/listing/${listingId}/sku/${sku}/locations`);
+    }
 }
 Inventory.id = 'Inventory';
 export default Inventory;