@onbeam/automation-api-client - npm Package Compare versions

Comparing version 2.0.1 to 2.0.2

dist/index.d.ts

@@ -261,2 +261,72 @@ type ApiRequestOptions = {
 
+type TransactionResponse = {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    chainId: number;
+    intent: {
+        interactions?: Array<{
+            to?: string;
+            value?: string;
+            contract?: string;
+            functionName?: string;
+            functionArgs?: Array<any>;
+        }> | null;
+        hash?: string | null;
+    };
+    /**
+     * The transaction object exists if you created the transaction deterministically and contains information about the on-chain transaction
+     */
+    transaction?: {
+        createdAt: string;
+        blockNumber?: number;
+        hash?: string;
+        gasUsed?: string;
+        gasFee?: string;
+        status?: number;
+        logs?: Array<{
+            blockNumber: number;
+            blockHash: string;
+            transactionIndex: number;
+            removed: boolean;
+            address: string;
+            data: string;
+            topics: Array<string>;
+            transactionHash: string;
+            logIndex: number;
+            orphaned?: boolean | null;
+        }>;
+    } | null;
+    /**
+     * Policy information related to the transaction
+     */
+    policy: {
+        id?: string | null;
+    };
+    /**
+     * Profile and wallet information related to the transaction
+     */
+    profile: {
+        id?: string | null;
+        wallet: {
+            address: string;
+        };
+    };
+    status: TransactionResponse.status;
+    type: TransactionResponse.type;
+    transactionHash?: string;
+    explorerUrl: string;
+    success: boolean;
+};
+declare namespace TransactionResponse {
+    enum status {
+        PENDING = "pending",
+        SUCCESS = "success"
+    }
+    enum type {
+        CUSTODIAL = "custodial",
+        SELF_CUSTODIAL = "self-custodial"
+    }
+}
+
 type TransferAssetRequestInputV2 = {
@@ -276,20 +346,2 @@ assets: Array<{
 
-type TransferAssetResponseV2 = {
-    status: TransferAssetResponseV2.status;
-    type: TransferAssetResponseV2.type;
-    payloadToSign?: string;
-    transactionHash?: string;
-    explorerUrl?: string;
-};
-declare namespace TransferAssetResponseV2 {
-    enum status {
-        PENDING = "pending",
-        SUCCESS = "success"
-    }
-    enum type {
-        CUSTODIAL = "custodial",
-        SELF_CUSTODIAL = "self-custodial"
-    }
-}
-
 type TransferNativeTokenRequestInputV2 = {
@@ -316,20 +368,2 @@ receiverEntityId?: string;
 
-type TransferTokenResponseV2 = {
-    status: TransferTokenResponseV2.status;
-    type: TransferTokenResponseV2.type;
-    payloadToSign?: string;
-    transactionHash?: string;
-    explorerUrl?: string;
-};
-declare namespace TransferTokenResponseV2 {
-    enum status {
-        PENDING = "pending",
-        SUCCESS = "success"
-    }
-    enum type {
-        CUSTODIAL = "custodial",
-        SELF_CUSTODIAL = "self-custodial"
-    }
-}
-
 declare class AssetsV2Service {
@@ -366,6 +400,6 @@ readonly httpRequest: BaseHttpRequest;
      * @param requestBody
-     * @returns TransferAssetResponseV2
+     * @returns TransactionResponse
      * @throws ApiError
      */
-    transferAssetV2(entityId: string, requestBody: TransferAssetRequestInputV2): CancelablePromise<TransferAssetResponseV2>;
+    transferAssetV2(entityId: string, requestBody: TransferAssetRequestInputV2): CancelablePromise<TransactionResponse>;
     /**
@@ -375,6 +409,6 @@ * Transfer a token (token assets, ERC20)
      * @param requestBody
-     * @returns TransferTokenResponseV2
+     * @returns TransactionResponse
      * @throws ApiError
      */
-    transferTokenV2(entityId: string, requestBody: TransferTokenRequestInputV2): CancelablePromise<TransferTokenResponseV2>;
+    transferTokenV2(entityId: string, requestBody: TransferTokenRequestInputV2): CancelablePromise<TransactionResponse>;
     /**
@@ -384,6 +418,6 @@ * Transfer the native token
      * @param requestBody
-     * @returns TransferTokenResponseV2
+     * @returns TransactionResponse
      * @throws ApiError
      */
-    transferNativeTokenV2(entityId: string, requestBody: TransferNativeTokenRequestInputV2): CancelablePromise<TransferTokenResponseV2>;
+    transferNativeTokenV2(entityId: string, requestBody: TransferNativeTokenRequestInputV2): CancelablePromise<TransactionResponse>;
     /**
@@ -468,19 +502,2 @@ * Get all the assets of contract (NFT assets, e.g. ERC721 / ERC1155)
 
-type ConvertTokenResponse = {
-    status: ConvertTokenResponse.status;
-    type: ConvertTokenResponse.type;
-    transactionHash?: string;
-    explorerUrl?: string;
-};
-declare namespace ConvertTokenResponse {
-    enum status {
-        PENDING = "pending",
-        SUCCESS = "success"
-    }
-    enum type {
-        CUSTODIAL = "custodial",
-        SELF_CUSTODIAL = "self-custodial"
-    }
-}
-
 type GetQuoteResponse = {
@@ -520,6 +537,6 @@ tokenIn: string;
      * @param requestBody
-     * @returns ConvertTokenResponse
+     * @returns TransactionResponse
      * @throws ApiError
      */
-    convertInput(entityId: string, requestBody: ConvertTokenRequestInput): CancelablePromise<ConvertTokenResponse>;
+    convertInput(entityId: string, requestBody: ConvertTokenRequestInput): CancelablePromise<TransactionResponse>;
     /**
@@ -529,6 +546,6 @@ * Swap a maximum amount of `tokenIn` for an exact amount of `tokenOut`
      * @param requestBody
-     * @returns ConvertTokenResponse
+     * @returns TransactionResponse
      * @throws ApiError
      */
-    convertToOutput(entityId: string, requestBody: ConvertTokenRequestInput): CancelablePromise<ConvertTokenResponse>;
+    convertToOutput(entityId: string, requestBody: ConvertTokenRequestInput): CancelablePromise<TransactionResponse>;
 }
@@ -815,8 +832,2 @@
 
-type AcceptOfferResponseV2 = {
-    success: boolean;
-    transactionHash?: string;
-    explorerUrl?: string;
-};
-
 type BuyAssetRequestInputV2 = {
@@ -830,8 +841,2 @@ quantity: number;
 
-type BuyAssetResponseV2 = {
-    success: boolean;
-    transactionHash?: string;
-    explorerUrl?: string;
-};
-
 type CancelAssetListingRequestInputV2 = {
@@ -843,6 +848,2 @@ optimistic?: boolean;
 
-type CancelAssetListingResponseV2 = {
-    success: boolean;
-};
-
 type CancelAssetOfferRequestInputV2 = {
@@ -856,8 +857,2 @@ optimistic?: boolean;
 
-type CancelOfferResponseV2 = {
-    success: boolean;
-    transactionHash?: string;
-    explorerUrl?: string;
-};
-
 type CreateAssetOfferRequestInputV2 = {
@@ -1040,6 +1035,6 @@ assetAddress: string;
      * @param requestBody
-     * @returns BuyAssetResponseV2
+     * @returns TransactionResponse
      * @throws ApiError
      */
-    buyListedAssetV2(entityId: string, orderId: string, requestBody: BuyAssetRequestInputV2): CancelablePromise<BuyAssetResponseV2>;
+    buyListedAssetV2(entityId: string, orderId: string, requestBody: BuyAssetRequestInputV2): CancelablePromise<TransactionResponse>;
     /**
@@ -1051,6 +1046,6 @@ * Cancel asset listing
      * @param chainId
-     * @returns CancelAssetListingResponseV2
+     * @returns TransactionResponse
      * @throws ApiError
      */
-    cancelListingV2(entityId: string, orderId: string, requestBody: CancelAssetListingRequestInputV2, chainId?: number): CancelablePromise<CancelAssetListingResponseV2>;
+    cancelListingV2(entityId: string, orderId: string, requestBody: CancelAssetListingRequestInputV2, chainId?: number): CancelablePromise<TransactionResponse>;
     /**
@@ -1089,6 +1084,6 @@ * Make an offer for an asset
      * @param requestBody
-     * @returns AcceptOfferResponseV2
+     * @returns TransactionResponse
      * @throws ApiError
      */
-    acceptAssetOfferV2(entityId: string, offerId: string, requestBody: AcceptAssetOfferRequestInputV2): CancelablePromise<AcceptOfferResponseV2>;
+    acceptAssetOfferV2(entityId: string, offerId: string, requestBody: AcceptAssetOfferRequestInputV2): CancelablePromise<TransactionResponse>;
     /**
@@ -1099,6 +1094,6 @@ * Cancel an offer for an asset
      * @param requestBody
-     * @returns CancelOfferResponseV2
+     * @returns TransactionResponse
      * @throws ApiError
      */
-    cancelAssetOfferV2(entityId: string, offerId: string, requestBody: CancelAssetOfferRequestInputV2): CancelablePromise<CancelOfferResponseV2>;
+    cancelAssetOfferV2(entityId: string, offerId: string, requestBody: CancelAssetOfferRequestInputV2): CancelablePromise<TransactionResponse>;
     /**
@@ -1551,19 +1546,2 @@ * Get all offers for an asset
 
-type TradeTokensResponse = {
-    status: TradeTokensResponse.status;
-    type: TradeTokensResponse.type;
-    transactionHash?: string;
-    explorerUrl?: string;
-};
-declare namespace TradeTokensResponse {
-    enum status {
-        PENDING = "pending",
-        SUCCESS = "success"
-    }
-    enum type {
-        CUSTODIAL = "custodial",
-        SELF_CUSTODIAL = "self-custodial"
-    }
-}
-
 declare class TradingService {
@@ -1574,118 +1552,8 @@ readonly httpRequest: BaseHttpRequest;
      * @param requestBody
-     * @returns TradeTokensResponse
+     * @returns TransactionResponse
      * @throws ApiError
      */
-    tradeAssets(requestBody: TradeTokensRequestInput): CancelablePromise<TradeTokensResponse>;
+    tradeAssets(requestBody: TradeTokensRequestInput): CancelablePromise<TransactionResponse>;
 }
 
-type CreateTransactionResponseV2 = {
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    chainId: number;
-    intent: {
-        interactions?: Array<{
-            to?: string;
-            value?: string;
-            contract?: string;
-            functionName?: string;
-            functionArgs?: Array<any>;
-        }> | null;
-        hash?: string | null;
-    };
-    /**
-     * The transaction object exists if you created the transaction deterministically and contains information about the on-chain transaction
-     */
-    transaction?: {
-        createdAt: string;
-        blockNumber?: number;
-        hash?: string;
-        gasUsed?: string;
-        gasFee?: string;
-        status?: number;
-        logs?: Array<{
-            blockNumber: number;
-            blockHash: string;
-            transactionIndex: number;
-            removed: boolean;
-            address: string;
-            data: string;
-            topics: Array<string>;
-            transactionHash: string;
-            logIndex: number;
-            orphaned?: boolean | null;
-        }>;
-    } | null;
-    /**
-     * Policy information related to the transaction
-     */
-    policy: {
-        id?: string | null;
-    };
-    /**
-     * Profile and wallet information related to the transaction
-     */
-    profile: {
-        id?: string | null;
-        wallet: {
-            address: string;
-        };
-    };
-};
-
-type GetTransactionResponseV2 = {
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    chainId: number;
-    intent: {
-        interactions?: Array<{
-            to?: string;
-            value?: string;
-            contract?: string;
-            functionName?: string;
-            functionArgs?: Array<any>;
-        }> | null;
-        hash?: string | null;
-    };
-    /**
-     * The transaction object exists if you created the transaction deterministically and contains information about the on-chain transaction
-     */
-    transaction?: {
-        createdAt: string;
-        blockNumber?: number;
-        hash?: string;
-        gasUsed?: string;
-        gasFee?: string;
-        status?: number;
-        logs?: Array<{
-            blockNumber: number;
-            blockHash: string;
-            transactionIndex: number;
-            removed: boolean;
-            address: string;
-            data: string;
-            topics: Array<string>;
-            transactionHash: string;
-            logIndex: number;
-            orphaned?: boolean | null;
-        }>;
-    } | null;
-    /**
-     * Policy information related to the transaction
-     */
-    policy: {
-        id?: string | null;
-    };
-    /**
-     * Profile and wallet information related to the transaction
-     */
-    profile: {
-        id?: string | null;
-        wallet: {
-            address: string;
-        };
-    };
-};
-
 type GetTransactionsResponseV2 = {
@@ -1752,6 +1620,6 @@ data: Array<{
      * @param transactionId
-     * @returns GetTransactionResponseV2
+     * @returns TransactionResponse
      * @throws ApiError
      */
-    getTransactionV2(transactionId: string): CancelablePromise<GetTransactionResponseV2>;
+    getTransactionV2(transactionId: string): CancelablePromise<TransactionResponse>;
     /**
@@ -1770,6 +1638,6 @@ * Get a paginated list of transactions created on behalf of a profile
      * @param requestBody
-     * @returns CreateTransactionResponseV2
+     * @returns TransactionResponse
      * @throws ApiError
      */
-    createProfileTransactionV2(entityId: string, requestBody: CreateTransactionRequestInputV2): CancelablePromise<CreateTransactionResponseV2>;
+    createProfileTransactionV2(entityId: string, requestBody: CreateTransactionRequestInputV2): CancelablePromise<TransactionResponse>;
 }
@@ -1816,2 +1684,3 @@
     /**
+     * @deprecated
      * Get webhooks registered by your game
@@ -1823,2 +1692,3 @@ * @returns GetWebhooksForGameResponse List of webhooks registered for your game
     /**
+     * @deprecated
      * Create webhook for your game
@@ -1831,2 +1701,3 @@ * @param requestBody
     /**
+     * @deprecated
      * Delete webhook from your game
@@ -1866,2 +1737,2 @@ * @param webhookId
 
-export { type AcceptAssetOfferRequestInputV2, type AcceptOfferResponseV2, AddContractRequestInput, AddContractResponse, Beam, type BuyAssetRequestInputV2, type BuyAssetResponseV2, type CancelAssetListingRequestInputV2, type CancelAssetListingResponseV2, type CancelAssetOfferRequestInputV2, type CancelOfferResponseV2, type CommonActivityRequestInput, type CommonActivityResponse, CommonAddPolicyRequestInput, CommonAddPolicyResponse, type CommonGetPoliciesResponse, type CommonRemovePolicyResponse, type CommonStatsRequestInput, type CommonStatsResponse, type ConvertTokenRequestInput, ConvertTokenResponse, CreateAssetOfferRequestInputV2, type CreateOfferResponseV2, type CreateProfileRequestInput, type CreateProfileResponse, type CreateTransactionRequestInputV2, type CreateTransactionResponseV2, type CreateWebhookForGame, type GenerateLinkCodeRequestInput, type GenerateLinkCodeResponse, type GenerateSignInCodeRequestInput, type GenerateSignInCodeResponse, type GetAllGasUsageResponse, type GetAllProfilesResponse, type GetAssetListingsResponseV2, GetAssetResponseV2, GetAssetsForContractBodyInputV2, type GetAssetsForContractResponseV2, GetAssetsForProfileBodyInputV2, type GetAssetsForProfileResponseV2, type GetChainCurrenciesResponseV2, type GetChainResponse, type GetEstimateResponse, GetGameResponse, type GetGasUsageResponse, GetListedAssetsBodyInputV2, GetPolicyUsageResponse, type GetProfileCurrenciesResponseV2, type GetProfileNativeCurrencyResponseV2, type GetProfileResponse, type GetQuoteResponse, type GetTransactionResponseV2, type GetTransactionsResponseV2, type GetWebhooksForGameResponse, type RefreshContractRequestBody, type RefreshTokenRequestBody, RegenerateGameApiKeysResponse, type RemoveContractResponse, SellAssetRequestInputV2, type SellAssetResponseV2, type TradeTokensRequestInput, TradeTokensResponse, type TransferAssetRequestInputV2, TransferAssetResponseV2, type TransferNativeTokenRequestInputV2, type TransferTokenRequestInputV2, TransferTokenResponseV2, UpdateGameRequestInput, UpdateGameResponse, type UpdateProfileRequestInput, type UpdateProfileResponse, type WebhookForGameResponse, Beam as default };
+export { type AcceptAssetOfferRequestInputV2, AddContractRequestInput, AddContractResponse, Beam, type BuyAssetRequestInputV2, type CancelAssetListingRequestInputV2, type CancelAssetOfferRequestInputV2, type CommonActivityRequestInput, type CommonActivityResponse, CommonAddPolicyRequestInput, CommonAddPolicyResponse, type CommonGetPoliciesResponse, type CommonRemovePolicyResponse, type CommonStatsRequestInput, type CommonStatsResponse, type ConvertTokenRequestInput, CreateAssetOfferRequestInputV2, type CreateOfferResponseV2, type CreateProfileRequestInput, type CreateProfileResponse, type CreateTransactionRequestInputV2, type CreateWebhookForGame, type GenerateLinkCodeRequestInput, type GenerateLinkCodeResponse, type GenerateSignInCodeRequestInput, type GenerateSignInCodeResponse, type GetAllGasUsageResponse, type GetAllProfilesResponse, type GetAssetListingsResponseV2, GetAssetResponseV2, GetAssetsForContractBodyInputV2, type GetAssetsForContractResponseV2, GetAssetsForProfileBodyInputV2, type GetAssetsForProfileResponseV2, type GetChainCurrenciesResponseV2, type GetChainResponse, type GetEstimateResponse, GetGameResponse, type GetGasUsageResponse, GetListedAssetsBodyInputV2, GetPolicyUsageResponse, type GetProfileCurrenciesResponseV2, type GetProfileNativeCurrencyResponseV2, type GetProfileResponse, type GetQuoteResponse, type GetTransactionsResponseV2, type GetWebhooksForGameResponse, type RefreshContractRequestBody, type RefreshTokenRequestBody, RegenerateGameApiKeysResponse, type RemoveContractResponse, SellAssetRequestInputV2, type SellAssetResponseV2, type TradeTokensRequestInput, TransactionResponse, type TransferAssetRequestInputV2, type TransferNativeTokenRequestInputV2, type TransferTokenRequestInputV2, UpdateGameRequestInput, UpdateGameResponse, type UpdateProfileRequestInput, type UpdateProfileResponse, type WebhookForGameResponse, Beam as default };

dist/index.js

@@ -527,3 +527,3 @@ var __accessCheck = (obj, member, msg) => {
    * @param requestBody
-   * @returns TransferAssetResponseV2
+   * @returns TransactionResponse
    * @throws ApiError
@@ -546,3 +546,3 @@ */
    * @param requestBody
-   * @returns TransferTokenResponseV2
+   * @returns TransactionResponse
    * @throws ApiError
@@ -565,3 +565,3 @@ */
    * @param requestBody
-   * @returns TransferTokenResponseV2
+   * @returns TransactionResponse
    * @throws ApiError
@@ -715,3 +715,3 @@ */
    * @param requestBody
-   * @returns ConvertTokenResponse
+   * @returns TransactionResponse
    * @throws ApiError
@@ -734,3 +734,3 @@ */
    * @param requestBody
-   * @returns ConvertTokenResponse
+   * @returns TransactionResponse
    * @throws ApiError
@@ -905,3 +905,3 @@ */
    * @param requestBody
-   * @returns BuyAssetResponseV2
+   * @returns TransactionResponse
    * @throws ApiError
@@ -927,3 +927,3 @@ */
    * @param chainId
-   * @returns CancelAssetListingResponseV2
+   * @returns TransactionResponse
    * @throws ApiError
@@ -1015,3 +1015,3 @@ */
    * @param requestBody
-   * @returns AcceptOfferResponseV2
+   * @returns TransactionResponse
    * @throws ApiError
@@ -1036,3 +1036,3 @@ */
    * @param requestBody
-   * @returns CancelOfferResponseV2
+   * @returns TransactionResponse
    * @throws ApiError
@@ -1376,3 +1376,3 @@ */
    * @param requestBody
-   * @returns TradeTokensResponse
+   * @returns TransactionResponse
    * @throws ApiError
@@ -1415,3 +1415,3 @@ */
    * @param transactionId
-   * @returns GetTransactionResponseV2
+   * @returns TransactionResponse
    * @throws ApiError
@@ -1453,3 +1453,3 @@ */
    * @param requestBody
-   * @returns CreateTransactionResponseV2
+   * @returns TransactionResponse
    * @throws ApiError
@@ -1476,2 +1476,3 @@ */
   /**
+   * @deprecated
    * Get webhooks registered by your game
@@ -1488,2 +1489,3 @@ * @returns GetWebhooksForGameResponse List of webhooks registered for your game
   /**
+   * @deprecated
    * Create webhook for your game
@@ -1503,2 +1505,3 @@ * @param requestBody
   /**
+   * @deprecated
    * Delete webhook from your game
@@ -1505,0 +1508,0 @@ * @param webhookId

package.json

@@ -26,3 +26,3 @@ {
   },
-  "version": "2.0.1",
+  "version": "2.0.2",
   "scripts": {
@@ -29,0 +29,0 @@ "generate": "pnpm generate:client && pnpm generate:barrels && pnpm build",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

783661

decreased by-0.84%

Lines of code

21617

decreased by-0.52%

No dependency changes