@commercelayer/sdk 4.40.0 → 4.41.0

package/lib/esm/error.js

@@ -1,14 +1,14 @@
-import axios from 'axios';
+/* eslint-disable @typescript-eslint/no-explicit-any */
 var ErrorType;
 (function (ErrorType) {
     ErrorType["CLIENT"] = "client";
     ErrorType["REQUEST"] = "request";
     ErrorType["RESPONSE"] = "response";
-    ErrorType["CANCEL"] = "cancel";
-    ErrorType["PARSE"] = "parse";
     ErrorType["GENERIC"] = "generic";
+    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);
     }
@@ -20,11 +20,12 @@ 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({ ...error, type: ErrorType.RESPONSE });
+        super(Object.assign(Object.assign({}, error), { type: ErrorType.RESPONSE }));
         this.errors = [];
         this.name = ApiError.NAME; // this.constructor.name
     }
@@ -34,36 +35,4 @@ class ApiError extends SdkError {
     }
 }
 ApiError.NAME = 'ApiError';
-const handleError = (error) => {
-    let sdkError = new SdkError({ message: error.message });
-    if (axios.isAxiosError(error)) {
-        if (error.response) {
-            // The request was made and the server responded with a status code that falls out of the range of 2xx
-            const apiError = new ApiError(sdkError);
-            apiError.type = ErrorType.RESPONSE;
-            apiError.status = error.response.status;
-            apiError.statusText = error.response.statusText;
-            apiError.code = String(apiError.status);
-            apiError.errors = error.response.data.errors;
-            if (!apiError.message && apiError.statusText)
-                apiError.message = apiError.statusText;
-            sdkError = apiError;
-        }
-        else if (error.request) {
-            // The request was made but no response was received
-            // `error.request` is an instance of XMLHttpRequest in the browser and an instance of http.ClientRequest in node.js
-            sdkError.type = ErrorType.REQUEST;
-            sdkError.request = error.request;
-        }
-        else {
-            // Something happened in setting up the request that triggered an Error
-            sdkError.type = ErrorType.CLIENT;
-        }
-    }
-    else if (axios.isCancel(error))
-        sdkError.type = ErrorType.CANCEL;
-    else
-        sdkError.source = error;
-    throw sdkError;
-};
-export { SdkError, ApiError, ErrorType, handleError };
+export { SdkError, ApiError, ErrorType };

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 type * from './model';
+export * from './model';
 export type { RequestObj, ResponseObj, ErrorObj, HeadersObj } from './interceptor';
 export type { SdkError, ApiError, ErrorType } from './error';

package/lib/esm/index.js

@@ -2,3 +2,5 @@
 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 type { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders } from 'axios';
+import { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders } from 'axios';
 type InterceptorManager = {
     request: AxiosInterceptorManager<AxiosRequestConfig>;
     response: AxiosInterceptorManager<any>;
@@ -7,11 +7,7 @@ type RequestObj = AxiosRequestConfig;
 type RequestInterceptor = (request: RequestObj) => RequestObj | Promise<RequestObj>;
 type ResponseObj = AxiosResponse;
 type ResponseInterceptor = (response: ResponseObj) => ResponseObj;
-type ApiHeadersList = 'x-ratelimit-limit' | 'x-ratelimit-count' | 'x-ratelimit-period' | 'x-ratelimit-interval' | 'x-ratelimit-remaining';
-type ApiHeaders = {
-    [key in ApiHeadersList]: string | number | boolean;
-};
-type HeadersObj = (AxiosResponseHeaders | RawAxiosResponseHeaders) & ApiHeaders;
+type HeadersObj = AxiosResponseHeaders | RawAxiosResponseHeaders;
 type ErrorObj = AxiosError;
 type ErrorInterceptor = (error: ErrorObj) => ErrorObj;
 type InterceptorType = 'request' | 'response';

package/lib/esm/jsonapi.js

@@ -28,11 +28,7 @@ const denormalizeResource = (res, included) => {
     debug('denormalize resource: %O, %o', res, included || {});
     if (!res)
         return res;
-    const resource = {
-        id: res.id,
-        type: res.type,
-        ...res.attributes,
-    };
+    const resource = Object.assign({ id: res.id, type: res.type }, res.attributes);
     if (res.relationships)
         Object.keys(res.relationships).forEach(key => {
             const rel = res.relationships[key].data;
@@ -57,10 +53,7 @@ const normalize = (resource) => {
         if (['type', 'id'].includes(field))
             continue;
         const value = resource[field];
-        if (Array.isArray(value) && (value.length === 1) && isResourceType(value[0]) && (value[0].id === null)) {
-            relationships[field] = { data: [] };
-        }
-        else if (value && isResourceType(value) && (value.id === null)) {
+        if (value && isResourceType(value) && value.id === null) {
             relationships[field] = { data: null };
         }
         else if (value && (isResourceId(value) || (Array.isArray(value) && isResourceId(value[0])))) {

package/lib/esm/model.d.ts

@@ -1,5 +1,5 @@
 /**
- * ©2023 Commerce Layer Inc.
+ * ©2024 Commerce Layer Inc.
  **/
 export type { Address, AddressCreate, AddressUpdate } from './resources/addresses';
 export type { Adjustment, AdjustmentCreate, AdjustmentUpdate } from './resources/adjustments';

package/lib/esm/query.d.ts

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

package/lib/esm/query.js

@@ -1,7 +1,7 @@
 import Debug from './debug';
 const debug = Debug('query');
 const isParamsList = (params) => {
-    return params && (params.filters || params.pageNumber || params.pageSize || params.sort);
+    return (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, isParamsList };
+export { generateQueryStringParams };

package/lib/esm/resource.d.ts

@@ -1,7 +1,8 @@
 import { type ApiClientInitConfig } from './client';
-import type { QueryParamsRetrieve, QueryParamsList, QueryFilter, QueryParams } from './query';
+import { type QueryParamsRetrieve, type QueryParamsList } from './query';
 import type { ResourceTypeLock } from './api';
 import type { InterceptorManager } from './interceptor';
+import type { QueryParams } from '.';
 type ResourceNull = {
     id: null;
 } & ResourceType;
@@ -13,19 +14,23 @@ interface ResourceType {
 interface ResourceId extends ResourceType {
     readonly id: string;
 }
-interface ResourceBase {
-    reference?: string | null;
-    reference_origin?: string | null;
+interface Resource extends ResourceId {
+    reference?: string;
+    reference_origin?: string;
     metadata?: Metadata;
-}
-interface Resource extends ResourceBase, ResourceId {
     readonly created_at: string;
     readonly updated_at: string;
 }
-interface ResourceCreate extends ResourceBase {
+interface ResourceCreate {
+    reference?: string;
+    reference_origin?: string;
+    metadata?: Metadata;
 }
-interface ResourceUpdate extends ResourceBase {
+interface ResourceUpdate {
     readonly id: string;
+    reference?: string;
+    reference_origin?: string;
+    metadata?: Metadata;
 }
 type ListMeta = {
     readonly pageCount: number;
@@ -39,14 +44,8 @@ declare class ListResponse<R> extends Array<R> {
     first(): R | undefined;
     last(): R | undefined;
     get(index: number): R | undefined;
-    hasNextPage(): boolean;
-    hasPrevPage(): boolean;
-    getRecordCount(): number;
-    getPageCount(): number;
-    get recordCount(): number;
-    get pageCount(): number;
 }
-export type { Metadata, ResourceType, ResourceId, Resource, ResourceCreate, ResourceUpdate, ListResponse, ListMeta, ResourceRel };
+export type { Metadata, ResourceType, ResourceId, Resource, ResourceCreate, ResourceUpdate, ListResponse, ResourceRel };
 type ResourceAdapterConfig = {};
 type ResourcesInitConfig = ResourceAdapterConfig & ApiClientInitConfig;
 type ResourcesConfig = Partial<ResourcesInitConfig>;
@@ -55,7 +54,7 @@ declare class ResourceAdapter {
     constructor(config: ResourcesInitConfig);
     get interceptors(): InterceptorManager;
     private localConfig;
-    config(config: ResourcesConfig): ResourceAdapter;
+    config(config: ResourcesConfig): void;
     singleton<R extends Resource>(resource: ResourceType, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
     retrieve<R extends Resource>(resource: ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
     list<R extends Resource>(resource: ResourceType, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
@@ -64,23 +63,13 @@ declare class ResourceAdapter {
     delete(resource: ResourceId, options?: ResourcesConfig): Promise<void>;
     fetch<R extends Resource>(resource: string | ResourceType, path: string, params?: QueryParams, options?: ResourcesConfig): Promise<R | ListResponse<R>>;
 }
-declare abstract class ApiResourceBase<R extends Resource> {
+declare abstract class ApiResource {
     static readonly TYPE: ResourceTypeLock;
-    protected readonly resources: ResourceAdapter;
+    protected resources: ResourceAdapter;
     constructor(adapter: ResourceAdapter);
     abstract relationship(id: string | ResourceId | null): ResourceRel;
-    abstract type(): ResourceTypeLock;
-    parse(resource: any): R | R[];
-    update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
-}
-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>>;
-    count(filter?: QueryFilter | QueryParamsList, options?: ResourcesConfig): Promise<number>;
-}
-declare abstract class ApiSingleton<R extends Resource> extends ApiResourceBase<R> {
-    retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
+    abstract type(): string;
+    update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Resource>;
 }
 export default ResourceAdapter;
-export { ApiResource, ApiSingleton };
-export type { ResourcesConfig, ResourcesInitConfig };
+export { ApiResource, type ResourcesConfig, type ResourcesInitConfig };

package/lib/esm/resource.js

@@ -12,10 +12,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _ResourceAdapter_client, _ResourceAdapter_config;
 import ApiClient from './client';
 import { denormalize, normalize } from './jsonapi';
-import { generateQueryStringParams, isParamsList } from './query';
+import { generateQueryStringParams } from './query';
 import config from './config';
 import Debug from './debug';
-import { ErrorType, SdkError } from './error';
 const debug = Debug('resource');
 class ListResponse extends Array {
     constructor(meta, data) {
@@ -25,12 +24,6 @@ class ListResponse extends Array {
     first() { return this.length ? this[0] : undefined; }
     last() { return this.length ? this[this.length - 1] : undefined; }
     get(index) { return (this.length && (index >= 0)) ? this[index] : undefined; }
-    hasNextPage() { return (this.meta.currentPage < this.meta.pageCount); }
-    hasPrevPage() { return (this.meta.currentPage > 1); }
-    getRecordCount() { return this.meta.recordCount; }
-    getPageCount() { return this.meta.pageCount; }
-    get recordCount() { return this.meta.recordCount; }
-    get pageCount() { return this.meta.pageCount; }
 }
 class ResourceAdapter {
     constructor(config) {
@@ -50,19 +43,13 @@ class ResourceAdapter {
         this.localConfig(config);
         // Client config
         __classPrivateFieldGet(this, _ResourceAdapter_client, "f").config(config);
-        return this;
     }
-    /*
-    get clientInstance(): ApiClient {
-        return this.#client
-    }
-    */
     async singleton(resource, params, options) {
         debug('singleton: %o, %O, %O', resource, params || {}, options || {});
         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, { ...options, params: queryParams });
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
         const r = denormalize(res);
         return r;
     }
@@ -71,7 +58,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, { ...options, params: queryParams });
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}/${resource.id}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
         const r = denormalize(res);
         return r;
     }
@@ -81,7 +68,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, { ...options, params: queryParams });
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
         const r = denormalize(res);
         const meta = {
             pageCount: Number((_a = res.meta) === null || _a === void 0 ? void 0 : _a.page_count),
@@ -97,7 +84,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, { ...options, params: queryParams });
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('post', resource.type, data, Object.assign(Object.assign({}, options), { params: queryParams }));
         const r = denormalize(res);
         return r;
     }
@@ -107,7 +94,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, { ...options, params: queryParams });
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('patch', `${resource.type}/${resource.id}`, data, Object.assign(Object.assign({}, options), { params: queryParams }));
         const r = denormalize(res);
         return r;
     }
@@ -121,7 +108,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, { ...options, params: queryParams });
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', path, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
         const r = denormalize(res);
         if (Array.isArray(r)) {
             const p = params;
@@ -138,48 +125,15 @@ class ResourceAdapter {
     }
 }
 _ResourceAdapter_client = new WeakMap(), _ResourceAdapter_config = new WeakMap();
-class ApiResourceBase {
+class ApiResource {
     constructor(adapter) {
         debug('new resource instance: %s', this.type());
         this.resources = adapter;
     }
-    parse(resource) {
-        var _a, _b;
-        try {
-            const res = JSON.parse(resource);
-            if (((_a = res.data) === null || _a === void 0 ? void 0 : _a.type) !== this.type())
-                throw new SdkError({ message: `Invalid resource type [${(_b = res.data) === null || _b === void 0 ? void 0 : _b.type}]`, type: ErrorType.PARSE });
-            return denormalize(res);
-        }
-        catch (error) {
-            if (SdkError.isSdkError(error))
-                throw error;
-            else
-                throw new SdkError({ message: `Payload parse error [${error.message}]`, type: ErrorType.PARSE });
-        }
-    }
     // reference, reference_origin and metadata attributes are always updatable
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: this.type() }, params, options);
-    }
-}
-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);
-    }
-    async count(filter, options) {
-        const params = { filters: isParamsList(filter) ? filter.filters : filter, pageNumber: 1, pageSize: 1 };
-        const response = await this.list(params, options);
-        return Promise.resolve(response.meta.recordCount);
-    }
-}
-class ApiSingleton extends ApiResourceBase {
-    async retrieve(params, options) {
-        return this.resources.singleton({ type: this.type() }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: this.type() }), params, options);
     }
 }
 export default ResourceAdapter;
-export { ApiResource, ApiSingleton };
+export { ApiResource };

package/lib/esm/resources/addresses.d.ts

@@ -1,103 +1,102 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
-import type { Geocoder, GeocoderType } from './geocoders';
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import type { Geocoder } from './geocoders';
 import type { Event } from './events';
-import type { Tag, TagType } from './tags';
+import type { Tag } from './tags';
 import type { Version } from './versions';
-type AddressType = 'addresses';
 type AddressRel = ResourceRel & {
-    type: AddressType;
+    type: typeof Addresses.TYPE;
 };
 type GeocoderRel = ResourceRel & {
-    type: GeocoderType;
+    type: 'geocoders';
 };
 type TagRel = ResourceRel & {
-    type: TagType;
+    type: 'tags';
 };
 interface Address extends Resource {
-    readonly type: AddressType;
-    business?: boolean | null;
-    first_name?: string | null;
-    last_name?: string | null;
-    company?: string | null;
-    full_name?: string | null;
-    line_1: string;
-    line_2?: string | null;
-    city: string;
-    zip_code?: string | null;
-    state_code: string;
-    country_code: string;
-    phone: string;
-    full_address?: string | null;
-    name?: string | null;
-    email?: string | null;
-    notes?: string | null;
-    lat?: number | null;
-    lng?: number | null;
-    is_localized?: boolean | null;
-    is_geocoded?: boolean | null;
-    provider_name?: string | null;
-    map_url?: string | null;
-    static_map_url?: string | null;
-    billing_info?: string | null;
-    geocoder?: Geocoder | null;
-    events?: Event[] | null;
-    tags?: Tag[] | null;
-    versions?: Version[] | null;
+    business?: boolean;
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    full_name?: string;
+    line_1?: string;
+    line_2?: string;
+    city?: string;
+    zip_code?: string;
+    state_code?: string;
+    country_code?: string;
+    phone?: string;
+    full_address?: string;
+    name?: string;
+    email?: string;
+    notes?: string;
+    lat?: number;
+    lng?: number;
+    is_localized?: boolean;
+    is_geocoded?: boolean;
+    provider_name?: string;
+    map_url?: string;
+    static_map_url?: string;
+    billing_info?: string;
+    geocoder?: Geocoder;
+    events?: Event[];
+    tags?: Tag[];
+    versions?: Version[];
 }
 interface AddressCreate extends ResourceCreate {
-    business?: boolean | null;
-    first_name?: string | null;
-    last_name?: string | null;
-    company?: string | null;
+    business?: boolean;
+    first_name?: string;
+    last_name?: string;
+    company?: string;
     line_1: string;
-    line_2?: string | null;
+    line_2?: string;
     city: string;
-    zip_code?: string | null;
+    zip_code?: string;
     state_code: string;
     country_code: string;
     phone: string;
-    email?: string | null;
-    notes?: string | null;
-    lat?: number | null;
-    lng?: number | null;
-    billing_info?: string | null;
-    geocoder?: GeocoderRel | null;
-    tags?: TagRel[] | null;
+    email?: string;
+    notes?: string;
+    lat?: number;
+    lng?: number;
+    billing_info?: string;
+    geocoder?: GeocoderRel;
+    tags?: TagRel[];
 }
 interface AddressUpdate extends ResourceUpdate {
-    business?: boolean | null;
-    first_name?: string | null;
-    last_name?: string | null;
-    company?: string | null;
-    line_1?: string | null;
-    line_2?: string | null;
-    city?: string | null;
-    zip_code?: string | null;
-    state_code?: string | null;
-    country_code?: string | null;
-    phone?: string | null;
-    email?: string | null;
-    notes?: string | null;
-    lat?: number | null;
-    lng?: number | null;
-    billing_info?: string | null;
-    geocoder?: GeocoderRel | null;
-    tags?: TagRel[] | null;
+    business?: boolean;
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    line_1?: string;
+    line_2?: string;
+    city?: string;
+    zip_code?: string;
+    state_code?: string;
+    country_code?: string;
+    phone?: string;
+    email?: string;
+    notes?: string;
+    lat?: number;
+    lng?: number;
+    billing_info?: string;
+    geocoder?: GeocoderRel;
+    tags?: TagRel[];
 }
-declare class Addresses extends ApiResource<Address> {
-    static readonly TYPE: AddressType;
+declare class Addresses extends ApiResource {
+    static readonly TYPE: 'addresses';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Address>>;
     create(resource: AddressCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
     update(resource: AddressUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
-    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
     geocoder(addressId: string | Address, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Geocoder>;
     events(addressId: string | Address, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     tags(addressId: string | Address, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     versions(addressId: string | Address, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isAddress(resource: any): resource is Address;
     relationship(id: string | ResourceId | null): AddressRel;
-    type(): AddressType;
+    type(): string;
 }
 export default Addresses;
-export type { Address, AddressCreate, AddressUpdate, AddressType };
+export { Address, AddressCreate, AddressUpdate };

package/lib/esm/resources/addresses.js

@@ -1,13 +1,20 @@
 import { ApiResource } from '../resource';
 class Addresses extends ApiResource {
+    // static readonly PATH = 'addresses'
+    async list(params, options) {
+        return this.resources.list({ type: Addresses.TYPE }, params, options);
+    }
     async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: Addresses.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Addresses.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: Addresses.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: Addresses.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Addresses.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: Addresses.TYPE } : id, options);
+        await this.resources.delete({ type: Addresses.TYPE, id }, options);
     }
     async geocoder(addressId, params, options) {
         const _addressId = addressId.id || addressId;
@@ -25,6 +32,7 @@ class Addresses extends ApiResource {
         const _addressId = addressId.id || addressId;
         return this.resources.fetch({ type: 'versions' }, `addresses/${_addressId}/versions`, params, options);
     }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isAddress(resource) {
         return resource.type && (resource.type === Addresses.TYPE);
     }