@commercelayer/sdk 6.26.0 → 6.27.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [2023] [Commerce Layer]
+Copyright (c) [2024] [Commerce Layer]
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/index.d.mts

@@ -1094,6 +1094,7 @@ interface PaymentMethod extends Resource {
     market?: Market | null;
     payment_gateway?: PaymentGateway | null;
     store?: Store | null;
+    orders?: Order[] | null;
     attachments?: Attachment[] | null;
     versions?: Version[] | null;
 }
@@ -1217,6 +1218,7 @@ declare class PaymentMethods extends ApiResource<PaymentMethod> {
     market(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<Market>, options?: ResourcesConfig): Promise<Market>;
     payment_gateway(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
     store(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<Store>, options?: ResourcesConfig): Promise<Store>;
+    orders(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Order>, options?: ResourcesConfig): Promise<ListResponse<Order>>;
     attachments(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     versions(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     _disable(id: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
@@ -14730,7 +14732,13 @@ interface CleanupCreate extends ResourceCreate {
      */
     filters?: Record<string, any> | null;
 }
-type CleanupUpdate = ResourceUpdate;
+interface CleanupUpdate extends ResourceUpdate {
+    /**
+     * Send this attribute if you want to mark status as 'interrupted'.
+     * @example ```"true"```
+     */
+    _interrupt?: boolean | null;
+}
 declare class Cleanups extends ApiResource<Cleanup> {
     static readonly TYPE: CleanupType;
     create(resource: CleanupCreate, params?: QueryParamsRetrieve<Cleanup>, options?: ResourcesConfig): Promise<Cleanup>;
@@ -14738,6 +14746,7 @@ declare class Cleanups extends ApiResource<Cleanup> {
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     events(cleanupId: string | Cleanup, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     versions(cleanupId: string | Cleanup, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    _interrupt(id: string | Cleanup, params?: QueryParamsRetrieve<Cleanup>, options?: ResourcesConfig): Promise<Cleanup>;
     isCleanup(resource: any): resource is Cleanup;
     relationship(id: string | ResourceId | null): CleanupRel;
     relationshipToMany(...ids: string[]): CleanupRel[];
@@ -14825,10 +14834,15 @@ interface Export extends Resource {
      */
     status: 'pending' | 'in_progress' | 'interrupted' | 'completed';
     /**
-     * List of related resources that should be included in the export.
+     * List of related resources that should be included in the export (redundant when 'fields' are specified).
      * @example ```"prices.price_tiers"```
      */
     includes?: string[] | null;
+    /**
+     * List of fields to export for the main and related resources (automatically included). Pass the asterisk '*' to include all exportable fields for the main and related resources.
+     * @example ```"code,name,prices.*,prices.price_tiers.price_amount_cents"```
+     */
+    fields?: string[] | null;
     /**
      * The filters used to select the records to be exported.
      * @example ```"[object Object]"```
@@ -14863,6 +14877,11 @@ interface Export extends Resource {
      * @example ```"http://cl_exports.s3.amazonaws.com/"```
      */
     attachment_url?: string | null;
+    /**
+     * Contains the exports errors, if any.
+     * @example ```"[object Object]"```
+     */
+    errors_log?: Record<string, any> | null;
     events?: Event[] | null;
 }
 interface ExportCreate extends ResourceCreate {
@@ -14877,10 +14896,15 @@ interface ExportCreate extends ResourceCreate {
      */
     format?: string | null;
     /**
-     * List of related resources that should be included in the export.
+     * List of related resources that should be included in the export (redundant when 'fields' are specified).
      * @example ```"prices.price_tiers"```
      */
     includes?: string[] | null;
+    /**
+     * List of fields to export for the main and related resources (automatically included). Pass the asterisk '*' to include all exportable fields for the main and related resources.
+     * @example ```"code,name,prices.*,prices.price_tiers.price_amount_cents"```
+     */
+    fields?: string[] | null;
     /**
      * The filters used to select the records to be exported.
      * @example ```"[object Object]"```
@@ -14891,13 +14915,20 @@ interface ExportCreate extends ResourceCreate {
      */
     dry_data?: boolean | null;
 }
-type ExportUpdate = ResourceUpdate;
+interface ExportUpdate extends ResourceUpdate {
+    /**
+     * Send this attribute if you want to mark status as 'interrupted'.
+     * @example ```"true"```
+     */
+    _interrupt?: boolean | null;
+}
 declare class Exports extends ApiResource<Export> {
     static readonly TYPE: ExportType;
     create(resource: ExportCreate, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
     update(resource: ExportUpdate, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     events(exportId: string | Export, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    _interrupt(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
     isExport(resource: any): resource is Export;
     relationship(id: string | ResourceId | null): ExportRel;
     relationshipToMany(...ids: string[]): ExportRel[];
@@ -15204,13 +15235,20 @@ interface ImportCreate extends ResourceCreate {
      */
     inputs: Array<Record<string, any>>;
 }
-type ImportUpdate = ResourceUpdate;
+interface ImportUpdate extends ResourceUpdate {
+    /**
+     * Send this attribute if you want to mark status as 'interrupted'.
+     * @example ```"true"```
+     */
+    _interrupt?: boolean | null;
+}
 declare class Imports extends ApiResource<Import> {
     static readonly TYPE: ImportType;
     create(resource: ImportCreate, params?: QueryParamsRetrieve<Import>, options?: ResourcesConfig): Promise<Import>;
     update(resource: ImportUpdate, params?: QueryParamsRetrieve<Import>, options?: ResourcesConfig): Promise<Import>;
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     events(importId: string | Import, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    _interrupt(id: string | Import, params?: QueryParamsRetrieve<Import>, options?: ResourcesConfig): Promise<Import>;
     isImport(resource: any): resource is Import;
     relationship(id: string | ResourceId | null): ImportRel;
     relationshipToMany(...ids: string[]): ImportRel[];
@@ -16204,7 +16242,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
 type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
 declare class CommerceLayerClient {
     #private;
-    readonly openApiSchemaVersion = "7.5.0";
+    readonly openApiSchemaVersion = "7.6.0";
     constructor(config: CommerceLayerInitConfig);
     get addresses(): Addresses;
     get adjustments(): Adjustments;

package/lib/index.d.ts

@@ -1094,6 +1094,7 @@ interface PaymentMethod extends Resource {
     market?: Market | null;
     payment_gateway?: PaymentGateway | null;
     store?: Store | null;
+    orders?: Order[] | null;
     attachments?: Attachment[] | null;
     versions?: Version[] | null;
 }
@@ -1217,6 +1218,7 @@ declare class PaymentMethods extends ApiResource<PaymentMethod> {
     market(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<Market>, options?: ResourcesConfig): Promise<Market>;
     payment_gateway(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
     store(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<Store>, options?: ResourcesConfig): Promise<Store>;
+    orders(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Order>, options?: ResourcesConfig): Promise<ListResponse<Order>>;
     attachments(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     versions(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     _disable(id: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
@@ -14730,7 +14732,13 @@ interface CleanupCreate extends ResourceCreate {
      */
     filters?: Record<string, any> | null;
 }
-type CleanupUpdate = ResourceUpdate;
+interface CleanupUpdate extends ResourceUpdate {
+    /**
+     * Send this attribute if you want to mark status as 'interrupted'.
+     * @example ```"true"```
+     */
+    _interrupt?: boolean | null;
+}
 declare class Cleanups extends ApiResource<Cleanup> {
     static readonly TYPE: CleanupType;
     create(resource: CleanupCreate, params?: QueryParamsRetrieve<Cleanup>, options?: ResourcesConfig): Promise<Cleanup>;
@@ -14738,6 +14746,7 @@ declare class Cleanups extends ApiResource<Cleanup> {
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     events(cleanupId: string | Cleanup, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     versions(cleanupId: string | Cleanup, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    _interrupt(id: string | Cleanup, params?: QueryParamsRetrieve<Cleanup>, options?: ResourcesConfig): Promise<Cleanup>;
     isCleanup(resource: any): resource is Cleanup;
     relationship(id: string | ResourceId | null): CleanupRel;
     relationshipToMany(...ids: string[]): CleanupRel[];
@@ -14825,10 +14834,15 @@ interface Export extends Resource {
      */
     status: 'pending' | 'in_progress' | 'interrupted' | 'completed';
     /**
-     * List of related resources that should be included in the export.
+     * List of related resources that should be included in the export (redundant when 'fields' are specified).
      * @example ```"prices.price_tiers"```
      */
     includes?: string[] | null;
+    /**
+     * List of fields to export for the main and related resources (automatically included). Pass the asterisk '*' to include all exportable fields for the main and related resources.
+     * @example ```"code,name,prices.*,prices.price_tiers.price_amount_cents"```
+     */
+    fields?: string[] | null;
     /**
      * The filters used to select the records to be exported.
      * @example ```"[object Object]"```
@@ -14863,6 +14877,11 @@ interface Export extends Resource {
      * @example ```"http://cl_exports.s3.amazonaws.com/"```
      */
     attachment_url?: string | null;
+    /**
+     * Contains the exports errors, if any.
+     * @example ```"[object Object]"```
+     */
+    errors_log?: Record<string, any> | null;
     events?: Event[] | null;
 }
 interface ExportCreate extends ResourceCreate {
@@ -14877,10 +14896,15 @@ interface ExportCreate extends ResourceCreate {
      */
     format?: string | null;
     /**
-     * List of related resources that should be included in the export.
+     * List of related resources that should be included in the export (redundant when 'fields' are specified).
      * @example ```"prices.price_tiers"```
      */
     includes?: string[] | null;
+    /**
+     * List of fields to export for the main and related resources (automatically included). Pass the asterisk '*' to include all exportable fields for the main and related resources.
+     * @example ```"code,name,prices.*,prices.price_tiers.price_amount_cents"```
+     */
+    fields?: string[] | null;
     /**
      * The filters used to select the records to be exported.
      * @example ```"[object Object]"```
@@ -14891,13 +14915,20 @@ interface ExportCreate extends ResourceCreate {
      */
     dry_data?: boolean | null;
 }
-type ExportUpdate = ResourceUpdate;
+interface ExportUpdate extends ResourceUpdate {
+    /**
+     * Send this attribute if you want to mark status as 'interrupted'.
+     * @example ```"true"```
+     */
+    _interrupt?: boolean | null;
+}
 declare class Exports extends ApiResource<Export> {
     static readonly TYPE: ExportType;
     create(resource: ExportCreate, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
     update(resource: ExportUpdate, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     events(exportId: string | Export, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    _interrupt(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
     isExport(resource: any): resource is Export;
     relationship(id: string | ResourceId | null): ExportRel;
     relationshipToMany(...ids: string[]): ExportRel[];
@@ -15204,13 +15235,20 @@ interface ImportCreate extends ResourceCreate {
      */
     inputs: Array<Record<string, any>>;
 }
-type ImportUpdate = ResourceUpdate;
+interface ImportUpdate extends ResourceUpdate {
+    /**
+     * Send this attribute if you want to mark status as 'interrupted'.
+     * @example ```"true"```
+     */
+    _interrupt?: boolean | null;
+}
 declare class Imports extends ApiResource<Import> {
     static readonly TYPE: ImportType;
     create(resource: ImportCreate, params?: QueryParamsRetrieve<Import>, options?: ResourcesConfig): Promise<Import>;
     update(resource: ImportUpdate, params?: QueryParamsRetrieve<Import>, options?: ResourcesConfig): Promise<Import>;
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     events(importId: string | Import, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    _interrupt(id: string | Import, params?: QueryParamsRetrieve<Import>, options?: ResourcesConfig): Promise<Import>;
     isImport(resource: any): resource is Import;
     relationship(id: string | ResourceId | null): ImportRel;
     relationshipToMany(...ids: string[]): ImportRel[];
@@ -16204,7 +16242,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
 type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
 declare class CommerceLayerClient {
     #private;
-    readonly openApiSchemaVersion = "7.5.0";
+    readonly openApiSchemaVersion = "7.6.0";
     constructor(config: CommerceLayerInitConfig);
     get addresses(): Addresses;
     get adjustments(): Adjustments;