@acmekit/js-sdk 2.13.1

package/dist/esm/admin/tax-region.js

@@ -0,0 +1,211 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+const taxRegionUrl = "/admin/tax-regions";
+/**
+ * @privateRemarks
+ *
+ * TODO: Add support for updating a tax region
+ */
+export class TaxRegion {
+    /**
+     * @ignore
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * This method creates a tax region. It sends a request to the
+     * [Create Tax Region](https://docs.acmekit.com/api/admin#tax-regions_posttaxregions)
+     * API route.
+     *
+     * @param body - The details of the tax region to create.
+     * @param query - Configure the fields and relations to retrieve in the tax region.
+     * @param headers - Headers to pass in the request.
+     * @returns The tax region's details.
+     *
+     * @example
+     * sdk.admin.taxRegion.create({
+     *   country_code: "us",
+     *   province_code: "ca",
+     *   default_tax_rate: {
+     *     code: "VAT",
+     *     name: "VAT",
+     *     rate: 20, // 20%
+     *     is_combinable: true,
+     *   },
+     * })
+     * .then(({ tax_region }) => {
+     *   console.log(tax_region)
+     * })
+     */
+    create(body, query, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(taxRegionUrl, {
+                method: "POST",
+                headers,
+                body,
+                query,
+            });
+        });
+    }
+    /**
+     * This method updates a tax region. It sends a request to the
+     * [Update Tax Region](https://docs.acmekit.com/api/admin#tax-regions_posttaxregionsid)
+     * API route.
+     *
+     * @since 2.8.0
+     *
+     * @param id - The ID of the tax region to update.
+     * @param body - The details of the tax region to update.
+     * @param query - Configure the fields and relations to retrieve in the tax region.
+     * @param headers - Headers to pass in the request.
+     * @returns The tax region's details.
+     *
+     * @example
+     * sdk.admin.taxRegion.update("txreg_123", {
+     *   province_code: "ca",
+     * })
+     * .then(({ tax_region }) => {
+     *   console.log(tax_region)
+     * })
+     */
+    update(id, body, query, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`${taxRegionUrl}/${id}`, {
+                method: "POST",
+                headers,
+                body,
+                query,
+            });
+        });
+    }
+    /**
+     * This method deletes a tax region. It sends a request to the
+     * [Delete Tax Region](https://docs.acmekit.com/api/admin#tax-regions_deletetaxregionsid)
+     * API route.
+     *
+     * @param id - The ID of the tax region to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.taxRegion.delete("txreg_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
+    delete(id, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`${taxRegionUrl}/${id}`, {
+                method: "DELETE",
+                headers,
+            });
+        });
+    }
+    /**
+     * This method retrieves a tax region. It sends a request to the
+     * [Get Tax Region](https://docs.acmekit.com/api/admin#tax-regions_gettaxregionsid)
+     * API route.
+     *
+     * @param id - The ID of the tax region to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the tax region.
+     * @param headers - Headers to pass in the request.
+     * @returns The tax region's details.
+     *
+     * @example
+     * To retrieve a tax region by its ID:
+     *
+     * ```ts
+     * sdk.admin.taxRegion.retrieve("txreg_123")
+     * .then(({ tax_region }) => {
+     *   console.log(tax_region)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.taxRegion.retrieve("txreg_123", {
+     *   fields: "id,*tax_rates"
+     * })
+     * .then(({ tax_region }) => {
+     *   console.log(tax_region)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
+     */
+    retrieve(id, query, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`${taxRegionUrl}/${id}`, {
+                method: "GET",
+                headers,
+                query,
+            });
+        });
+    }
+    /**
+     * This method retrieves a list of tax regions. It sends a request to the
+     * [List Tax Regions](https://docs.acmekit.com/api/admin#tax-regions_gettaxregions)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of tax regions.
+     *
+     * @example
+     * To retrieve the list of tax regions:
+     *
+     * ```ts
+     * sdk.admin.taxRegion.list()
+     * .then(({ tax_regions, count, limit, offset }) => {
+     *   console.log(tax_regions)
+     * })
+     * ```
+     *
+     * 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.taxRegion.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ tax_regions, count, limit, offset }) => {
+     *   console.log(tax_regions)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each tax region:
+     *
+     * ```ts
+     * sdk.admin.taxRegion.list({
+     *   fields: "id,*tax_rates"
+     * })
+     * .then(({ tax_regions, count, limit, offset }) => {
+     *   console.log(tax_regions)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
+     */
+    list(query, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(taxRegionUrl, {
+                method: "GET",
+                headers,
+                query,
+            });
+        });
+    }
+}
+//# sourceMappingURL=tax-region.js.map

package/dist/esm/admin/tax-region.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-region.js","sourceRoot":"","sources":["../../../src/admin/tax-region.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,YAAY,GAAG,oBAAoB,CAAA;AAEzC;;;;GAIG;AACH,MAAM,OAAO,SAAS;IAKpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,MAAM,CACV,IAAoC,EACpC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,YAAY,EACZ;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACV,EAAU,EACV,IAAoC,EACpC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,GAAG,YAAY,IAAI,EAAE,EAAE,EACvB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,GAAG,YAAY,IAAI,EAAE,EAAE,EACvB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,GAAG,YAAY,IAAI,EAAE,EAAE,EACvB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAA0C,EAC1C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,YAAY,EACZ;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/dist/esm/admin/translation.d.ts

@@ -0,0 +1,253 @@
+import { HttpTypes } from "@acmekit/types";
+import { Client } from "../client";
+import { ClientHeaders } from "../types";
+export declare class Translation {
+    /**
+     * @ignore
+     */
+    private client;
+    /**
+     * @ignore
+     */
+    constructor(client: Client);
+    /**
+     * This method retrieves a paginated list of translations. It sends a request to the
+     * [List Translations](https://docs.acmekit.com/api/admin#translations_gettranslations)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of translations.
+     *
+     * @example
+     * To retrieve the list of translations:
+     *
+     * ```ts
+     * sdk.admin.translation.list()
+     * .then(({ translations, count, limit, offset }) => {
+     *   console.log(translations)
+     * })
+     * ```
+     *
+     * 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.translation.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ translations, count, limit, offset }) => {
+     *   console.log(translations)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each translation:
+     *
+     * ```ts
+     * sdk.admin.translation.list({
+     *   fields: "id,name"
+     * })
+     * .then(({ translations, count, limit, offset }) => {
+     *   console.log(translations)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
+     */
+    list(query?: HttpTypes.AdminTranslationsListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTranslationsListResponse>;
+    /**
+     * This method allows bulk operations on translations. It sends a request to the
+     * [Manage Translations](https://docs.acmekit.com/api/admin#translations_posttranslationsbatch)
+     * API route.
+     *
+     * @param payload - The translations to create, update, or delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The translations' details.
+     *
+     * @example
+     * sdk.admin.translation.batch({
+     *   create: [
+     *     {
+     *       reference_id: "prod_123",
+     *       reference: "product",
+     *       locale_code: "en-US",
+     *       translations: { title: "Shirt" }
+     *     }
+     *   ],
+     *   update: [
+     *     {
+     *       id: "trans_123",
+     *       translations: { title: "Pants" }
+     *     }
+     *   ],
+     *   delete: ["trans_321"]
+     * })
+     * .then(({ created, updated, deleted }) => {
+     *   console.log(created, updated, deleted)
+     * })
+     */
+    batch(body: HttpTypes.AdminBatchTranslations, headers?: ClientHeaders): Promise<HttpTypes.AdminTranslationsBatchResponse>;
+    /**
+     * This method retrieves the settings for the translations for a given entity type or all entity types if no entity type is provided.
+     * It sends a request to the
+     * [Get Translation Settings](https://docs.acmekit.com/api/admin#translations_gettranslationssettings) API route.
+     *
+     * @param query - The query parameters which can optionally include the entity type to get the settings for and whether to get the settings for active/inactive entities only.
+     * @param headers - Headers to pass in the request.
+     * @returns The translation settings.
+     *
+     * @example
+     * To retrieve the settings for the translations for a given entity type:
+     *
+     * ```ts
+     * sdk.admin.translation.settings({
+     *   entity_type: "product"
+     * })
+     * .then(({ translation_settings }) => {
+     *   console.log(translation_settings)
+     * })
+     * ```
+     *
+     * To retrieve the settings for all entity types:
+     *
+     * ```ts
+     * sdk.admin.translation.settings()
+     * .then(({ translation_settings }) => {
+     *   console.log(translation_settings)
+     * })
+     * ```
+     *
+     * To retrieve the settings for active entities only:
+     *
+     * ```ts
+     * sdk.admin.translation.settings({
+     *   is_active: true
+     * })
+     * .then(({ translation_settings }) => {
+     *   console.log(translation_settings)
+     * })
+     * ```
+     *
+     * To retrieve the settings for inactive entities only:
+     *
+     * ```ts
+     * sdk.admin.translation.settings({
+     *   is_active: false
+     * })
+     * .then(({ translation_settings }) => {
+     *   console.log(translation_settings)
+     * })
+     * ```
+     */
+    settings(query?: HttpTypes.AdminTranslationSettingsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTranslationSettingsResponse>;
+    /**
+     * This method allows bulk operations on translation settings. It sends a request to the
+     * [Batch Translation Settings](https://docs.acmekit.com/api/admin#translations_posttranslationssettingsbatch)
+     * API route.
+     *
+     * @since 2.12.6
+     *
+     * @param body - The translation settings to create, update, or delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The translation settings' details.
+     *
+     * @example
+     * sdk.admin.translation.batchSettings({
+     *   create: [
+     *     {
+     *       entity_type: "product",
+     *       fields: ["title", "description"],
+     *       is_active: true
+     *     }
+     *   ],
+     *   update: [
+     *     {
+     *       id: "trset_123",
+     *       fields: ["title", "description", "subtitle"],
+     *       is_active: true
+     *     }
+     *   ],
+     *   delete: ["trset_456"]
+     * })
+     * .then(({ created, updated, deleted }) => {
+     *   console.log(created, updated, deleted)
+     * })
+     * ```
+     */
+    batchSettings(body: HttpTypes.AdminBatchTranslationSettings, headers?: ClientHeaders): Promise<HttpTypes.AdminBatchTranslationSettingsResponse>;
+    /**
+     * This method retrieves a paginated list of entities for a given entity type with only their
+     * translatable fields.
+     * It sends a request to the
+     * [Get Translation Entities](https://docs.acmekit.com/api/admin#translations_gettranslationentities) API route.
+     *
+     * @since 2.12.4
+     *
+     * @param query - The query parameters including the entity type and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of entities with their translatable fields.
+     *
+     * @example
+     * To retrieve the entities for a given entity type:
+     *
+     * ```ts
+     * sdk.admin.translation.entities({
+     *   type: "product"
+     * })
+     * .then(({ data, count, offset, limit }) => {
+     *   console.log(data)
+     * })
+     * ```
+     *
+     * 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.translation.entities({
+     *   type: "product",
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ data, count, offset, limit }) => {
+     *   console.log(data)
+     * })
+     * ```
+     */
+    entities(query: HttpTypes.AdminTranslationEntitiesParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTranslationEntitiesResponse>;
+    /**
+     * This method retrieves the statistics for the translations for a given entity type or all entity types if no entity type is provided.
+     * It sends a request to the
+     * [Get Translation Statistics](https://docs.acmekit.com/api/admin#translations_gettranslationsstatistics) API route.
+     *
+     * @param query - The query parameters which can optionally include the entity type to get the statistics for.
+     * @param headers - Headers to pass in the request.
+     * @returns The translation statistics.
+     *
+     * @example
+     * To retrieve the statistics for the translations for a given entity type:
+     *
+     * ```ts
+     * sdk.admin.translation.statistics({
+     *   entity_type: "product"
+     * })
+     * .then(({ statistics }) => {
+     *   console.log(statistics)
+     * })
+     * ```
+     *
+     * To retrieve the statistics for all entity types:
+     *
+     * ```ts
+     * sdk.admin.translation.statistics()
+     * .then(({ statistics }) => {
+     *   console.log(statistics)
+     * })
+     * ```
+     */
+    statistics(query?: HttpTypes.AdminTranslationStatisticsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTranslationStatisticsResponse>;
+}
+//# sourceMappingURL=translation.d.ts.map

package/dist/esm/admin/translation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"translation.d.ts","sourceRoot":"","sources":["../../../src/admin/translation.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;AAExC,qBAAa,WAAW;IACtB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IAEtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,sBAAsB,EAAE,OAAO,CAAC,EAAE,aAAa;IAW3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACG,QAAQ,CACZ,KAAK,CAAC,EAAE,SAAS,CAAC,8BAA8B,EAChD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,aAAa,CACjB,IAAI,EAAE,SAAS,CAAC,6BAA6B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACG,QAAQ,CACZ,KAAK,EAAE,SAAS,CAAC,8BAA8B,EAC/C,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,UAAU,CACd,KAAK,CAAC,EAAE,SAAS,CAAC,gCAAgC,EAClD,OAAO,CAAC,EAAE,aAAa;CAU1B"}