@commercelayer/sdk 8.0.0-beta.1 → 8.0.0-beta.11

package/lib/chunk-346DE4FR.cjs

@@ -0,0 +1,193 @@
+'use strict';
+
+var chunkGKPLAZMH_cjs = require('./chunk-GKPLAZMH.cjs');
+
+// src/resources/external_promotions.ts
+var ExternalPromotions = class _ExternalPromotions extends chunkGKPLAZMH_cjs.ApiResource {
+  static TYPE = "external_promotions";
+  async create(resource, params, options) {
+    return this.resources.create(
+      { ...resource, type: _ExternalPromotions.TYPE },
+      params,
+      options
+    );
+  }
+  async update(resource, params, options) {
+    return this.resources.update(
+      { ...resource, type: _ExternalPromotions.TYPE },
+      params,
+      options
+    );
+  }
+  async delete(id, options) {
+    await this.resources.delete(typeof id === "string" ? { id, type: _ExternalPromotions.TYPE } : id, options);
+  }
+  async market(externalPromotionId, params, options) {
+    const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+    return this.resources.fetch(
+      { type: "markets" },
+      `external_promotions/${_externalPromotionId}/market`,
+      params,
+      options
+    );
+  }
+  async order_amount_promotion_rule(externalPromotionId, params, options) {
+    const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+    return this.resources.fetch(
+      { type: "order_amount_promotion_rules" },
+      `external_promotions/${_externalPromotionId}/order_amount_promotion_rule`,
+      params,
+      options
+    );
+  }
+  async sku_list_promotion_rule(externalPromotionId, params, options) {
+    const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+    return this.resources.fetch(
+      { type: "sku_list_promotion_rules" },
+      `external_promotions/${_externalPromotionId}/sku_list_promotion_rule`,
+      params,
+      options
+    );
+  }
+  async coupon_codes_promotion_rule(externalPromotionId, params, options) {
+    const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+    return this.resources.fetch(
+      { type: "coupon_codes_promotion_rules" },
+      `external_promotions/${_externalPromotionId}/coupon_codes_promotion_rule`,
+      params,
+      options
+    );
+  }
+  async custom_promotion_rule(externalPromotionId, params, options) {
+    const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+    return this.resources.fetch(
+      { type: "custom_promotion_rules" },
+      `external_promotions/${_externalPromotionId}/custom_promotion_rule`,
+      params,
+      options
+    );
+  }
+  async sku_list(externalPromotionId, params, options) {
+    const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+    return this.resources.fetch(
+      { type: "sku_lists" },
+      `external_promotions/${_externalPromotionId}/sku_list`,
+      params,
+      options
+    );
+  }
+  async coupons(externalPromotionId, params, options) {
+    const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+    return this.resources.fetch(
+      { type: "coupons" },
+      `external_promotions/${_externalPromotionId}/coupons`,
+      params,
+      options
+    );
+  }
+  async attachments(externalPromotionId, params, options) {
+    const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+    return this.resources.fetch(
+      { type: "attachments" },
+      `external_promotions/${_externalPromotionId}/attachments`,
+      params,
+      options
+    );
+  }
+  async events(externalPromotionId, params, options) {
+    const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+    return this.resources.fetch(
+      { type: "events" },
+      `external_promotions/${_externalPromotionId}/events`,
+      params,
+      options
+    );
+  }
+  async tags(externalPromotionId, params, options) {
+    const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+    return this.resources.fetch(
+      { type: "tags" },
+      `external_promotions/${_externalPromotionId}/tags`,
+      params,
+      options
+    );
+  }
+  async event_stores(externalPromotionId, params, options) {
+    const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+    return this.resources.fetch(
+      { type: "event_stores" },
+      `external_promotions/${_externalPromotionId}/event_stores`,
+      params,
+      options
+    );
+  }
+  async skus(externalPromotionId, params, options) {
+    const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+    return this.resources.fetch(
+      { type: "skus" },
+      `external_promotions/${_externalPromotionId}/skus`,
+      params,
+      options
+    );
+  }
+  async _disable(id, params, options) {
+    return this.resources.update(
+      { id: typeof id === "string" ? id : id.id, type: _ExternalPromotions.TYPE, _disable: true },
+      params,
+      options
+    );
+  }
+  async _enable(id, params, options) {
+    return this.resources.update(
+      { id: typeof id === "string" ? id : id.id, type: _ExternalPromotions.TYPE, _enable: true },
+      params,
+      options
+    );
+  }
+  async _add_tags(id, triggerValue, params, options) {
+    return this.resources.update(
+      { id: typeof id === "string" ? id : id.id, type: _ExternalPromotions.TYPE, _add_tags: triggerValue },
+      params,
+      options
+    );
+  }
+  async _remove_tags(id, triggerValue, params, options) {
+    return this.resources.update(
+      { id: typeof id === "string" ? id : id.id, type: _ExternalPromotions.TYPE, _remove_tags: triggerValue },
+      params,
+      options
+    );
+  }
+  async _reset_circuit(id, params, options) {
+    return this.resources.update(
+      { id: typeof id === "string" ? id : id.id, type: _ExternalPromotions.TYPE, _reset_circuit: true },
+      params,
+      options
+    );
+  }
+  async _regenerate_shared_secret(id, params, options) {
+    return this.resources.update(
+      { id: typeof id === "string" ? id : id.id, type: _ExternalPromotions.TYPE, _regenerate_shared_secret: true },
+      params,
+      options
+    );
+  }
+  isExternalPromotion(resource) {
+    return resource.type && resource.type === _ExternalPromotions.TYPE;
+  }
+  relationship(id) {
+    return super.relationshipOneToOne(id);
+  }
+  relationshipToMany(...ids) {
+    return super.relationshipOneToMany(...ids);
+  }
+  type() {
+    return _ExternalPromotions.TYPE;
+  }
+};
+var instance = new ExternalPromotions();
+var external_promotions_default = instance;
+
+exports.external_promotions_default = external_promotions_default;
+//# sourceMappingURL=chunk-346DE4FR.cjs.map
+//# sourceMappingURL=chunk-346DE4FR.cjs.map

package/lib/chunk-346DE4FR.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/resources/external_promotions.ts"],"names":["ApiResource"],"mappings":";;;;;AAmUA,IAAM,kBAAA,GAAN,MAAM,mBAAA,SAA2BA,6BAAA,CAA+B;AAAA,EAC9D,OAAgB,IAAA,GAA8B,qBAAA;AAAA,EAE9C,MAAM,MAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,oBAAmB,IAAA,EAAK;AAAA,MAC7C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,oBAAmB,IAAA,EAAK;AAAA,MAC7C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CAAO,EAAA,EAAyB,OAAA,EAA0C;AAC9E,IAAA,MAAM,IAAA,CAAK,SAAA,CAAU,MAAA,CAAO,OAAO,EAAA,KAAO,QAAA,GAAW,EAAE,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAK,GAAI,IAAI,OAAO,CAAA;AAAA,EAC1G;AAAA,EAEA,MAAM,MAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACiB;AACjB,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,SAAA,EAAU;AAAA,MAClB,uBAAuB,oBAAoB,CAAA,OAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,2BAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACmC;AACnC,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,8BAAA,EAA+B;AAAA,MACvC,uBAAuB,oBAAoB,CAAA,4BAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,uBAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EAC+B;AAC/B,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,0BAAA,EAA2B;AAAA,MACnC,uBAAuB,oBAAoB,CAAA,wBAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,2BAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACmC;AACnC,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,8BAAA,EAA+B;AAAA,MACvC,uBAAuB,oBAAoB,CAAA,4BAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,qBAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EAC8B;AAC9B,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,wBAAA,EAAyB;AAAA,MACjC,uBAAuB,oBAAoB,CAAA,sBAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACkB;AAClB,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,WAAA,EAAY;AAAA,MACpB,uBAAuB,oBAAoB,CAAA,SAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,OAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EAC+B;AAC/B,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,SAAA,EAAU;AAAA,MAClB,uBAAuB,oBAAoB,CAAA,QAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,WAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACmC;AACnC,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,aAAA,EAAc;AAAA,MACtB,uBAAuB,oBAAoB,CAAA,YAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EAC8B;AAC9B,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,QAAA,EAAS;AAAA,MACjB,uBAAuB,oBAAoB,CAAA,OAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,IAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,MAAA,EAAO;AAAA,MACf,uBAAuB,oBAAoB,CAAA,KAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,YAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACmC;AACnC,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,cAAA,EAAe;AAAA,MACvB,uBAAuB,oBAAoB,CAAA,aAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,IAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,MAAA,EAAO;AAAA,MACf,uBAAuB,oBAAoB,CAAA,KAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,CACJ,EAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,EAAA,EAAI,OAAO,EAAA,KAAO,QAAA,GAAW,EAAA,GAAK,EAAA,CAAG,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAM,QAAA,EAAU,IAAA,EAAK;AAAA,MACzF,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,OAAA,CACJ,EAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,EAAA,EAAI,OAAO,EAAA,KAAO,QAAA,GAAW,EAAA,GAAK,EAAA,CAAG,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAM,OAAA,EAAS,IAAA,EAAK;AAAA,MACxF,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,SAAA,CACJ,EAAA,EACA,YAAA,EACA,QACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,EAAA,EAAI,OAAO,EAAA,KAAO,QAAA,GAAW,EAAA,GAAK,EAAA,CAAG,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAM,SAAA,EAAW,YAAA,EAAa;AAAA,MAClG,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,YAAA,CACJ,EAAA,EACA,YAAA,EACA,QACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,EAAA,EAAI,OAAO,EAAA,KAAO,QAAA,GAAW,EAAA,GAAK,EAAA,CAAG,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAM,YAAA,EAAc,YAAA,EAAa;AAAA,MACrG,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,cAAA,CACJ,EAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,EAAA,EAAI,OAAO,EAAA,KAAO,QAAA,GAAW,EAAA,GAAK,EAAA,CAAG,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAM,cAAA,EAAgB,IAAA,EAAK;AAAA,MAC/F,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,yBAAA,CACJ,EAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,EAAA,EAAI,OAAO,EAAA,KAAO,QAAA,GAAW,EAAA,GAAK,EAAA,CAAG,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAM,yBAAA,EAA2B,IAAA,EAAK;AAAA,MAC1G,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,oBAAoB,QAAA,EAA8C;AAChE,IAAA,OAAO,QAAA,CAAS,IAAA,IAAQ,QAAA,CAAS,IAAA,KAAS,mBAAA,CAAmB,IAAA;AAAA,EAC/D;AAAA,EAEA,aAAa,EAAA,EAAsD;AACjE,IAAA,OAAO,KAAA,CAAM,qBAA2C,EAAE,CAAA;AAAA,EAC5D;AAAA,EAEA,sBAAsB,GAAA,EAAuC;AAC3D,IAAA,OAAO,KAAA,CAAM,qBAAA,CAA4C,GAAG,GAAG,CAAA;AAAA,EACjE;AAAA,EAEA,IAAA,GAA8B;AAC5B,IAAA,OAAO,mBAAA,CAAmB,IAAA;AAAA,EAC5B;AACF,CAAA;AAEA,IAAM,QAAA,GAAW,IAAI,kBAAA,EAAmB;AACxC,IAAO,2BAAA,GAAQ","file":"chunk-346DE4FR.cjs","sourcesContent":["import type { QueryParamsList, QueryParamsRetrieve } from '../query'\nimport type {\n  ListResponse,\n  Resource,\n  ResourceCreate,\n  ResourceId,\n  ResourceRel,\n  ResourceSort,\n  /* ResourceFilter */ ResourcesConfig,\n  ResourceUpdate,\n} from '../resource'\nimport { ApiResource } from '../resource'\nimport type { Attachment } from './attachments'\nimport type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules'\nimport type { Coupon } from './coupons'\nimport type { CustomPromotionRule, CustomPromotionRuleType } from './custom_promotion_rules'\nimport type { EventStore } from './event_stores'\nimport type { Event } from './events'\nimport type { Market, MarketType } from './markets'\nimport type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './order_amount_promotion_rules'\nimport type { PromotionRule } from './promotion_rules'\nimport type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules'\nimport type { SkuList, SkuListType } from './sku_lists'\nimport type { Sku } from './skus'\nimport type { Tag, TagType } from './tags'\n\ntype ExternalPromotionType = 'external_promotions'\ntype ExternalPromotionRel = ResourceRel & { type: ExternalPromotionType }\ntype MarketRel = ResourceRel & { type: MarketType }\ntype OrderAmountPromotionRuleRel = ResourceRel & { type: OrderAmountPromotionRuleType }\ntype SkuListPromotionRuleRel = ResourceRel & { type: SkuListPromotionRuleType }\ntype CouponCodesPromotionRuleRel = ResourceRel & { type: CouponCodesPromotionRuleType }\ntype CustomPromotionRuleRel = ResourceRel & { type: CustomPromotionRuleType }\ntype SkuListRel = ResourceRel & { type: SkuListType }\ntype TagRel = ResourceRel & { type: TagType }\n\nexport type ExternalPromotionSort = Pick<\n  ExternalPromotion,\n  | 'id'\n  | 'name'\n  | 'currency_code'\n  | 'exclusive'\n  | 'priority'\n  | 'starts_at'\n  | 'expires_at'\n  | 'total_usage_limit'\n  | 'total_usage_count'\n  | 'total_usage_reached'\n  | 'disabled_at'\n  | 'circuit_state'\n  | 'circuit_failure_count'\n> &\n  ResourceSort\n// export type ExternalPromotionFilter = Pick<ExternalPromotion, 'id' | 'name' | 'currency_code' | 'exclusive' | 'priority' | 'starts_at' | 'expires_at' | 'total_usage_limit' | 'total_usage_count' | 'total_usage_reached' | 'disabled_at' | 'circuit_state' | 'circuit_failure_count'> & ResourceFilter\n\n/**\n * The External promotion object is returned as part of the response body of each successful list, retrieve, create, update or delete API call to the /api/external_promotions endpoint.\n *\n * @link https://docs.commercelayer.io/core-api-reference/external_promotions/object\n */\ninterface ExternalPromotion extends Resource {\n  readonly type: ExternalPromotionType\n\n  /**\n   * The promotion's internal name.\n   * @example ```\"Personal promotion\"```\n   */\n  name: string\n  /**\n   * The international 3-letter currency code as defined by the ISO 4217 standard.\n   * @example ```\"EUR\"```\n   */\n  currency_code?: string | null\n  /**\n   * Indicates if the promotion will be applied exclusively, based on its priority score.\n   * @example ```true```\n   */\n  exclusive?: boolean | null\n  /**\n   * The priority assigned to the promotion (lower means higher priority).\n   * @example ```2```\n   */\n  priority?: number | null\n  /**\n   * The activation date/time of this promotion.\n   * @example ```\"2018-01-01T12:00:00.000Z\"```\n   */\n  starts_at: string\n  /**\n   * The expiration date/time of this promotion (must be after starts_at).\n   * @example ```\"2018-01-02T12:00:00.000Z\"```\n   */\n  expires_at: string\n  /**\n   * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.\n   * @example ```5```\n   */\n  total_usage_limit?: number | null\n  /**\n   * The number of times this promotion has been applied.\n   * @example ```2```\n   */\n  total_usage_count?: number | null\n  /**\n   * Indicates if the promotion has been applied the total number of allowed times.\n   */\n  total_usage_reached?: boolean | null\n  /**\n   * Indicates if the promotion is active (enabled and not expired).\n   * @example ```true```\n   */\n  active?: boolean | null\n  /**\n   * The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.\n   * @example ```\"pending\"```\n   */\n  status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null\n  /**\n   * The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.\n   * @example ```112```\n   */\n  weight?: number | null\n  /**\n   * The total number of coupons created for this promotion.\n   * @example ```2```\n   */\n  coupons_count?: number | null\n  /**\n   * Time at which this resource was disabled.\n   * @example ```\"2018-01-01T12:00:00.000Z\"```\n   */\n  disabled_at?: string | null\n  /**\n   * The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.\n   * @example ```\"closed\"```\n   */\n  circuit_state?: string | null\n  /**\n   * The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.\n   * @example ```5```\n   */\n  circuit_failure_count?: number | null\n  /**\n   * The shared secret used to sign the external request payload.\n   * @example ```\"1c0994cc4e996e8c6ee56a2198f66f3c\"```\n   */\n  shared_secret: string\n  /**\n   * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.\n   * @example ```[\"order.line_item_options\"]```\n   */\n  external_includes?: string[] | null\n  /**\n   * The URL to the service that will compute the discount.\n   * @example ```\"https://external_promotion.yourbrand.com\"```\n   */\n  promotion_url: string\n\n  market?: Market | null\n  promotion_rules?: PromotionRule[] | null\n  order_amount_promotion_rule?: OrderAmountPromotionRule | null\n  sku_list_promotion_rule?: SkuListPromotionRule | null\n  coupon_codes_promotion_rule?: CouponCodesPromotionRule | null\n  custom_promotion_rule?: CustomPromotionRule | null\n  sku_list?: SkuList | null\n  coupons?: Coupon[] | null\n  attachments?: Attachment[] | null\n  events?: Event[] | null\n  tags?: Tag[] | null\n  event_stores?: EventStore[] | null\n  skus?: Sku[] | null\n}\n\ninterface ExternalPromotionCreate extends ResourceCreate {\n  /**\n   * The promotion's internal name.\n   * @example ```\"Personal promotion\"```\n   */\n  name: string\n  /**\n   * The international 3-letter currency code as defined by the ISO 4217 standard.\n   * @example ```\"EUR\"```\n   */\n  currency_code?: string | null\n  /**\n   * Indicates if the promotion will be applied exclusively, based on its priority score.\n   * @example ```true```\n   */\n  exclusive?: boolean | null\n  /**\n   * The priority assigned to the promotion (lower means higher priority).\n   * @example ```2```\n   */\n  priority?: number | null\n  /**\n   * The activation date/time of this promotion.\n   * @example ```\"2018-01-01T12:00:00.000Z\"```\n   */\n  starts_at: string\n  /**\n   * The expiration date/time of this promotion (must be after starts_at).\n   * @example ```\"2018-01-02T12:00:00.000Z\"```\n   */\n  expires_at: string\n  /**\n   * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.\n   * @example ```5```\n   */\n  total_usage_limit?: number | null\n  /**\n   * Send this attribute if you want to mark this resource as disabled.\n   * @example ```true```\n   */\n  _disable?: boolean | null\n  /**\n   * Send this attribute if you want to mark this resource as enabled.\n   * @example ```true```\n   */\n  _enable?: boolean | null\n  /**\n   * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.\n   * @example ```[\"order.line_item_options\"]```\n   */\n  external_includes?: string[] | null\n  /**\n   * The URL to the service that will compute the discount.\n   * @example ```\"https://external_promotion.yourbrand.com\"```\n   */\n  promotion_url: string\n\n  market?: MarketRel | null\n  order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null\n  sku_list_promotion_rule?: SkuListPromotionRuleRel | null\n  coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null\n  custom_promotion_rule?: CustomPromotionRuleRel | null\n  sku_list?: SkuListRel | null\n  tags?: TagRel[] | null\n}\n\ninterface ExternalPromotionUpdate extends ResourceUpdate {\n  /**\n   * The promotion's internal name.\n   * @example ```\"Personal promotion\"```\n   */\n  name?: string | null\n  /**\n   * The international 3-letter currency code as defined by the ISO 4217 standard.\n   * @example ```\"EUR\"```\n   */\n  currency_code?: string | null\n  /**\n   * Indicates if the promotion will be applied exclusively, based on its priority score.\n   * @example ```true```\n   */\n  exclusive?: boolean | null\n  /**\n   * The priority assigned to the promotion (lower means higher priority).\n   * @example ```2```\n   */\n  priority?: number | null\n  /**\n   * The activation date/time of this promotion.\n   * @example ```\"2018-01-01T12:00:00.000Z\"```\n   */\n  starts_at?: string | null\n  /**\n   * The expiration date/time of this promotion (must be after starts_at).\n   * @example ```\"2018-01-02T12:00:00.000Z\"```\n   */\n  expires_at?: string | null\n  /**\n   * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.\n   * @example ```5```\n   */\n  total_usage_limit?: number | null\n  /**\n   * Send this attribute if you want to mark this resource as disabled.\n   * @example ```true```\n   */\n  _disable?: boolean | null\n  /**\n   * Send this attribute if you want to mark this resource as enabled.\n   * @example ```true```\n   */\n  _enable?: boolean | null\n  /**\n   * Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.\n   */\n  _add_tags?: string | null\n  /**\n   * Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.\n   */\n  _remove_tags?: string | null\n  /**\n   * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.\n   * @example ```true```\n   */\n  _reset_circuit?: boolean | null\n  /**\n   * Send this attribute if you want to regenerate the shared secret.\n   * @example ```true```\n   */\n  _regenerate_shared_secret?: boolean | null\n  /**\n   * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.\n   * @example ```[\"order.line_item_options\"]```\n   */\n  external_includes?: string[] | null\n  /**\n   * The URL to the service that will compute the discount.\n   * @example ```\"https://external_promotion.yourbrand.com\"```\n   */\n  promotion_url?: string | null\n\n  market?: MarketRel | null\n  order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null\n  sku_list_promotion_rule?: SkuListPromotionRuleRel | null\n  coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null\n  custom_promotion_rule?: CustomPromotionRuleRel | null\n  sku_list?: SkuListRel | null\n  tags?: TagRel[] | null\n}\n\nclass ExternalPromotions extends ApiResource<ExternalPromotion> {\n  static readonly TYPE: ExternalPromotionType = 'external_promotions' as const\n\n  async create(\n    resource: ExternalPromotionCreate,\n    params?: QueryParamsRetrieve<ExternalPromotion>,\n    options?: ResourcesConfig,\n  ): Promise<ExternalPromotion> {\n    return this.resources.create<ExternalPromotionCreate, ExternalPromotion>(\n      { ...resource, type: ExternalPromotions.TYPE },\n      params,\n      options,\n    )\n  }\n\n  async update(\n    resource: ExternalPromotionUpdate,\n    params?: QueryParamsRetrieve<ExternalPromotion>,\n    options?: ResourcesConfig,\n  ): Promise<ExternalPromotion> {\n    return this.resources.update<ExternalPromotionUpdate, ExternalPromotion>(\n      { ...resource, type: ExternalPromotions.TYPE },\n      params,\n      options,\n    )\n  }\n\n  async delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void> {\n    await this.resources.delete(typeof id === 'string' ? { id, type: ExternalPromotions.TYPE } : id, options)\n  }\n\n  async market(\n    externalPromotionId: string | ExternalPromotion,\n    params?: QueryParamsRetrieve<Market>,\n    options?: ResourcesConfig,\n  ): Promise<Market> {\n    const _externalPromotionId = (externalPromotionId as ExternalPromotion).id || (externalPromotionId as string)\n    return this.resources.fetch<Market>(\n      { type: 'markets' },\n      `external_promotions/${_externalPromotionId}/market`,\n      params,\n      options,\n    ) as unknown as Market\n  }\n\n  async order_amount_promotion_rule(\n    externalPromotionId: string | ExternalPromotion,\n    params?: QueryParamsRetrieve<OrderAmountPromotionRule>,\n    options?: ResourcesConfig,\n  ): Promise<OrderAmountPromotionRule> {\n    const _externalPromotionId = (externalPromotionId as ExternalPromotion).id || (externalPromotionId as string)\n    return this.resources.fetch<OrderAmountPromotionRule>(\n      { type: 'order_amount_promotion_rules' },\n      `external_promotions/${_externalPromotionId}/order_amount_promotion_rule`,\n      params,\n      options,\n    ) as unknown as OrderAmountPromotionRule\n  }\n\n  async sku_list_promotion_rule(\n    externalPromotionId: string | ExternalPromotion,\n    params?: QueryParamsRetrieve<SkuListPromotionRule>,\n    options?: ResourcesConfig,\n  ): Promise<SkuListPromotionRule> {\n    const _externalPromotionId = (externalPromotionId as ExternalPromotion).id || (externalPromotionId as string)\n    return this.resources.fetch<SkuListPromotionRule>(\n      { type: 'sku_list_promotion_rules' },\n      `external_promotions/${_externalPromotionId}/sku_list_promotion_rule`,\n      params,\n      options,\n    ) as unknown as SkuListPromotionRule\n  }\n\n  async coupon_codes_promotion_rule(\n    externalPromotionId: string | ExternalPromotion,\n    params?: QueryParamsRetrieve<CouponCodesPromotionRule>,\n    options?: ResourcesConfig,\n  ): Promise<CouponCodesPromotionRule> {\n    const _externalPromotionId = (externalPromotionId as ExternalPromotion).id || (externalPromotionId as string)\n    return this.resources.fetch<CouponCodesPromotionRule>(\n      { type: 'coupon_codes_promotion_rules' },\n      `external_promotions/${_externalPromotionId}/coupon_codes_promotion_rule`,\n      params,\n      options,\n    ) as unknown as CouponCodesPromotionRule\n  }\n\n  async custom_promotion_rule(\n    externalPromotionId: string | ExternalPromotion,\n    params?: QueryParamsRetrieve<CustomPromotionRule>,\n    options?: ResourcesConfig,\n  ): Promise<CustomPromotionRule> {\n    const _externalPromotionId = (externalPromotionId as ExternalPromotion).id || (externalPromotionId as string)\n    return this.resources.fetch<CustomPromotionRule>(\n      { type: 'custom_promotion_rules' },\n      `external_promotions/${_externalPromotionId}/custom_promotion_rule`,\n      params,\n      options,\n    ) as unknown as CustomPromotionRule\n  }\n\n  async sku_list(\n    externalPromotionId: string | ExternalPromotion,\n    params?: QueryParamsRetrieve<SkuList>,\n    options?: ResourcesConfig,\n  ): Promise<SkuList> {\n    const _externalPromotionId = (externalPromotionId as ExternalPromotion).id || (externalPromotionId as string)\n    return this.resources.fetch<SkuList>(\n      { type: 'sku_lists' },\n      `external_promotions/${_externalPromotionId}/sku_list`,\n      params,\n      options,\n    ) as unknown as SkuList\n  }\n\n  async coupons(\n    externalPromotionId: string | ExternalPromotion,\n    params?: QueryParamsList<Coupon>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<Coupon>> {\n    const _externalPromotionId = (externalPromotionId as ExternalPromotion).id || (externalPromotionId as string)\n    return this.resources.fetch<Coupon>(\n      { type: 'coupons' },\n      `external_promotions/${_externalPromotionId}/coupons`,\n      params,\n      options,\n    ) as unknown as ListResponse<Coupon>\n  }\n\n  async attachments(\n    externalPromotionId: string | ExternalPromotion,\n    params?: QueryParamsList<Attachment>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<Attachment>> {\n    const _externalPromotionId = (externalPromotionId as ExternalPromotion).id || (externalPromotionId as string)\n    return this.resources.fetch<Attachment>(\n      { type: 'attachments' },\n      `external_promotions/${_externalPromotionId}/attachments`,\n      params,\n      options,\n    ) as unknown as ListResponse<Attachment>\n  }\n\n  async events(\n    externalPromotionId: string | ExternalPromotion,\n    params?: QueryParamsList<Event>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<Event>> {\n    const _externalPromotionId = (externalPromotionId as ExternalPromotion).id || (externalPromotionId as string)\n    return this.resources.fetch<Event>(\n      { type: 'events' },\n      `external_promotions/${_externalPromotionId}/events`,\n      params,\n      options,\n    ) as unknown as ListResponse<Event>\n  }\n\n  async tags(\n    externalPromotionId: string | ExternalPromotion,\n    params?: QueryParamsList<Tag>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<Tag>> {\n    const _externalPromotionId = (externalPromotionId as ExternalPromotion).id || (externalPromotionId as string)\n    return this.resources.fetch<Tag>(\n      { type: 'tags' },\n      `external_promotions/${_externalPromotionId}/tags`,\n      params,\n      options,\n    ) as unknown as ListResponse<Tag>\n  }\n\n  async event_stores(\n    externalPromotionId: string | ExternalPromotion,\n    params?: QueryParamsList<EventStore>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<EventStore>> {\n    const _externalPromotionId = (externalPromotionId as ExternalPromotion).id || (externalPromotionId as string)\n    return this.resources.fetch<EventStore>(\n      { type: 'event_stores' },\n      `external_promotions/${_externalPromotionId}/event_stores`,\n      params,\n      options,\n    ) as unknown as ListResponse<EventStore>\n  }\n\n  async skus(\n    externalPromotionId: string | ExternalPromotion,\n    params?: QueryParamsList<Sku>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<Sku>> {\n    const _externalPromotionId = (externalPromotionId as ExternalPromotion).id || (externalPromotionId as string)\n    return this.resources.fetch<Sku>(\n      { type: 'skus' },\n      `external_promotions/${_externalPromotionId}/skus`,\n      params,\n      options,\n    ) as unknown as ListResponse<Sku>\n  }\n\n  async _disable(\n    id: string | ExternalPromotion,\n    params?: QueryParamsRetrieve<ExternalPromotion>,\n    options?: ResourcesConfig,\n  ): Promise<ExternalPromotion> {\n    return this.resources.update<ExternalPromotionUpdate, ExternalPromotion>(\n      { id: typeof id === 'string' ? id : id.id, type: ExternalPromotions.TYPE, _disable: true },\n      params,\n      options,\n    )\n  }\n\n  async _enable(\n    id: string | ExternalPromotion,\n    params?: QueryParamsRetrieve<ExternalPromotion>,\n    options?: ResourcesConfig,\n  ): Promise<ExternalPromotion> {\n    return this.resources.update<ExternalPromotionUpdate, ExternalPromotion>(\n      { id: typeof id === 'string' ? id : id.id, type: ExternalPromotions.TYPE, _enable: true },\n      params,\n      options,\n    )\n  }\n\n  async _add_tags(\n    id: string | ExternalPromotion,\n    triggerValue: string,\n    params?: QueryParamsRetrieve<ExternalPromotion>,\n    options?: ResourcesConfig,\n  ): Promise<ExternalPromotion> {\n    return this.resources.update<ExternalPromotionUpdate, ExternalPromotion>(\n      { id: typeof id === 'string' ? id : id.id, type: ExternalPromotions.TYPE, _add_tags: triggerValue },\n      params,\n      options,\n    )\n  }\n\n  async _remove_tags(\n    id: string | ExternalPromotion,\n    triggerValue: string,\n    params?: QueryParamsRetrieve<ExternalPromotion>,\n    options?: ResourcesConfig,\n  ): Promise<ExternalPromotion> {\n    return this.resources.update<ExternalPromotionUpdate, ExternalPromotion>(\n      { id: typeof id === 'string' ? id : id.id, type: ExternalPromotions.TYPE, _remove_tags: triggerValue },\n      params,\n      options,\n    )\n  }\n\n  async _reset_circuit(\n    id: string | ExternalPromotion,\n    params?: QueryParamsRetrieve<ExternalPromotion>,\n    options?: ResourcesConfig,\n  ): Promise<ExternalPromotion> {\n    return this.resources.update<ExternalPromotionUpdate, ExternalPromotion>(\n      { id: typeof id === 'string' ? id : id.id, type: ExternalPromotions.TYPE, _reset_circuit: true },\n      params,\n      options,\n    )\n  }\n\n  async _regenerate_shared_secret(\n    id: string | ExternalPromotion,\n    params?: QueryParamsRetrieve<ExternalPromotion>,\n    options?: ResourcesConfig,\n  ): Promise<ExternalPromotion> {\n    return this.resources.update<ExternalPromotionUpdate, ExternalPromotion>(\n      { id: typeof id === 'string' ? id : id.id, type: ExternalPromotions.TYPE, _regenerate_shared_secret: true },\n      params,\n      options,\n    )\n  }\n\n  isExternalPromotion(resource: any): resource is ExternalPromotion {\n    return resource.type && resource.type === ExternalPromotions.TYPE\n  }\n\n  relationship(id: string | ResourceId | null): ExternalPromotionRel {\n    return super.relationshipOneToOne<ExternalPromotionRel>(id)\n  }\n\n  relationshipToMany(...ids: string[]): ExternalPromotionRel[] {\n    return super.relationshipOneToMany<ExternalPromotionRel>(...ids)\n  }\n\n  type(): ExternalPromotionType {\n    return ExternalPromotions.TYPE\n  }\n}\n\nconst instance = new ExternalPromotions()\nexport default instance\n\nexport type {\n  ExternalPromotion,\n  ExternalPromotionCreate,\n  ExternalPromotions,\n  ExternalPromotionType,\n  ExternalPromotionUpdate,\n}\n"]}

package/lib/chunk-35HABXOS.cjs

@@ -0,0 +1,205 @@
+'use strict';
+
+var chunkGKPLAZMH_cjs = require('./chunk-GKPLAZMH.cjs');
+
+// src/resources/order_subscriptions.ts
+var OrderSubscriptions = class _OrderSubscriptions extends chunkGKPLAZMH_cjs.ApiResource {
+  static TYPE = "order_subscriptions";
+  async create(resource, params, options) {
+    return this.resources.create(
+      { ...resource, type: _OrderSubscriptions.TYPE },
+      params,
+      options
+    );
+  }
+  async update(resource, params, options) {
+    return this.resources.update(
+      { ...resource, type: _OrderSubscriptions.TYPE },
+      params,
+      options
+    );
+  }
+  async delete(id, options) {
+    await this.resources.delete(typeof id === "string" ? { id, type: _OrderSubscriptions.TYPE } : id, options);
+  }
+  async market(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "markets" },
+      `order_subscriptions/${_orderSubscriptionId}/market`,
+      params,
+      options
+    );
+  }
+  async subscription_model(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "subscription_models" },
+      `order_subscriptions/${_orderSubscriptionId}/subscription_model`,
+      params,
+      options
+    );
+  }
+  async source_order(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "orders" },
+      `order_subscriptions/${_orderSubscriptionId}/source_order`,
+      params,
+      options
+    );
+  }
+  async customer(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "customers" },
+      `order_subscriptions/${_orderSubscriptionId}/customer`,
+      params,
+      options
+    );
+  }
+  async customer_payment_source(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "customer_payment_sources" },
+      `order_subscriptions/${_orderSubscriptionId}/customer_payment_source`,
+      params,
+      options
+    );
+  }
+  async order_subscription_items(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "order_subscription_items" },
+      `order_subscriptions/${_orderSubscriptionId}/order_subscription_items`,
+      params,
+      options
+    );
+  }
+  async order_factories(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "order_factories" },
+      `order_subscriptions/${_orderSubscriptionId}/order_factories`,
+      params,
+      options
+    );
+  }
+  /**
+   * @deprecated
+   */
+  async order_copies(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "order_copies" },
+      `order_subscriptions/${_orderSubscriptionId}/order_copies`,
+      params,
+      options
+    );
+  }
+  async recurring_order_copies(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "recurring_order_copies" },
+      `order_subscriptions/${_orderSubscriptionId}/recurring_order_copies`,
+      params,
+      options
+    );
+  }
+  async orders(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "orders" },
+      `order_subscriptions/${_orderSubscriptionId}/orders`,
+      params,
+      options
+    );
+  }
+  async events(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "events" },
+      `order_subscriptions/${_orderSubscriptionId}/events`,
+      params,
+      options
+    );
+  }
+  async tags(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "tags" },
+      `order_subscriptions/${_orderSubscriptionId}/tags`,
+      params,
+      options
+    );
+  }
+  async event_stores(orderSubscriptionId, params, options) {
+    const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+    return this.resources.fetch(
+      { type: "event_stores" },
+      `order_subscriptions/${_orderSubscriptionId}/event_stores`,
+      params,
+      options
+    );
+  }
+  async _activate(id, params, options) {
+    return this.resources.update(
+      { id: typeof id === "string" ? id : id.id, type: _OrderSubscriptions.TYPE, _activate: true },
+      params,
+      options
+    );
+  }
+  async _deactivate(id, params, options) {
+    return this.resources.update(
+      { id: typeof id === "string" ? id : id.id, type: _OrderSubscriptions.TYPE, _deactivate: true },
+      params,
+      options
+    );
+  }
+  async _cancel(id, params, options) {
+    return this.resources.update(
+      { id: typeof id === "string" ? id : id.id, type: _OrderSubscriptions.TYPE, _cancel: true },
+      params,
+      options
+    );
+  }
+  async _convert(id, params, options) {
+    return this.resources.update(
+      { id: typeof id === "string" ? id : id.id, type: _OrderSubscriptions.TYPE, _convert: true },
+      params,
+      options
+    );
+  }
+  async _add_tags(id, triggerValue, params, options) {
+    return this.resources.update(
+      { id: typeof id === "string" ? id : id.id, type: _OrderSubscriptions.TYPE, _add_tags: triggerValue },
+      params,
+      options
+    );
+  }
+  async _remove_tags(id, triggerValue, params, options) {
+    return this.resources.update(
+      { id: typeof id === "string" ? id : id.id, type: _OrderSubscriptions.TYPE, _remove_tags: triggerValue },
+      params,
+      options
+    );
+  }
+  isOrderSubscription(resource) {
+    return resource.type && resource.type === _OrderSubscriptions.TYPE;
+  }
+  relationship(id) {
+    return super.relationshipOneToOne(id);
+  }
+  relationshipToMany(...ids) {
+    return super.relationshipOneToMany(...ids);
+  }
+  type() {
+    return _OrderSubscriptions.TYPE;
+  }
+};
+var instance = new OrderSubscriptions();
+var order_subscriptions_default = instance;
+
+exports.order_subscriptions_default = order_subscriptions_default;
+//# sourceMappingURL=chunk-35HABXOS.cjs.map
+//# sourceMappingURL=chunk-35HABXOS.cjs.map

package/lib/chunk-35HABXOS.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/resources/order_subscriptions.ts"],"names":["ApiResource"],"mappings":";;;;;AAsQA,IAAM,kBAAA,GAAN,MAAM,mBAAA,SAA2BA,6BAAA,CAA+B;AAAA,EAC9D,OAAgB,IAAA,GAA8B,qBAAA;AAAA,EAE9C,MAAM,MAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,oBAAmB,IAAA,EAAK;AAAA,MAC7C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,oBAAmB,IAAA,EAAK;AAAA,MAC7C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CAAO,EAAA,EAAyB,OAAA,EAA0C;AAC9E,IAAA,MAAM,IAAA,CAAK,SAAA,CAAU,MAAA,CAAO,OAAO,EAAA,KAAO,QAAA,GAAW,EAAE,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAK,GAAI,IAAI,OAAO,CAAA;AAAA,EAC1G;AAAA,EAEA,MAAM,MAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACiB;AACjB,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,SAAA,EAAU;AAAA,MAClB,uBAAuB,oBAAoB,CAAA,OAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,kBAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,qBAAA,EAAsB;AAAA,MAC9B,uBAAuB,oBAAoB,CAAA,mBAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,YAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACgB;AAChB,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,QAAA,EAAS;AAAA,MACjB,uBAAuB,oBAAoB,CAAA,aAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACmB;AACnB,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,WAAA,EAAY;AAAA,MACpB,uBAAuB,oBAAoB,CAAA,SAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,uBAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACgC;AAChC,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,0BAAA,EAA2B;AAAA,MACnC,uBAAuB,oBAAoB,CAAA,wBAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,wBAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EAC8C;AAC9C,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,0BAAA,EAA2B;AAAA,MACnC,uBAAuB,oBAAoB,CAAA,yBAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,eAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACqC;AACrC,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,iBAAA,EAAkB;AAAA,MAC1B,uBAAuB,oBAAoB,CAAA,gBAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,YAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACkC;AAClC,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,cAAA,EAAe;AAAA,MACvB,uBAAuB,oBAAoB,CAAA,aAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,sBAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,wBAAA,EAAyB;AAAA,MACjC,uBAAuB,oBAAoB,CAAA,uBAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EAC8B;AAC9B,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,QAAA,EAAS;AAAA,MACjB,uBAAuB,oBAAoB,CAAA,OAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EAC8B;AAC9B,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,QAAA,EAAS;AAAA,MACjB,uBAAuB,oBAAoB,CAAA,OAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,IAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,MAAA,EAAO;AAAA,MACf,uBAAuB,oBAAoB,CAAA,KAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,YAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACmC;AACnC,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,cAAA,EAAe;AAAA,MACvB,uBAAuB,oBAAoB,CAAA,aAAA,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,SAAA,CACJ,EAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,EAAA,EAAI,OAAO,EAAA,KAAO,QAAA,GAAW,EAAA,GAAK,EAAA,CAAG,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAM,SAAA,EAAW,IAAA,EAAK;AAAA,MAC1F,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,WAAA,CACJ,EAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,EAAA,EAAI,OAAO,EAAA,KAAO,QAAA,GAAW,EAAA,GAAK,EAAA,CAAG,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAM,WAAA,EAAa,IAAA,EAAK;AAAA,MAC5F,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,OAAA,CACJ,EAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,EAAA,EAAI,OAAO,EAAA,KAAO,QAAA,GAAW,EAAA,GAAK,EAAA,CAAG,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAM,OAAA,EAAS,IAAA,EAAK;AAAA,MACxF,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,CACJ,EAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,EAAA,EAAI,OAAO,EAAA,KAAO,QAAA,GAAW,EAAA,GAAK,EAAA,CAAG,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAM,QAAA,EAAU,IAAA,EAAK;AAAA,MACzF,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,SAAA,CACJ,EAAA,EACA,YAAA,EACA,QACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,EAAA,EAAI,OAAO,EAAA,KAAO,QAAA,GAAW,EAAA,GAAK,EAAA,CAAG,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAM,SAAA,EAAW,YAAA,EAAa;AAAA,MAClG,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,YAAA,CACJ,EAAA,EACA,YAAA,EACA,QACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,EAAA,EAAI,OAAO,EAAA,KAAO,QAAA,GAAW,EAAA,GAAK,EAAA,CAAG,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAM,YAAA,EAAc,YAAA,EAAa;AAAA,MACrG,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,oBAAoB,QAAA,EAA8C;AAChE,IAAA,OAAO,QAAA,CAAS,IAAA,IAAQ,QAAA,CAAS,IAAA,KAAS,mBAAA,CAAmB,IAAA;AAAA,EAC/D;AAAA,EAEA,aAAa,EAAA,EAAsD;AACjE,IAAA,OAAO,KAAA,CAAM,qBAA2C,EAAE,CAAA;AAAA,EAC5D;AAAA,EAEA,sBAAsB,GAAA,EAAuC;AAC3D,IAAA,OAAO,KAAA,CAAM,qBAAA,CAA4C,GAAG,GAAG,CAAA;AAAA,EACjE;AAAA,EAEA,IAAA,GAA8B;AAC5B,IAAA,OAAO,mBAAA,CAAmB,IAAA;AAAA,EAC5B;AACF,CAAA;AAEA,IAAM,QAAA,GAAW,IAAI,kBAAA,EAAmB;AACxC,IAAO,2BAAA,GAAQ","file":"chunk-35HABXOS.cjs","sourcesContent":["import type { QueryParamsList, QueryParamsRetrieve } from '../query'\nimport type {\n  ListResponse,\n  Resource,\n  ResourceCreate,\n  ResourceId,\n  ResourceRel,\n  ResourceSort,\n  /* ResourceFilter */ ResourcesConfig,\n  ResourceUpdate,\n} from '../resource'\nimport { ApiResource } from '../resource'\nimport type { CustomerPaymentSource, CustomerPaymentSourceType } from './customer_payment_sources'\nimport type { Customer } from './customers'\nimport type { EventStore } from './event_stores'\nimport type { Event } from './events'\nimport type { Market, MarketType } from './markets'\nimport type { OrderCopy } from './order_copies'\nimport type { OrderFactory } from './order_factories'\nimport type { OrderSubscriptionItem } from './order_subscription_items'\nimport type { Order, OrderType } from './orders'\nimport type { RecurringOrderCopy } from './recurring_order_copies'\nimport type { SubscriptionModel } from './subscription_models'\nimport type { Tag, TagType } from './tags'\n\ntype OrderSubscriptionType = 'order_subscriptions'\ntype OrderSubscriptionRel = ResourceRel & { type: OrderSubscriptionType }\ntype MarketRel = ResourceRel & { type: MarketType }\ntype OrderRel = ResourceRel & { type: OrderType }\ntype TagRel = ResourceRel & { type: TagType }\ntype CustomerPaymentSourceRel = ResourceRel & { type: CustomerPaymentSourceType }\n\nexport type OrderSubscriptionSort = Pick<\n  OrderSubscription,\n  | 'id'\n  | 'number'\n  | 'status'\n  | 'frequency'\n  | 'starts_at'\n  | 'expires_at'\n  | 'last_run_at'\n  | 'next_run_at'\n  | 'occurrencies'\n  | 'errors_count'\n  | 'succeeded_on_last_run'\n> &\n  ResourceSort\n// export type OrderSubscriptionFilter = Pick<OrderSubscription, 'id' | 'number' | 'status' | 'frequency' | 'customer_email' | 'starts_at' | 'expires_at' | 'last_run_at' | 'next_run_at' | 'occurrencies' | 'errors_count' | 'succeeded_on_last_run'> & ResourceFilter\n\n/**\n * The Order subscription object is returned as part of the response body of each successful list, retrieve, create, update or delete API call to the /api/order_subscriptions endpoint.\n *\n * @link https://docs.commercelayer.io/core-api-reference/order_subscriptions/object\n */\ninterface OrderSubscription extends Resource {\n  readonly type: OrderSubscriptionType\n\n  /**\n   * Unique identifier for the subscription (numeric).\n   * @example ```\"1234\"```\n   */\n  number?: string | null\n  /**\n   * The subscription status. One of 'draft' (default), 'inactive', 'active', 'running', or 'cancelled'.\n   * @example ```\"draft\"```\n   */\n  status: 'draft' | 'inactive' | 'active' | 'running' | 'cancelled'\n  /**\n   * The frequency of the subscription. Use one of the supported within 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or provide your custom crontab expression (min unit is hour). Must be supported by existing associated subscription_model.\n   * @example ```\"monthly\"```\n   */\n  frequency: string\n  /**\n   * Indicates if the subscription will be activated considering the placed source order as its first run.\n   * @example ```true```\n   */\n  activate_by_source_order?: boolean | null\n  /**\n   * Indicates if the subscription created orders are automatically placed at the end of the copy.\n   * @example ```true```\n   */\n  place_target_order?: boolean | null\n  /**\n   * Indicates the number of hours the renewal alert will be triggered before the subscription next run. Must be included between 1 and 720 hours.\n   * @example ```1```\n   */\n  renewal_alert_period?: number | null\n  /**\n   * The email address of the customer, if any, associated to the source order.\n   * @example ```\"john@example.com\"```\n   */\n  customer_email?: string | null\n  /**\n   * The activation date/time of this subscription.\n   * @example ```\"2018-01-01T12:00:00.000Z\"```\n   */\n  starts_at?: string | null\n  /**\n   * The expiration date/time of this subscription (must be after starts_at).\n   * @example ```\"2018-01-02T12:00:00.000Z\"```\n   */\n  expires_at?: string | null\n  /**\n   * The date/time of the subscription last run.\n   * @example ```\"2018-01-01T12:00:00.000Z\"```\n   */\n  last_run_at?: string | null\n  /**\n   * The date/time of the subscription next run. Can be updated but only in the future, to copy with frequency changes.\n   * @example ```\"2018-01-01T12:00:00.000Z\"```\n   */\n  next_run_at?: string | null\n  /**\n   * The number of times this subscription has run.\n   * @example ```2```\n   */\n  occurrencies?: number | null\n  /**\n   * Indicates the number of subscription errors, if any.\n   * @example ```3```\n   */\n  errors_count?: number | null\n  /**\n   * Indicates if the subscription has succeeded on its last run.\n   * @example ```true```\n   */\n  succeeded_on_last_run?: boolean | null\n  /**\n   * The subscription options used to create the order.\n   * @example ```{\"place_target_order\":false}```\n   */\n  options?: Record<string, any> | null\n\n  market?: Market | null\n  subscription_model?: SubscriptionModel | null\n  source_order?: Order | null\n  customer?: Customer | null\n  customer_payment_source?: CustomerPaymentSource | null\n  order_subscription_items?: OrderSubscriptionItem[] | null\n  order_factories?: OrderFactory[] | null\n  /**\n   * @deprecated\n   */\n  order_copies?: OrderCopy[] | null\n  recurring_order_copies?: RecurringOrderCopy[] | null\n  orders?: Order[] | null\n  events?: Event[] | null\n  tags?: Tag[] | null\n  event_stores?: EventStore[] | null\n}\n\ninterface OrderSubscriptionCreate extends ResourceCreate {\n  /**\n   * The frequency of the subscription. Use one of the supported within 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or provide your custom crontab expression (min unit is hour). Must be supported by existing associated subscription_model.\n   * @example ```\"monthly\"```\n   */\n  frequency: string\n  /**\n   * Indicates if the subscription will be activated considering the placed source order as its first run.\n   * @example ```true```\n   */\n  activate_by_source_order?: boolean | null\n  /**\n   * Indicates if the subscription created orders are automatically placed at the end of the copy.\n   * @example ```true```\n   */\n  place_target_order?: boolean | null\n  /**\n   * Indicates the number of hours the renewal alert will be triggered before the subscription next run. Must be included between 1 and 720 hours.\n   * @example ```1```\n   */\n  renewal_alert_period?: number | null\n  /**\n   * The activation date/time of this subscription.\n   * @example ```\"2018-01-01T12:00:00.000Z\"```\n   */\n  starts_at?: string | null\n  /**\n   * The expiration date/time of this subscription (must be after starts_at).\n   * @example ```\"2018-01-02T12:00:00.000Z\"```\n   */\n  expires_at?: string | null\n  /**\n   * The subscription options used to create the order.\n   * @example ```{\"place_target_order\":false}```\n   */\n  options?: Record<string, any> | null\n\n  market?: MarketRel | null\n  source_order: OrderRel\n  tags?: TagRel[] | null\n}\n\ninterface OrderSubscriptionUpdate extends ResourceUpdate {\n  /**\n   * The frequency of the subscription. Use one of the supported within 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or provide your custom crontab expression (min unit is hour). Must be supported by existing associated subscription_model.\n   * @example ```\"monthly\"```\n   */\n  frequency?: string | null\n  /**\n   * Indicates if the subscription will be activated considering the placed source order as its first run.\n   * @example ```true```\n   */\n  activate_by_source_order?: boolean | null\n  /**\n   * Indicates if the subscription created orders are automatically placed at the end of the copy.\n   * @example ```true```\n   */\n  place_target_order?: boolean | null\n  /**\n   * Indicates the number of hours the renewal alert will be triggered before the subscription next run. Must be included between 1 and 720 hours.\n   * @example ```1```\n   */\n  renewal_alert_period?: number | null\n  /**\n   * The expiration date/time of this subscription (must be after starts_at).\n   * @example ```\"2018-01-02T12:00:00.000Z\"```\n   */\n  expires_at?: string | null\n  /**\n   * The date/time of the subscription next run. Can be updated but only in the future, to copy with frequency changes.\n   * @example ```\"2018-01-01T12:00:00.000Z\"```\n   */\n  next_run_at?: string | null\n  /**\n   * The subscription options used to create the order.\n   * @example ```{\"place_target_order\":false}```\n   */\n  options?: Record<string, any> | null\n  /**\n   * Send this attribute if you want to mark this subscription as active.\n   * @example ```true```\n   */\n  _activate?: boolean | null\n  /**\n   * Send this attribute if you want to mark this subscription as inactive.\n   * @example ```true```\n   */\n  _deactivate?: boolean | null\n  /**\n   * Send this attribute if you want to mark this subscription as cancelled.\n   * @example ```true```\n   */\n  _cancel?: boolean | null\n  /**\n   * Send this attribute if you want to convert a manual subscription to an automatic one. A subscription model is required before conversion.\n   * @example ```true```\n   */\n  _convert?: boolean | null\n  /**\n   * Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.\n   */\n  _add_tags?: string | null\n  /**\n   * Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.\n   */\n  _remove_tags?: string | null\n\n  customer_payment_source?: CustomerPaymentSourceRel | null\n  tags?: TagRel[] | null\n}\n\nclass OrderSubscriptions extends ApiResource<OrderSubscription> {\n  static readonly TYPE: OrderSubscriptionType = 'order_subscriptions' as const\n\n  async create(\n    resource: OrderSubscriptionCreate,\n    params?: QueryParamsRetrieve<OrderSubscription>,\n    options?: ResourcesConfig,\n  ): Promise<OrderSubscription> {\n    return this.resources.create<OrderSubscriptionCreate, OrderSubscription>(\n      { ...resource, type: OrderSubscriptions.TYPE },\n      params,\n      options,\n    )\n  }\n\n  async update(\n    resource: OrderSubscriptionUpdate,\n    params?: QueryParamsRetrieve<OrderSubscription>,\n    options?: ResourcesConfig,\n  ): Promise<OrderSubscription> {\n    return this.resources.update<OrderSubscriptionUpdate, OrderSubscription>(\n      { ...resource, type: OrderSubscriptions.TYPE },\n      params,\n      options,\n    )\n  }\n\n  async delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void> {\n    await this.resources.delete(typeof id === 'string' ? { id, type: OrderSubscriptions.TYPE } : id, options)\n  }\n\n  async market(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsRetrieve<Market>,\n    options?: ResourcesConfig,\n  ): Promise<Market> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<Market>(\n      { type: 'markets' },\n      `order_subscriptions/${_orderSubscriptionId}/market`,\n      params,\n      options,\n    ) as unknown as Market\n  }\n\n  async subscription_model(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsRetrieve<SubscriptionModel>,\n    options?: ResourcesConfig,\n  ): Promise<SubscriptionModel> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<SubscriptionModel>(\n      { type: 'subscription_models' },\n      `order_subscriptions/${_orderSubscriptionId}/subscription_model`,\n      params,\n      options,\n    ) as unknown as SubscriptionModel\n  }\n\n  async source_order(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsRetrieve<Order>,\n    options?: ResourcesConfig,\n  ): Promise<Order> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<Order>(\n      { type: 'orders' },\n      `order_subscriptions/${_orderSubscriptionId}/source_order`,\n      params,\n      options,\n    ) as unknown as Order\n  }\n\n  async customer(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsRetrieve<Customer>,\n    options?: ResourcesConfig,\n  ): Promise<Customer> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<Customer>(\n      { type: 'customers' },\n      `order_subscriptions/${_orderSubscriptionId}/customer`,\n      params,\n      options,\n    ) as unknown as Customer\n  }\n\n  async customer_payment_source(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsRetrieve<CustomerPaymentSource>,\n    options?: ResourcesConfig,\n  ): Promise<CustomerPaymentSource> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<CustomerPaymentSource>(\n      { type: 'customer_payment_sources' },\n      `order_subscriptions/${_orderSubscriptionId}/customer_payment_source`,\n      params,\n      options,\n    ) as unknown as CustomerPaymentSource\n  }\n\n  async order_subscription_items(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsList<OrderSubscriptionItem>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<OrderSubscriptionItem>> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<OrderSubscriptionItem>(\n      { type: 'order_subscription_items' },\n      `order_subscriptions/${_orderSubscriptionId}/order_subscription_items`,\n      params,\n      options,\n    ) as unknown as ListResponse<OrderSubscriptionItem>\n  }\n\n  async order_factories(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsList<OrderFactory>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<OrderFactory>> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<OrderFactory>(\n      { type: 'order_factories' },\n      `order_subscriptions/${_orderSubscriptionId}/order_factories`,\n      params,\n      options,\n    ) as unknown as ListResponse<OrderFactory>\n  }\n\n  /**\n   * @deprecated\n   */\n  async order_copies(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsList<OrderCopy>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<OrderCopy>> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<OrderCopy>(\n      { type: 'order_copies' },\n      `order_subscriptions/${_orderSubscriptionId}/order_copies`,\n      params,\n      options,\n    ) as unknown as ListResponse<OrderCopy>\n  }\n\n  async recurring_order_copies(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsList<RecurringOrderCopy>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<RecurringOrderCopy>> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<RecurringOrderCopy>(\n      { type: 'recurring_order_copies' },\n      `order_subscriptions/${_orderSubscriptionId}/recurring_order_copies`,\n      params,\n      options,\n    ) as unknown as ListResponse<RecurringOrderCopy>\n  }\n\n  async orders(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsList<Order>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<Order>> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<Order>(\n      { type: 'orders' },\n      `order_subscriptions/${_orderSubscriptionId}/orders`,\n      params,\n      options,\n    ) as unknown as ListResponse<Order>\n  }\n\n  async events(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsList<Event>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<Event>> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<Event>(\n      { type: 'events' },\n      `order_subscriptions/${_orderSubscriptionId}/events`,\n      params,\n      options,\n    ) as unknown as ListResponse<Event>\n  }\n\n  async tags(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsList<Tag>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<Tag>> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<Tag>(\n      { type: 'tags' },\n      `order_subscriptions/${_orderSubscriptionId}/tags`,\n      params,\n      options,\n    ) as unknown as ListResponse<Tag>\n  }\n\n  async event_stores(\n    orderSubscriptionId: string | OrderSubscription,\n    params?: QueryParamsList<EventStore>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<EventStore>> {\n    const _orderSubscriptionId = (orderSubscriptionId as OrderSubscription).id || (orderSubscriptionId as string)\n    return this.resources.fetch<EventStore>(\n      { type: 'event_stores' },\n      `order_subscriptions/${_orderSubscriptionId}/event_stores`,\n      params,\n      options,\n    ) as unknown as ListResponse<EventStore>\n  }\n\n  async _activate(\n    id: string | OrderSubscription,\n    params?: QueryParamsRetrieve<OrderSubscription>,\n    options?: ResourcesConfig,\n  ): Promise<OrderSubscription> {\n    return this.resources.update<OrderSubscriptionUpdate, OrderSubscription>(\n      { id: typeof id === 'string' ? id : id.id, type: OrderSubscriptions.TYPE, _activate: true },\n      params,\n      options,\n    )\n  }\n\n  async _deactivate(\n    id: string | OrderSubscription,\n    params?: QueryParamsRetrieve<OrderSubscription>,\n    options?: ResourcesConfig,\n  ): Promise<OrderSubscription> {\n    return this.resources.update<OrderSubscriptionUpdate, OrderSubscription>(\n      { id: typeof id === 'string' ? id : id.id, type: OrderSubscriptions.TYPE, _deactivate: true },\n      params,\n      options,\n    )\n  }\n\n  async _cancel(\n    id: string | OrderSubscription,\n    params?: QueryParamsRetrieve<OrderSubscription>,\n    options?: ResourcesConfig,\n  ): Promise<OrderSubscription> {\n    return this.resources.update<OrderSubscriptionUpdate, OrderSubscription>(\n      { id: typeof id === 'string' ? id : id.id, type: OrderSubscriptions.TYPE, _cancel: true },\n      params,\n      options,\n    )\n  }\n\n  async _convert(\n    id: string | OrderSubscription,\n    params?: QueryParamsRetrieve<OrderSubscription>,\n    options?: ResourcesConfig,\n  ): Promise<OrderSubscription> {\n    return this.resources.update<OrderSubscriptionUpdate, OrderSubscription>(\n      { id: typeof id === 'string' ? id : id.id, type: OrderSubscriptions.TYPE, _convert: true },\n      params,\n      options,\n    )\n  }\n\n  async _add_tags(\n    id: string | OrderSubscription,\n    triggerValue: string,\n    params?: QueryParamsRetrieve<OrderSubscription>,\n    options?: ResourcesConfig,\n  ): Promise<OrderSubscription> {\n    return this.resources.update<OrderSubscriptionUpdate, OrderSubscription>(\n      { id: typeof id === 'string' ? id : id.id, type: OrderSubscriptions.TYPE, _add_tags: triggerValue },\n      params,\n      options,\n    )\n  }\n\n  async _remove_tags(\n    id: string | OrderSubscription,\n    triggerValue: string,\n    params?: QueryParamsRetrieve<OrderSubscription>,\n    options?: ResourcesConfig,\n  ): Promise<OrderSubscription> {\n    return this.resources.update<OrderSubscriptionUpdate, OrderSubscription>(\n      { id: typeof id === 'string' ? id : id.id, type: OrderSubscriptions.TYPE, _remove_tags: triggerValue },\n      params,\n      options,\n    )\n  }\n\n  isOrderSubscription(resource: any): resource is OrderSubscription {\n    return resource.type && resource.type === OrderSubscriptions.TYPE\n  }\n\n  relationship(id: string | ResourceId | null): OrderSubscriptionRel {\n    return super.relationshipOneToOne<OrderSubscriptionRel>(id)\n  }\n\n  relationshipToMany(...ids: string[]): OrderSubscriptionRel[] {\n    return super.relationshipOneToMany<OrderSubscriptionRel>(...ids)\n  }\n\n  type(): OrderSubscriptionType {\n    return OrderSubscriptions.TYPE\n  }\n}\n\nconst instance = new OrderSubscriptions()\nexport default instance\n\nexport type {\n  OrderSubscription,\n  OrderSubscriptionCreate,\n  OrderSubscriptions,\n  OrderSubscriptionType,\n  OrderSubscriptionUpdate,\n}\n"]}

package/lib/chunk-3DMYHXGB.js

@@ -0,0 +1,20 @@
+// src/config.ts
+var config = {
+  default: {
+    domain: "commercelayer.io",
+    pageNumber: 1,
+    pageSize: 10
+  },
+  client: {
+    timeout: 15e3,
+    requiredAttributes: ["organization", "accessToken"]
+  },
+  jsonapi: {
+    maxResourceIncluded: 2
+  }
+};
+var config_default = config;
+
+export { config_default };
+//# sourceMappingURL=chunk-3DMYHXGB.js.map
+//# sourceMappingURL=chunk-3DMYHXGB.js.map

package/lib/chunk-3DMYHXGB.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/config.ts"],"names":[],"mappings":";AAEA,IAAM,MAAA,GAAS;AAAA,EACb,OAAA,EAAS;AAAA,IACP,MAAA,EAAQ,kBAAA;AAAA,IACR,UAAA,EAAY,CAAA;AAAA,IACZ,QAAA,EAAU;AAAA,GACZ;AAAA,EACA,MAAA,EAAQ;AAAA,IACN,OAAA,EAAS,IAAA;AAAA,IACT,kBAAA,EAAoB,CAAC,cAAA,EAAgB,aAAa;AAAA,GACpD;AAAA,EACA,OAAA,EAAS;AAAA,IACP,mBAAA,EAAqB;AAAA;AAEzB,CAAA;AAEA,IAAO,cAAA,GAAQ","file":"chunk-3DMYHXGB.js","sourcesContent":["import type { ApiClientInitConfig } from './client'\n\nconst config = {\n  default: {\n    domain: 'commercelayer.io',\n    pageNumber: 1,\n    pageSize: 10,\n  },\n  client: {\n    timeout: 15000,\n    requiredAttributes: ['organization', 'accessToken'] as Array<keyof ApiClientInitConfig>,\n  },\n  jsonapi: {\n    maxResourceIncluded: 2,\n  },\n} as const\n\nexport default config\n"]}

package/lib/chunk-3EI7CXU3.js

@@ -0,0 +1,68 @@
+import { ApiResource } from './chunk-5W54ENHX.js';
+
+// src/resources/gift_card_recipients.ts
+var GiftCardRecipients = class _GiftCardRecipients extends ApiResource {
+  static TYPE = "gift_card_recipients";
+  async create(resource, params, options) {
+    return this.resources.create(
+      { ...resource, type: _GiftCardRecipients.TYPE },
+      params,
+      options
+    );
+  }
+  async update(resource, params, options) {
+    return this.resources.update(
+      { ...resource, type: _GiftCardRecipients.TYPE },
+      params,
+      options
+    );
+  }
+  async delete(id, options) {
+    await this.resources.delete(typeof id === "string" ? { id, type: _GiftCardRecipients.TYPE } : id, options);
+  }
+  async customer(giftCardRecipientId, params, options) {
+    const _giftCardRecipientId = giftCardRecipientId.id || giftCardRecipientId;
+    return this.resources.fetch(
+      { type: "customers" },
+      `gift_card_recipients/${_giftCardRecipientId}/customer`,
+      params,
+      options
+    );
+  }
+  async event_stores(giftCardRecipientId, params, options) {
+    const _giftCardRecipientId = giftCardRecipientId.id || giftCardRecipientId;
+    return this.resources.fetch(
+      { type: "event_stores" },
+      `gift_card_recipients/${_giftCardRecipientId}/event_stores`,
+      params,
+      options
+    );
+  }
+  async attachments(giftCardRecipientId, params, options) {
+    const _giftCardRecipientId = giftCardRecipientId.id || giftCardRecipientId;
+    return this.resources.fetch(
+      { type: "attachments" },
+      `gift_card_recipients/${_giftCardRecipientId}/attachments`,
+      params,
+      options
+    );
+  }
+  isGiftCardRecipient(resource) {
+    return resource.type && resource.type === _GiftCardRecipients.TYPE;
+  }
+  relationship(id) {
+    return super.relationshipOneToOne(id);
+  }
+  relationshipToMany(...ids) {
+    return super.relationshipOneToMany(...ids);
+  }
+  type() {
+    return _GiftCardRecipients.TYPE;
+  }
+};
+var instance = new GiftCardRecipients();
+var gift_card_recipients_default = instance;
+
+export { gift_card_recipients_default };
+//# sourceMappingURL=chunk-3EI7CXU3.js.map
+//# sourceMappingURL=chunk-3EI7CXU3.js.map

package/lib/chunk-3EI7CXU3.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/resources/gift_card_recipients.ts"],"names":[],"mappings":";;;AA4FA,IAAM,kBAAA,GAAN,MAAM,mBAAA,SAA2B,WAAA,CAA+B;AAAA,EAC9D,OAAgB,IAAA,GAA8B,sBAAA;AAAA,EAE9C,MAAM,MAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,oBAAmB,IAAA,EAAK;AAAA,MAC7C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EAC4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,oBAAmB,IAAA,EAAK;AAAA,MAC7C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CAAO,EAAA,EAAyB,OAAA,EAA0C;AAC9E,IAAA,MAAM,IAAA,CAAK,SAAA,CAAU,MAAA,CAAO,OAAO,EAAA,KAAO,QAAA,GAAW,EAAE,EAAA,EAAI,IAAA,EAAM,mBAAA,CAAmB,IAAA,EAAK,GAAI,IAAI,OAAO,CAAA;AAAA,EAC1G;AAAA,EAEA,MAAM,QAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACmB;AACnB,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,WAAA,EAAY;AAAA,MACpB,wBAAwB,oBAAoB,CAAA,SAAA,CAAA;AAAA,MAC5C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,YAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACmC;AACnC,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,cAAA,EAAe;AAAA,MACvB,wBAAwB,oBAAoB,CAAA,aAAA,CAAA;AAAA,MAC5C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,WAAA,CACJ,mBAAA,EACA,MAAA,EACA,OAAA,EACmC;AACnC,IAAA,MAAM,oBAAA,GAAwB,oBAA0C,EAAA,IAAO,mBAAA;AAC/E,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,aAAA,EAAc;AAAA,MACtB,wBAAwB,oBAAoB,CAAA,YAAA,CAAA;AAAA,MAC5C,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,oBAAoB,QAAA,EAA8C;AAChE,IAAA,OAAO,QAAA,CAAS,IAAA,IAAQ,QAAA,CAAS,IAAA,KAAS,mBAAA,CAAmB,IAAA;AAAA,EAC/D;AAAA,EAEA,aAAa,EAAA,EAAsD;AACjE,IAAA,OAAO,KAAA,CAAM,qBAA2C,EAAE,CAAA;AAAA,EAC5D;AAAA,EAEA,sBAAsB,GAAA,EAAuC;AAC3D,IAAA,OAAO,KAAA,CAAM,qBAAA,CAA4C,GAAG,GAAG,CAAA;AAAA,EACjE;AAAA,EAEA,IAAA,GAA8B;AAC5B,IAAA,OAAO,mBAAA,CAAmB,IAAA;AAAA,EAC5B;AACF,CAAA;AAEA,IAAM,QAAA,GAAW,IAAI,kBAAA,EAAmB;AACxC,IAAO,4BAAA,GAAQ","file":"chunk-3EI7CXU3.js","sourcesContent":["import type { QueryParamsList, QueryParamsRetrieve } from '../query'\nimport type {\n  ListResponse,\n  Resource,\n  ResourceCreate,\n  ResourceId,\n  ResourceRel,\n  ResourceSort,\n  /* ResourceFilter */ ResourcesConfig,\n  ResourceUpdate,\n} from '../resource'\nimport { ApiResource } from '../resource'\nimport type { Attachment } from './attachments'\nimport type { Customer, CustomerType } from './customers'\nimport type { EventStore } from './event_stores'\n\ntype GiftCardRecipientType = 'gift_card_recipients'\ntype GiftCardRecipientRel = ResourceRel & { type: GiftCardRecipientType }\ntype CustomerRel = ResourceRel & { type: CustomerType }\n\nexport type GiftCardRecipientSort = Pick<GiftCardRecipient, 'id' | 'email'> & ResourceSort\n// export type GiftCardRecipientFilter = Pick<GiftCardRecipient, 'id' | 'email' | 'first_name' | 'last_name'> & ResourceFilter\n\n/**\n * The Gift card recipient object is returned as part of the response body of each successful list, retrieve, create, update or delete API call to the /api/gift_card_recipients endpoint.\n *\n * @link https://docs.commercelayer.io/core-api-reference/gift_card_recipients/object\n */\ninterface GiftCardRecipient extends Resource {\n  readonly type: GiftCardRecipientType\n\n  /**\n   * The recipient email address.\n   * @example ```\"john@example.com\"```\n   */\n  email: string\n  /**\n   * The recipient first name.\n   * @example ```\"John\"```\n   */\n  first_name?: string | null\n  /**\n   * The recipient last name.\n   * @example ```\"Smith\"```\n   */\n  last_name?: string | null\n\n  customer?: Customer | null\n  event_stores?: EventStore[] | null\n  attachments?: Attachment[] | null\n}\n\ninterface GiftCardRecipientCreate extends ResourceCreate {\n  /**\n   * The recipient email address.\n   * @example ```\"john@example.com\"```\n   */\n  email: string\n  /**\n   * The recipient first name.\n   * @example ```\"John\"```\n   */\n  first_name?: string | null\n  /**\n   * The recipient last name.\n   * @example ```\"Smith\"```\n   */\n  last_name?: string | null\n\n  customer?: CustomerRel | null\n}\n\ninterface GiftCardRecipientUpdate extends ResourceUpdate {\n  /**\n   * The recipient email address.\n   * @example ```\"john@example.com\"```\n   */\n  email?: string | null\n  /**\n   * The recipient first name.\n   * @example ```\"John\"```\n   */\n  first_name?: string | null\n  /**\n   * The recipient last name.\n   * @example ```\"Smith\"```\n   */\n  last_name?: string | null\n\n  customer?: CustomerRel | null\n}\n\nclass GiftCardRecipients extends ApiResource<GiftCardRecipient> {\n  static readonly TYPE: GiftCardRecipientType = 'gift_card_recipients' as const\n\n  async create(\n    resource: GiftCardRecipientCreate,\n    params?: QueryParamsRetrieve<GiftCardRecipient>,\n    options?: ResourcesConfig,\n  ): Promise<GiftCardRecipient> {\n    return this.resources.create<GiftCardRecipientCreate, GiftCardRecipient>(\n      { ...resource, type: GiftCardRecipients.TYPE },\n      params,\n      options,\n    )\n  }\n\n  async update(\n    resource: GiftCardRecipientUpdate,\n    params?: QueryParamsRetrieve<GiftCardRecipient>,\n    options?: ResourcesConfig,\n  ): Promise<GiftCardRecipient> {\n    return this.resources.update<GiftCardRecipientUpdate, GiftCardRecipient>(\n      { ...resource, type: GiftCardRecipients.TYPE },\n      params,\n      options,\n    )\n  }\n\n  async delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void> {\n    await this.resources.delete(typeof id === 'string' ? { id, type: GiftCardRecipients.TYPE } : id, options)\n  }\n\n  async customer(\n    giftCardRecipientId: string | GiftCardRecipient,\n    params?: QueryParamsRetrieve<Customer>,\n    options?: ResourcesConfig,\n  ): Promise<Customer> {\n    const _giftCardRecipientId = (giftCardRecipientId as GiftCardRecipient).id || (giftCardRecipientId as string)\n    return this.resources.fetch<Customer>(\n      { type: 'customers' },\n      `gift_card_recipients/${_giftCardRecipientId}/customer`,\n      params,\n      options,\n    ) as unknown as Customer\n  }\n\n  async event_stores(\n    giftCardRecipientId: string | GiftCardRecipient,\n    params?: QueryParamsList<EventStore>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<EventStore>> {\n    const _giftCardRecipientId = (giftCardRecipientId as GiftCardRecipient).id || (giftCardRecipientId as string)\n    return this.resources.fetch<EventStore>(\n      { type: 'event_stores' },\n      `gift_card_recipients/${_giftCardRecipientId}/event_stores`,\n      params,\n      options,\n    ) as unknown as ListResponse<EventStore>\n  }\n\n  async attachments(\n    giftCardRecipientId: string | GiftCardRecipient,\n    params?: QueryParamsList<Attachment>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<Attachment>> {\n    const _giftCardRecipientId = (giftCardRecipientId as GiftCardRecipient).id || (giftCardRecipientId as string)\n    return this.resources.fetch<Attachment>(\n      { type: 'attachments' },\n      `gift_card_recipients/${_giftCardRecipientId}/attachments`,\n      params,\n      options,\n    ) as unknown as ListResponse<Attachment>\n  }\n\n  isGiftCardRecipient(resource: any): resource is GiftCardRecipient {\n    return resource.type && resource.type === GiftCardRecipients.TYPE\n  }\n\n  relationship(id: string | ResourceId | null): GiftCardRecipientRel {\n    return super.relationshipOneToOne<GiftCardRecipientRel>(id)\n  }\n\n  relationshipToMany(...ids: string[]): GiftCardRecipientRel[] {\n    return super.relationshipOneToMany<GiftCardRecipientRel>(...ids)\n  }\n\n  type(): GiftCardRecipientType {\n    return GiftCardRecipients.TYPE\n  }\n}\n\nconst instance = new GiftCardRecipients()\nexport default instance\n\nexport type {\n  GiftCardRecipient,\n  GiftCardRecipientCreate,\n  GiftCardRecipients,\n  GiftCardRecipientType,\n  GiftCardRecipientUpdate,\n}\n"]}