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

package/lib/chunk-TK6ZJDPM.cjs

@@ -0,0 +1,89 @@
+'use strict';
+
+var chunkGKPLAZMH_cjs = require('./chunk-GKPLAZMH.cjs');
+
+// src/resources/parcels.ts
+var Parcels = class _Parcels extends chunkGKPLAZMH_cjs.ApiResource {
+  static TYPE = "parcels";
+  async create(resource, params, options) {
+    return this.resources.create({ ...resource, type: _Parcels.TYPE }, params, options);
+  }
+  async update(resource, params, options) {
+    return this.resources.update({ ...resource, type: _Parcels.TYPE }, params, options);
+  }
+  async delete(id, options) {
+    await this.resources.delete(typeof id === "string" ? { id, type: _Parcels.TYPE } : id, options);
+  }
+  async shipment(parcelId, params, options) {
+    const _parcelId = parcelId.id || parcelId;
+    return this.resources.fetch(
+      { type: "shipments" },
+      `parcels/${_parcelId}/shipment`,
+      params,
+      options
+    );
+  }
+  async package(parcelId, params, options) {
+    const _parcelId = parcelId.id || parcelId;
+    return this.resources.fetch(
+      { type: "packages" },
+      `parcels/${_parcelId}/package`,
+      params,
+      options
+    );
+  }
+  async parcel_line_items(parcelId, params, options) {
+    const _parcelId = parcelId.id || parcelId;
+    return this.resources.fetch(
+      { type: "parcel_line_items" },
+      `parcels/${_parcelId}/parcel_line_items`,
+      params,
+      options
+    );
+  }
+  async attachments(parcelId, params, options) {
+    const _parcelId = parcelId.id || parcelId;
+    return this.resources.fetch(
+      { type: "attachments" },
+      `parcels/${_parcelId}/attachments`,
+      params,
+      options
+    );
+  }
+  async events(parcelId, params, options) {
+    const _parcelId = parcelId.id || parcelId;
+    return this.resources.fetch(
+      { type: "events" },
+      `parcels/${_parcelId}/events`,
+      params,
+      options
+    );
+  }
+  async event_stores(parcelId, params, options) {
+    const _parcelId = parcelId.id || parcelId;
+    return this.resources.fetch(
+      { type: "event_stores" },
+      `parcels/${_parcelId}/event_stores`,
+      params,
+      options
+    );
+  }
+  isParcel(resource) {
+    return resource.type && resource.type === _Parcels.TYPE;
+  }
+  relationship(id) {
+    return super.relationshipOneToOne(id);
+  }
+  relationshipToMany(...ids) {
+    return super.relationshipOneToMany(...ids);
+  }
+  type() {
+    return _Parcels.TYPE;
+  }
+};
+var instance = new Parcels();
+var parcels_default = instance;
+
+exports.parcels_default = parcels_default;
+//# sourceMappingURL=chunk-TK6ZJDPM.cjs.map
+//# sourceMappingURL=chunk-TK6ZJDPM.cjs.map

package/lib/chunk-TK6ZJDPM.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/resources/parcels.ts"],"names":["ApiResource"],"mappings":";;;;;AA6ZA,IAAM,OAAA,GAAN,MAAM,QAAA,SAAgBA,6BAAA,CAAoB;AAAA,EACxC,OAAgB,IAAA,GAAmB,SAAA;AAAA,EAEnC,MAAM,MAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EACiB;AACjB,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,QAAA,CAAQ,IAAA,EAAK,EAAG,MAAA,EAAQ,OAAO,CAAA;AAAA,EACzG;AAAA,EAEA,MAAM,MAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EACiB;AACjB,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,QAAA,CAAQ,IAAA,EAAK,EAAG,MAAA,EAAQ,OAAO,CAAA;AAAA,EACzG;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,QAAA,CAAQ,IAAA,EAAK,GAAI,IAAI,OAAO,CAAA;AAAA,EAC/F;AAAA,EAEA,MAAM,QAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EACmB;AACnB,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAO,QAAA;AAC9C,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,WAAA,EAAY;AAAA,MACpB,WAAW,SAAS,CAAA,SAAA,CAAA;AAAA,MACpB,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,OAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EACkB;AAClB,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAO,QAAA;AAC9C,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,UAAA,EAAW;AAAA,MACnB,WAAW,SAAS,CAAA,QAAA,CAAA;AAAA,MACpB,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,iBAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EACuC;AACvC,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAO,QAAA;AAC9C,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,mBAAA,EAAoB;AAAA,MAC5B,WAAW,SAAS,CAAA,kBAAA,CAAA;AAAA,MACpB,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,WAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EACmC;AACnC,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAO,QAAA;AAC9C,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,aAAA,EAAc;AAAA,MACtB,WAAW,SAAS,CAAA,YAAA,CAAA;AAAA,MACpB,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EAC8B;AAC9B,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAO,QAAA;AAC9C,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,QAAA,EAAS;AAAA,MACjB,WAAW,SAAS,CAAA,OAAA,CAAA;AAAA,MACpB,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,YAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EACmC;AACnC,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAO,QAAA;AAC9C,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,cAAA,EAAe;AAAA,MACvB,WAAW,SAAS,CAAA,aAAA,CAAA;AAAA,MACpB,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,SAAS,QAAA,EAAmC;AAC1C,IAAA,OAAO,QAAA,CAAS,IAAA,IAAQ,QAAA,CAAS,IAAA,KAAS,QAAA,CAAQ,IAAA;AAAA,EACpD;AAAA,EAEA,aAAa,EAAA,EAA2C;AACtD,IAAA,OAAO,KAAA,CAAM,qBAAgC,EAAE,CAAA;AAAA,EACjD;AAAA,EAEA,sBAAsB,GAAA,EAA4B;AAChD,IAAA,OAAO,KAAA,CAAM,qBAAA,CAAiC,GAAG,GAAG,CAAA;AAAA,EACtD;AAAA,EAEA,IAAA,GAAmB;AACjB,IAAA,OAAO,QAAA,CAAQ,IAAA;AAAA,EACjB;AACF,CAAA;AAEA,IAAM,QAAA,GAAW,IAAI,OAAA,EAAQ;AAC7B,IAAO,eAAA,GAAQ","file":"chunk-TK6ZJDPM.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 { EventStore } from './event_stores'\nimport type { Event } from './events'\nimport type { Package, PackageType } from './packages'\nimport type { ParcelLineItem } from './parcel_line_items'\nimport type { Shipment, ShipmentType } from './shipments'\n\ntype ParcelType = 'parcels'\ntype ParcelRel = ResourceRel & { type: ParcelType }\ntype ShipmentRel = ResourceRel & { type: ShipmentType }\ntype PackageRel = ResourceRel & { type: PackageType }\n\nexport type ParcelSort = Pick<\n  Parcel,\n  'id' | 'weight' | 'tracking_status' | 'tracking_status_updated_at' | 'carrier_weight_oz'\n> &\n  ResourceSort\n// export type ParcelFilter = Pick<Parcel, 'id' | 'weight' | 'contents_explanation' | 'shipping_label_url' | 'shipping_label_file_type' | 'shipping_label_size' | 'shipping_label_resolution' | 'tracking_number' | 'tracking_status' | 'tracking_status_detail' | 'tracking_status_updated_at' | 'carrier_weight_oz' | 'incoterm' | 'delivery_confirmation'> & ResourceFilter\n\n/**\n * The Parcel object is returned as part of the response body of each successful list, retrieve, create, update or delete API call to the /api/parcels endpoint.\n *\n * @link https://docs.commercelayer.io/core-api-reference/parcels/object\n */\ninterface Parcel extends Resource {\n  readonly type: ParcelType\n\n  /**\n   * Unique identifier for the parcel.\n   * @example ```\"#1234/S/001/P/001\"```\n   */\n  number?: string | null\n  /**\n   * The parcel weight, used to automatically calculate the tax rates from the available carrier accounts.\n   * @example ```1000```\n   */\n  weight: number\n  /**\n   * The unit of weight. One of 'gr', 'oz', or 'lb'.\n   * @example ```\"gr\"```\n   */\n  unit_of_weight: 'gr' | 'oz' | 'lb'\n  /**\n   * When shipping outside the US, you need to provide either an Exemption and Exclusion Legend (EEL) code or a Proof of Filing Citation (PFC). Which you need is based on the value of the goods being shipped. Value can be one of \"EEL\" o \"PFC\".\n   * @example ```\"EEL\"```\n   */\n  eel_pfc?: string | null\n  /**\n   * The type of item you are sending.\n   * @example ```\"merchandise\"```\n   */\n  contents_type?: string | null\n  /**\n   * If you specify 'other' in the 'contents_type' attribute, you must supply a brief description in this attribute.\n   */\n  contents_explanation?: string | null\n  /**\n   * Indicates if the provided information is accurate.\n   */\n  customs_certify?: boolean | null\n  /**\n   * This is the name of the person who is certifying that the information provided on the customs form is accurate. Use a name of the person in your organization who is responsible for this.\n   * @example ```\"John Doe\"```\n   */\n  customs_signer?: string | null\n  /**\n   * In case the shipment cannot be delivered, this option tells the carrier what you want to happen to the parcel. You can pass either 'return', or 'abandon'. The value defaults to 'return'. If you pass 'abandon', you will not receive the parcel back if it cannot be delivered.\n   * @example ```\"return\"```\n   */\n  non_delivery_option?: string | null\n  /**\n   * Describes if your parcel requires any special treatment or quarantine when entering the country. Can be one of 'none', 'other', 'quarantine', or 'sanitary_phytosanitary_inspection'.\n   * @example ```\"none\"```\n   */\n  restriction_type?: string | null\n  /**\n   * If you specify 'other' in the restriction type, you must supply a brief description of what is required.\n   */\n  restriction_comments?: string | null\n  /**\n   * Indicates if the parcel requires customs info to get the shipping rates.\n   */\n  customs_info_required?: boolean | null\n  /**\n   * The shipping label url, ready to be downloaded and printed.\n   * @example ```\"https://bucket.s3-us-west-2.amazonaws.com/files/postage_label/20180101/123.pdf\"```\n   */\n  shipping_label_url?: string | null\n  /**\n   * The shipping label file type. One of 'application/pdf', 'application/zpl', 'application/epl2', or 'image/png'.\n   * @example ```\"application/pdf\"```\n   */\n  shipping_label_file_type?: string | null\n  /**\n   * The shipping label size.\n   * @example ```\"4x7\"```\n   */\n  shipping_label_size?: string | null\n  /**\n   * The shipping label resolution.\n   * @example ```\"200\"```\n   */\n  shipping_label_resolution?: string | null\n  /**\n   * The tracking number associated to this parcel.\n   * @example ```\"1Z4V2A000000000000\"```\n   */\n  tracking_number?: string | null\n  /**\n   * The tracking status for this parcel, automatically updated in real time by the shipping carrier.\n   * @example ```\"delivered\"```\n   */\n  tracking_status?: string | null\n  /**\n   * Additional information about the tracking status, automatically updated in real time by the shipping carrier.\n   * @example ```\"arrived_at_destination\"```\n   */\n  tracking_status_detail?: string | null\n  /**\n   * Time at which the parcel's tracking status was last updated.\n   * @example ```\"2018-01-01T12:00:00.000Z\"```\n   */\n  tracking_status_updated_at?: string | null\n  /**\n   * The parcel's full tracking history, automatically updated in real time by the shipping carrier.\n   * @example ```[{\"object\":\"TrackingDetail\",\"message\":\"Pre-Shipment information received\",\"status\":\"pre_transit\",\"datetime\":\"2018-02-27T16:02:17Z\",\"source\":\"DHLExpress\",\"tracking_location\":{\"object\":\"TrackingLocation\"}}]```\n   */\n  tracking_details?: Array<Record<string, any>> | null\n  /**\n   * The weight of the parcel as measured by the carrier in ounces (if available).\n   * @example ```\"42.32\"```\n   */\n  carrier_weight_oz?: string | null\n  /**\n   * The name of the person who signed for the parcel (if available).\n   * @example ```\"John Smith\"```\n   */\n  signed_by?: string | null\n  /**\n   * The type of Incoterm (if available).\n   * @example ```\"EXW\"```\n   */\n  incoterm?: string | null\n  /**\n   * The type of delivery confirmation option upon delivery.\n   * @example ```\"SIGNATURE\"```\n   */\n  delivery_confirmation?: string | null\n\n  shipment?: Shipment | null\n  package?: Package | null\n  parcel_line_items?: ParcelLineItem[] | null\n  attachments?: Attachment[] | null\n  events?: Event[] | null\n  event_stores?: EventStore[] | null\n}\n\ninterface ParcelCreate extends ResourceCreate {\n  /**\n   * The parcel weight, used to automatically calculate the tax rates from the available carrier accounts.\n   * @example ```1000```\n   */\n  weight: number\n  /**\n   * The unit of weight. One of 'gr', 'oz', or 'lb'.\n   * @example ```\"gr\"```\n   */\n  unit_of_weight: 'gr' | 'oz' | 'lb'\n  /**\n   * When shipping outside the US, you need to provide either an Exemption and Exclusion Legend (EEL) code or a Proof of Filing Citation (PFC). Which you need is based on the value of the goods being shipped. Value can be one of \"EEL\" o \"PFC\".\n   * @example ```\"EEL\"```\n   */\n  eel_pfc?: string | null\n  /**\n   * The type of item you are sending.\n   * @example ```\"merchandise\"```\n   */\n  contents_type?: string | null\n  /**\n   * If you specify 'other' in the 'contents_type' attribute, you must supply a brief description in this attribute.\n   */\n  contents_explanation?: string | null\n  /**\n   * Indicates if the provided information is accurate.\n   */\n  customs_certify?: boolean | null\n  /**\n   * This is the name of the person who is certifying that the information provided on the customs form is accurate. Use a name of the person in your organization who is responsible for this.\n   * @example ```\"John Doe\"```\n   */\n  customs_signer?: string | null\n  /**\n   * In case the shipment cannot be delivered, this option tells the carrier what you want to happen to the parcel. You can pass either 'return', or 'abandon'. The value defaults to 'return'. If you pass 'abandon', you will not receive the parcel back if it cannot be delivered.\n   * @example ```\"return\"```\n   */\n  non_delivery_option?: string | null\n  /**\n   * Describes if your parcel requires any special treatment or quarantine when entering the country. Can be one of 'none', 'other', 'quarantine', or 'sanitary_phytosanitary_inspection'.\n   * @example ```\"none\"```\n   */\n  restriction_type?: string | null\n  /**\n   * If you specify 'other' in the restriction type, you must supply a brief description of what is required.\n   */\n  restriction_comments?: string | null\n  /**\n   * Indicates if the parcel requires customs info to get the shipping rates.\n   */\n  customs_info_required?: boolean | null\n  /**\n   * The shipping label url, ready to be downloaded and printed.\n   * @example ```\"https://bucket.s3-us-west-2.amazonaws.com/files/postage_label/20180101/123.pdf\"```\n   */\n  shipping_label_url?: string | null\n  /**\n   * The shipping label file type. One of 'application/pdf', 'application/zpl', 'application/epl2', or 'image/png'.\n   * @example ```\"application/pdf\"```\n   */\n  shipping_label_file_type?: string | null\n  /**\n   * The shipping label size.\n   * @example ```\"4x7\"```\n   */\n  shipping_label_size?: string | null\n  /**\n   * The shipping label resolution.\n   * @example ```\"200\"```\n   */\n  shipping_label_resolution?: string | null\n  /**\n   * The tracking number associated to this parcel.\n   * @example ```\"1Z4V2A000000000000\"```\n   */\n  tracking_number?: string | null\n  /**\n   * The tracking status for this parcel, automatically updated in real time by the shipping carrier.\n   * @example ```\"delivered\"```\n   */\n  tracking_status?: string | null\n  /**\n   * Additional information about the tracking status, automatically updated in real time by the shipping carrier.\n   * @example ```\"arrived_at_destination\"```\n   */\n  tracking_status_detail?: string | null\n  /**\n   * Time at which the parcel's tracking status was last updated.\n   * @example ```\"2018-01-01T12:00:00.000Z\"```\n   */\n  tracking_status_updated_at?: string | null\n  /**\n   * The parcel's full tracking history, automatically updated in real time by the shipping carrier.\n   * @example ```[{\"object\":\"TrackingDetail\",\"message\":\"Pre-Shipment information received\",\"status\":\"pre_transit\",\"datetime\":\"2018-02-27T16:02:17Z\",\"source\":\"DHLExpress\",\"tracking_location\":{\"object\":\"TrackingLocation\"}}]```\n   */\n  tracking_details?: Array<Record<string, any>> | null\n  /**\n   * The weight of the parcel as measured by the carrier in ounces (if available).\n   * @example ```\"42.32\"```\n   */\n  carrier_weight_oz?: string | null\n  /**\n   * The name of the person who signed for the parcel (if available).\n   * @example ```\"John Smith\"```\n   */\n  signed_by?: string | null\n  /**\n   * The type of Incoterm (if available).\n   * @example ```\"EXW\"```\n   */\n  incoterm?: string | null\n  /**\n   * The type of delivery confirmation option upon delivery.\n   * @example ```\"SIGNATURE\"```\n   */\n  delivery_confirmation?: string | null\n\n  shipment: ShipmentRel\n  package: PackageRel\n}\n\ninterface ParcelUpdate extends ResourceUpdate {\n  /**\n   * The parcel weight, used to automatically calculate the tax rates from the available carrier accounts.\n   * @example ```1000```\n   */\n  weight?: number | null\n  /**\n   * The unit of weight. One of 'gr', 'oz', or 'lb'.\n   * @example ```\"gr\"```\n   */\n  unit_of_weight?: 'gr' | 'oz' | 'lb' | null\n  /**\n   * When shipping outside the US, you need to provide either an Exemption and Exclusion Legend (EEL) code or a Proof of Filing Citation (PFC). Which you need is based on the value of the goods being shipped. Value can be one of \"EEL\" o \"PFC\".\n   * @example ```\"EEL\"```\n   */\n  eel_pfc?: string | null\n  /**\n   * The type of item you are sending.\n   * @example ```\"merchandise\"```\n   */\n  contents_type?: string | null\n  /**\n   * If you specify 'other' in the 'contents_type' attribute, you must supply a brief description in this attribute.\n   */\n  contents_explanation?: string | null\n  /**\n   * Indicates if the provided information is accurate.\n   */\n  customs_certify?: boolean | null\n  /**\n   * This is the name of the person who is certifying that the information provided on the customs form is accurate. Use a name of the person in your organization who is responsible for this.\n   * @example ```\"John Doe\"```\n   */\n  customs_signer?: string | null\n  /**\n   * In case the shipment cannot be delivered, this option tells the carrier what you want to happen to the parcel. You can pass either 'return', or 'abandon'. The value defaults to 'return'. If you pass 'abandon', you will not receive the parcel back if it cannot be delivered.\n   * @example ```\"return\"```\n   */\n  non_delivery_option?: string | null\n  /**\n   * Describes if your parcel requires any special treatment or quarantine when entering the country. Can be one of 'none', 'other', 'quarantine', or 'sanitary_phytosanitary_inspection'.\n   * @example ```\"none\"```\n   */\n  restriction_type?: string | null\n  /**\n   * If you specify 'other' in the restriction type, you must supply a brief description of what is required.\n   */\n  restriction_comments?: string | null\n  /**\n   * Indicates if the parcel requires customs info to get the shipping rates.\n   */\n  customs_info_required?: boolean | null\n  /**\n   * The shipping label url, ready to be downloaded and printed.\n   * @example ```\"https://bucket.s3-us-west-2.amazonaws.com/files/postage_label/20180101/123.pdf\"```\n   */\n  shipping_label_url?: string | null\n  /**\n   * The shipping label file type. One of 'application/pdf', 'application/zpl', 'application/epl2', or 'image/png'.\n   * @example ```\"application/pdf\"```\n   */\n  shipping_label_file_type?: string | null\n  /**\n   * The shipping label size.\n   * @example ```\"4x7\"```\n   */\n  shipping_label_size?: string | null\n  /**\n   * The shipping label resolution.\n   * @example ```\"200\"```\n   */\n  shipping_label_resolution?: string | null\n  /**\n   * The tracking number associated to this parcel.\n   * @example ```\"1Z4V2A000000000000\"```\n   */\n  tracking_number?: string | null\n  /**\n   * The tracking status for this parcel, automatically updated in real time by the shipping carrier.\n   * @example ```\"delivered\"```\n   */\n  tracking_status?: string | null\n  /**\n   * Additional information about the tracking status, automatically updated in real time by the shipping carrier.\n   * @example ```\"arrived_at_destination\"```\n   */\n  tracking_status_detail?: string | null\n  /**\n   * Time at which the parcel's tracking status was last updated.\n   * @example ```\"2018-01-01T12:00:00.000Z\"```\n   */\n  tracking_status_updated_at?: string | null\n  /**\n   * The parcel's full tracking history, automatically updated in real time by the shipping carrier.\n   * @example ```[{\"object\":\"TrackingDetail\",\"message\":\"Pre-Shipment information received\",\"status\":\"pre_transit\",\"datetime\":\"2018-02-27T16:02:17Z\",\"source\":\"DHLExpress\",\"tracking_location\":{\"object\":\"TrackingLocation\"}}]```\n   */\n  tracking_details?: Array<Record<string, any>> | null\n  /**\n   * The weight of the parcel as measured by the carrier in ounces (if available).\n   * @example ```\"42.32\"```\n   */\n  carrier_weight_oz?: string | null\n  /**\n   * The name of the person who signed for the parcel (if available).\n   * @example ```\"John Smith\"```\n   */\n  signed_by?: string | null\n  /**\n   * The type of Incoterm (if available).\n   * @example ```\"EXW\"```\n   */\n  incoterm?: string | null\n  /**\n   * The type of delivery confirmation option upon delivery.\n   * @example ```\"SIGNATURE\"```\n   */\n  delivery_confirmation?: string | null\n\n  shipment?: ShipmentRel | null\n  package?: PackageRel | null\n}\n\nclass Parcels extends ApiResource<Parcel> {\n  static readonly TYPE: ParcelType = 'parcels' as const\n\n  async create(\n    resource: ParcelCreate,\n    params?: QueryParamsRetrieve<Parcel>,\n    options?: ResourcesConfig,\n  ): Promise<Parcel> {\n    return this.resources.create<ParcelCreate, Parcel>({ ...resource, type: Parcels.TYPE }, params, options)\n  }\n\n  async update(\n    resource: ParcelUpdate,\n    params?: QueryParamsRetrieve<Parcel>,\n    options?: ResourcesConfig,\n  ): Promise<Parcel> {\n    return this.resources.update<ParcelUpdate, Parcel>({ ...resource, type: Parcels.TYPE }, params, options)\n  }\n\n  async delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void> {\n    await this.resources.delete(typeof id === 'string' ? { id, type: Parcels.TYPE } : id, options)\n  }\n\n  async shipment(\n    parcelId: string | Parcel,\n    params?: QueryParamsRetrieve<Shipment>,\n    options?: ResourcesConfig,\n  ): Promise<Shipment> {\n    const _parcelId = (parcelId as Parcel).id || (parcelId as string)\n    return this.resources.fetch<Shipment>(\n      { type: 'shipments' },\n      `parcels/${_parcelId}/shipment`,\n      params,\n      options,\n    ) as unknown as Shipment\n  }\n\n  async package(\n    parcelId: string | Parcel,\n    params?: QueryParamsRetrieve<Package>,\n    options?: ResourcesConfig,\n  ): Promise<Package> {\n    const _parcelId = (parcelId as Parcel).id || (parcelId as string)\n    return this.resources.fetch<Package>(\n      { type: 'packages' },\n      `parcels/${_parcelId}/package`,\n      params,\n      options,\n    ) as unknown as Package\n  }\n\n  async parcel_line_items(\n    parcelId: string | Parcel,\n    params?: QueryParamsList<ParcelLineItem>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<ParcelLineItem>> {\n    const _parcelId = (parcelId as Parcel).id || (parcelId as string)\n    return this.resources.fetch<ParcelLineItem>(\n      { type: 'parcel_line_items' },\n      `parcels/${_parcelId}/parcel_line_items`,\n      params,\n      options,\n    ) as unknown as ListResponse<ParcelLineItem>\n  }\n\n  async attachments(\n    parcelId: string | Parcel,\n    params?: QueryParamsList<Attachment>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<Attachment>> {\n    const _parcelId = (parcelId as Parcel).id || (parcelId as string)\n    return this.resources.fetch<Attachment>(\n      { type: 'attachments' },\n      `parcels/${_parcelId}/attachments`,\n      params,\n      options,\n    ) as unknown as ListResponse<Attachment>\n  }\n\n  async events(\n    parcelId: string | Parcel,\n    params?: QueryParamsList<Event>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<Event>> {\n    const _parcelId = (parcelId as Parcel).id || (parcelId as string)\n    return this.resources.fetch<Event>(\n      { type: 'events' },\n      `parcels/${_parcelId}/events`,\n      params,\n      options,\n    ) as unknown as ListResponse<Event>\n  }\n\n  async event_stores(\n    parcelId: string | Parcel,\n    params?: QueryParamsList<EventStore>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<EventStore>> {\n    const _parcelId = (parcelId as Parcel).id || (parcelId as string)\n    return this.resources.fetch<EventStore>(\n      { type: 'event_stores' },\n      `parcels/${_parcelId}/event_stores`,\n      params,\n      options,\n    ) as unknown as ListResponse<EventStore>\n  }\n\n  isParcel(resource: any): resource is Parcel {\n    return resource.type && resource.type === Parcels.TYPE\n  }\n\n  relationship(id: string | ResourceId | null): ParcelRel {\n    return super.relationshipOneToOne<ParcelRel>(id)\n  }\n\n  relationshipToMany(...ids: string[]): ParcelRel[] {\n    return super.relationshipOneToMany<ParcelRel>(...ids)\n  }\n\n  type(): ParcelType {\n    return Parcels.TYPE\n  }\n}\n\nconst instance = new Parcels()\nexport default instance\n\nexport type { Parcel, ParcelCreate, Parcels, ParcelType, ParcelUpdate }\n"]}

package/lib/chunk-TKLJQ4EZ.cjs

@@ -0,0 +1,70 @@
+'use strict';
+
+var chunkGKPLAZMH_cjs = require('./chunk-GKPLAZMH.cjs');
+
+// src/resources/payment_options.ts
+var PaymentOptions = class _PaymentOptions extends chunkGKPLAZMH_cjs.ApiResource {
+  static TYPE = "payment_options";
+  async create(resource, params, options) {
+    return this.resources.create(
+      { ...resource, type: _PaymentOptions.TYPE },
+      params,
+      options
+    );
+  }
+  async update(resource, params, options) {
+    return this.resources.update(
+      { ...resource, type: _PaymentOptions.TYPE },
+      params,
+      options
+    );
+  }
+  async delete(id, options) {
+    await this.resources.delete(typeof id === "string" ? { id, type: _PaymentOptions.TYPE } : id, options);
+  }
+  async order(paymentOptionId, params, options) {
+    const _paymentOptionId = paymentOptionId.id || paymentOptionId;
+    return this.resources.fetch(
+      { type: "orders" },
+      `payment_options/${_paymentOptionId}/order`,
+      params,
+      options
+    );
+  }
+  async attachments(paymentOptionId, params, options) {
+    const _paymentOptionId = paymentOptionId.id || paymentOptionId;
+    return this.resources.fetch(
+      { type: "attachments" },
+      `payment_options/${_paymentOptionId}/attachments`,
+      params,
+      options
+    );
+  }
+  async event_stores(paymentOptionId, params, options) {
+    const _paymentOptionId = paymentOptionId.id || paymentOptionId;
+    return this.resources.fetch(
+      { type: "event_stores" },
+      `payment_options/${_paymentOptionId}/event_stores`,
+      params,
+      options
+    );
+  }
+  isPaymentOption(resource) {
+    return resource.type && resource.type === _PaymentOptions.TYPE;
+  }
+  relationship(id) {
+    return super.relationshipOneToOne(id);
+  }
+  relationshipToMany(...ids) {
+    return super.relationshipOneToMany(...ids);
+  }
+  type() {
+    return _PaymentOptions.TYPE;
+  }
+};
+var instance = new PaymentOptions();
+var payment_options_default = instance;
+
+exports.payment_options_default = payment_options_default;
+//# sourceMappingURL=chunk-TKLJQ4EZ.cjs.map
+//# sourceMappingURL=chunk-TKLJQ4EZ.cjs.map

package/lib/chunk-TKLJQ4EZ.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/resources/payment_options.ts"],"names":["ApiResource"],"mappings":";;;;;AA2GA,IAAM,cAAA,GAAN,MAAM,eAAA,SAAuBA,6BAAA,CAA2B;AAAA,EACtD,OAAgB,IAAA,GAA0B,iBAAA;AAAA,EAE1C,MAAM,MAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EACwB;AACxB,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,gBAAe,IAAA,EAAK;AAAA,MACzC,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CACJ,QAAA,EACA,MAAA,EACA,OAAA,EACwB;AACxB,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA;AAAA,MACpB,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,gBAAe,IAAA,EAAK;AAAA,MACzC,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,eAAA,CAAe,IAAA,EAAK,GAAI,IAAI,OAAO,CAAA;AAAA,EACtG;AAAA,EAEA,MAAM,KAAA,CACJ,eAAA,EACA,MAAA,EACA,OAAA,EACgB;AAChB,IAAA,MAAM,gBAAA,GAAoB,gBAAkC,EAAA,IAAO,eAAA;AACnE,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,QAAA,EAAS;AAAA,MACjB,mBAAmB,gBAAgB,CAAA,MAAA,CAAA;AAAA,MACnC,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,WAAA,CACJ,eAAA,EACA,MAAA,EACA,OAAA,EACmC;AACnC,IAAA,MAAM,gBAAA,GAAoB,gBAAkC,EAAA,IAAO,eAAA;AACnE,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,aAAA,EAAc;AAAA,MACtB,mBAAmB,gBAAgB,CAAA,YAAA,CAAA;AAAA,MACnC,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,YAAA,CACJ,eAAA,EACA,MAAA,EACA,OAAA,EACmC;AACnC,IAAA,MAAM,gBAAA,GAAoB,gBAAkC,EAAA,IAAO,eAAA;AACnE,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,MACpB,EAAE,MAAM,cAAA,EAAe;AAAA,MACvB,mBAAmB,gBAAgB,CAAA,aAAA,CAAA;AAAA,MACnC,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,gBAAgB,QAAA,EAA0C;AACxD,IAAA,OAAO,QAAA,CAAS,IAAA,IAAQ,QAAA,CAAS,IAAA,KAAS,eAAA,CAAe,IAAA;AAAA,EAC3D;AAAA,EAEA,aAAa,EAAA,EAAkD;AAC7D,IAAA,OAAO,KAAA,CAAM,qBAAuC,EAAE,CAAA;AAAA,EACxD;AAAA,EAEA,sBAAsB,GAAA,EAAmC;AACvD,IAAA,OAAO,KAAA,CAAM,qBAAA,CAAwC,GAAG,GAAG,CAAA;AAAA,EAC7D;AAAA,EAEA,IAAA,GAA0B;AACxB,IAAA,OAAO,eAAA,CAAe,IAAA;AAAA,EACxB;AACF,CAAA;AAEA,IAAM,QAAA,GAAW,IAAI,cAAA,EAAe;AACpC,IAAO,uBAAA,GAAQ","file":"chunk-TKLJQ4EZ.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 { EventStore } from './event_stores'\nimport type { Order, OrderType } from './orders'\n\ntype PaymentOptionType = 'payment_options'\ntype PaymentOptionRel = ResourceRel & { type: PaymentOptionType }\ntype OrderRel = ResourceRel & { type: OrderType }\n\nexport type PaymentOptionSort = Pick<PaymentOption, 'id' | 'name' | 'payment_source_type'> & ResourceSort\n// export type PaymentOptionFilter = Pick<PaymentOption, 'id' | 'name' | 'payment_source_type' | 'data'> & ResourceFilter\n\n/**\n * The Payment option object is returned as part of the response body of each successful list, retrieve, create, update or delete API call to the /api/payment_options endpoint.\n *\n * @link https://docs.commercelayer.io/core-api-reference/payment_options/object\n */\ninterface PaymentOption extends Resource {\n  readonly type: PaymentOptionType\n\n  /**\n   * The payment option's name. Wehn blank is inherited by payment source type.\n   * @example ```\"Stripe Payment Option\"```\n   */\n  name?: string | null\n  /**\n   * The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.\n   * @example ```\"stripe_payments\"```\n   */\n  payment_source_type:\n    | 'adyen_payments'\n    | 'axerve_payments'\n    | 'braintree_payments'\n    | 'checkout_com_payments'\n    | 'external_payments'\n    | 'klarna_payments'\n    | 'paypal_payments'\n    | 'satispay_payments'\n    | 'stripe_payments'\n    | 'wire_transfers'\n  /**\n   * The payment options data to be added to the payment source payload. Check payment specific API for more details.\n   * @example ```{\"application_fee_amount\":1000,\"on_behalf_of\":\"pm_xxx\"}```\n   */\n  data: Record<string, any>\n\n  order?: Order | null\n  attachments?: Attachment[] | null\n  event_stores?: EventStore[] | null\n}\n\ninterface PaymentOptionCreate extends ResourceCreate {\n  /**\n   * The payment option's name. Wehn blank is inherited by payment source type.\n   * @example ```\"Stripe Payment Option\"```\n   */\n  name?: string | null\n  /**\n   * The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.\n   * @example ```\"stripe_payments\"```\n   */\n  payment_source_type:\n    | 'adyen_payments'\n    | 'axerve_payments'\n    | 'braintree_payments'\n    | 'checkout_com_payments'\n    | 'external_payments'\n    | 'klarna_payments'\n    | 'paypal_payments'\n    | 'satispay_payments'\n    | 'stripe_payments'\n    | 'wire_transfers'\n  /**\n   * The payment options data to be added to the payment source payload. Check payment specific API for more details.\n   * @example ```{\"application_fee_amount\":1000,\"on_behalf_of\":\"pm_xxx\"}```\n   */\n  data: Record<string, any>\n\n  order: OrderRel\n}\n\ninterface PaymentOptionUpdate extends ResourceUpdate {\n  /**\n   * The payment option's name. Wehn blank is inherited by payment source type.\n   * @example ```\"Stripe Payment Option\"```\n   */\n  name?: string | null\n  /**\n   * The payment options data to be added to the payment source payload. Check payment specific API for more details.\n   * @example ```{\"application_fee_amount\":1000,\"on_behalf_of\":\"pm_xxx\"}```\n   */\n  data?: Record<string, any> | null\n\n  order?: OrderRel | null\n}\n\nclass PaymentOptions extends ApiResource<PaymentOption> {\n  static readonly TYPE: PaymentOptionType = 'payment_options' as const\n\n  async create(\n    resource: PaymentOptionCreate,\n    params?: QueryParamsRetrieve<PaymentOption>,\n    options?: ResourcesConfig,\n  ): Promise<PaymentOption> {\n    return this.resources.create<PaymentOptionCreate, PaymentOption>(\n      { ...resource, type: PaymentOptions.TYPE },\n      params,\n      options,\n    )\n  }\n\n  async update(\n    resource: PaymentOptionUpdate,\n    params?: QueryParamsRetrieve<PaymentOption>,\n    options?: ResourcesConfig,\n  ): Promise<PaymentOption> {\n    return this.resources.update<PaymentOptionUpdate, PaymentOption>(\n      { ...resource, type: PaymentOptions.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: PaymentOptions.TYPE } : id, options)\n  }\n\n  async order(\n    paymentOptionId: string | PaymentOption,\n    params?: QueryParamsRetrieve<Order>,\n    options?: ResourcesConfig,\n  ): Promise<Order> {\n    const _paymentOptionId = (paymentOptionId as PaymentOption).id || (paymentOptionId as string)\n    return this.resources.fetch<Order>(\n      { type: 'orders' },\n      `payment_options/${_paymentOptionId}/order`,\n      params,\n      options,\n    ) as unknown as Order\n  }\n\n  async attachments(\n    paymentOptionId: string | PaymentOption,\n    params?: QueryParamsList<Attachment>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<Attachment>> {\n    const _paymentOptionId = (paymentOptionId as PaymentOption).id || (paymentOptionId as string)\n    return this.resources.fetch<Attachment>(\n      { type: 'attachments' },\n      `payment_options/${_paymentOptionId}/attachments`,\n      params,\n      options,\n    ) as unknown as ListResponse<Attachment>\n  }\n\n  async event_stores(\n    paymentOptionId: string | PaymentOption,\n    params?: QueryParamsList<EventStore>,\n    options?: ResourcesConfig,\n  ): Promise<ListResponse<EventStore>> {\n    const _paymentOptionId = (paymentOptionId as PaymentOption).id || (paymentOptionId as string)\n    return this.resources.fetch<EventStore>(\n      { type: 'event_stores' },\n      `payment_options/${_paymentOptionId}/event_stores`,\n      params,\n      options,\n    ) as unknown as ListResponse<EventStore>\n  }\n\n  isPaymentOption(resource: any): resource is PaymentOption {\n    return resource.type && resource.type === PaymentOptions.TYPE\n  }\n\n  relationship(id: string | ResourceId | null): PaymentOptionRel {\n    return super.relationshipOneToOne<PaymentOptionRel>(id)\n  }\n\n  relationshipToMany(...ids: string[]): PaymentOptionRel[] {\n    return super.relationshipOneToMany<PaymentOptionRel>(...ids)\n  }\n\n  type(): PaymentOptionType {\n    return PaymentOptions.TYPE\n  }\n}\n\nconst instance = new PaymentOptions()\nexport default instance\n\nexport type { PaymentOption, PaymentOptionCreate, PaymentOptions, PaymentOptionType, PaymentOptionUpdate }\n"]}