@commercelayer/sdk 4.41.0 → 4.42.0

package/lib/cjs/resources/adjustments.js

@@ -2,27 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Adjustments extends resource_1.ApiResource {
-    // static readonly PATH = 'adjustments'
-    async list(params, options) {
-        return this.resources.list({ type: Adjustments.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Adjustments.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Adjustments.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: Adjustments.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Adjustments.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Adjustments.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: Adjustments.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: Adjustments.TYPE } : id, options);
     }
     async versions(adjustmentId, params, options) {
         const _adjustmentId = adjustmentId.id || adjustmentId;
         return this.resources.fetch({ type: 'versions' }, `adjustments/${_adjustmentId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isAdjustment(resource) {
         return resource.type && (resource.type === Adjustments.TYPE);
     }

package/lib/cjs/resources/adyen_gateways.d.ts

@@ -1,59 +1,60 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { PaymentMethod } from './payment_methods';
 import type { Version } from './versions';
-import type { AdyenPayment } from './adyen_payments';
+import type { AdyenPayment, AdyenPaymentType } from './adyen_payments';
+type AdyenGatewayType = 'adyen_gateways';
 type AdyenGatewayRel = ResourceRel & {
-    type: typeof AdyenGateways.TYPE;
+    type: AdyenGatewayType;
 };
 type AdyenPaymentRel = ResourceRel & {
-    type: 'adyen_payments';
+    type: AdyenPaymentType;
 };
 interface AdyenGateway extends Resource {
-    name?: string;
-    live_url_prefix?: string;
-    async_api?: boolean;
-    webhook_endpoint_secret?: string;
-    webhook_endpoint_url?: string;
-    payment_methods?: PaymentMethod[];
-    versions?: Version[];
-    adyen_payments?: AdyenPayment[];
+    readonly type: AdyenGatewayType;
+    name: string;
+    live_url_prefix: string;
+    async_api?: boolean | null;
+    webhook_endpoint_secret?: string | null;
+    webhook_endpoint_url?: string | null;
+    payment_methods?: PaymentMethod[] | null;
+    versions?: Version[] | null;
+    adyen_payments?: AdyenPayment[] | null;
 }
 interface AdyenGatewayCreate extends ResourceCreate {
     name: string;
     merchant_account: string;
     api_key: string;
-    public_key?: string;
+    public_key?: string | null;
     live_url_prefix: string;
-    api_version?: string;
-    async_api?: boolean;
-    webhook_endpoint_secret?: string;
-    adyen_payments?: AdyenPaymentRel[];
+    api_version?: string | null;
+    async_api?: boolean | null;
+    webhook_endpoint_secret?: string | null;
+    adyen_payments?: AdyenPaymentRel[] | null;
 }
 interface AdyenGatewayUpdate extends ResourceUpdate {
-    name?: string;
-    merchant_account?: string;
-    api_key?: string;
-    public_key?: string;
-    live_url_prefix?: string;
-    api_version?: string;
-    async_api?: boolean;
-    webhook_endpoint_secret?: string;
-    adyen_payments?: AdyenPaymentRel[];
+    name?: string | null;
+    merchant_account?: string | null;
+    api_key?: string | null;
+    public_key?: string | null;
+    live_url_prefix?: string | null;
+    api_version?: string | null;
+    async_api?: boolean | null;
+    webhook_endpoint_secret?: string | null;
+    adyen_payments?: AdyenPaymentRel[] | null;
 }
-declare class AdyenGateways extends ApiResource {
-    static readonly TYPE: 'adyen_gateways';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<AdyenGateway>>;
+declare class AdyenGateways extends ApiResource<AdyenGateway> {
+    static readonly TYPE: AdyenGatewayType;
     create(resource: AdyenGatewayCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenGateway>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenGateway>;
     update(resource: AdyenGatewayUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenGateway>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     payment_methods(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
     versions(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     adyen_payments(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<AdyenPayment>>;
     isAdyenGateway(resource: any): resource is AdyenGateway;
     relationship(id: string | ResourceId | null): AdyenGatewayRel;
-    type(): string;
+    type(): AdyenGatewayType;
 }
 export default AdyenGateways;
-export { AdyenGateway, AdyenGatewayCreate, AdyenGatewayUpdate };
+export type { AdyenGateway, AdyenGatewayCreate, AdyenGatewayUpdate, AdyenGatewayType };

package/lib/cjs/resources/adyen_gateways.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class AdyenGateways extends resource_1.ApiResource {
-    // static readonly PATH = 'adyen_gateways'
-    async list(params, options) {
-        return this.resources.list({ type: AdyenGateways.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: AdyenGateways.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: AdyenGateways.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: AdyenGateways.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: AdyenGateways.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: AdyenGateways.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: AdyenGateways.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: AdyenGateways.TYPE } : id, options);
     }
     async payment_methods(adyenGatewayId, params, options) {
         const _adyenGatewayId = adyenGatewayId.id || adyenGatewayId;
@@ -30,7 +23,6 @@ class AdyenGateways extends resource_1.ApiResource {
         const _adyenGatewayId = adyenGatewayId.id || adyenGatewayId;
         return this.resources.fetch({ type: 'adyen_payments' }, `adyen_gateways/${_adyenGatewayId}/adyen_payments`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isAdyenGateway(resource) {
         return resource.type && (resource.type === AdyenGateways.TYPE);
     }

package/lib/cjs/resources/adyen_payments.d.ts

@@ -1,49 +1,51 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Order } from './orders';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order, OrderType } from './orders';
 import type { PaymentGateway } from './payment_gateways';
 import type { Version } from './versions';
+type AdyenPaymentType = 'adyen_payments';
 type AdyenPaymentRel = ResourceRel & {
-    type: typeof AdyenPayments.TYPE;
+    type: AdyenPaymentType;
 };
 type OrderRel = ResourceRel & {
-    type: 'orders';
+    type: OrderType;
 };
 interface AdyenPayment extends Resource {
-    public_key?: string;
-    payment_methods?: object;
-    payment_request_data?: object;
-    payment_request_details?: object;
-    payment_response?: object;
-    mismatched_amounts?: boolean;
-    payment_instrument?: object;
-    order?: Order;
-    payment_gateway?: PaymentGateway;
-    versions?: Version[];
+    readonly type: AdyenPaymentType;
+    public_key?: string | null;
+    payment_methods: Record<string, any>;
+    payment_request_data?: Record<string, any> | null;
+    payment_request_details?: Record<string, any> | null;
+    payment_response?: Record<string, any> | null;
+    mismatched_amounts?: boolean | null;
+    payment_instrument?: Record<string, any> | null;
+    order?: Order | null;
+    payment_gateway?: PaymentGateway | null;
+    versions?: Version[] | null;
 }
 interface AdyenPaymentCreate extends ResourceCreate {
     order: OrderRel;
 }
 interface AdyenPaymentUpdate extends ResourceUpdate {
-    payment_request_data?: object;
-    payment_request_details?: object;
-    payment_response?: object;
-    _details?: boolean;
-    order?: OrderRel;
+    payment_request_data?: Record<string, any> | null;
+    payment_request_details?: Record<string, any> | null;
+    payment_response?: Record<string, any> | null;
+    _details?: boolean | null;
+    order?: OrderRel | null;
 }
-declare class AdyenPayments extends ApiResource {
-    static readonly TYPE: 'adyen_payments';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<AdyenPayment>>;
+declare class AdyenPayments extends ApiResource<AdyenPayment> {
+    static readonly TYPE: AdyenPaymentType;
     create(resource: AdyenPaymentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenPayment>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenPayment>;
     update(resource: AdyenPaymentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenPayment>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     order(adyenPaymentId: string | AdyenPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     payment_gateway(adyenPaymentId: string | AdyenPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
     versions(adyenPaymentId: string | AdyenPayment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    _details(id: string | AdyenPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenPayment>;
     isAdyenPayment(resource: any): resource is AdyenPayment;
     relationship(id: string | ResourceId | null): AdyenPaymentRel;
-    type(): string;
+    type(): AdyenPaymentType;
 }
 export default AdyenPayments;
-export { AdyenPayment, AdyenPaymentCreate, AdyenPaymentUpdate };
+export type { AdyenPayment, AdyenPaymentCreate, AdyenPaymentUpdate, AdyenPaymentType };

package/lib/cjs/resources/adyen_payments.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class AdyenPayments extends resource_1.ApiResource {
-    // static readonly PATH = 'adyen_payments'
-    async list(params, options) {
-        return this.resources.list({ type: AdyenPayments.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: AdyenPayments.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: AdyenPayments.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: AdyenPayments.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: AdyenPayments.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: AdyenPayments.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: AdyenPayments.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: AdyenPayments.TYPE } : id, options);
     }
     async order(adyenPaymentId, params, options) {
         const _adyenPaymentId = adyenPaymentId.id || adyenPaymentId;
@@ -30,7 +23,9 @@ class AdyenPayments extends resource_1.ApiResource {
         const _adyenPaymentId = adyenPaymentId.id || adyenPaymentId;
         return this.resources.fetch({ type: 'versions' }, `adyen_payments/${_adyenPaymentId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    async _details(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: AdyenPayments.TYPE, _details: true }, params, options);
+    }
     isAdyenPayment(resource) {
         return resource.type && (resource.type === AdyenPayments.TYPE);
     }

package/lib/cjs/resources/application.d.ts

@@ -1,21 +1,22 @@
-import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel } from '../resource';
-import type { QueryParamsRetrieve } from '../query';
+import { ApiSingleton } from '../resource';
+import type { Resource, ResourceId, ResourceRel } from '../resource';
+type ApplicationType = 'application';
 type ApplicationRel = ResourceRel & {
-    type: typeof Applications.TYPE;
+    type: ApplicationType;
 };
 interface Application extends Resource {
-    name?: string;
-    kind?: string;
-    public_access?: boolean;
-    redirect_uri?: string;
-    scopes?: string;
+    readonly type: ApplicationType;
+    name?: string | null;
+    kind?: string | null;
+    public_access?: boolean | null;
+    redirect_uri?: string | null;
+    scopes?: string | null;
 }
-declare class Applications extends ApiResource {
-    static readonly TYPE: 'application';
-    retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Application>;
+declare class Applications extends ApiSingleton<Application> {
+    static readonly TYPE: ApplicationType;
     isApplication(resource: any): resource is Application;
     relationship(id: string | ResourceId | null): ApplicationRel;
-    type(): string;
+    type(): ApplicationType;
 }
 export default Applications;
-export { Application };
+export type { Application, ApplicationType };

package/lib/cjs/resources/application.js

@@ -1,12 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
-class Applications extends resource_1.ApiResource {
-    // static readonly PATH = 'application'
-    async retrieve(params, options) {
-        return this.resources.singleton({ type: Applications.TYPE }, params, options);
-    }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+class Applications extends resource_1.ApiSingleton {
     isApplication(resource) {
         return resource.type && (resource.type === Applications.TYPE);
     }

package/lib/cjs/resources/attachments.d.ts

@@ -1,156 +1,157 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Bundle } from './bundles';
-import type { CarrierAccount } from './carrier_accounts';
-import type { CustomerGroup } from './customer_groups';
-import type { Customer } from './customers';
-import type { DeliveryLeadTime } from './delivery_lead_times';
-import type { Geocoder } from './geocoders';
-import type { GiftCardRecipient } from './gift_card_recipients';
-import type { GiftCard } from './gift_cards';
-import type { InventoryModel } from './inventory_models';
-import type { Market } from './markets';
-import type { Merchant } from './merchants';
-import type { BillingInfoValidationRule } from './billing_info_validation_rules';
-import type { Order } from './orders';
-import type { Package } from './packages';
-import type { Parcel } from './parcels';
-import type { PaymentMethod } from './payment_methods';
-import type { PriceList } from './price_lists';
-import type { Price } from './prices';
-import type { Promotion } from './promotions';
-import type { Return } from './returns';
-import type { Shipment } from './shipments';
-import type { ShippingCategory } from './shipping_categories';
-import type { ShippingMethod } from './shipping_methods';
-import type { ShippingZone } from './shipping_zones';
-import type { SkuOption } from './sku_options';
-import type { Sku } from './skus';
-import type { StockItem } from './stock_items';
-import type { StockLocation } from './stock_locations';
-import type { TaxCalculator } from './tax_calculators';
-import type { TaxCategory } from './tax_categories';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
+import type { QueryParamsRetrieve } from '../query';
+import type { Bundle, BundleType } from './bundles';
+import type { CarrierAccount, CarrierAccountType } from './carrier_accounts';
+import type { CustomerGroup, CustomerGroupType } from './customer_groups';
+import type { Customer, CustomerType } from './customers';
+import type { DeliveryLeadTime, DeliveryLeadTimeType } from './delivery_lead_times';
+import type { Geocoder, GeocoderType } from './geocoders';
+import type { GiftCardRecipient, GiftCardRecipientType } from './gift_card_recipients';
+import type { GiftCard, GiftCardType } from './gift_cards';
+import type { InventoryModel, InventoryModelType } from './inventory_models';
+import type { Market, MarketType } from './markets';
+import type { Merchant, MerchantType } from './merchants';
+import type { BillingInfoValidationRule, BillingInfoValidationRuleType } from './billing_info_validation_rules';
+import type { Order, OrderType } from './orders';
+import type { Package, PackageType } from './packages';
+import type { Parcel, ParcelType } from './parcels';
+import type { PaymentMethod, PaymentMethodType } from './payment_methods';
+import type { PriceList, PriceListType } from './price_lists';
+import type { Price, PriceType } from './prices';
+import type { Promotion, PromotionType } from './promotions';
+import type { Return, ReturnType } from './returns';
+import type { Shipment, ShipmentType } from './shipments';
+import type { ShippingCategory, ShippingCategoryType } from './shipping_categories';
+import type { ShippingMethod, ShippingMethodType } from './shipping_methods';
+import type { ShippingZone, ShippingZoneType } from './shipping_zones';
+import type { SkuOption, SkuOptionType } from './sku_options';
+import type { Sku, SkuType } from './skus';
+import type { StockItem, StockItemType } from './stock_items';
+import type { StockLocation, StockLocationType } from './stock_locations';
+import type { TaxCalculator, TaxCalculatorType } from './tax_calculators';
+import type { TaxCategory, TaxCategoryType } from './tax_categories';
+type AttachmentType = 'attachments';
 type AttachmentRel = ResourceRel & {
-    type: typeof Attachments.TYPE;
+    type: AttachmentType;
 };
 type BundleRel = ResourceRel & {
-    type: 'bundles';
+    type: BundleType;
 };
 type CarrierAccountRel = ResourceRel & {
-    type: 'carrier_accounts';
+    type: CarrierAccountType;
 };
 type CustomerGroupRel = ResourceRel & {
-    type: 'customer_groups';
+    type: CustomerGroupType;
 };
 type CustomerRel = ResourceRel & {
-    type: 'customers';
+    type: CustomerType;
 };
 type DeliveryLeadTimeRel = ResourceRel & {
-    type: 'delivery_lead_times';
+    type: DeliveryLeadTimeType;
 };
 type GeocoderRel = ResourceRel & {
-    type: 'geocoders';
+    type: GeocoderType;
 };
 type GiftCardRecipientRel = ResourceRel & {
-    type: 'gift_card_recipients';
+    type: GiftCardRecipientType;
 };
 type GiftCardRel = ResourceRel & {
-    type: 'gift_cards';
+    type: GiftCardType;
 };
 type InventoryModelRel = ResourceRel & {
-    type: 'inventory_models';
+    type: InventoryModelType;
 };
 type MarketRel = ResourceRel & {
-    type: 'markets';
+    type: MarketType;
 };
 type MerchantRel = ResourceRel & {
-    type: 'merchants';
+    type: MerchantType;
 };
 type BillingInfoValidationRuleRel = ResourceRel & {
-    type: 'billing_info_validation_rules';
+    type: BillingInfoValidationRuleType;
 };
 type OrderRel = ResourceRel & {
-    type: 'orders';
+    type: OrderType;
 };
 type PackageRel = ResourceRel & {
-    type: 'packages';
+    type: PackageType;
 };
 type ParcelRel = ResourceRel & {
-    type: 'parcels';
+    type: ParcelType;
 };
 type PaymentMethodRel = ResourceRel & {
-    type: 'payment_methods';
+    type: PaymentMethodType;
 };
 type PriceListRel = ResourceRel & {
-    type: 'price_lists';
+    type: PriceListType;
 };
 type PriceRel = ResourceRel & {
-    type: 'prices';
+    type: PriceType;
 };
 type PromotionRel = ResourceRel & {
-    type: 'promotions';
+    type: PromotionType;
 };
 type ReturnRel = ResourceRel & {
-    type: 'returns';
+    type: ReturnType;
 };
 type ShipmentRel = ResourceRel & {
-    type: 'shipments';
+    type: ShipmentType;
 };
 type ShippingCategoryRel = ResourceRel & {
-    type: 'shipping_categories';
+    type: ShippingCategoryType;
 };
 type ShippingMethodRel = ResourceRel & {
-    type: 'shipping_methods';
+    type: ShippingMethodType;
 };
 type ShippingZoneRel = ResourceRel & {
-    type: 'shipping_zones';
+    type: ShippingZoneType;
 };
 type SkuOptionRel = ResourceRel & {
-    type: 'sku_options';
+    type: SkuOptionType;
 };
 type SkuRel = ResourceRel & {
-    type: 'skus';
+    type: SkuType;
 };
 type StockItemRel = ResourceRel & {
-    type: 'stock_items';
+    type: StockItemType;
 };
 type StockLocationRel = ResourceRel & {
-    type: 'stock_locations';
+    type: StockLocationType;
 };
 type TaxCalculatorRel = ResourceRel & {
-    type: 'tax_calculators';
+    type: TaxCalculatorType;
 };
 type TaxCategoryRel = ResourceRel & {
-    type: 'tax_categories';
+    type: TaxCategoryType;
 };
 interface Attachment extends Resource {
-    name?: string;
-    description?: string;
-    url?: string;
-    attachable?: Bundle | CarrierAccount | CustomerGroup | Customer | DeliveryLeadTime | Geocoder | GiftCardRecipient | GiftCard | InventoryModel | Market | Merchant | BillingInfoValidationRule | Order | Package | Parcel | PaymentMethod | PriceList | Price | Promotion | Return | Shipment | ShippingCategory | ShippingMethod | ShippingZone | SkuOption | Sku | StockItem | StockLocation | TaxCalculator | TaxCategory;
+    readonly type: AttachmentType;
+    name: string;
+    description?: string | null;
+    url?: string | null;
+    attachable?: Bundle | CarrierAccount | CustomerGroup | Customer | DeliveryLeadTime | Geocoder | GiftCardRecipient | GiftCard | InventoryModel | Market | Merchant | BillingInfoValidationRule | Order | Package | Parcel | PaymentMethod | PriceList | Price | Promotion | Return | Shipment | ShippingCategory | ShippingMethod | ShippingZone | SkuOption | Sku | StockItem | StockLocation | TaxCalculator | TaxCategory | null;
 }
 interface AttachmentCreate extends ResourceCreate {
     name: string;
-    description?: string;
-    url?: string;
+    description?: string | null;
+    url?: string | null;
     attachable: BundleRel | CarrierAccountRel | CustomerGroupRel | CustomerRel | DeliveryLeadTimeRel | GeocoderRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel | MarketRel | MerchantRel | BillingInfoValidationRuleRel | OrderRel | PackageRel | ParcelRel | PaymentMethodRel | PriceListRel | PriceRel | PromotionRel | ReturnRel | ShipmentRel | ShippingCategoryRel | ShippingMethodRel | ShippingZoneRel | SkuOptionRel | SkuRel | StockItemRel | StockLocationRel | TaxCalculatorRel | TaxCategoryRel;
 }
 interface AttachmentUpdate extends ResourceUpdate {
-    name?: string;
-    description?: string;
-    url?: string;
-    attachable?: BundleRel | CarrierAccountRel | CustomerGroupRel | CustomerRel | DeliveryLeadTimeRel | GeocoderRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel | MarketRel | MerchantRel | BillingInfoValidationRuleRel | OrderRel | PackageRel | ParcelRel | PaymentMethodRel | PriceListRel | PriceRel | PromotionRel | ReturnRel | ShipmentRel | ShippingCategoryRel | ShippingMethodRel | ShippingZoneRel | SkuOptionRel | SkuRel | StockItemRel | StockLocationRel | TaxCalculatorRel | TaxCategoryRel;
+    name?: string | null;
+    description?: string | null;
+    url?: string | null;
+    attachable?: BundleRel | CarrierAccountRel | CustomerGroupRel | CustomerRel | DeliveryLeadTimeRel | GeocoderRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel | MarketRel | MerchantRel | BillingInfoValidationRuleRel | OrderRel | PackageRel | ParcelRel | PaymentMethodRel | PriceListRel | PriceRel | PromotionRel | ReturnRel | ShipmentRel | ShippingCategoryRel | ShippingMethodRel | ShippingZoneRel | SkuOptionRel | SkuRel | StockItemRel | StockLocationRel | TaxCalculatorRel | TaxCategoryRel | null;
 }
-declare class Attachments extends ApiResource {
-    static readonly TYPE: 'attachments';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+declare class Attachments extends ApiResource<Attachment> {
+    static readonly TYPE: AttachmentType;
     create(resource: AttachmentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Attachment>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Attachment>;
     update(resource: AttachmentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Attachment>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     isAttachment(resource: any): resource is Attachment;
     relationship(id: string | ResourceId | null): AttachmentRel;
-    type(): string;
+    type(): AttachmentType;
 }
 export default Attachments;
-export { Attachment, AttachmentCreate, AttachmentUpdate };
+export type { Attachment, AttachmentCreate, AttachmentUpdate, AttachmentType };

package/lib/cjs/resources/attachments.js

@@ -2,23 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Attachments extends resource_1.ApiResource {
-    // static readonly PATH = 'attachments'
-    async list(params, options) {
-        return this.resources.list({ type: Attachments.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Attachments.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Attachments.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: Attachments.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Attachments.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Attachments.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: Attachments.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: Attachments.TYPE } : id, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isAttachment(resource) {
         return resource.type && (resource.type === Attachments.TYPE);
     }