@commercelayer/sdk 4.41.0 → 4.42.0

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

@@ -1,47 +1,48 @@
-import { ApiResource, Resource, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Order } from './orders';
 import type { Attachment } from './attachments';
 import type { Event } from './events';
 import type { Version } from './versions';
 import type { Authorization } from './authorizations';
 import type { Refund } from './refunds';
+type CaptureType = 'captures';
 type CaptureRel = ResourceRel & {
-    type: typeof Captures.TYPE;
+    type: CaptureType;
 };
 interface Capture extends Resource {
-    number?: string;
-    currency_code?: string;
-    amount_cents?: number;
-    amount_float?: number;
-    formatted_amount?: string;
-    succeeded?: boolean;
-    message?: string;
-    error_code?: string;
-    error_detail?: string;
-    token?: string;
-    gateway_transaction_id?: string;
-    refund_amount_cents?: number;
-    refund_amount_float?: number;
-    formatted_refund_amount?: string;
-    refund_balance_cents?: number;
-    refund_balance_float?: number;
-    formatted_refund_balance?: string;
-    order?: Order;
-    attachments?: Attachment[];
-    events?: Event[];
-    versions?: Version[];
-    reference_authorization?: Authorization;
-    refunds?: Refund[];
+    readonly type: CaptureType;
+    number: string;
+    currency_code: string;
+    amount_cents: number;
+    amount_float: number;
+    formatted_amount: string;
+    succeeded: boolean;
+    message?: string | null;
+    error_code?: string | null;
+    error_detail?: string | null;
+    token?: string | null;
+    gateway_transaction_id?: string | null;
+    refund_amount_cents?: number | null;
+    refund_amount_float?: number | null;
+    formatted_refund_amount?: string | null;
+    refund_balance_cents?: number | null;
+    refund_balance_float?: number | null;
+    formatted_refund_balance?: string | null;
+    order?: Order | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+    versions?: Version[] | null;
+    reference_authorization?: Authorization | null;
+    refunds?: Refund[] | null;
 }
 interface CaptureUpdate extends ResourceUpdate {
-    _refund?: boolean;
-    _refund_amount_cents?: number;
+    _refund?: boolean | null;
+    _refund_amount_cents?: number | null;
 }
-declare class Captures extends ApiResource {
-    static readonly TYPE: 'captures';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Capture>>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Capture>;
+declare class Captures extends ApiResource<Capture> {
+    static readonly TYPE: CaptureType;
     update(resource: CaptureUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Capture>;
     order(captureId: string | Capture, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     attachments(captureId: string | Capture, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
@@ -49,9 +50,11 @@ declare class Captures extends ApiResource {
     versions(captureId: string | Capture, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     reference_authorization(captureId: string | Capture, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Authorization>;
     refunds(captureId: string | Capture, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Refund>>;
+    _refund(id: string | Capture, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Capture>;
+    _refund_amount_cents(id: string | Capture, triggerValue: number, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Capture>;
     isCapture(resource: any): resource is Capture;
     relationship(id: string | ResourceId | null): CaptureRel;
-    type(): string;
+    type(): CaptureType;
 }
 export default Captures;
-export { Capture, CaptureUpdate };
+export type { Capture, CaptureUpdate, CaptureType };

package/lib/esm/resources/captures.js

@@ -1,14 +1,7 @@
 import { ApiResource } from '../resource';
 class Captures extends ApiResource {
-    // static readonly PATH = 'captures'
-    async list(params, options) {
-        return this.resources.list({ type: Captures.TYPE }, params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Captures.TYPE, id }, params, options);
-    }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Captures.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Captures.TYPE }, params, options);
     }
     async order(captureId, params, options) {
         const _captureId = captureId.id || captureId;
@@ -34,7 +27,12 @@ class Captures extends ApiResource {
         const _captureId = captureId.id || captureId;
         return this.resources.fetch({ type: 'refunds' }, `captures/${_captureId}/refunds`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    async _refund(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Captures.TYPE, _refund: true }, params, options);
+    }
+    async _refund_amount_cents(id, triggerValue, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Captures.TYPE, _refund_amount_cents: triggerValue }, params, options);
+    }
     isCapture(resource) {
         return resource.type && (resource.type === Captures.TYPE);
     }

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

@@ -1,29 +1,30 @@
-import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Market } from './markets';
 import type { Attachment } from './attachments';
 import type { Version } from './versions';
+type CarrierAccountType = 'carrier_accounts';
 type CarrierAccountRel = ResourceRel & {
-    type: typeof CarrierAccounts.TYPE;
+    type: CarrierAccountType;
 };
 interface CarrierAccount extends Resource {
-    name?: string;
-    easypost_type?: string;
-    easypost_id?: string;
-    market?: Market;
-    attachments?: Attachment[];
-    versions?: Version[];
+    readonly type: CarrierAccountType;
+    name?: string | null;
+    easypost_type?: string | null;
+    easypost_id?: string | null;
+    market?: Market | null;
+    attachments?: Attachment[] | null;
+    versions?: Version[] | null;
 }
-declare class CarrierAccounts extends ApiResource {
-    static readonly TYPE: 'carrier_accounts';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CarrierAccount>>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CarrierAccount>;
+declare class CarrierAccounts extends ApiResource<CarrierAccount> {
+    static readonly TYPE: CarrierAccountType;
     market(carrierAccountId: string | CarrierAccount, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     attachments(carrierAccountId: string | CarrierAccount, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     versions(carrierAccountId: string | CarrierAccount, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isCarrierAccount(resource: any): resource is CarrierAccount;
     relationship(id: string | ResourceId | null): CarrierAccountRel;
-    type(): string;
+    type(): CarrierAccountType;
 }
 export default CarrierAccounts;
-export { CarrierAccount };
+export type { CarrierAccount, CarrierAccountType };

package/lib/esm/resources/carrier_accounts.js

@@ -1,12 +1,5 @@
 import { ApiResource } from '../resource';
 class CarrierAccounts extends ApiResource {
-    // static readonly PATH = 'carrier_accounts'
-    async list(params, options) {
-        return this.resources.list({ type: CarrierAccounts.TYPE }, params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: CarrierAccounts.TYPE, id }, params, options);
-    }
     async market(carrierAccountId, params, options) {
         const _carrierAccountId = carrierAccountId.id || carrierAccountId;
         return this.resources.fetch({ type: 'markets' }, `carrier_accounts/${_carrierAccountId}/market`, params, options);
@@ -19,7 +12,6 @@ class CarrierAccounts extends ApiResource {
         const _carrierAccountId = carrierAccountId.id || carrierAccountId;
         return this.resources.fetch({ type: 'versions' }, `carrier_accounts/${_carrierAccountId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isCarrierAccount(resource) {
         return resource.type && (resource.type === CarrierAccounts.TYPE);
     }

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

@@ -1,48 +1,49 @@
-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 { CheckoutComPayment } from './checkout_com_payments';
+import type { CheckoutComPayment, CheckoutComPaymentType } from './checkout_com_payments';
+type CheckoutComGatewayType = 'checkout_com_gateways';
 type CheckoutComGatewayRel = ResourceRel & {
-    type: typeof CheckoutComGateways.TYPE;
+    type: CheckoutComGatewayType;
 };
 type CheckoutComPaymentRel = ResourceRel & {
-    type: 'checkout_com_payments';
+    type: CheckoutComPaymentType;
 };
 interface CheckoutComGateway extends Resource {
-    name?: string;
-    webhook_endpoint_id?: string;
-    webhook_endpoint_secret?: string;
-    webhook_endpoint_url?: string;
-    payment_methods?: PaymentMethod[];
-    versions?: Version[];
-    checkout_com_payments?: CheckoutComPayment[];
+    readonly type: CheckoutComGatewayType;
+    name: string;
+    webhook_endpoint_id?: string | null;
+    webhook_endpoint_secret?: string | null;
+    webhook_endpoint_url?: string | null;
+    payment_methods?: PaymentMethod[] | null;
+    versions?: Version[] | null;
+    checkout_com_payments?: CheckoutComPayment[] | null;
 }
 interface CheckoutComGatewayCreate extends ResourceCreate {
     name: string;
     secret_key: string;
     public_key: string;
-    checkout_com_payments?: CheckoutComPaymentRel[];
+    checkout_com_payments?: CheckoutComPaymentRel[] | null;
 }
 interface CheckoutComGatewayUpdate extends ResourceUpdate {
-    name?: string;
-    secret_key?: string;
-    public_key?: string;
-    checkout_com_payments?: CheckoutComPaymentRel[];
+    name?: string | null;
+    secret_key?: string | null;
+    public_key?: string | null;
+    checkout_com_payments?: CheckoutComPaymentRel[] | null;
 }
-declare class CheckoutComGateways extends ApiResource {
-    static readonly TYPE: 'checkout_com_gateways';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CheckoutComGateway>>;
+declare class CheckoutComGateways extends ApiResource<CheckoutComGateway> {
+    static readonly TYPE: CheckoutComGatewayType;
     create(resource: CheckoutComGatewayCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CheckoutComGateway>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CheckoutComGateway>;
     update(resource: CheckoutComGatewayUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CheckoutComGateway>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     payment_methods(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
     versions(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     checkout_com_payments(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CheckoutComPayment>>;
     isCheckoutComGateway(resource: any): resource is CheckoutComGateway;
     relationship(id: string | ResourceId | null): CheckoutComGatewayRel;
-    type(): string;
+    type(): CheckoutComGatewayType;
 }
 export default CheckoutComGateways;
-export { CheckoutComGateway, CheckoutComGatewayCreate, CheckoutComGatewayUpdate };
+export type { CheckoutComGateway, CheckoutComGatewayCreate, CheckoutComGatewayUpdate, CheckoutComGatewayType };

package/lib/esm/resources/checkout_com_gateways.js

@@ -1,20 +1,13 @@
 import { ApiResource } from '../resource';
 class CheckoutComGateways extends ApiResource {
-    // static readonly PATH = 'checkout_com_gateways'
-    async list(params, options) {
-        return this.resources.list({ type: CheckoutComGateways.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: CheckoutComGateways.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: CheckoutComGateways.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: CheckoutComGateways.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: CheckoutComGateways.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: CheckoutComGateways.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: CheckoutComGateways.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: CheckoutComGateways.TYPE } : id, options);
     }
     async payment_methods(checkoutComGatewayId, params, options) {
         const _checkoutComGatewayId = checkoutComGatewayId.id || checkoutComGatewayId;
@@ -28,7 +21,6 @@ class CheckoutComGateways extends ApiResource {
         const _checkoutComGatewayId = checkoutComGatewayId.id || checkoutComGatewayId;
         return this.resources.fetch({ type: 'checkout_com_payments' }, `checkout_com_gateways/${_checkoutComGatewayId}/checkout_com_payments`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isCheckoutComGateway(resource) {
         return resource.type && (resource.type === CheckoutComGateways.TYPE);
     }

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

@@ -1,62 +1,65 @@
-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 CheckoutComPaymentType = 'checkout_com_payments';
 type CheckoutComPaymentRel = ResourceRel & {
-    type: typeof CheckoutComPayments.TYPE;
+    type: CheckoutComPaymentType;
 };
 type OrderRel = ResourceRel & {
-    type: 'orders';
+    type: OrderType;
 };
 interface CheckoutComPayment extends Resource {
-    public_key?: string;
-    payment_type?: string;
-    token?: string;
-    session_id?: string;
-    success_url?: string;
-    failure_url?: string;
-    source_id?: string;
-    customer_token?: string;
-    redirect_uri?: string;
-    payment_response?: object;
-    mismatched_amounts?: boolean;
-    payment_instrument?: object;
-    order?: Order;
-    payment_gateway?: PaymentGateway;
-    versions?: Version[];
+    readonly type: CheckoutComPaymentType;
+    public_key?: string | null;
+    payment_type: string;
+    token: string;
+    session_id?: string | null;
+    success_url?: string | null;
+    failure_url?: string | null;
+    source_id?: string | null;
+    customer_token?: string | null;
+    redirect_uri?: string | 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 CheckoutComPaymentCreate extends ResourceCreate {
     payment_type: string;
     token: string;
-    session_id?: string;
-    success_url?: string;
-    failure_url?: string;
+    session_id?: string | null;
+    success_url?: string | null;
+    failure_url?: string | null;
     order: OrderRel;
 }
 interface CheckoutComPaymentUpdate extends ResourceUpdate {
-    payment_type?: string;
-    token?: string;
-    session_id?: string;
-    success_url?: string;
-    failure_url?: string;
-    _details?: boolean;
-    _refresh?: boolean;
-    order?: OrderRel;
+    payment_type?: string | null;
+    token?: string | null;
+    session_id?: string | null;
+    success_url?: string | null;
+    failure_url?: string | null;
+    _details?: boolean | null;
+    _refresh?: boolean | null;
+    order?: OrderRel | null;
 }
-declare class CheckoutComPayments extends ApiResource {
-    static readonly TYPE: 'checkout_com_payments';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CheckoutComPayment>>;
+declare class CheckoutComPayments extends ApiResource<CheckoutComPayment> {
+    static readonly TYPE: CheckoutComPaymentType;
     create(resource: CheckoutComPaymentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CheckoutComPayment>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CheckoutComPayment>;
     update(resource: CheckoutComPaymentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CheckoutComPayment>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     order(checkoutComPaymentId: string | CheckoutComPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     payment_gateway(checkoutComPaymentId: string | CheckoutComPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
     versions(checkoutComPaymentId: string | CheckoutComPayment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    _details(id: string | CheckoutComPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CheckoutComPayment>;
+    _refresh(id: string | CheckoutComPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CheckoutComPayment>;
     isCheckoutComPayment(resource: any): resource is CheckoutComPayment;
     relationship(id: string | ResourceId | null): CheckoutComPaymentRel;
-    type(): string;
+    type(): CheckoutComPaymentType;
 }
 export default CheckoutComPayments;
-export { CheckoutComPayment, CheckoutComPaymentCreate, CheckoutComPaymentUpdate };
+export type { CheckoutComPayment, CheckoutComPaymentCreate, CheckoutComPaymentUpdate, CheckoutComPaymentType };

package/lib/esm/resources/checkout_com_payments.js

@@ -1,20 +1,13 @@
 import { ApiResource } from '../resource';
 class CheckoutComPayments extends ApiResource {
-    // static readonly PATH = 'checkout_com_payments'
-    async list(params, options) {
-        return this.resources.list({ type: CheckoutComPayments.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: CheckoutComPayments.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: CheckoutComPayments.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: CheckoutComPayments.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: CheckoutComPayments.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: CheckoutComPayments.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: CheckoutComPayments.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: CheckoutComPayments.TYPE } : id, options);
     }
     async order(checkoutComPaymentId, params, options) {
         const _checkoutComPaymentId = checkoutComPaymentId.id || checkoutComPaymentId;
@@ -28,7 +21,12 @@ class CheckoutComPayments extends ApiResource {
         const _checkoutComPaymentId = checkoutComPaymentId.id || checkoutComPaymentId;
         return this.resources.fetch({ type: 'versions' }, `checkout_com_payments/${_checkoutComPaymentId}/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: CheckoutComPayments.TYPE, _details: true }, params, options);
+    }
+    async _refresh(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: CheckoutComPayments.TYPE, _refresh: true }, params, options);
+    }
     isCheckoutComPayment(resource) {
         return resource.type && (resource.type === CheckoutComPayments.TYPE);
     }

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

@@ -1,39 +1,40 @@
-import { ApiResource, Resource, ResourceCreate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Event } from './events';
 import type { Version } from './versions';
+type CleanupType = 'cleanups';
 type CleanupRel = ResourceRel & {
-    type: typeof Cleanups.TYPE;
+    type: CleanupType;
 };
 interface Cleanup extends Resource {
-    resource_type?: string;
-    status?: string;
-    started_at?: string;
-    completed_at?: string;
-    interrupted_at?: string;
-    filters?: object;
-    records_count?: number;
-    errors_count?: number;
-    processed_count?: number;
-    errors_log?: object;
-    events?: Event[];
-    versions?: Version[];
+    readonly type: CleanupType;
+    resource_type: string;
+    status: 'pending' | 'in_progress' | 'interrupted' | 'completed';
+    started_at?: string | null;
+    completed_at?: string | null;
+    interrupted_at?: string | null;
+    filters?: Record<string, any> | null;
+    records_count?: number | null;
+    errors_count?: number | null;
+    processed_count?: number | null;
+    errors_log?: Record<string, any> | null;
+    events?: Event[] | null;
+    versions?: Version[] | null;
 }
 interface CleanupCreate extends ResourceCreate {
     resource_type: string;
-    filters?: object;
+    filters?: Record<string, any> | null;
 }
-declare class Cleanups extends ApiResource {
-    static readonly TYPE: 'cleanups';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Cleanup>>;
+declare class Cleanups extends ApiResource<Cleanup> {
+    static readonly TYPE: CleanupType;
     create(resource: CleanupCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Cleanup>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Cleanup>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     events(cleanupId: string | Cleanup, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     versions(cleanupId: string | Cleanup, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isCleanup(resource: any): resource is Cleanup;
     relationship(id: string | ResourceId | null): CleanupRel;
-    type(): string;
+    type(): CleanupType;
 }
 export default Cleanups;
-export { Cleanup, CleanupCreate };
+export type { Cleanup, CleanupCreate, CleanupType };

package/lib/esm/resources/cleanups.js

@@ -1,17 +1,10 @@
 import { ApiResource } from '../resource';
 class Cleanups extends ApiResource {
-    // static readonly PATH = 'cleanups'
-    async list(params, options) {
-        return this.resources.list({ type: Cleanups.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Cleanups.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Cleanups.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: Cleanups.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: Cleanups.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: Cleanups.TYPE } : id, options);
     }
     async events(cleanupId, params, options) {
         const _cleanupId = cleanupId.id || cleanupId;
@@ -21,7 +14,6 @@ class Cleanups extends ApiResource {
         const _cleanupId = cleanupId.id || cleanupId;
         return this.resources.fetch({ type: 'versions' }, `cleanups/${_cleanupId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isCleanup(resource) {
         return resource.type && (resource.type === Cleanups.TYPE);
     }