[AUTOMATED] Update: docs/pages/api/**/*.gen.yaml

0xsequence · Oct 28, 2024 · c266dff · c266dff
1 parent b939049
commit c266dff
Show file tree

Hide file tree

Showing 3 changed files with 1,473 additions and 52 deletions.
diff --git a/docs/pages/api/indexer/indexer.gen.yaml b/docs/pages/api/indexer/indexer.gen.yaml
@@ -89,7 +89,8 @@ components:
       type: apiKey
       in: header
       description: >-
-        Project access key for authenticating requests, get an access key at https://sequence.build
+        Project access key for authenticating requests, get an access key at
+        https://sequence.build
       name: X-Access-Key
   schemas:
     ErrorWebrpcEndpoint:
@@ -2112,7 +2113,8 @@ paths:
       summary: GetEtherBalance
       deprecated: true
       description: >-
-        Queries an ethereum node for the latest and confirm ETH balances DEPRECATED: use GetNativeTokenBalance instead
+        Queries an ethereum node for the latest and confirm ETH balances
+        DEPRECATED: use GetNativeTokenBalance instead
       requestBody:
         content:
           application/json:
@@ -2177,7 +2179,10 @@ paths:
     post:
       summary: GetNativeTokenBalance
       description: >-
-        GetNativeTokenBalance queries an ethereum node for the latest native token account balance. The native token is the token of the chain the indexer is connected to, for example, ETH on Ethereum and POL on Polygon.
+        GetNativeTokenBalance queries an ethereum node for the latest native
+        token account balance. The native token is the token of the chain the
+        indexer is connected to, for example, ETH on Ethereum and POL on
+        Polygon.
       requestBody:
         content:
           application/json:
@@ -2230,11 +2235,15 @@ paths:
     post:
       summary: GetTokenBalancesSummary
       description: >-
-        GetTokenBalancesSummary returns a summary of token balances for a specific accounts. The collection ERC721 & ERC1155 tokens are represented as a single aggregated balance.
+        GetTokenBalancesSummary returns a summary of token balances for a
+        specific accounts. The collection ERC721 & ERC1155 tokens are
+        represented as a single aggregated balance.
 
-        If `filter` is not provided, it will use the filter with account from the jwt session.
+        If `filter` is not provided, it will use the filter with account from
+        the jwt session.
 
-        If `filter.contractStatus` is not provided, it will include verified only tokens.
+        If `filter.contractStatus` is not provided, it will include verified
+        only tokens.
       requestBody:
         content:
           application/json:
@@ -2287,11 +2296,15 @@ paths:
     post:
       summary: GetTokenBalancesDetails
       description: >-
-        GetTokenBalancesDetails returns a detailed balance summary for a specific accounts. The collection ERC721 & ERC1155 tokens are represented as individual balances.
+        GetTokenBalancesDetails returns a detailed balance summary for a
+        specific accounts. The collection ERC721 & ERC1155 tokens are
+        represented as individual balances.
 
-        If `filter` is not provided, it will use the filter with account from the jwt session.
+        If `filter` is not provided, it will use the filter with account from
+        the jwt session.
 
-        If `filter.contractStatus` is not provided, it will include verified only tokens.
+        If `filter.contractStatus` is not provided, it will include verified
+        only tokens.
       requestBody:
         content:
           application/json:
@@ -2344,11 +2357,15 @@ paths:
     post:
       summary: GetTokenBalancesByContract
       description: >-
-        GetTokenBalancesByContract returns a balances for a specific accounts and contracts. The collection ERC721 & ERC1155 tokens are represented as individual balances.
+        GetTokenBalancesByContract returns a balances for a specific accounts
+        and contracts. The collection ERC721 & ERC1155 tokens are represented as
+        individual balances.
 
-        If `filter` is not provided, it will error out as it requires at least contract address.
+        If `filter` is not provided, it will error out as it requires at least
+        contract address.
 
-        If `filter.contractStatus` is not provided, it will include verified only tokens.
+        If `filter.contractStatus` is not provided, it will include verified
+        only tokens.
       requestBody:
         content:
           application/json:
@@ -2402,9 +2419,15 @@ paths:
     post:
       summary: GetTokenBalances
       description: >-
-        GetTokenBalances returns a balance summary/details for a specific account. By default if accountAddress is left empty, it will use the account from the jwt session.
+        GetTokenBalances returns a balance summary/details for a specific
+        account. By default if accountAddress is left empty, it will use the
+        account from the jwt session.
 
-        Also, if contractAddress is undefined, then it will list all current user coins/collectibles. But, if contractAddress is provided, then it will return the token balances for the contract, this is only useful for 1155, but for other tokens, it can act as a filter for the single balance.
+        Also, if contractAddress is undefined, then it will list all current
+        user coins/collectibles. But, if contractAddress is provided, then it
+        will return the token balances for the contract, this is only useful for
+        1155, but for other tokens, it can act as a filter for the single
+        balance.
       requestBody:
         content:
           application/json:
@@ -2457,7 +2480,9 @@ paths:
     post:
       summary: GetTokenSupplies
       description: >-
-        GetTokenSupplies returns the set of tokenIDs used by a contract address, supporting ERC-20, ERC-721, and ERC-1155 contracts, and their respective supply as well.
+        GetTokenSupplies returns the set of tokenIDs used by a contract address,
+        supporting ERC-20, ERC-721, and ERC-1155 contracts, and their respective
+        supply as well.
       requestBody:
         content:
           application/json:
@@ -2527,9 +2552,13 @@ paths:
     post:
       summary: GetTokenSuppliesMap
       description: >-
-        GetTokenSuppliesMap returns the token supplies of ERC-20 and ERC-1155 tokens as requested in the `tokenMap` represented as a map of contractAddress :: []tokenIDs.
+        GetTokenSuppliesMap returns the token supplies of ERC-20 and ERC-1155
+        tokens as requested in the `tokenMap` represented as a map of
+        contractAddress :: []tokenIDs.
 
-        For an ERC-20 specify tokenIDs as an empty array or [0], for example, { '0xdef': [] } or { '0xdef': [0] } For ERC-1155 pass the array of tokens are strings, ie. { '0xabc': ['1', '2', '3'] }
+        For an ERC-20 specify tokenIDs as an empty array or [0], for example, {
+        '0xdef': [] } or { '0xdef': [0] } For ERC-1155 pass the array of tokens
+        are strings, ie. { '0xabc': ['1', '2', '3'] }
       requestBody:
         content:
           application/json:
@@ -2582,7 +2611,8 @@ paths:
     post:
       summary: GetBalanceUpdates
       description: >-
-        Get balance update aggregate values -- useful for syncing balance details of a contract, ie. from Skyweaver
+        Get balance update aggregate values -- useful for syncing balance
+        details of a contract, ie. from Skyweaver
       requestBody:
         content:
           application/json:
@@ -2694,7 +2724,9 @@ paths:
     post:
       summary: GetTransactionHistory
       description: >-
-        History of mined transactions for the account which includes a list of token transfers (sent/recieved) and sent transactions from a Sequence wallet
+        History of mined transactions for the account which includes a list of
+        token transfers (sent/recieved) and sent transactions from a Sequence
+        wallet
       requestBody:
         content:
           application/json:
@@ -2940,9 +2972,13 @@ paths:
     post:
       summary: GetOrderbookOrders
       description: >-
-        These parameters are depracated, please don't use them: - filters - beforeExpiryTimestamp - blockNumberAfter - createdAtAfter and in OrderbookOrderFilter these fields are depracated: - userAddress - excludeUserAddress
+        These parameters are depracated, please don't use them: - filters -
+        beforeExpiryTimestamp - blockNumberAfter - createdAtAfter and in
+        OrderbookOrderFilter these fields are depracated: - userAddress -
+        excludeUserAddress
 
-        Use 'filter' and these fields instead - userAddresses - excludeUserAddress'
+        Use 'filter' and these fields instead - userAddresses -
+        excludeUserAddress'
       requestBody:
         content:
           application/json:
@@ -3179,7 +3215,8 @@ paths:
                         filters:
                           events:
                             - >-
-                              Transfer(address indexed from,address indexed to,uint256 indexed tokenId)
+                              Transfer(address indexed from,address indexed
+                              to,uint256 indexed tokenId)
                           contractAddresses:
                             - '0x9bec34c1f7098e278afd48fedcf13355b854364a'
                           accounts:
@@ -3257,7 +3294,8 @@ paths:
                       filters:
                         events:
                           - >-
-                            Transfer(address indexed from,address indexed to,uint256 indexed tokenId)
+                            Transfer(address indexed from,address indexed
+                            to,uint256 indexed tokenId)
                         contractAddresses:
                           - '0x9bec34c1f7098e278afd48fedcf13355b854364a'
                         accounts:
@@ -3321,7 +3359,8 @@ paths:
                       - '0x9bec34c1f7098e278afd48fedcf13355b854364a'
                     events:
                       - >-
-                        Transfer(address indexed from, address indexed to, uint256 indexed tokenId)
+                        Transfer(address indexed from, address indexed to,
+                        uint256 indexed tokenId)
                   projectId: 31396
                   url: >-
                     https://webhook.site/#!/view/a2859143-0a52-4b69-98f2-a58733e4dcf0
@@ -3345,7 +3384,8 @@ paths:
                       filters:
                         events:
                           - >-
-                            Transfer(address indexed from,address indexed to,uint256 indexed tokenId)
+                            Transfer(address indexed from,address indexed
+                            to,uint256 indexed tokenId)
                         contractAddresses:
                           - '0x9bec34c1f7098e278afd48fedcf13355b854364a'
                         accounts:
@@ -3411,7 +3451,8 @@ paths:
                       - '100'
                     events:
                       - >-
-                        Transfer(address indexed from, address indexed to, uint256 indexed tokenId)
+                        Transfer(address indexed from, address indexed to,
+                        uint256 indexed tokenId)
                   projectId: 31396
                   url: >-
                     https://webhook.site/#!/view/a2859143-0a52-4b69-98f2-a58733e4dcf0
@@ -3435,7 +3476,8 @@ paths:
                       filters:
                         events:
                           - >-
-                            Transfer(address indexed from,address indexed to,uint256 indexed tokenId)
+                            Transfer(address indexed from,address indexed
+                            to,uint256 indexed tokenId)
                         contractAddresses:
                           - '0x9bec34c1f7098e278afd48fedcf13355b854364a'
                         accounts:
@@ -3753,7 +3795,8 @@ paths:
     post:
       summary: SubscribeEvents
       description: >-
-        TODO: pass optional block ... can pass too, reorg true, etc. or stay behind, etc.
+        TODO: pass optional block ... can pass too, reorg true, etc. or stay
+        behind, etc.
       requestBody:
         content:
           application/json:

diff --git a/docs/pages/api/marketplace/marketplace.gen.yaml b/docs/pages/api/marketplace/marketplace.gen.yaml
@@ -85,7 +85,8 @@ components:
       type: apiKey
       in: header
       description: >-
-        Project access key for authenticating requests, get an access key at https://sequence.build
+        Project access key for authenticating requests, get an access key at
+        https://sequence.build
       name: X-Access-Key
   schemas:
     ErrorWebrpcEndpoint:
@@ -2447,7 +2448,8 @@ paths:
       summary: GetCollectibleHighestOffer
       deprecated: true
       description: >-
-        This endpoint is deprecated. Please use GetHighestPriceOfferForCollectible()
+        This endpoint is deprecated. Please use
+        GetHighestPriceOfferForCollectible()
       requestBody:
         content:
           application/json:
@@ -2501,7 +2503,8 @@ paths:
       summary: GetCollectibleLowestListing
       deprecated: true
       description: >-
-        This endpoint is deprecated. Please use GetLowestPriceListingForCollectible()
+        This endpoint is deprecated. Please use
+        GetLowestPriceListingForCollectible()
       requestBody:
         content:
           application/json:
@@ -2555,7 +2558,8 @@ paths:
       summary: GetCollectibleHighestListing
       deprecated: true
       description: >-
-        This endpoint is deprecated. Please use GetHighestPriceListingForCollectible()
+        This endpoint is deprecated. Please use
+        GetHighestPriceListingForCollectible()
       requestBody:
         content:
           application/json:
@@ -2940,7 +2944,8 @@ paths:
     post:
       summary: Execute
       description: >-
-        only used in a case of external transactions ( when we create off-chain transactions ) for instance opensea market
+        only used in a case of external transactions ( when we create off-chain
+        transactions ) for instance opensea market
       requestBody:
         content:
           application/json: