@commercelayer/sdk 6.55.0 → 6.57.0

package/lib/index.d.mts

@@ -10946,6 +10946,11 @@ interface OrderUpdate extends ResourceUpdate {
      * @example ```true```
      */
     _refresh?: boolean | null;
+    /**
+     * Send this attribute if you want to refresh the prices of the line items associated to this order. Cannot be passed by sales channels.
+     * @example ```true```
+     */
+    _refresh_prices?: boolean | null;
     /**
      * Send this attribute if you want to trigger the external validation for the order.
      * @example ```true```
@@ -11067,6 +11072,7 @@ declare class Orders extends ApiResource<Order> {
     _save_shipping_address_to_customer_address_book(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _save_billing_address_to_customer_address_book(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _refresh(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
+    _refresh_prices(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _validate(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _create_subscriptions(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _start_editing(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
@@ -15554,7 +15560,7 @@ interface Application extends Resource {
      * The application's kind. One of 'sales_channel', 'integration', or 'webapp'.
      * @example ```"sales-channel"```
      */
-    kind?: 'dashboard' | 'user' | 'metrics' | 'contentful' | 'bundles' | 'customers' | 'datocms' | 'exports' | 'external' | 'generic' | 'gift_cards' | 'imports' | 'integration' | 'inventory' | 'orders' | 'price_lists' | 'promotions' | 'resources' | 'returns' | 'sales_channel' | 'sanity' | 'shipments' | 'skus' | 'sku_lists' | 'stock_transfers' | 'subscriptions' | 'tags' | 'webapp' | 'webhooks' | 'zapier' | null;
+    kind?: 'dashboard' | 'user' | 'contentful' | 'bundles' | 'customers' | 'datocms' | 'exports' | 'external' | 'generic' | 'gift_cards' | 'imports' | 'integration' | 'inventory' | 'metrics' | 'orders' | 'price_lists' | 'promotions' | 'resources' | 'returns' | 'sales_channel' | 'sanity' | 'shipments' | 'skus' | 'sku_lists' | 'stock_transfers' | 'subscriptions' | 'tags' | 'webapp' | 'webhooks' | 'zapier' | null;
     /**
      * Indicates if the application has public access.
      * @example ```true```
@@ -16336,7 +16342,7 @@ type ExportType = 'exports';
 type ExportRel = ResourceRel & {
     type: ExportType;
 };
-type ExportSort = Pick<Export, 'id' | 'resource_type' | 'format' | 'status' | 'started_at' | 'completed_at' | 'interrupted_at' | 'records_count' | 'attachment_url'> & ResourceSort;
+type ExportSort = Pick<Export, 'id' | 'resource_type' | 'format' | 'status' | 'started_at' | 'completed_at' | 'interrupted_at' | 'records_count' | 'processed_count' | 'attachment_url'> & ResourceSort;
 interface Export extends Resource {
     readonly type: ExportType;
     /**
@@ -16350,10 +16356,10 @@ interface Export extends Resource {
      */
     format?: string | null;
     /**
-     * The export job status. One of 'pending' (default), 'in_progress', 'interrupted', or 'completed'.
+     * The export job status. One of 'pending' (default), 'in_progress', 'interrupted', 'completed', or 'failed'.
      * @example ```"in_progress"```
      */
-    status: 'pending' | 'in_progress' | 'interrupted' | 'completed';
+    status: 'pending' | 'in_progress' | 'interrupted' | 'completed' | 'failed';
     /**
      * List of related resources that should be included in the export (redundant when 'fields' are specified).
      * @example ```["prices.price_tiers"]```
@@ -16373,6 +16379,11 @@ interface Export extends Resource {
      * Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.
      */
     dry_data?: boolean | null;
+    /**
+     * Send this attribute to apply JWT scope–based sales channel filtering to the exported data.
+     * @example ```true```
+     */
+    jwt_filters?: boolean | null;
     /**
      * Time at which the export was started.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -16383,6 +16394,11 @@ interface Export extends Resource {
      * @example ```"2018-01-01T12:00:00.000Z"```
      */
     completed_at?: string | null;
+    /**
+     * Estimated time at which the export should complete (dynamically refres^hed).
+     * @example ```"2018-01-01T12:00:00.000Z"```
+     */
+    estimated_completion_at?: string | null;
     /**
      * Time at which the export was interrupted.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -16393,6 +16409,16 @@ interface Export extends Resource {
      * @example ```300```
      */
     records_count?: number | null;
+    /**
+     * Indicates how many records have been processed in real time.
+     * @example ```270```
+     */
+    processed_count?: number | null;
+    /**
+     * The percentage of progress of the export.
+     * @example ```30```
+     */
+    progress?: number | null;
     /**
      * The URL to the output file, which will be generated upon export completion.
      * @example ```"http://cl_exports.s3.amazonaws.com/"```
@@ -16437,8 +16463,18 @@ interface ExportCreate extends ResourceCreate {
      * Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.
      */
     dry_data?: boolean | null;
+    /**
+     * Send this attribute to apply JWT scope–based sales channel filtering to the exported data.
+     * @example ```true```
+     */
+    jwt_filters?: boolean | null;
 }
 interface ExportUpdate extends ResourceUpdate {
+    /**
+     * Send this attribute if you want to restart an 'interrupted' export.
+     * @example ```true```
+     */
+    _start?: boolean | null;
     /**
      * Send this attribute if you want to mark status as 'interrupted'.
      * @example ```true```
@@ -16453,6 +16489,7 @@ declare class Exports extends ApiResource<Export> {
     events(exportId: string | Export, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     versions(exportId: string | Export, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     event_stores(exportId: string | Export, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
+    _start(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
     _interrupt(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
     isExport(resource: any): resource is Export;
     relationship(id: string | ResourceId | null): ExportRel;
@@ -18234,7 +18271,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
 type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
 declare class CommerceLayerClient {
     #private;
-    readonly openApiSchemaVersion = "7.9.14";
+    readonly openApiSchemaVersion = "7.9.16";
     constructor(config: CommerceLayerInitConfig);
     get addresses(): Addresses;
     get adjustments(): Adjustments;

package/lib/index.d.ts

@@ -10946,6 +10946,11 @@ interface OrderUpdate extends ResourceUpdate {
      * @example ```true```
      */
     _refresh?: boolean | null;
+    /**
+     * Send this attribute if you want to refresh the prices of the line items associated to this order. Cannot be passed by sales channels.
+     * @example ```true```
+     */
+    _refresh_prices?: boolean | null;
     /**
      * Send this attribute if you want to trigger the external validation for the order.
      * @example ```true```
@@ -11067,6 +11072,7 @@ declare class Orders extends ApiResource<Order> {
     _save_shipping_address_to_customer_address_book(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _save_billing_address_to_customer_address_book(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _refresh(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
+    _refresh_prices(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _validate(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _create_subscriptions(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _start_editing(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
@@ -15554,7 +15560,7 @@ interface Application extends Resource {
      * The application's kind. One of 'sales_channel', 'integration', or 'webapp'.
      * @example ```"sales-channel"```
      */
-    kind?: 'dashboard' | 'user' | 'metrics' | 'contentful' | 'bundles' | 'customers' | 'datocms' | 'exports' | 'external' | 'generic' | 'gift_cards' | 'imports' | 'integration' | 'inventory' | 'orders' | 'price_lists' | 'promotions' | 'resources' | 'returns' | 'sales_channel' | 'sanity' | 'shipments' | 'skus' | 'sku_lists' | 'stock_transfers' | 'subscriptions' | 'tags' | 'webapp' | 'webhooks' | 'zapier' | null;
+    kind?: 'dashboard' | 'user' | 'contentful' | 'bundles' | 'customers' | 'datocms' | 'exports' | 'external' | 'generic' | 'gift_cards' | 'imports' | 'integration' | 'inventory' | 'metrics' | 'orders' | 'price_lists' | 'promotions' | 'resources' | 'returns' | 'sales_channel' | 'sanity' | 'shipments' | 'skus' | 'sku_lists' | 'stock_transfers' | 'subscriptions' | 'tags' | 'webapp' | 'webhooks' | 'zapier' | null;
     /**
      * Indicates if the application has public access.
      * @example ```true```
@@ -16336,7 +16342,7 @@ type ExportType = 'exports';
 type ExportRel = ResourceRel & {
     type: ExportType;
 };
-type ExportSort = Pick<Export, 'id' | 'resource_type' | 'format' | 'status' | 'started_at' | 'completed_at' | 'interrupted_at' | 'records_count' | 'attachment_url'> & ResourceSort;
+type ExportSort = Pick<Export, 'id' | 'resource_type' | 'format' | 'status' | 'started_at' | 'completed_at' | 'interrupted_at' | 'records_count' | 'processed_count' | 'attachment_url'> & ResourceSort;
 interface Export extends Resource {
     readonly type: ExportType;
     /**
@@ -16350,10 +16356,10 @@ interface Export extends Resource {
      */
     format?: string | null;
     /**
-     * The export job status. One of 'pending' (default), 'in_progress', 'interrupted', or 'completed'.
+     * The export job status. One of 'pending' (default), 'in_progress', 'interrupted', 'completed', or 'failed'.
      * @example ```"in_progress"```
      */
-    status: 'pending' | 'in_progress' | 'interrupted' | 'completed';
+    status: 'pending' | 'in_progress' | 'interrupted' | 'completed' | 'failed';
     /**
      * List of related resources that should be included in the export (redundant when 'fields' are specified).
      * @example ```["prices.price_tiers"]```
@@ -16373,6 +16379,11 @@ interface Export extends Resource {
      * Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.
      */
     dry_data?: boolean | null;
+    /**
+     * Send this attribute to apply JWT scope–based sales channel filtering to the exported data.
+     * @example ```true```
+     */
+    jwt_filters?: boolean | null;
     /**
      * Time at which the export was started.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -16383,6 +16394,11 @@ interface Export extends Resource {
      * @example ```"2018-01-01T12:00:00.000Z"```
      */
     completed_at?: string | null;
+    /**
+     * Estimated time at which the export should complete (dynamically refres^hed).
+     * @example ```"2018-01-01T12:00:00.000Z"```
+     */
+    estimated_completion_at?: string | null;
     /**
      * Time at which the export was interrupted.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -16393,6 +16409,16 @@ interface Export extends Resource {
      * @example ```300```
      */
     records_count?: number | null;
+    /**
+     * Indicates how many records have been processed in real time.
+     * @example ```270```
+     */
+    processed_count?: number | null;
+    /**
+     * The percentage of progress of the export.
+     * @example ```30```
+     */
+    progress?: number | null;
     /**
      * The URL to the output file, which will be generated upon export completion.
      * @example ```"http://cl_exports.s3.amazonaws.com/"```
@@ -16437,8 +16463,18 @@ interface ExportCreate extends ResourceCreate {
      * Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.
      */
     dry_data?: boolean | null;
+    /**
+     * Send this attribute to apply JWT scope–based sales channel filtering to the exported data.
+     * @example ```true```
+     */
+    jwt_filters?: boolean | null;
 }
 interface ExportUpdate extends ResourceUpdate {
+    /**
+     * Send this attribute if you want to restart an 'interrupted' export.
+     * @example ```true```
+     */
+    _start?: boolean | null;
     /**
      * Send this attribute if you want to mark status as 'interrupted'.
      * @example ```true```
@@ -16453,6 +16489,7 @@ declare class Exports extends ApiResource<Export> {
     events(exportId: string | Export, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     versions(exportId: string | Export, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     event_stores(exportId: string | Export, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
+    _start(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
     _interrupt(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
     isExport(resource: any): resource is Export;
     relationship(id: string | ResourceId | null): ExportRel;
@@ -18234,7 +18271,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
 type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
 declare class CommerceLayerClient {
     #private;
-    readonly openApiSchemaVersion = "7.9.14";
+    readonly openApiSchemaVersion = "7.9.16";
     constructor(config: CommerceLayerInitConfig);
     get addresses(): Addresses;
     get adjustments(): Adjustments;