@commercelayer/sdk 5.0.0-beta.2 → 5.0.0-beta.21

package/lib/esm/api.js

@@ -63,6 +63,8 @@ export { default as Markets } from './resources/markets';
 export { default as Merchants } from './resources/merchants';
 export { default as OrderAmountPromotionRules } from './resources/order_amount_promotion_rules';
 export { default as OrderCopies } from './resources/order_copies';
+export { default as OrderFactories } from './resources/order_factories';
+export { default as OrderSubscriptionItems } from './resources/order_subscription_items';
 export { default as OrderSubscriptions } from './resources/order_subscriptions';
 export { default as OrderValidationRules } from './resources/order_validation_rules';
 export { default as Orders } from './resources/orders';
@@ -75,12 +77,14 @@ export { default as PaymentMethods } from './resources/payment_methods';
 export { default as PaypalGateways } from './resources/paypal_gateways';
 export { default as PaypalPayments } from './resources/paypal_payments';
 export { default as PercentageDiscountPromotions } from './resources/percentage_discount_promotions';
+export { default as PriceFrequencyTiers } from './resources/price_frequency_tiers';
 export { default as PriceLists } from './resources/price_lists';
 export { default as PriceTiers } from './resources/price_tiers';
 export { default as PriceVolumeTiers } from './resources/price_volume_tiers';
 export { default as Prices } from './resources/prices';
 export { default as PromotionRules } from './resources/promotion_rules';
 export { default as Promotions } from './resources/promotions';
+export { default as RecurringOrderCopies } from './resources/recurring_order_copies';
 export { default as Refunds } from './resources/refunds';
 export { default as ReturnLineItems } from './resources/return_line_items';
 export { default as Returns } from './resources/returns';
@@ -103,6 +107,7 @@ export { default as StockLocations } from './resources/stock_locations';
 export { default as StockTransfers } from './resources/stock_transfers';
 export { default as StripeGateways } from './resources/stripe_gateways';
 export { default as StripePayments } from './resources/stripe_payments';
+export { default as SubscriptionModels } from './resources/subscription_models';
 export { default as TaxCalculators } from './resources/tax_calculators';
 export { default as TaxCategories } from './resources/tax_categories';
 export { default as TaxRules } from './resources/tax_rules';
@@ -174,6 +179,8 @@ export const resourceList = [
     'merchants',
     'order_amount_promotion_rules',
     'order_copies',
+    'order_factories',
+    'order_subscription_items',
     'order_subscriptions',
     'order_validation_rules',
     'orders',
@@ -186,12 +193,14 @@ export const resourceList = [
     'paypal_gateways',
     'paypal_payments',
     'percentage_discount_promotions',
+    'price_frequency_tiers',
     'price_lists',
     'price_tiers',
     'price_volume_tiers',
     'prices',
     'promotion_rules',
     'promotions',
+    'recurring_order_copies',
     'refunds',
     'return_line_items',
     'returns',
@@ -214,6 +223,7 @@ export const resourceList = [
     'stock_transfers',
     'stripe_gateways',
     'stripe_payments',
+    'subscription_models',
     'tax_calculators',
     'tax_categories',
     'tax_rules',
@@ -224,16 +234,3 @@ export const resourceList = [
     'wire_transfers'
     // ##__API_RESOURCE_LIST_STOP__##
 ];
-/*
-type ResourceInfo = {
-    name: string;
-    type: string;
-    api: string;
-}
-
-
-export const resourceMap: { [res: string]: ResourceInfo } = {
-    // ##__API_RESOURCE_MAP_START__##
-    // ##__API_RESOURCE_MAP_STOP__##
-} as const
-*/ 

package/lib/esm/client.d.ts

@@ -1,15 +1,13 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { AxiosProxyConfig, Method } from 'axios';
+import { type AxiosProxyConfig, type Method } from 'axios';
 import type { InterceptorManager } from './interceptor';
 import type { Agent as HttpAgent } from 'http';
 import type { Agent as HttpsAgent } from 'https';
 type ProxyConfig = AxiosProxyConfig | false;
 type RequestConfig = {
     timeout?: number;
-    params?: {
-        [key: string]: string | number | boolean;
-    };
+    params?: Record<string, string | number | boolean>;
     httpAgent?: HttpAgent;
     httpsAgent?: HttpsAgent;
     proxy?: ProxyConfig;
@@ -30,4 +28,4 @@ declare class ApiClient {
     request(method: Method, path: string, body?: any, options?: ApiClientConfig): Promise<any>;
 }
 export default ApiClient;
-export { ApiClientInitConfig, ApiClientConfig, RequestConfig };
+export type { ApiClientInitConfig, ApiClientConfig, RequestConfig };

package/lib/esm/client.js

@@ -49,10 +49,9 @@ const handleError = (error) => {
 };
 class ApiClient {
     static create(options) {
-        if (!(options === null || options === void 0 ? void 0 : options.organization))
-            throw new Error("Undefined 'organization' parameter");
-        if (!(options === null || options === void 0 ? void 0 : options.accessToken))
-            throw new Error("Undefined 'accessToken' parameter");
+        for (const attr of config.client.requiredAttributes)
+            if (!options || !options[attr])
+                throw new SdkError({ message: `Undefined '${attr}' parameter` });
         return new ApiClient(options);
     }
     constructor(options) {
@@ -67,11 +66,16 @@ class ApiClient {
             httpAgent: options.httpAgent,
             httpsAgent: options.httpsAgent,
         };
-        const axiosOptions = Object.assign({ baseURL: this.baseUrl, timeout: config.client.timeout, headers: {
+        const axiosOptions = {
+            baseURL: this.baseUrl,
+            timeout: config.client.timeout,
+            headers: {
                 'Accept': 'application/vnd.api+json',
                 'Content-Type': 'application/vnd.api+json',
                 'Authorization': 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f"),
-            } }, axiosConfig);
+            },
+            ...axiosConfig
+        };
         debug('axios options: %O', axiosOptions);
         __classPrivateFieldSet(this, _ApiClient_client, axios.create(axiosOptions), "f");
         this.interceptors = __classPrivateFieldGet(this, _ApiClient_client, "f").interceptors;
@@ -104,7 +108,7 @@ class ApiClient {
         const baseUrl = (options === null || options === void 0 ? void 0 : options.organization) ? baseURL(options.organization, options.domain) : undefined;
         const accessToken = (options === null || options === void 0 ? void 0 : options.accessToken) || __classPrivateFieldGet(this, _ApiClient_accessToken, "f");
         const headers = accessToken ? { 'Authorization': 'Bearer ' + accessToken } : undefined;
-        const requestParams = Object.assign({ method, baseURL: baseUrl, url, data, headers }, options);
+        const requestParams = { method, baseURL: baseUrl, url, data, headers, ...options };
         debug('request params: %O', requestParams);
         // const start = Date.now()
         return __classPrivateFieldGet(this, _ApiClient_client, "f").request(requestParams)

package/lib/esm/commercelayer.d.ts

@@ -1,16 +1,16 @@
 import * as api from './api';
-import { ApiError } from './error';
+import type { ApiError } from './error';
 import type { ErrorInterceptor, InterceptorType, RawResponseReader, RequestInterceptor, ResponseInterceptor } from './interceptor';
-import { ResourcesInitConfig } from './resource';
-declare const OPEN_API_SCHEMA_VERSION = "4.0.0";
+import { type ResourcesInitConfig } from './resource';
+declare const OPEN_API_SCHEMA_VERSION = "4.1.3";
 export { OPEN_API_SCHEMA_VERSION };
-type SdkConfig = {};
+type SdkConfig = Record<string, unknown>;
 type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
 type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
 declare class CommerceLayerClient {
     #private;
     static get openApiSchemaVersion(): string;
-    readonly openApiSchemaVersion = "4.0.0";
+    readonly openApiSchemaVersion = "4.1.3";
     addresses: api.Addresses;
     adjustments: api.Adjustments;
     adyen_gateways: api.AdyenGateways;
@@ -71,6 +71,8 @@ declare class CommerceLayerClient {
     merchants: api.Merchants;
     order_amount_promotion_rules: api.OrderAmountPromotionRules;
     order_copies: api.OrderCopies;
+    order_factories: api.OrderFactories;
+    order_subscription_items: api.OrderSubscriptionItems;
     order_subscriptions: api.OrderSubscriptions;
     order_validation_rules: api.OrderValidationRules;
     orders: api.Orders;
@@ -83,12 +85,14 @@ declare class CommerceLayerClient {
     paypal_gateways: api.PaypalGateways;
     paypal_payments: api.PaypalPayments;
     percentage_discount_promotions: api.PercentageDiscountPromotions;
+    price_frequency_tiers: api.PriceFrequencyTiers;
     price_lists: api.PriceLists;
     price_tiers: api.PriceTiers;
     price_volume_tiers: api.PriceVolumeTiers;
     prices: api.Prices;
     promotion_rules: api.PromotionRules;
     promotions: api.Promotions;
+    recurring_order_copies: api.RecurringOrderCopies;
     refunds: api.Refunds;
     return_line_items: api.ReturnLineItems;
     returns: api.Returns;
@@ -111,6 +115,7 @@ declare class CommerceLayerClient {
     stock_transfers: api.StockTransfers;
     stripe_gateways: api.StripeGateways;
     stripe_payments: api.StripePayments;
+    subscription_models: api.SubscriptionModels;
     tax_calculators: api.TaxCalculators;
     tax_categories: api.TaxCategories;
     tax_rules: api.TaxRules;

package/lib/esm/commercelayer.js

@@ -16,7 +16,7 @@ import ResourceAdapter from './resource';
 import Debug from './debug';
 const debug = Debug('commercelayer');
 // Autogenerated schema version number, do not remove this line
-const OPEN_API_SCHEMA_VERSION = '4.0.0';
+const OPEN_API_SCHEMA_VERSION = '4.1.3';
 export { OPEN_API_SCHEMA_VERSION };
 class CommerceLayerClient {
     static get openApiSchemaVersion() { return OPEN_API_SCHEMA_VERSION; }
@@ -90,6 +90,8 @@ class CommerceLayerClient {
         this.merchants = new api.Merchants(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.order_amount_promotion_rules = new api.OrderAmountPromotionRules(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.order_copies = new api.OrderCopies(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
+        this.order_factories = new api.OrderFactories(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
+        this.order_subscription_items = new api.OrderSubscriptionItems(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.order_subscriptions = new api.OrderSubscriptions(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.order_validation_rules = new api.OrderValidationRules(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.orders = new api.Orders(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
@@ -102,12 +104,14 @@ class CommerceLayerClient {
         this.paypal_gateways = new api.PaypalGateways(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.paypal_payments = new api.PaypalPayments(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.percentage_discount_promotions = new api.PercentageDiscountPromotions(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
+        this.price_frequency_tiers = new api.PriceFrequencyTiers(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.price_lists = new api.PriceLists(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.price_tiers = new api.PriceTiers(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.price_volume_tiers = new api.PriceVolumeTiers(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.prices = new api.Prices(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.promotion_rules = new api.PromotionRules(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.promotions = new api.Promotions(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
+        this.recurring_order_copies = new api.RecurringOrderCopies(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.refunds = new api.Refunds(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.return_line_items = new api.ReturnLineItems(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.returns = new api.Returns(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
@@ -130,6 +134,7 @@ class CommerceLayerClient {
         this.stock_transfers = new api.StockTransfers(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.stripe_gateways = new api.StripeGateways(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.stripe_payments = new api.StripePayments(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
+        this.subscription_models = new api.SubscriptionModels(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.tax_calculators = new api.TaxCalculators(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.tax_categories = new api.TaxCategories(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
         this.tax_rules = new api.TaxRules(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
@@ -169,7 +174,7 @@ class CommerceLayerClient {
         return __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").interceptors.response.use(onFulfilled, onRejected);
     }
     removeInterceptor(type, id) {
-        return __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").interceptors[type].eject(id);
+        __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").interceptors[type].eject(id);
     }
     addRawResponseReader(options) {
         const reader = {
@@ -190,7 +195,7 @@ class CommerceLayerClient {
     removeRawResponseReader(reader) {
         const id = (typeof reader === 'number') ? reader : reader === null || reader === void 0 ? void 0 : reader.id;
         if (id && (id >= 0))
-            return this.removeInterceptor('response', id);
+            this.removeInterceptor('response', id);
     }
 }
 _CommerceLayerClient_adapter = new WeakMap(), _CommerceLayerClient_organization = new WeakMap();

package/lib/esm/common.d.ts

@@ -2,3 +2,4 @@ import type { ResourceId, ResourceType } from './resource';
 declare const isResourceId: (resource: any) => resource is ResourceId;
 declare const isResourceType: (resource: any) => resource is ResourceType;
 export { isResourceId, isResourceType };
+export type ObjectType = Record<string, any>;

package/lib/esm/common.js

@@ -6,3 +6,14 @@ const isResourceType = (resource) => {
     return resource && (typeof resource.type !== 'undefined') && resource.type && resourceList.includes(resource.type);
 };
 export { isResourceId, isResourceType };
+/*
+// Nullable types
+type StringNullable = string | null
+type NumberNullable = number | null
+type BooleanNullable = boolean | null
+type ResourceNullable<R extends Resource> = R | null
+type ResourceArrayNullable<R extends Resource> = R[] | null
+
+
+export type { StringNullable, NumberNullable, BooleanNullable, ResourceNullable, ResourceArrayNullable }
+*/

package/lib/esm/config.d.ts

@@ -6,6 +6,7 @@ declare const config: {
     };
     readonly client: {
         readonly timeout: 15000;
+        readonly requiredAttributes: readonly ["organization", "accessToken"];
     };
 };
 export default config;

package/lib/esm/config.js

@@ -6,6 +6,7 @@ const config = {
     },
     client: {
         timeout: 15000,
+        requiredAttributes: ['organization', 'accessToken']
     }
 };
 export default config;

package/lib/esm/debug.js

@@ -5,7 +5,6 @@ const debuggerFunction = (_pattern, ..._args) => {
 let debuggerFactory = (_namespace) => debuggerFunction;
 /* Try loading 'debug' module */
 try {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     const debugModule = require('debug');
     if (debugModule && (typeof debugModule === 'function'))
         debuggerFactory = debugModule;

package/lib/esm/error.js

@@ -7,7 +7,6 @@ var ErrorType;
     ErrorType["CANCEL"] = "cancel";
 })(ErrorType || (ErrorType = {}));
 class SdkError extends Error {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     static isSdkError(error) {
         return error && [SdkError.NAME, ApiError.NAME].includes(error.name) && Object.values(ErrorType).includes(error.type);
     }
@@ -19,12 +18,11 @@ class SdkError extends Error {
 }
 SdkError.NAME = 'SdkError';
 class ApiError extends SdkError {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     static isApiError(error) {
         return SdkError.isSdkError(error) && (error.name === ApiError.NAME) && (error.type === ErrorType.RESPONSE);
     }
     constructor(error) {
-        super(Object.assign(Object.assign({}, error), { type: ErrorType.RESPONSE }));
+        super({ ...error, type: ErrorType.RESPONSE });
         this.errors = [];
         this.name = ApiError.NAME; // this.constructor.name
     }

package/lib/esm/index.d.ts

@@ -2,6 +2,6 @@ export { default, CommerceLayer } from './commercelayer';
 export type { CommerceLayerClient } from './commercelayer';
 export { CommerceLayerStatic } from './static';
 export type { QueryParamsRetrieve, QueryParamsList, QueryParams } from './query';
-export * from './model';
+export type * from './model';
 export type { RequestObj, ResponseObj, ErrorObj, HeadersObj } from './interceptor';
 export type { SdkError, ApiError, ErrorType } from './error';

package/lib/esm/index.js

@@ -2,5 +2,3 @@
 export { default, CommerceLayer } from './commercelayer';
 // Commerce Layer static functions
 export { CommerceLayerStatic } from './static';
-// Resource model types
-export * from './model';

package/lib/esm/interceptor.d.ts

@@ -1,4 +1,4 @@
-import { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders } from 'axios';
+import type { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders } from 'axios';
 type InterceptorManager = {
     request: AxiosInterceptorManager<AxiosRequestConfig>;
     response: AxiosInterceptorManager<any>;

package/lib/esm/jsonapi.js

@@ -28,7 +28,11 @@ const denormalizeResource = (res, included) => {
     debug('denormalize resource: %O, %o', res, included || {});
     if (!res)
         return res;
-    const resource = Object.assign({ id: res.id, type: res.type }, res.attributes);
+    const resource = {
+        id: res.id,
+        type: res.type,
+        ...res.attributes,
+    };
     if (res.relationships)
         Object.keys(res.relationships).forEach(key => {
             const rel = res.relationships[key].data;

package/lib/esm/model.d.ts

@@ -60,7 +60,9 @@ export type { ManualTaxCalculator, ManualTaxCalculatorCreate, ManualTaxCalculato
 export type { Market, MarketCreate, MarketUpdate } from './resources/markets';
 export type { Merchant, MerchantCreate, MerchantUpdate } from './resources/merchants';
 export type { OrderAmountPromotionRule, OrderAmountPromotionRuleCreate, OrderAmountPromotionRuleUpdate } from './resources/order_amount_promotion_rules';
-export type { OrderCopy, OrderCopyCreate } from './resources/order_copies';
+export type { OrderCopy, OrderCopyCreate, OrderCopyUpdate } from './resources/order_copies';
+export type { OrderFactory } from './resources/order_factories';
+export type { OrderSubscriptionItem, OrderSubscriptionItemCreate, OrderSubscriptionItemUpdate } from './resources/order_subscription_items';
 export type { OrderSubscription, OrderSubscriptionCreate, OrderSubscriptionUpdate } from './resources/order_subscriptions';
 export type { OrderValidationRule } from './resources/order_validation_rules';
 export type { Order, OrderCreate, OrderUpdate } from './resources/orders';
@@ -73,12 +75,14 @@ export type { PaymentMethod, PaymentMethodCreate, PaymentMethodUpdate } from './
 export type { PaypalGateway, PaypalGatewayCreate, PaypalGatewayUpdate } from './resources/paypal_gateways';
 export type { PaypalPayment, PaypalPaymentCreate, PaypalPaymentUpdate } from './resources/paypal_payments';
 export type { PercentageDiscountPromotion, PercentageDiscountPromotionCreate, PercentageDiscountPromotionUpdate } from './resources/percentage_discount_promotions';
+export type { PriceFrequencyTier, PriceFrequencyTierCreate, PriceFrequencyTierUpdate } from './resources/price_frequency_tiers';
 export type { PriceList, PriceListCreate, PriceListUpdate } from './resources/price_lists';
 export type { PriceTier } from './resources/price_tiers';
 export type { PriceVolumeTier, PriceVolumeTierCreate, PriceVolumeTierUpdate } from './resources/price_volume_tiers';
 export type { Price, PriceCreate, PriceUpdate } from './resources/prices';
 export type { PromotionRule } from './resources/promotion_rules';
 export type { Promotion } from './resources/promotions';
+export type { RecurringOrderCopy, RecurringOrderCopyCreate, RecurringOrderCopyUpdate } from './resources/recurring_order_copies';
 export type { Refund } from './resources/refunds';
 export type { ReturnLineItem, ReturnLineItemCreate, ReturnLineItemUpdate } from './resources/return_line_items';
 export type { Return, ReturnCreate, ReturnUpdate } from './resources/returns';
@@ -101,6 +105,7 @@ export type { StockLocation, StockLocationCreate, StockLocationUpdate } from './
 export type { StockTransfer, StockTransferCreate, StockTransferUpdate } from './resources/stock_transfers';
 export type { StripeGateway, StripeGatewayCreate, StripeGatewayUpdate } from './resources/stripe_gateways';
 export type { StripePayment, StripePaymentCreate, StripePaymentUpdate } from './resources/stripe_payments';
+export type { SubscriptionModel, SubscriptionModelCreate, SubscriptionModelUpdate } from './resources/subscription_models';
 export type { TaxCalculator } from './resources/tax_calculators';
 export type { TaxCategory, TaxCategoryCreate, TaxCategoryUpdate } from './resources/tax_categories';
 export type { TaxRule, TaxRuleCreate, TaxRuleUpdate } from './resources/tax_rules';

package/lib/esm/query.d.ts

@@ -1,24 +1,17 @@
-import { ResourceType } from "./resource";
-type QueryFilter = {
-    [key: string]: string | number | boolean;
-};
+import type { ResourceType } from "./resource";
+type QueryFilter = Record<string, string | number | boolean>;
 interface QueryParamsRetrieve {
     include?: string[];
-    fields?: string[] | {
-        [key: string]: string[];
-    };
+    fields?: string[] | Record<string, string[]>;
 }
 interface QueryParamsList extends QueryParamsRetrieve {
-    sort?: string[] | {
-        [key: string]: 'asc' | 'desc';
-    };
+    sort?: string[] | Record<string, 'asc' | 'desc'>;
     filters?: QueryFilter;
     pageNumber?: number;
     pageSize?: number;
 }
 type QueryParams = QueryParamsRetrieve | QueryParamsList;
-export { QueryParamsRetrieve, QueryParamsList, QueryParams, QueryFilter };
-declare const generateQueryStringParams: (params: QueryParamsRetrieve | QueryParamsList | undefined, res: string | ResourceType) => {
-    [key: string]: string;
-};
-export { generateQueryStringParams };
+export type { QueryParamsRetrieve, QueryParamsList, QueryParams, QueryFilter };
+declare const isParamsList: (params: any) => params is QueryParamsList;
+declare const generateQueryStringParams: (params: QueryParamsRetrieve | QueryParamsList | undefined, res: string | ResourceType) => Record<string, string>;
+export { generateQueryStringParams, isParamsList };

package/lib/esm/query.js

@@ -1,7 +1,7 @@
 import Debug from './debug';
 const debug = Debug('query');
 const isParamsList = (params) => {
-    return (params.filters || params.pageNumber || params.pageSize || params.sort);
+    return params && (params.filters || params.pageNumber || params.pageSize || params.sort);
 };
 const generateQueryStringParams = (params, res) => {
     debug('generate query string params: %O, %O', params, res);
@@ -42,4 +42,4 @@ const generateQueryStringParams = (params, res) => {
     debug('query string params: %O', qp);
     return qp;
 };
-export { generateQueryStringParams };
+export { generateQueryStringParams, isParamsList };

package/lib/esm/resource.d.ts

@@ -1,38 +1,31 @@
-import { ApiClientInitConfig } from './client';
-import { QueryParamsRetrieve, QueryParamsList, QueryFilter } from './query';
-import { ResourceTypeLock } from './api';
-import { InterceptorManager } from './interceptor';
-import { QueryParams } from '.';
+import { type ApiClientInitConfig } from './client';
+import type { QueryParamsRetrieve, QueryParamsList, QueryFilter, QueryParams } from './query';
+import type { ResourceTypeLock } from './api';
+import type { InterceptorManager } from './interceptor';
 type ResourceNull = {
     id: null;
 } & ResourceType;
 type ResourceRel = ResourceId | ResourceNull;
-type Metadata = {
-    [key: string]: any;
-};
+type Metadata = Record<string, any>;
 interface ResourceType {
     readonly type: ResourceTypeLock;
 }
 interface ResourceId extends ResourceType {
     readonly id: string;
 }
-interface Resource extends ResourceId {
-    reference?: string;
-    reference_origin?: string;
+interface ResourceBase {
+    reference?: string | null;
+    reference_origin?: string | null;
     metadata?: Metadata;
+}
+interface Resource extends ResourceBase, ResourceId {
     readonly created_at: string;
     readonly updated_at: string;
 }
-interface ResourceCreate {
-    reference?: string;
-    reference_origin?: string;
-    metadata?: Metadata;
+interface ResourceCreate extends ResourceBase {
 }
-interface ResourceUpdate {
+interface ResourceUpdate extends ResourceBase {
     readonly id: string;
-    reference?: string;
-    reference_origin?: string;
-    metadata?: Metadata;
 }
 type ListMeta = {
     readonly pageCount: number;
@@ -73,18 +66,20 @@ declare class ResourceAdapter {
 }
 declare abstract class ApiResourceBase<R extends Resource> {
     static readonly TYPE: ResourceTypeLock;
-    protected resources: ResourceAdapter;
+    protected readonly resources: ResourceAdapter;
     constructor(adapter: ResourceAdapter);
     abstract relationship(id: string | ResourceId | null): ResourceRel;
     abstract type(): ResourceTypeLock;
     update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
-    count(filter?: QueryFilter, options?: ResourcesConfig): Promise<number>;
+    count(filter?: QueryFilter | QueryParamsList, options?: ResourcesConfig): Promise<number>;
 }
 declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R> {
     retrieve(id: string | ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
 }
 declare abstract class ApiSingleton<R extends Resource> extends ApiResourceBase<R> {
     retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
 }
 export default ResourceAdapter;
-export { ApiResource, ApiSingleton, ResourcesConfig, ResourcesInitConfig };
+export { ApiResource, ApiSingleton };
+export type { ResourcesConfig, ResourcesInitConfig };

package/lib/esm/resource.js

@@ -12,7 +12,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _ResourceAdapter_client, _ResourceAdapter_config;
 import ApiClient from './client';
 import { denormalize, normalize } from './jsonapi';
-import { generateQueryStringParams } from './query';
+import { generateQueryStringParams, isParamsList } from './query';
 import config from './config';
 import Debug from './debug';
 const debug = Debug('resource');
@@ -55,7 +55,7 @@ class ResourceAdapter {
         const queryParams = generateQueryStringParams(params, resource);
         if (options === null || options === void 0 ? void 0 : options.params)
             Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
-        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, { ...options, params: queryParams });
         const r = denormalize(res);
         return r;
     }
@@ -64,7 +64,7 @@ class ResourceAdapter {
         const queryParams = generateQueryStringParams(params, resource);
         if (options === null || options === void 0 ? void 0 : options.params)
             Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
-        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}/${resource.id}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}/${resource.id}`, undefined, { ...options, params: queryParams });
         const r = denormalize(res);
         return r;
     }
@@ -74,7 +74,7 @@ class ResourceAdapter {
         const queryParams = generateQueryStringParams(params, resource);
         if (options === null || options === void 0 ? void 0 : options.params)
             Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
-        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, { ...options, params: queryParams });
         const r = denormalize(res);
         const meta = {
             pageCount: Number((_a = res.meta) === null || _a === void 0 ? void 0 : _a.page_count),
@@ -90,7 +90,7 @@ class ResourceAdapter {
         if (options === null || options === void 0 ? void 0 : options.params)
             Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
         const data = normalize(resource);
-        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('post', resource.type, data, Object.assign(Object.assign({}, options), { params: queryParams }));
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('post', resource.type, data, { ...options, params: queryParams });
         const r = denormalize(res);
         return r;
     }
@@ -100,7 +100,7 @@ class ResourceAdapter {
         if (options === null || options === void 0 ? void 0 : options.params)
             Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
         const data = normalize(resource);
-        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('patch', `${resource.type}/${resource.id}`, data, Object.assign(Object.assign({}, options), { params: queryParams }));
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('patch', `${resource.type}/${resource.id}`, data, { ...options, params: queryParams });
         const r = denormalize(res);
         return r;
     }
@@ -114,7 +114,7 @@ class ResourceAdapter {
         const queryParams = generateQueryStringParams(params, resource);
         if (options === null || options === void 0 ? void 0 : options.params)
             Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
-        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', path, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', path, undefined, { ...options, params: queryParams });
         const r = denormalize(res);
         if (Array.isArray(r)) {
             const p = params;
@@ -138,10 +138,10 @@ class ApiResourceBase {
     }
     // reference, reference_origin and metadata attributes are always updatable
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: this.type() }), params, options);
+        return this.resources.update({ ...resource, type: this.type() }, params, options);
     }
     async count(filter, options) {
-        const params = { filters: filter, pageNumber: 1, pageSize: 1 };
+        const params = { filters: isParamsList(filter) ? filter.filters : filter, pageNumber: 1, pageSize: 1 };
         const response = await this.resources.list({ type: this.type() }, params, options);
         return Promise.resolve(response.meta.recordCount);
     }
@@ -150,6 +150,9 @@ class ApiResource extends ApiResourceBase {
     async retrieve(id, params, options) {
         return this.resources.retrieve((typeof id === 'string') ? { type: this.type(), id } : id, params, options);
     }
+    async list(params, options) {
+        return this.resources.list({ type: this.type() }, params, options);
+    }
 }
 class ApiSingleton extends ApiResourceBase {
     async retrieve(params, options) {