@acmekit/js-sdk 2.13.1

package/dist/admin/stock-location.js

@@ -0,0 +1,260 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StockLocation = void 0;
+class StockLocation {
+    /**
+     * @ignore
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * This method creates a new stock location. It sends a request to the
+     * [Create Stock Location](https://docs.acmekit.com/api/admin#stock-locations_poststocklocations)
+     * API route.
+     *
+     * @param body - The details of the stock location to create.
+     * @param query - Configure the fields and relations to retrieve in the stock location.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.create({
+     *   name: "Main Warehouse",
+     *   address_id: "addr_123",
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
+    async create(body, query, headers) {
+        return await this.client.fetch(`/admin/stock-locations`, {
+            method: "POST",
+            headers,
+            body,
+            query,
+        });
+    }
+    /**
+     * This method updates a stock location. It sends a request to the
+     * [Update Stock Location](https://docs.acmekit.com/api/admin#stock-locations_poststocklocationsid)
+     * API route.
+     *
+     * @param id - The ID of the stock location to update.
+     * @param body - The details of the stock location to update.
+     * @param query - Configure the fields and relations to retrieve in the stock location.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.update("sloc_123", {
+     *   name: "European Warehouse",
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
+    async update(id, body, query, headers) {
+        return await this.client.fetch(`/admin/stock-locations/${id}`, {
+            method: "POST",
+            headers,
+            body,
+            query,
+        });
+    }
+    /**
+     * This method deletes a stock location. It sends a request to the
+     * [Delete Stock Location](https://docs.acmekit.com/api/admin#stock-locations_deletestocklocationsid)
+     * API route.
+     *
+     * @param id - The ID of the stock location to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.delete("sloc_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
+    async delete(id, headers) {
+        return await this.client.fetch(`/admin/stock-locations/${id}`, {
+            method: "DELETE",
+            headers,
+        });
+    }
+    /**
+     * This method retrieves a stock location. It sends a request to the
+     * [Get Stock Location](https://docs.acmekit.com/api/admin#stock-locations_getstocklocationsid)
+     * API route.
+     *
+     * @param id - The ID of the stock location to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the stock location.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * To retrieve a stock location by its ID:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.retrieve("sloc_123")
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.retrieve("sloc_123", {
+     *   fields: "id,*sales_channels"
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
+     */
+    async retrieve(id, query, headers) {
+        return await this.client.fetch(`/admin/stock-locations/${id}`, {
+            method: "GET",
+            headers,
+            query,
+        });
+    }
+    /**
+     * This method retrieves a list of stock locations. It sends a request to the
+     * [List Stock Locations](https://docs.acmekit.com/api/admin#stock-locations_getstocklocations)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of stock locations.
+     *
+     * @example
+     * To retrieve the list of stock locations:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.list()
+     * .then(({ stock_locations, count, limit, offset }) => {
+     *   console.log(stock_locations)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ stock_locations, count, limit, offset }) => {
+     *   console.log(stock_locations)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each stock location:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.list({
+     *   fields: "id,*sales_channels"
+     * })
+     * .then(({ stock_locations, count, limit, offset }) => {
+     *   console.log(stock_locations)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
+     */
+    async list(query, headers) {
+        return await this.client.fetch(`/admin/stock-locations`, {
+            method: "GET",
+            headers,
+            query,
+        });
+    }
+    /**
+     * This method manages the sales channels of a stock location by adding or removing them. It sends a request to the
+     * [Manage Stock Location Sales Channels](https://docs.acmekit.com/api/admin#stock-locations_poststocklocationsidsaleschannels)
+     * API route.
+     *
+     * @param id - The ID of the stock location to update the sales channels for.
+     * @param body - The details of the sales channels to update.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.updateSalesChannels("sloc_123", {
+     *   add: ["sc_123"],
+     *   remove: ["sc_456"],
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
+    async updateSalesChannels(id, body, headers) {
+        return await this.client.fetch(`/admin/stock-locations/${id}/sales-channels`, {
+            method: "POST",
+            headers,
+            body,
+        });
+    }
+    /**
+     * This method adds a new fulfillment set to a stock location. It sends a request to the
+     * [Add Fulfillment Set to Stock Location](https://docs.acmekit.com/api/admin#stock-locations_poststocklocationsidfulfillmentsets)
+     * API route.
+     *
+     * @param id - The ID of the stock location to add the fulfillment set to.
+     * @param body - The details of the fulfillment set to add.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.createFulfillmentSet("sloc_123", {
+     *   name: "Shipping",
+     *   type: "shipping",
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
+    async createFulfillmentSet(id, body, headers) {
+        return await this.client.fetch(`/admin/stock-locations/${id}/fulfillment-sets`, {
+            method: "POST",
+            headers,
+            body,
+        });
+    }
+    /**
+     * This method manages the fulfillment providers of a stock location by adding or removing them. It sends a request to the
+     * [Manage Fulfillment Providers of Stock Location](https://docs.acmekit.com/api/admin#stock-locations_poststocklocationsidfulfillmentproviders)
+     * API route.
+     *
+     * @param id - The ID of the stock location to manage the fulfillment providers for.
+     * @param body - The details of the fulfillment providers to manage.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.updateFulfillmentProviders("sloc_123", {
+     *   add: ["fp_manual_manual"],
+     *   remove: ["fp_shipstation_shipstation"],
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
+    async updateFulfillmentProviders(id, body, headers) {
+        return await this.client.fetch(`/admin/stock-locations/${id}/fulfillment-providers`, {
+            method: "POST",
+            headers,
+            body,
+        });
+    }
+}
+exports.StockLocation = StockLocation;
+//# sourceMappingURL=stock-location.js.map

package/dist/admin/stock-location.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stock-location.js","sourceRoot":"","sources":["../../src/admin/stock-location.ts"],"names":[],"mappings":";;;AAIA,MAAa,aAAa;IAKxB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,IAAwC,EACxC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAwC,EACxC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAA8C,EAC9C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,mBAAmB,CACvB,EAAU,EACV,IAAqD,EACrD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,iBAAiB,EAC7C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,oBAAoB,CACxB,EAAU,EACV,IAAsD,EACtD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,mBAAmB,EAC/C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,0BAA0B,CAC9B,EAAU,EACV,IAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,wBAAwB,EACpD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AA1TD,sCA0TC"}

package/dist/admin/store.d.ts

@@ -0,0 +1,116 @@
+import { HttpTypes, SelectParams } from "@acmekit/types";
+import { Client } from "../client";
+import { ClientHeaders } from "../types";
+export declare class Store {
+    /**
+     * @ignore
+     */
+    private client;
+    /**
+     * @ignore
+     */
+    constructor(client: Client);
+    /**
+     * This method retrieves a store by its ID. It sends a request to the
+     * [Get Store](https://docs.acmekit.com/api/admin#stores_getstoresid)
+     * API route.
+     *
+     * @param id - The ID of the store to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the store.
+     * @param headers - Headers to pass in the request.
+     * @returns The store's details.
+     *
+     * @example
+     * To retrieve a store by its ID:
+     *
+     * ```ts
+     * sdk.admin.store.retrieve("store_123")
+     * .then(({ store }) => {
+     *   console.log(store)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.store.retrieve("store_123", {
+     *   fields: "id,*supported_currencies"
+     * })
+     * .then(({ store }) => {
+     *   console.log(store)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
+     */
+    retrieve(id: string, query?: HttpTypes.AdminStoreParams, headers?: ClientHeaders): Promise<HttpTypes.AdminStoreResponse>;
+    /**
+     * This method retrieves a list of stores. It sends a request to the
+     * [List Stores](https://docs.acmekit.com/api/admin#stores_getstores)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of stores.
+     *
+     * @example
+     * To retrieve the list of stores:
+     *
+     * ```ts
+     * sdk.admin.store.list()
+     * .then(({ stores, count, limit, offset }) => {
+     *   console.log(stores)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.store.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ stores, count, limit, offset }) => {
+     *   console.log(stores)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each store:
+     *
+     * ```ts
+     * sdk.admin.store.list({
+     *   fields: "id,*supported_currencies"
+     * })
+     * .then(({ stores, count, limit, offset }) => {
+     *   console.log(stores)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
+     */
+    list(query?: HttpTypes.AdminStoreListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminStoreListResponse>;
+    /**
+     * This method updates a store. It sends a request to the
+     * [Update Store](https://docs.acmekit.com/api/admin#stores_poststoresid)
+     * API route.
+     *
+     * @param id - The ID of the store to update.
+     * @param body - The details of the store to update.
+     * @param query - Configure the fields and relations to retrieve in the store.
+     * @param headers - Headers to pass in the request.
+     * @returns The store's details.
+     *
+     * @example
+     * sdk.admin.store.update("store_123", {
+     *   name: "My Store",
+     * })
+     * .then(({ store }) => {
+     *   console.log(store)
+     * })
+     */
+    update(id: string, body: HttpTypes.AdminUpdateStore, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminStoreResponse>;
+}
+//# sourceMappingURL=store.d.ts.map

package/dist/admin/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/admin/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,KAAK;IAChB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,gBAAgB,EAClC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,EAAE,aAAa;IAW1E;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gBAAgB,EAChC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;CAY1B"}

package/dist/admin/store.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Store = void 0;
+class Store {
+    /**
+     * @ignore
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * This method retrieves a store by its ID. It sends a request to the
+     * [Get Store](https://docs.acmekit.com/api/admin#stores_getstoresid)
+     * API route.
+     *
+     * @param id - The ID of the store to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the store.
+     * @param headers - Headers to pass in the request.
+     * @returns The store's details.
+     *
+     * @example
+     * To retrieve a store by its ID:
+     *
+     * ```ts
+     * sdk.admin.store.retrieve("store_123")
+     * .then(({ store }) => {
+     *   console.log(store)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.store.retrieve("store_123", {
+     *   fields: "id,*supported_currencies"
+     * })
+     * .then(({ store }) => {
+     *   console.log(store)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
+     */
+    async retrieve(id, query, headers) {
+        return await this.client.fetch(`/admin/stores/${id}`, {
+            method: "GET",
+            headers,
+            query,
+        });
+    }
+    /**
+     * This method retrieves a list of stores. It sends a request to the
+     * [List Stores](https://docs.acmekit.com/api/admin#stores_getstores)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of stores.
+     *
+     * @example
+     * To retrieve the list of stores:
+     *
+     * ```ts
+     * sdk.admin.store.list()
+     * .then(({ stores, count, limit, offset }) => {
+     *   console.log(stores)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.store.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ stores, count, limit, offset }) => {
+     *   console.log(stores)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each store:
+     *
+     * ```ts
+     * sdk.admin.store.list({
+     *   fields: "id,*supported_currencies"
+     * })
+     * .then(({ stores, count, limit, offset }) => {
+     *   console.log(stores)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
+     */
+    async list(query, headers) {
+        return await this.client.fetch(`/admin/stores`, {
+            method: "GET",
+            headers,
+            query,
+        });
+    }
+    /**
+     * This method updates a store. It sends a request to the
+     * [Update Store](https://docs.acmekit.com/api/admin#stores_poststoresid)
+     * API route.
+     *
+     * @param id - The ID of the store to update.
+     * @param body - The details of the store to update.
+     * @param query - Configure the fields and relations to retrieve in the store.
+     * @param headers - Headers to pass in the request.
+     * @returns The store's details.
+     *
+     * @example
+     * sdk.admin.store.update("store_123", {
+     *   name: "My Store",
+     * })
+     * .then(({ store }) => {
+     *   console.log(store)
+     * })
+     */
+    async update(id, body, query, headers) {
+        return await this.client.fetch(`/admin/stores/${id}`, {
+            method: "POST",
+            headers,
+            body,
+            query,
+        });
+    }
+}
+exports.Store = Store;
+//# sourceMappingURL=store.js.map

package/dist/admin/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../../src/admin/store.ts"],"names":[],"mappings":";;;AAIA,MAAa,KAAK;IAKhB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAkC,EAClC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CAAC,KAAsC,EAAE,OAAuB;QACxE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,eAAe,EACf;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAgC,EAChC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAzJD,sBAyJC"}

package/dist/admin/tax-provider.d.ts

@@ -0,0 +1,64 @@
+import { HttpTypes } from "@acmekit/types";
+import { Client } from "../client";
+import { ClientHeaders } from "../types";
+export declare class TaxProvider {
+    /**
+     * @ignore
+     */
+    private client;
+    /**
+     * @ignore
+     */
+    constructor(client: Client);
+    /**
+     * This method retrieves a list of tax providers. It sends a request to the
+     * [List Tax Providers](https://docs.acmekit.com/api/admin#tax-providers_gettaxproviders)
+     * API route.
+     *
+     * @since 2.8.0
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of tax providers.
+     *
+     * @example
+     * To retrieve the list of tax providers:
+     *
+     * ```ts
+     * sdk.admin.taxProvider.list()
+     * .then(({ tax_providers, count, limit, offset }) => {
+     *   console.log(tax_providers)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.taxProvider.list({
+     *   limit: 10,
+     *   offset: 10,
+     * })
+     * .then(({ tax_providers, count, limit, offset }) => {
+     *   console.log(tax_providers)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each products:
+     *
+     * ```ts
+     * sdk.admin.taxProvider.list({
+     *   fields: "id,*regions"
+     * })
+     * .then(({ tax_providers, count, limit, offset }) => {
+     *   console.log(tax_providers)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
+     */
+    list(query?: HttpTypes.AdminGetTaxProvidersParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxProviderListResponse>;
+}
+//# sourceMappingURL=tax-provider.d.ts.map

package/dist/admin/tax-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-provider.d.ts","sourceRoot":"","sources":["../../src/admin/tax-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAIxC,qBAAa,WAAW;IACtB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/admin/tax-provider.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaxProvider = void 0;
+const taxProviderUrl = "/admin/tax-providers";
+class TaxProvider {
+    /**
+     * @ignore
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * This method retrieves a list of tax providers. It sends a request to the
+     * [List Tax Providers](https://docs.acmekit.com/api/admin#tax-providers_gettaxproviders)
+     * API route.
+     *
+     * @since 2.8.0
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of tax providers.
+     *
+     * @example
+     * To retrieve the list of tax providers:
+     *
+     * ```ts
+     * sdk.admin.taxProvider.list()
+     * .then(({ tax_providers, count, limit, offset }) => {
+     *   console.log(tax_providers)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.taxProvider.list({
+     *   limit: 10,
+     *   offset: 10,
+     * })
+     * .then(({ tax_providers, count, limit, offset }) => {
+     *   console.log(tax_providers)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each products:
+     *
+     * ```ts
+     * sdk.admin.taxProvider.list({
+     *   fields: "id,*regions"
+     * })
+     * .then(({ tax_providers, count, limit, offset }) => {
+     *   console.log(tax_providers)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
+     */
+    async list(query, headers) {
+        return await this.client.fetch(taxProviderUrl, {
+            method: "GET",
+            headers,
+            query,
+        });
+    }
+}
+exports.TaxProvider = TaxProvider;
+//# sourceMappingURL=tax-provider.js.map

package/dist/admin/tax-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-provider.js","sourceRoot":"","sources":["../../src/admin/tax-provider.ts"],"names":[],"mappings":";;;AAIA,MAAM,cAAc,GAAG,sBAAsB,CAAA;AAE7C,MAAa,WAAW;IAKtB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,KAAK,CAAC,IAAI,CACR,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,cAAc,EACd;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AA1ED,kCA0EC"}