@imtbl/sdk 1.5.0 → 1.5.2

package/dist/index.d.ts

@@ -30092,7 +30092,7 @@ type SellResultInsufficientFunds = {
     /** The insufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutInsufficient;
 };
-type CancelResult = CancelResultSuccess | CancelResultFailed | CancelResultFulfillmentsUnsettled;
+type CancelResult = CancelResultSuccess | CancelResultFailed | CancelResultFulfillmentsUnsettled | CancelResultGasless;
 /**
  * Represents the result of {@link Checkout.cancel}
  * @property {CheckoutStatus.SUCCESS} status
@@ -30121,18 +30121,58 @@ type CancelResultFailed = {
  * @property {SendTransactionResult[]} transactions
  */
 type CancelResultFulfillmentsUnsettled = {
-    /** The status to indicate success */
+    /** The status to indicate the fulfillments have not yet settled on chain. */
     status: CheckoutStatus.FULFILLMENTS_UNSETTLED;
     /** Array of transaction results */
     transactions: TransactionResponse[];
 };
+/**
+ * Represents the result of {@link Checkout.cancel} when using gasless cancel
+ * @property {SuccessfulGaslessCancellation[]} successfulCancellations
+ * @property {FailedGaslessCancellation[]} failedCancellations
+ * @property {PendingGaslessCancellation[]} pendingCancellations
+ */
+type CancelResultGasless = {
+    successfulCancellations: SuccessfulGaslessCancellation[];
+    failedCancellations: FailedGaslessCancellation[];
+    pendingCancellations: PendingGaslessCancellation[];
+};
+/**
+ * Represents a successful gasless cancellation
+ * @property {string} orderId
+ */
+type SuccessfulGaslessCancellation = {
+    /** The order id of the successful cancellation */
+    orderId: string;
+};
+/**
+ * Represents a failed gasless cancellation
+ * @property {string} orderId
+ * @property {string} reason
+ */
+type FailedGaslessCancellation = {
+    /** The order id of the failed cancellation */
+    orderId: string;
+    /** The reason for failure */
+    reason: string;
+};
+/**
+ * Represents a pending gasless cancellation
+ * @property {string} orderId
+ */
+type PendingGaslessCancellation = {
+    /** The order id of the pending cancellation */
+    orderId: string;
+};
 /**
  * Represents the overrides available for {@link Checkout.cancel}
  * @property {boolean} waitFulfillmentSettlements
  */
 type CancelOverrides = {
-    /** If the buy should wait for the fulfillment transactions to settle */
+    /** If the cancel should wait for the fulfillment transactions to settle */
     waitFulfillmentSettlements?: boolean;
+    /** If the cancel should use the gasless option */
+    useGaslessCancel?: boolean;
 };
 /**
  * An enum representing the checkout status types
@@ -30151,7 +30191,7 @@ declare enum CheckoutStatus {
 /**
  * The type representing the order to buy
  * @property {string} orderId
- * @property {Array<OrderFee>} takerFees
+ * @property {OrderFee[]} takerFees
  */
 type BuyOrder = {
     /** the id of the order to buy */
@@ -32496,6 +32536,7 @@ type checkout_d_CancelParams = CancelParams;
 type checkout_d_CancelResult = CancelResult;
 type checkout_d_CancelResultFailed = CancelResultFailed;
 type checkout_d_CancelResultFulfillmentsUnsettled = CancelResultFulfillmentsUnsettled;
+type checkout_d_CancelResultGasless = CancelResultGasless;
 type checkout_d_CancelResultSuccess = CancelResultSuccess;
 type checkout_d_ChainId = ChainId;
 declare const checkout_d_ChainId: typeof ChainId;
@@ -32537,6 +32578,7 @@ type checkout_d_ERC721ItemRequirement = ERC721ItemRequirement;
 type checkout_d_ErrorType = ErrorType;
 type checkout_d_ExchangeType = ExchangeType;
 declare const checkout_d_ExchangeType: typeof ExchangeType;
+type checkout_d_FailedGaslessCancellation = FailedGaslessCancellation;
 type checkout_d_Fee = Fee;
 type checkout_d_FeePercentage = FeePercentage;
 type checkout_d_FeeToken = FeeToken;
@@ -32599,6 +32641,7 @@ type checkout_d_OrchestrationEventData = OrchestrationEventData;
 type checkout_d_OrchestrationEventType = OrchestrationEventType;
 declare const checkout_d_OrchestrationEventType: typeof OrchestrationEventType;
 type checkout_d_OrderFee = OrderFee;
+type checkout_d_PendingGaslessCancellation = PendingGaslessCancellation;
 type checkout_d_ProviderEvent<KEventName extends keyof ProviderEventMapping> = ProviderEvent<KEventName>;
 type checkout_d_ProviderEventType = ProviderEventType;
 declare const checkout_d_ProviderEventType: typeof ProviderEventType;
@@ -32639,6 +32682,7 @@ type checkout_d_SmartCheckoutParams = SmartCheckoutParams;
 type checkout_d_SmartCheckoutResult = SmartCheckoutResult;
 type checkout_d_SmartCheckoutRouter = SmartCheckoutRouter;
 type checkout_d_SmartCheckoutSufficient = SmartCheckoutSufficient;
+type checkout_d_SuccessfulGaslessCancellation = SuccessfulGaslessCancellation;
 type checkout_d_SwapEventType = SwapEventType;
 declare const checkout_d_SwapEventType: typeof SwapEventType;
 type checkout_d_SwapFailed = SwapFailed;
@@ -32711,6 +32755,7 @@ declare namespace checkout_d {
     checkout_d_CancelResult as CancelResult,
     checkout_d_CancelResultFailed as CancelResultFailed,
     checkout_d_CancelResultFulfillmentsUnsettled as CancelResultFulfillmentsUnsettled,
+    checkout_d_CancelResultGasless as CancelResultGasless,
     checkout_d_CancelResultSuccess as CancelResultSuccess,
     checkout_d_ChainId as ChainId,
     checkout_d_ChainName as ChainName,
@@ -32742,6 +32787,7 @@ declare namespace checkout_d {
     checkout_d_ERC721ItemRequirement as ERC721ItemRequirement,
     checkout_d_ErrorType as ErrorType,
     checkout_d_ExchangeType as ExchangeType,
+    checkout_d_FailedGaslessCancellation as FailedGaslessCancellation,
     checkout_d_Fee as Fee,
     checkout_d_FeePercentage as FeePercentage,
     checkout_d_FeeToken as FeeToken,
@@ -32795,6 +32841,7 @@ declare namespace checkout_d {
     checkout_d_OrchestrationEventData as OrchestrationEventData,
     checkout_d_OrchestrationEventType as OrchestrationEventType,
     checkout_d_OrderFee as OrderFee,
+    checkout_d_PendingGaslessCancellation as PendingGaslessCancellation,
     checkout_d_ProviderEvent as ProviderEvent,
     checkout_d_ProviderEventType as ProviderEventType,
     checkout_d_ProviderUpdated as ProviderUpdated,
@@ -32831,6 +32878,7 @@ declare namespace checkout_d {
     checkout_d_SmartCheckoutResult as SmartCheckoutResult,
     checkout_d_SmartCheckoutRouter as SmartCheckoutRouter,
     checkout_d_SmartCheckoutSufficient as SmartCheckoutSufficient,
+    checkout_d_SuccessfulGaslessCancellation as SuccessfulGaslessCancellation,
     checkout_d_SwapEventType as SwapEventType,
     checkout_d_SwapFailed as SwapFailed,
     checkout_d_SwapFundingStep as SwapFundingStep,