diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 49913e1c266..1e8205a338f 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -19,10 +19,24 @@ jobs: run: | npm install -g pnpm@8.15.4 pnpm install - - - name: Update API Examples + + + - name: setup-go + uses: actions/setup-go@v5 + with: + go-version: "1.22.5" + + - name: Update openapi docs run: | - pnpm update-examples + # Read the changed files from the previous step + go mod init github.com/0xsequence/docs + go get github.com/mikefarah/yq/v4@latest + go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/api/api.gen.yaml + go run github.com/mikefarah/yq/v4 -e -i '.security=[{"BearerAuth":[]}]' docs/pages/api/analytics/analytics.gen.yaml + go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/marketplace/marketplace.gen.yaml + go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}, {"BearerAuth":[]}]' docs/pages/api/metadata/metadata.gen.yaml + go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}, {"BearerAuth":[]}]' docs/pages/api/indexer/indexer.gen.yaml + go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/relayer/relayer.gen.yaml - name: Build run: pnpm run build diff --git a/.github/workflows/scheme.yml b/.github/workflows/scheme.yml deleted file mode 100644 index 843782aff44..00000000000 --- a/.github/workflows/scheme.yml +++ /dev/null @@ -1,43 +0,0 @@ -name: Scheme -on: - pull_request: - paths: - - "**/*.gen.yaml" - -jobs: - securityScheme: - runs-on: ubuntu-latest - name: Add security schemes - steps: - - name: git-checkout - uses: actions/checkout@v4 - with: - lfs: true - - - name: setup-go - uses: actions/setup-go@v5 - with: - go-version: "1.22.5" - - - name: Update openapi docs - run: | - # Read the changed files from the previous step - go mod init github.com/0xsequence/docs - go get github.com/mikefarah/yq/v4@latest - go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/marketplace/marketplace.gen.yaml - go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}, {"BearerAuth":[]}]' docs/pages/api/metadata/metadata.gen.yaml - go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/indexer/indexer.gen.yaml - go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/relayer/relayer.gen.yaml - go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/api/api.gen.yaml - go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/analytics/analytics.gen.yaml - - - name: Push changes - uses: 0xsequence/actions/git-commit@master - env: - API_TOKEN_GITHUB: ${{ secrets.GH_TOKEN_GIT_COMMIT }} - with: - files: "docs/pages/api/**/*.gen.yaml" - branch: ${{ github.head_ref }} - ## since openapi docs are generated and PR is automatically created there is no need to try create new one - pr_title: "[AUTOMATED] Add global security schemes" - pr_create: false diff --git a/.gitignore b/.gitignore index c1f5b055870..04f310e185d 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,10 @@ docs/pages/solutions/.DS_Store .cursorrules .env* docs/data + +docs/pages/api/analytics/analytics.gen.yaml +docs/pages/api/api/api.gen.yaml +docs/pages/api/indexer/indexer.gen.yaml +docs/pages/api/marketplace/marketplace.gen.yaml +docs/pages/api/metadata/metadata.gen.yaml +docs/pages/api/relayer/relayer.gen.yaml \ No newline at end of file diff --git a/docs/pages/api/analytics/analytics.gen.yaml b/docs/pages/api/analytics/analytics.gen.yaml deleted file mode 100644 index 854342614e7..00000000000 --- a/docs/pages/api/analytics/analytics.gen.yaml +++ /dev/null @@ -1,5570 +0,0 @@ -# sequence-builder v0.1.0 b55e6ab04641579821b72c346b85585c1257ba57 -# -- -# Code generated by webrpc-gen@v0.20.3 with openapi generator; DO NOT EDIT -# -# webrpc-gen -service=Builder -match=@analytics -schema=proto/builder.main.ridl -target=openapi -title=Analytics Api -servers=https://api.sequence.app;Analytics -securityAnnotation=@auth -securitySchemes= -out=proto/docs/analytics.gen.yaml -openapi: 3.0.0 -info: - title: 'Analytics Api' - version: '' -servers: - - url: 'https://api.sequence.app' - description: 'Analytics' -components: - schemas: - ErrorWebrpcEndpoint: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "WebrpcEndpoint" - code: - type: number - example: 0 - msg: - type: string - example: "endpoint error" - cause: - type: string - status: - type: number - example: 400 - ErrorWebrpcRequestFailed: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "WebrpcRequestFailed" - code: - type: number - example: -1 - msg: - type: string - example: "request failed" - cause: - type: string - status: - type: number - example: 400 - ErrorWebrpcBadRoute: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "WebrpcBadRoute" - code: - type: number - example: -2 - msg: - type: string - example: "bad route" - cause: - type: string - status: - type: number - example: 404 - ErrorWebrpcBadMethod: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "WebrpcBadMethod" - code: - type: number - example: -3 - msg: - type: string - example: "bad method" - cause: - type: string - status: - type: number - example: 405 - ErrorWebrpcBadRequest: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "WebrpcBadRequest" - code: - type: number - example: -4 - msg: - type: string - example: "bad request" - cause: - type: string - status: - type: number - example: 400 - ErrorWebrpcBadResponse: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "WebrpcBadResponse" - code: - type: number - example: -5 - msg: - type: string - example: "bad response" - cause: - type: string - status: - type: number - example: 500 - ErrorWebrpcServerPanic: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "WebrpcServerPanic" - code: - type: number - example: -6 - msg: - type: string - example: "server panic" - cause: - type: string - status: - type: number - example: 500 - ErrorWebrpcInternalError: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "WebrpcInternalError" - code: - type: number - example: -7 - msg: - type: string - example: "internal error" - cause: - type: string - status: - type: number - example: 500 - ErrorWebrpcClientDisconnected: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "WebrpcClientDisconnected" - code: - type: number - example: -8 - msg: - type: string - example: "client disconnected" - cause: - type: string - status: - type: number - example: 400 - ErrorWebrpcStreamLost: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "WebrpcStreamLost" - code: - type: number - example: -9 - msg: - type: string - example: "stream lost" - cause: - type: string - status: - type: number - example: 400 - ErrorWebrpcStreamFinished: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "WebrpcStreamFinished" - code: - type: number - example: -10 - msg: - type: string - example: "stream finished" - cause: - type: string - status: - type: number - example: 200 - ErrorUnauthorized: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "Unauthorized" - code: - type: number - example: 1000 - msg: - type: string - example: "Unauthorized access" - cause: - type: string - status: - type: number - example: 401 - ErrorPermissionDenied: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "PermissionDenied" - code: - type: number - example: 1001 - msg: - type: string - example: "Permission denied" - cause: - type: string - status: - type: number - example: 403 - ErrorSessionExpired: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "SessionExpired" - code: - type: number - example: 1002 - msg: - type: string - example: "Session expired" - cause: - type: string - status: - type: number - example: 403 - ErrorMethodNotFound: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "MethodNotFound" - code: - type: number - example: 1003 - msg: - type: string - example: "Method not found" - cause: - type: string - status: - type: number - example: 404 - ErrorRequestConflict: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "RequestConflict" - code: - type: number - example: 1004 - msg: - type: string - example: "Conflict with target resource" - cause: - type: string - status: - type: number - example: 409 - ErrorServiceDisabled: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "ServiceDisabled" - code: - type: number - example: 1005 - msg: - type: string - example: "Service disabled" - cause: - type: string - status: - type: number - example: 404 - ErrorTimeout: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "Timeout" - code: - type: number - example: 2000 - msg: - type: string - example: "Request timed out" - cause: - type: string - status: - type: number - example: 408 - ErrorInvalidArgument: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "InvalidArgument" - code: - type: number - example: 2001 - msg: - type: string - example: "Invalid argument" - cause: - type: string - status: - type: number - example: 400 - ErrorNotFound: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "NotFound" - code: - type: number - example: 3000 - msg: - type: string - example: "Resource not found" - cause: - type: string - status: - type: number - example: 400 - ErrorUserNotFound: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "UserNotFound" - code: - type: number - example: 3001 - msg: - type: string - example: "User not found" - cause: - type: string - status: - type: number - example: 400 - ErrorProjectNotFound: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "ProjectNotFound" - code: - type: number - example: 3002 - msg: - type: string - example: "Project not found" - cause: - type: string - status: - type: number - example: 400 - ErrorInvalidTier: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "InvalidTier" - code: - type: number - example: 3003 - msg: - type: string - example: "Invalid subscription tier" - cause: - type: string - status: - type: number - example: 400 - ErrorEmailTemplateExists: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "EmailTemplateExists" - code: - type: number - example: 3004 - msg: - type: string - example: "Email Template exists" - cause: - type: string - status: - type: number - example: 409 - ErrorSubscriptionLimit: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "SubscriptionLimit" - code: - type: number - example: 3005 - msg: - type: string - example: "Subscription limit reached" - cause: - type: string - status: - type: number - example: 402 - ErrorFeatureNotIncluded: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "FeatureNotIncluded" - code: - type: number - example: 3006 - msg: - type: string - example: "Feature not included" - cause: - type: string - status: - type: number - example: 402 - ErrorInvalidNetwork: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "InvalidNetwork" - code: - type: number - example: 3007 - msg: - type: string - example: "Invalid network" - cause: - type: string - status: - type: number - example: 400 - ErrorInvitationExpired: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "InvitationExpired" - code: - type: number - example: 4000 - msg: - type: string - example: "Invitation code is expired" - cause: - type: string - status: - type: number - example: 400 - ErrorAlreadyCollaborator: - type: object - required: - - error - - code - - msg - - status - properties: - error: - type: string - example: "AlreadyCollaborator" - code: - type: number - example: 4001 - msg: - type: string - example: "Already a collaborator" - cause: - type: string - status: - type: number - example: 409 - AuthSessionType: - type: string - description: Represented as uint16 on the server side - enum: - - PUBLIC - - WALLET - - USER - - ADMIN - - SERVICE - SubscriptionTier: - type: string - description: Represented as uint8 on the server side - enum: - - COMMUNITY - - DEVELOPER - - GROWTH - - PRO - - ENTERPRISE - ProjectType: - type: string - description: Represented as string on the server side - enum: - - EMBEDDED_WALLET_REACT - - EMBEDDED_WALLET_NEXTJS - - EMBEDDED_WALLET_UNITY - - EMBEDDED_WALLET_UNREAL - - MARKETPLACE_STANDALONE - - MARKETPLACE_REACT - - MARKETPLACE_UNITY - - MARKETPLACE_UNREAL - - SALE_CONTRACT_ERC1155 - - SALE_CONTRACT_ERC721 - ResourceType: - type: string - description: Represented as int8 on the server side - enum: - - CONTRACTS - SubscriptionProvider: - type: string - description: Represented as string on the server side - enum: - - ADMIN - - STRIPE - - GOOGLE - CollaboratorAccess: - type: string - description: Represented as uint32 on the server side - enum: - - NONE - - READ - - WRITE - - ADMIN - CollaboratorType: - type: string - description: Represented as uint8 on the server side - enum: - - USER - - SERVICE_ACCOUNT - ContractSourceType: - type: string - description: Represented as uint8 on the server side - enum: - - LINKED - - DEPLOYED - - SALE - SortOrder: - type: string - description: Represented as uint32 on the server side - enum: - - DESC - - ASC - PaymentProvider: - type: string - description: Represented as uint16 on the server side - enum: - - UNKNOWN - - STRIPE - - MANUAL - PaymentStatus: - type: string - description: Represented as uint16 on the server side - enum: - - INITIATED - - PENDING - - SUCCEEDED - - FAILED - - PROCESSED - MarketplaceWallet: - type: string - description: Represented as uint8 on the server side - enum: - - UNIVERSAL - - EMBEDDED - MarketplaceType: - type: string - description: Represented as uint8 on the server side - enum: - - AMM - - P2P - - SEQUENCE - - ORDERBOOK - TokenType: - type: string - description: Represented as uint8 on the server side - enum: - - ERC20 - - ERC721 - - ERC1155 - FileScope: - type: string - description: Represented as uint8 on the server side - enum: - - LOGO - - MARKETPLACE - - AVATAR - - EMAIL - - WALLET - - TOKEN_DIRECTORY - EmailTemplateType: - type: string - description: Represented as uint8 on the server side - enum: - - UNKNOWN - - LOGIN - - GUARD - TaskStatus: - type: string - description: Represented as uint8 on the server side - enum: - - PENDING - - PAUSED - - FAILED - - COMPLETED - - DISABLED - DateInterval: - type: string - description: Represented as uint16 on the server side - enum: - - DAY - - WEEK - - MONTH - OnboardingStep: - type: string - description: Represented as string on the server side - enum: - - linkOrDeployContract - - createMarketplace - - setUpGasTank - - configureWaas - - customizeWallet - - inviteCollaborator - - cloneGithub - - copyCredentials - - customizeMarketplace - - deployERC721Contract - - deployERC1155Contract - - addMarketplaceCollection - - createCollection - - customizeCollectible - - deploySaleContract - - setSaleSettings - - addMinterRoleToItems - - setUpAudienceList - WaasTenantState: - type: string - description: Represented as uint8 on the server side - enum: - - PENDING - - DEPLOYING - - READY - - FAILED - TrialType: - type: string - description: Represented as string on the server side - enum: - - ANALYTICS - Version: - type: object - required: - - webrpcVersion - - schemaVersion - - schemaHash - - appVersion - properties: - webrpcVersion: - type: string - schemaVersion: - type: string - schemaHash: - type: string - appVersion: - type: string - RuntimeStatus: - type: object - required: - - healthOK - - startTime - - uptime - - ver - - env - - branch - - commitHash - - networks - - checks - properties: - healthOK: - type: boolean - startTime: - type: string - uptime: - type: number - ver: - type: string - env: - type: string - branch: - type: string - commitHash: - type: string - networks: - type: object - description: 'map' - additionalProperties: - type: boolean - checks: - $ref: '#/components/schemas/RuntimeChecks' - RuntimeChecks: - type: object - required: - - quotaControl - - joqueue - - stripe - - cloudCommerce - properties: - quotaControl: - type: boolean - joqueue: - type: boolean - stripe: - type: boolean - cloudCommerce: - type: boolean - Configuration: - type: object - required: - - name - - title - - chainIds - - domains - properties: - name: - type: string - title: - type: string - chainIds: - type: array - description: '[]uint64' - items: - type: number - domains: - type: array - description: '[]string' - items: - type: string - logoUrl: - type: string - logoLightUrl: - type: string - titleUrl: - type: string - backgroundUrl: - type: string - mobileBackgroundUrl: - type: string - customCss: - type: string - animationUrl: - type: string - crispWebsiteId: - type: string - learnMoreButton: - type: string - learnMoreUrl: - type: string - AuthState: - type: object - required: - - jwtToken - - expiresAt - - address - - sessionType - properties: - jwtToken: - type: string - expiresAt: - type: string - address: - type: string - sessionType: - $ref: '#/components/schemas/AuthSessionType' - user: - $ref: '#/components/schemas/User' - User: - type: object - required: - - address - - createdAt - - updatedAt - - sysAdmin - - avatarKey - - avatarUrl - properties: - address: - type: string - email: - type: string - createdAt: - type: string - updatedAt: - type: string - sysAdmin: - type: boolean - avatarKey: - type: string - avatarUrl: - type: string - UserSettings: - type: object - required: - - freeProjectsLeft - properties: - freeProjectsLeft: - type: number - UserOverride: - type: object - required: - - id - - address - - extraProjects - - createdAt - - updatedAt - properties: - id: - type: number - address: - type: string - extraProjects: - type: number - createdAt: - type: string - updatedAt: - type: string - Project: - type: object - required: - - id - - name - - ownerAddress - - ownerAvatarUrl - - draft - - logoImageKey - - logoImageUrl - - websiteUrl - - chainIds - - whitelabel - - subscriptionTier - - collaboratorCount - - onboardingSteps - - createdAt - - updatedAt - properties: - id: - type: number - name: - type: string - type: - $ref: '#/components/schemas/ProjectType' - ownerAddress: - type: string - ownerEmail: - type: string - ownerAvatarUrl: - type: string - draft: - type: boolean - logoImageKey: - type: string - logoImageUrl: - type: string - websiteUrl: - type: string - chainIds: - type: array - description: '[]uint64' - items: - type: number - whitelabel: - type: string - subscriptionTier: - $ref: '#/components/schemas/SubscriptionTier' - collaboratorCount: - type: number - onboardingSteps: - type: object - description: 'map' - additionalProperties: - type: boolean - createdAt: - type: string - updatedAt: - type: string - deletedAt: - type: string - ResourceFilter: - type: object - properties: - contracts: - $ref: '#/components/schemas/ContractFilter' - Resource: - type: object - required: - - type - - total - - detail - properties: - type: - $ref: '#/components/schemas/ResourceType' - total: - type: number - detail: - type: array - description: '[]ResourceDetail' - items: - $ref: '#/components/schemas/ResourceDetail' - ResourceDetail: - type: object - required: - - key - - count - properties: - key: - type: object - count: - type: number - ProjectSubscription: - type: object - required: - - id - - projectId - - subscriptionTier - - provider - - providerId - - dateStart - properties: - id: - type: number - projectId: - type: number - subscriptionTier: - $ref: '#/components/schemas/SubscriptionTier' - provider: - $ref: '#/components/schemas/SubscriptionProvider' - providerId: - type: string - dateStart: - type: string - dateEnd: - type: string - Collaborator: - type: object - required: - - id - - projectId - - type - - userAddress - - access - - createdAt - - updatedAt - properties: - id: - type: number - projectId: - type: number - type: - $ref: '#/components/schemas/CollaboratorType' - userAddress: - type: string - userEmail: - type: string - userAvatarUrl: - type: string - userAvatarKey: - type: string - access: - $ref: '#/components/schemas/CollaboratorAccess' - invitationId: - type: number - createdAt: - type: string - updatedAt: - type: string - Contract: - type: object - required: - - id - - projectId - - contractName - - contractAddress - - contractType - - chainId - - source - - createdAt - - updatedAt - properties: - id: - type: number - projectId: - type: number - contractName: - type: string - contractAddress: - type: string - contractType: - type: string - chainId: - type: number - source: - $ref: '#/components/schemas/ContractSourceType' - itemsContractAddress: - type: string - abi: - type: string - bytecode: - type: string - bytecodeHash: - type: string - audienceId: - type: number - createdAt: - type: string - updatedAt: - type: string - ContractFilter: - type: object - properties: - chainId: - type: number - contractSourceType: - $ref: '#/components/schemas/ContractSourceType' - contractType: - type: string - ContractLink: - type: object - required: - - project - - collaborator - properties: - contract: - $ref: '#/components/schemas/Contract' - project: - $ref: '#/components/schemas/Project' - collaborator: - $ref: '#/components/schemas/Collaborator' - NodeAccount: - type: object - required: - - id - - displayName - - requestRateLimit - - requestMonthlyQuota - - active - properties: - id: - type: number - displayName: - type: string - requestRateLimit: - type: number - requestMonthlyQuota: - type: number - active: - type: boolean - RelayerGasTank: - type: object - required: - - id - - projectId - - relayerIdMap - - totalPayments - - totalUsage - properties: - id: - type: number - projectId: - type: number - relayerIdMap: - type: object - description: 'map' - additionalProperties: - type: number - totalPayments: - type: number - totalUsage: - type: number - timestampUsage: - type: string - lastPaymentId: - type: number - RelayerGasBalance: - type: object - required: - - id - - name - - chainId - - currentBalance - - feeMarkupFactor - - unlimited - properties: - id: - type: number - name: - type: string - chainId: - type: number - currentBalance: - type: number - feeMarkupFactor: - type: number - unlimited: - type: boolean - RelayerGasSponsor: - type: object - required: - - id - - projectId - - chainId - - displayName - - address - - active - - createdAt - - updatedAt - properties: - id: - type: number - projectId: - type: number - chainId: - type: number - displayName: - type: string - address: - type: string - active: - type: boolean - createdAt: - type: string - updatedAt: - type: string - RelayerGasSponsorUsage: - type: object - required: - - id - - chainId - - totalGasUsed - - totalTxnFees - - avgGasPrice - - totalTxns - - startTime - - endTime - properties: - id: - type: number - chainId: - type: number - totalGasUsed: - type: number - totalTxnFees: - type: number - avgGasPrice: - type: number - totalTxns: - type: number - startTime: - type: string - endTime: - type: string - RelayerTransaction: - type: object - required: - - txnHash - - txnNonce - - txnStatus - - txnRevertReason - - requeues - - queuedAt - - sentAt - - minedAt - - target - - input - - txnArgs - - walletAddress - - metaTxnNonce - - gasLimit - - gasPrice - - gasUsed - - gasEstimated - - usdRate - - creditsUsed - - isWhitelisted - - createdAt - - updatedAt - properties: - txnHash: - type: string - txnNonce: - type: string - metaTxnID: - type: string - txnStatus: - type: string - txnRevertReason: - type: string - requeues: - type: number - queuedAt: - type: string - sentAt: - type: string - minedAt: - type: string - target: - type: string - input: - type: string - txnArgs: - type: object - description: 'map' - additionalProperties: - type: object - txnReceipt: - type: object - description: 'map' - additionalProperties: - type: object - walletAddress: - type: string - metaTxnNonce: - type: string - gasLimit: - type: number - gasPrice: - type: string - gasUsed: - type: number - gasEstimated: - type: number - gasFeeMarkup: - type: number - usdRate: - type: string - creditsUsed: - type: number - isWhitelisted: - type: boolean - gasSponsor: - type: number - createdAt: - type: string - updatedAt: - type: string - IndexerWebhook: - type: object - required: - - id - - projectId - - chainId - - contractAddress - - eventSig - - webhookUrl - - disabled - - createdAt - - updatedAt - properties: - id: - type: number - projectId: - type: number - chainId: - type: number - contractAddress: - type: string - eventSig: - type: string - webhookUrl: - type: string - disabled: - type: boolean - createdAt: - type: string - updatedAt: - type: string - ContractSource: - type: object - required: - - id - - uid - - contractType - - name - - description - - author - - license - - audited - - moreInfoUrl - - disabled - - factorySourceUid - - abi - - bytecode - - bytecodeHash - - createdAt - - updatedAt - properties: - id: - type: number - uid: - type: string - contractType: - type: string - projectId: - type: number - name: - type: string - description: - type: string - author: - type: string - license: - type: string - audited: - type: boolean - moreInfoUrl: - type: string - disabled: - type: boolean - factorySourceUid: - type: string - abi: - type: string - bytecode: - type: string - bytecodeHash: - type: string - createdAt: - type: string - updatedAt: - type: string - ContractFactory: - type: object - required: - - id - - chainId - - contractAddress - - uid - - createdAt - - updatedAt - properties: - id: - type: number - chainId: - type: number - contractAddress: - type: string - uid: - type: string - abi: - type: string - bytecode: - type: string - bytecodeHash: - type: string - createdAt: - type: string - updatedAt: - type: string - NewContractSource: - type: object - required: - - uid - - name - - contractType - - bytecode - - abi - properties: - uid: - type: string - name: - type: string - description: - type: string - author: - type: string - license: - type: string - audited: - type: boolean - moreInfoUrl: - type: string - disabled: - type: boolean - contractType: - type: string - bytecode: - type: string - abi: - type: string - Page: - type: object - properties: - pageSize: - type: number - page: - type: number - column: - type: string - more: - type: boolean - before: - type: object - after: - type: object - sort: - type: array - description: '[]SortBy' - items: - $ref: '#/components/schemas/SortBy' - SortBy: - type: object - required: - - column - properties: - column: - type: string - order: - $ref: '#/components/schemas/SortOrder' - BillingSettings: - type: object - required: - - maxKeys - - rateLimit - - creditsIncludedWarn - - creditsIncludedMax - - creditsOverageWarn - - creditsOverageMax - - priceSubscriptionTier - - priceCreditOverage - - marketplaceFee - - gasFeeMarkup - - blockTransactions - - providerSettings - properties: - maxKeys: - type: number - rateLimit: - type: number - creditsIncludedWarn: - type: number - creditsIncludedMax: - type: number - creditsOverageWarn: - type: number - creditsOverageMax: - type: number - priceSubscriptionTier: - type: string - priceCreditOverage: - type: string - marketplaceFee: - type: string - gasFeeMarkup: - type: string - blockTransactions: - type: boolean - providerSettings: - type: object - description: 'map' - additionalProperties: - $ref: '#/components/schemas/BillingProviderSettings' - BillingProviderSettings: - type: object - required: - - priceSubscriptionTier - - priceCreditOverage - - disabled - properties: - priceSubscriptionTier: - type: string - priceCreditOverage: - type: string - disabled: - type: boolean - BillingOverride: - type: object - required: - - extraKeys - - discountSubscriptionTier - - discountCreditOverage - - forceAllowTransactions - properties: - extraKeys: - type: number - rateLimit: - type: number - creditsIncludedWarn: - type: number - creditsOverageWarn: - type: number - creditsOverageMax: - type: number - discountSubscriptionTier: - type: number - discountCreditOverage: - type: number - marketplaceFee: - type: number - forceAllowTransactions: - type: boolean - SubscriptionInfo: - type: object - required: - - current - - subscriptionUrl - - cycleStart - - cycleEnd - - settings - - creditsBonus - - creditUsage - - creditBalance - - creditOverage - properties: - current: - $ref: '#/components/schemas/ProjectSubscription' - subscriptionUrl: - type: string - cycleStart: - type: string - cycleEnd: - type: string - plannedDowngrade: - $ref: '#/components/schemas/SubscriptionTier' - pendingUpgrade: - $ref: '#/components/schemas/SubscriptionTier' - settings: - $ref: '#/components/schemas/BillingSettings' - creditsBonus: - type: number - creditUsage: - type: number - creditBalance: - type: number - creditOverage: - type: number - extraCharged: - type: string - PaymentHistory: - type: object - required: - - totalPayments - - payments - properties: - totalPayments: - type: number - payments: - type: array - description: '[]Payment' - items: - $ref: '#/components/schemas/Payment' - Redirect: - type: object - required: - - url - properties: - url: - type: string - StripeEventData: - type: object - required: - - object - properties: - object: - $ref: '#/components/schemas/StripeEventDataObject' - StripeEventDataObject: - type: object - required: - - id - - object - properties: - id: - type: string - object: - type: string - Payment: - type: object - required: - - id - - projectId - - provider - - externalTxnID - - createdAt - properties: - id: - type: number - projectId: - type: number - chainId: - type: number - status: - $ref: '#/components/schemas/PaymentStatus' - provider: - $ref: '#/components/schemas/PaymentProvider' - externalTxnID: - type: string - createdAt: - type: string - PaymentLog: - type: object - required: - - id - - paymentID - - data - - createdAt - properties: - id: - type: number - paymentID: - type: number - data: - $ref: '#/components/schemas/PaymentLogData' - createdAt: - type: string - PaymentLogData: - type: object - required: - - type - - data - properties: - type: - type: string - data: - type: object - InvoicesReturn: - type: object - required: - - hasMore - - invoices - properties: - hasMore: - type: boolean - invoices: - type: array - description: '[]Invoice' - items: - $ref: '#/components/schemas/Invoice' - Invoice: - type: object - required: - - id - - date - - amount - - paid - - url - properties: - id: - type: string - date: - type: string - amount: - type: string - paid: - type: boolean - url: - type: string - SubscriptionPlans: - type: object - required: - - configs - properties: - configs: - type: object - description: 'map' - additionalProperties: - $ref: '#/components/schemas/SubscriptionPlan' - SubscriptionPlan: - type: object - required: - - tier - - settings - - features - properties: - tier: - $ref: '#/components/schemas/SubscriptionTier' - settings: - $ref: '#/components/schemas/BillingSettings' - features: - type: array - description: '[]string' - items: - type: string - CollectionInfo: - type: object - required: - - chainId - - title - - type - - image - - address - - link - - description - - featured - properties: - chainId: - type: number - title: - type: string - type: - type: string - image: - type: string - address: - type: string - link: - type: string - description: - type: string - featured: - type: boolean - ContractInfo: - type: object - required: - - chainId - - address - - name - - type - - symbol - - logoURI - - deployed - - bytecodeHash - - extensions - - contentHash - - updatedAt - properties: - chainId: - type: number - address: - type: string - name: - type: string - type: - type: string - symbol: - type: string - decimals: - type: number - logoURI: - type: string - deployed: - type: boolean - bytecodeHash: - type: string - extensions: - type: object - contentHash: - type: number - updatedAt: - type: string - ProjectInvitation: - type: object - required: - - id - - projectId - - code - - access - - expiresAt - - usageCount - - createdAt - properties: - id: - type: number - projectId: - type: number - code: - type: string - access: - $ref: '#/components/schemas/CollaboratorAccess' - expiresAt: - type: string - usageCount: - type: number - signupLimit: - type: number - createdAt: - type: string - deletedAt: - type: string - MarketplaceConfigSchema: - type: object - required: - - version - - config - - style - properties: - version: - type: number - config: - type: object - description: 'map' - additionalProperties: - type: object - style: - type: object - description: 'map' - additionalProperties: - type: object - MarketplaceConfig: - type: object - required: - - id - - projectId - - version - - config - - settings - - style - properties: - id: - type: number - projectId: - type: number - version: - type: number - config: - type: object - description: 'map' - additionalProperties: - type: object - settings: - $ref: '#/components/schemas/MarketplaceSettings' - style: - type: object - description: 'map' - additionalProperties: - type: object - createdAt: - type: string - updatedAt: - type: string - MarketplaceWalletOptions: - type: object - required: - - walletType - - oidcIssuers - - connectors - - includeEIP6963Wallets - properties: - walletType: - $ref: '#/components/schemas/MarketplaceWallet' - oidcIssuers: - type: object - description: 'map' - additionalProperties: - type: string - connectors: - type: array - description: '[]string' - items: - type: string - includeEIP6963Wallets: - type: boolean - MarketplaceCollection: - type: object - required: - - marketplaceType - - chainId - - address - - feePercetage - - currencyOptions - properties: - marketplaceType: - $ref: '#/components/schemas/MarketplaceType' - chainId: - type: number - address: - type: string - feePercetage: - type: number - currencyOptions: - type: array - description: '[]string' - items: - type: string - MarketplaceSettings: - type: object - required: - - publisherId - - title - - shortDescription - - socials - - faviconUrl - - landingBannerUrl - - collections - - walletOptions - - landingPageLayout - - logoUrl - - bannerUrl - properties: - publisherId: - type: string - title: - type: string - shortDescription: - type: string - socials: - type: object - description: 'map' - additionalProperties: - type: string - faviconUrl: - type: string - landingBannerUrl: - type: string - collections: - type: array - description: '[]MarketplaceCollection' - items: - $ref: '#/components/schemas/MarketplaceCollection' - walletOptions: - $ref: '#/components/schemas/MarketplaceWalletOptions' - landingPageLayout: - type: string - logoUrl: - type: string - bannerUrl: - type: string - fontUrl: - type: string - ogImage: - type: string - MarketplaceHostname: - type: object - required: - - id - - marketplaceConfigId - - hostname - - isDefaultHostname - - isCustomDomain - - createdAt - properties: - id: - type: number - marketplaceConfigId: - type: number - hostname: - type: string - isDefaultHostname: - type: boolean - isCustomDomain: - type: boolean - createdAt: - type: string - OffchainInventory: - type: object - required: - - id - - projectId - - chainId - - externalProductId - - paymentTokenAddress - - paymentTokenType - - paymentTokenId - - paymentAmount - - paymentRecipient - properties: - id: - type: number - projectId: - type: number - chainId: - type: number - externalProductId: - type: string - paymentTokenAddress: - type: string - paymentTokenType: - $ref: '#/components/schemas/TokenType' - paymentTokenId: - type: number - paymentAmount: - type: number - paymentRecipient: - type: string - chainedCallAddress: - type: string - chainedCallData: - type: string - allowCrossChainPayments: - type: boolean - callbackURL: - type: string - createdAt: - type: string - deletedAt: - type: string - OffchainPayment: - type: object - required: - - id - - offchainInventoryId - - productRecipient - - paymentChainId - - paymentTokenAddress - - expiration - - createdAt - properties: - id: - type: number - offchainInventoryId: - type: number - productRecipient: - type: string - paymentChainId: - type: number - paymentTokenAddress: - type: string - expiration: - type: string - createdAt: - type: string - completedAt: - type: string - processedAt: - type: string - WalletConfigSchema: - type: object - required: - - version - - config - properties: - version: - type: number - config: - type: object - description: 'map' - additionalProperties: - type: object - WalletConfig: - type: object - required: - - version - - projectId - - platform - - config - properties: - id: - type: number - version: - type: number - projectId: - type: number - platform: - type: string - config: - type: object - description: 'map' - additionalProperties: - type: object - createdAt: - type: string - updatedAt: - type: string - ProjectFile: - type: object - required: - - id - - projectId - - scope - - mimetype - - filepath - - contents - - hash - - url - - createdAt - properties: - id: - type: number - projectId: - type: number - scope: - $ref: '#/components/schemas/FileScope' - mimetype: - type: string - filepath: - type: string - contents: - type: array - description: '[]byte' - items: - type: string - hash: - type: array - description: '[]byte' - items: - type: string - url: - type: string - createdAt: - type: string - EmailTemplate: - type: object - required: - - id - - projectId - - subject - - introText - - logoUrl - - placeholders - - createdAt - - updatedAt - properties: - id: - type: number - templateType: - $ref: '#/components/schemas/EmailTemplateType' - projectId: - type: number - subject: - type: string - introText: - type: string - logoUrl: - type: string - template: - type: string - placeholders: - type: array - description: '[]string' - items: - type: string - createdAt: - type: string - updatedAt: - type: string - deletedAt: - type: string - TaskRunner: - type: object - required: - - id - - workGroup - - runAt - properties: - id: - type: number - workGroup: - type: string - runAt: - type: string - Task: - type: object - required: - - id - - queue - - status - - try - - payload - - hash - properties: - id: - type: number - queue: - type: string - status: - $ref: '#/components/schemas/TaskStatus' - try: - type: number - runAt: - type: string - lastRanAt: - type: string - createdAt: - type: string - payload: - type: array - description: '[]byte' - items: - type: string - hash: - type: string - QueryFilter: - type: object - required: - - projectId - properties: - projectId: - type: number - startDate: - type: string - endDate: - type: string - dateInterval: - $ref: '#/components/schemas/DateInterval' - collections: - type: array - description: '[]string' - items: - type: string - tokenId: - type: string - Chart: - type: object - required: - - value - - label - properties: - value: - type: number - label: - type: string - MultiValueChart: - type: object - required: - - value - - label - properties: - value: - type: object - description: 'map' - additionalProperties: - type: number - label: - type: string - QueryResult: - type: object - required: - - collection - - source - - volumeUSD - - numTokens - - numTxns - properties: - collection: - type: string - source: - type: string - tokenId: - type: string - volumeUSD: - type: number - numTokens: - type: number - numTxns: - type: number - CreditBonus: - type: object - required: - - id - - projectId - - amount - - balance - - createdAt - - updatedAt - properties: - id: - type: number - projectId: - type: number - amount: - type: number - balance: - type: number - createdAt: - type: string - updatedAt: - type: string - OpenIdProvider: - type: object - required: - - iss - - aud - properties: - iss: - type: string - aud: - type: array - description: '[]string' - items: - type: string - WaasSettings: - type: object - required: - - recoveryAddress - - authConfig - - tenantState - - emailAuth - - oidcProviders - - allowedOrigins - - updateCode - - tenantKey - properties: - recoveryAddress: - type: string - authConfig: - $ref: '#/components/schemas/WaasAuthConfig' - tenantState: - $ref: '#/components/schemas/WaasTenantState' - emailAuth: - type: boolean - oidcProviders: - type: array - description: '[]OpenIdProvider' - items: - $ref: '#/components/schemas/OpenIdProvider' - allowedOrigins: - type: array - description: '[]string' - items: - type: string - updateCode: - type: string - tenantKey: - type: string - WaasAuthEmailConfig: - type: object - required: - - enabled - properties: - enabled: - type: boolean - WaasAuthGuestConfig: - type: object - required: - - enabled - properties: - enabled: - type: boolean - WaasAuthPlayfabConfig: - type: object - required: - - enabled - properties: - enabled: - type: boolean - titleId: - type: string - WaasAuthStytchConfig: - type: object - required: - - enabled - properties: - enabled: - type: boolean - projectId: - type: string - WaasAuthConfig: - type: object - properties: - email: - $ref: '#/components/schemas/WaasAuthEmailConfig' - guest: - $ref: '#/components/schemas/WaasAuthGuestConfig' - playfab: - $ref: '#/components/schemas/WaasAuthPlayfabConfig' - stytch: - $ref: '#/components/schemas/WaasAuthStytchConfig' - WaasWalletStatus: - type: object - required: - - chainId - - address - - deployed - properties: - chainId: - type: number - address: - type: string - deployed: - type: boolean - RawData: - type: object - required: - - data - properties: - data: - type: object - description: 'map' - additionalProperties: - type: object - Audience: - type: object - required: - - id - - projectId - - name - - contactCount - - createdAt - - updatedAt - properties: - id: - type: number - projectId: - type: number - name: - type: string - contactCount: - type: number - createdAt: - type: string - updatedAt: - type: string - deletedAt: - type: string - AudienceContact: - type: object - required: - - id - - audienceId - - address - - createdAt - - updatedAt - properties: - id: - type: number - audienceId: - type: number - name: - type: string - address: - type: string - email: - type: string - createdAt: - type: string - updatedAt: - type: string - Trial: - type: object - required: - - id - - projectId - - type - - startAt - - endAt - properties: - id: - type: number - projectId: - type: number - type: - $ref: '#/components/schemas/TrialType' - startAt: - type: string - endAt: - type: string - ExtendedMarketplaceConfig: - type: object - required: - - config - - accessKey - - waasEmailEnabled - - waasTenantKey - - waasProviders - properties: - config: - $ref: '#/components/schemas/MarketplaceSettings' - accessKey: - type: string - waasEmailEnabled: - type: boolean - waasTenantKey: - type: string - waasProviders: - type: array - description: '[]OpenIdProvider' - items: - $ref: '#/components/schemas/OpenIdProvider' - Builder_TotalCompute_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_ComputeByService_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_DailyComputeByType_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_DailyComputeByService_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_GetOrderbookCollections_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_WalletsTotal_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_WalletsDaily_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_WalletsMonthly_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_WalletsByCountry_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_WalletsByDevice_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_WalletsByBrowser_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_WalletsByOS_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_WalletsTxnSentTotal_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_WalletsTxnSentDaily_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_WalletsTxnSentMonthly_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_MarketTxnEventTotal_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_MarketTxnEventDaily_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_MarketTxnEventMonthly_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_MarketWalletsTotal_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_MarketWalletsDaily_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_MarketWalletsMonthly_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_TotalWalletTxnConversionRate_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_DailyWalletTxnConversionRate_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_MonthlyWalletTxnConversionRate_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_DailyNewWallets_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_MonthlyNewWallets_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_TotalNewWallets_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_AverageDAU_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_RollingStickiness_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_AverageStickiness_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_D1RetentionByCohort_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_D3RetentionByCohort_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_D7RetentionByCohort_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_D14RetentionByCohort_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_D28RetentionByCohort_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_AverageD1Retention_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_AverageD3Retention_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_AverageD7Retention_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_AverageD14Retention_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_AverageD28Retention_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_MonthlyActiveWalletsBySegment_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_MonthlyTransactingWalletsBySegment_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_WeeklyActiveWallets_Request: - type: object - properties: - filter: - $ref: '#/components/schemas/QueryFilter' - Builder_TotalCompute_Response: - type: object - properties: - computeStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_ComputeByService_Response: - type: object - properties: - computeStats: - type: array - description: '[]MultiValueChart' - items: - $ref: '#/components/schemas/MultiValueChart' - Builder_DailyComputeByType_Response: - type: object - properties: - computeStats: - type: array - description: '[]MultiValueChart' - items: - $ref: '#/components/schemas/MultiValueChart' - Builder_DailyComputeByService_Response: - type: object - properties: - computeStats: - type: object - description: 'map' - additionalProperties: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_GetOrderbookCollections_Response: - type: object - properties: - data: - type: array - description: '[]QueryResult' - items: - $ref: '#/components/schemas/QueryResult' - Builder_WalletsTotal_Response: - type: object - properties: - walletStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_WalletsDaily_Response: - type: object - properties: - walletStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_WalletsMonthly_Response: - type: object - properties: - walletStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_WalletsByCountry_Response: - type: object - properties: - walletStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_WalletsByDevice_Response: - type: object - properties: - walletStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_WalletsByBrowser_Response: - type: object - properties: - walletStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_WalletsByOS_Response: - type: object - properties: - walletStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_WalletsTxnSentTotal_Response: - type: object - properties: - walletStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_WalletsTxnSentDaily_Response: - type: object - properties: - walletStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_WalletsTxnSentMonthly_Response: - type: object - properties: - walletStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_MarketTxnEventTotal_Response: - type: object - properties: - marketStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_MarketTxnEventDaily_Response: - type: object - properties: - marketStats: - type: array - description: '[]MultiValueChart' - items: - $ref: '#/components/schemas/MultiValueChart' - Builder_MarketTxnEventMonthly_Response: - type: object - properties: - marketStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_MarketWalletsTotal_Response: - type: object - properties: - marketStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_MarketWalletsDaily_Response: - type: object - properties: - marketStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_MarketWalletsMonthly_Response: - type: object - properties: - marketStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_TotalWalletTxnConversionRate_Response: - type: object - properties: - marketStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_DailyWalletTxnConversionRate_Response: - type: object - properties: - marketStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_MonthlyWalletTxnConversionRate_Response: - type: object - properties: - marketStats: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_DailyNewWallets_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_MonthlyNewWallets_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_TotalNewWallets_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_AverageDAU_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_RollingStickiness_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_AverageStickiness_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_D1RetentionByCohort_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_D3RetentionByCohort_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_D7RetentionByCohort_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_D14RetentionByCohort_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_D28RetentionByCohort_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_AverageD1Retention_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_AverageD3Retention_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_AverageD7Retention_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_AverageD14Retention_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_AverageD28Retention_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_MonthlyActiveWalletsBySegment_Response: - type: object - properties: - data: - type: object - description: 'map' - additionalProperties: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_MonthlyTransactingWalletsBySegment_Response: - type: object - properties: - data: - type: object - description: 'map' - additionalProperties: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' - Builder_WeeklyActiveWallets_Response: - type: object - properties: - data: - type: array - description: '[]Chart' - items: - $ref: '#/components/schemas/Chart' -paths: - /rpc/Builder/TotalCompute: - post: - summary: TotalCompute - description: "Analytics" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_TotalCompute_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_TotalCompute_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/ComputeByService: - post: - summary: ComputeByService - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_ComputeByService_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_ComputeByService_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/DailyComputeByType: - post: - summary: DailyComputeByType - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_DailyComputeByType_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_DailyComputeByType_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/DailyComputeByService: - post: - summary: DailyComputeByService - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_DailyComputeByService_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_DailyComputeByService_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/GetOrderbookCollections: - post: - summary: GetOrderbookCollections - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_GetOrderbookCollections_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_GetOrderbookCollections_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/WalletsTotal: - post: - summary: WalletsTotal - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsTotal_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsTotal_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/WalletsDaily: - post: - summary: WalletsDaily - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsDaily_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsDaily_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/WalletsMonthly: - post: - summary: WalletsMonthly - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsMonthly_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsMonthly_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/WalletsByCountry: - post: - summary: WalletsByCountry - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsByCountry_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsByCountry_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/WalletsByDevice: - post: - summary: WalletsByDevice - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsByDevice_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsByDevice_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/WalletsByBrowser: - post: - summary: WalletsByBrowser - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsByBrowser_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsByBrowser_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/WalletsByOS: - post: - summary: WalletsByOS - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsByOS_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsByOS_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/WalletsTxnSentTotal: - post: - summary: WalletsTxnSentTotal - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsTxnSentTotal_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsTxnSentTotal_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/WalletsTxnSentDaily: - post: - summary: WalletsTxnSentDaily - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsTxnSentDaily_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsTxnSentDaily_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/WalletsTxnSentMonthly: - post: - summary: WalletsTxnSentMonthly - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsTxnSentMonthly_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WalletsTxnSentMonthly_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/MarketTxnEventTotal: - post: - summary: MarketTxnEventTotal - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MarketTxnEventTotal_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MarketTxnEventTotal_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/MarketTxnEventDaily: - post: - summary: MarketTxnEventDaily - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MarketTxnEventDaily_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MarketTxnEventDaily_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/MarketTxnEventMonthly: - post: - summary: MarketTxnEventMonthly - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MarketTxnEventMonthly_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MarketTxnEventMonthly_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/MarketWalletsTotal: - post: - summary: MarketWalletsTotal - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MarketWalletsTotal_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MarketWalletsTotal_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/MarketWalletsDaily: - post: - summary: MarketWalletsDaily - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MarketWalletsDaily_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MarketWalletsDaily_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/MarketWalletsMonthly: - post: - summary: MarketWalletsMonthly - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MarketWalletsMonthly_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MarketWalletsMonthly_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/TotalWalletTxnConversionRate: - post: - summary: TotalWalletTxnConversionRate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_TotalWalletTxnConversionRate_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_TotalWalletTxnConversionRate_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/DailyWalletTxnConversionRate: - post: - summary: DailyWalletTxnConversionRate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_DailyWalletTxnConversionRate_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_DailyWalletTxnConversionRate_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/MonthlyWalletTxnConversionRate: - post: - summary: MonthlyWalletTxnConversionRate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MonthlyWalletTxnConversionRate_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MonthlyWalletTxnConversionRate_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/DailyNewWallets: - post: - summary: DailyNewWallets - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_DailyNewWallets_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_DailyNewWallets_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/MonthlyNewWallets: - post: - summary: MonthlyNewWallets - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MonthlyNewWallets_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MonthlyNewWallets_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/TotalNewWallets: - post: - summary: TotalNewWallets - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_TotalNewWallets_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_TotalNewWallets_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/AverageDAU: - post: - summary: AverageDAU - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageDAU_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageDAU_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/RollingStickiness: - post: - summary: RollingStickiness - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_RollingStickiness_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_RollingStickiness_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/AverageStickiness: - post: - summary: AverageStickiness - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageStickiness_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageStickiness_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/D1RetentionByCohort: - post: - summary: D1RetentionByCohort - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_D1RetentionByCohort_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_D1RetentionByCohort_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/D3RetentionByCohort: - post: - summary: D3RetentionByCohort - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_D3RetentionByCohort_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_D3RetentionByCohort_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/D7RetentionByCohort: - post: - summary: D7RetentionByCohort - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_D7RetentionByCohort_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_D7RetentionByCohort_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/D14RetentionByCohort: - post: - summary: D14RetentionByCohort - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_D14RetentionByCohort_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_D14RetentionByCohort_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/D28RetentionByCohort: - post: - summary: D28RetentionByCohort - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_D28RetentionByCohort_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_D28RetentionByCohort_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/AverageD1Retention: - post: - summary: AverageD1Retention - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageD1Retention_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageD1Retention_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/AverageD3Retention: - post: - summary: AverageD3Retention - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageD3Retention_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageD3Retention_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/AverageD7Retention: - post: - summary: AverageD7Retention - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageD7Retention_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageD7Retention_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/AverageD14Retention: - post: - summary: AverageD14Retention - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageD14Retention_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageD14Retention_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/AverageD28Retention: - post: - summary: AverageD28Retention - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageD28Retention_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_AverageD28Retention_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/MonthlyActiveWalletsBySegment: - post: - summary: MonthlyActiveWalletsBySegment - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MonthlyActiveWalletsBySegment_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MonthlyActiveWalletsBySegment_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/MonthlyTransactingWalletsBySegment: - post: - summary: MonthlyTransactingWalletsBySegment - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MonthlyTransactingWalletsBySegment_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_MonthlyTransactingWalletsBySegment_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' - /rpc/Builder/WeeklyActiveWallets: - post: - summary: WeeklyActiveWallets - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WeeklyActiveWallets_Request' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Builder_WeeklyActiveWallets_Response' - '4XX': - description: Client error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcEndpoint' - - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' - - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - - $ref: '#/components/schemas/ErrorUnauthorized' - - $ref: '#/components/schemas/ErrorPermissionDenied' - - $ref: '#/components/schemas/ErrorSessionExpired' - - $ref: '#/components/schemas/ErrorMethodNotFound' - - $ref: '#/components/schemas/ErrorRequestConflict' - - $ref: '#/components/schemas/ErrorServiceDisabled' - - $ref: '#/components/schemas/ErrorTimeout' - - $ref: '#/components/schemas/ErrorInvalidArgument' - - $ref: '#/components/schemas/ErrorNotFound' - - $ref: '#/components/schemas/ErrorUserNotFound' - - $ref: '#/components/schemas/ErrorProjectNotFound' - - $ref: '#/components/schemas/ErrorInvalidTier' - - $ref: '#/components/schemas/ErrorEmailTemplateExists' - - $ref: '#/components/schemas/ErrorSubscriptionLimit' - - $ref: '#/components/schemas/ErrorFeatureNotIncluded' - - $ref: '#/components/schemas/ErrorInvalidNetwork' - - $ref: '#/components/schemas/ErrorInvitationExpired' - - $ref: '#/components/schemas/ErrorAlreadyCollaborator' - '5XX': - description: Server error - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - - $ref: '#/components/schemas/ErrorWebrpcInternalError' -security: - - ApiKeyAuth: [] diff --git a/docs/pages/api/analytics/examples.json b/docs/pages/api/analytics/examples.json index 667280a6222..7a62955a6cd 100644 --- a/docs/pages/api/analytics/examples.json +++ b/docs/pages/api/analytics/examples.json @@ -1,15 +1,18 @@ { - "/rpc/Builder/WalletsDaily": { - "request": { - "filter": { - "dateInterval": "DAY", - "endDate": "2024-10-10", - "projectId": "122", - "startDate": "2024-09-30" + "/rpc/Builder/WalletsDaily": [ + { + "description": "Wallets daily", + "request": { + "filter": { + "dateInterval": "DAY", + "endDate": "2024-10-10", + "projectId": "122", + "startDate": "2024-09-30" + } + }, + "response": { + "walletStats": [{ "value": 2, "label": "2024-09-23" }, { "value": 3, "label": "2024-09-29" }] } - }, - "response": { - "walletStats": [{ "value": 2, "label": "2024-09-23" }, { "value": 3, "label": "2024-09-29" }] } - } + ] } diff --git a/docs/pages/api/api/api.gen.yaml b/docs/pages/api/api/rpc.gen.yaml similarity index 87% rename from docs/pages/api/api/api.gen.yaml rename to docs/pages/api/api/rpc.gen.yaml index 145eb8d26a6..0170fec6fe9 100644 --- a/docs/pages/api/api/api.gen.yaml +++ b/docs/pages/api/api/rpc.gen.yaml @@ -1,17 +1,19 @@ -# sequence-api v0.4.0 6ca5da9ef09a29cf36defe4d236894ea4dd78ed9 -# -- -# Code generated by webrpc-gen@v0.20.3 with openapi generator; DO NOT EDIT -# -# webrpc-gen -service=API -match=@public -schema=proto/api.ridl -target=openapi -title=Sequence Api -servers=https://api.sequence.app/;Api -securityAnnotation=@auth -securitySchemes={ 'ApiKeyAuth': { 'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key' }, } -out=proto/docs/api.gen.yaml openapi: 3.0.0 info: - title: 'Sequence Api' + title: Sequence Api version: '' servers: - - url: 'https://api.sequence.app/' - description: 'Api' + - url: https://api.sequence.app/ + description: Api components: - securitySchemes: {'ApiKeyAuth': {'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key'}} + securitySchemes: + ApiKeyAuth: + type: apiKey + in: header + description: >- + Project access key for authenticating requests, get an access key at + https://sequence.build + name: X-Access-Key schemas: ErrorWebrpcEndpoint: type: object @@ -23,13 +25,13 @@ components: properties: error: type: string - example: "WebrpcEndpoint" + example: WebrpcEndpoint code: type: number example: 0 msg: type: string - example: "endpoint error" + example: endpoint error cause: type: string status: @@ -45,13 +47,13 @@ components: properties: error: type: string - example: "WebrpcRequestFailed" + example: WebrpcRequestFailed code: type: number example: -1 msg: type: string - example: "request failed" + example: request failed cause: type: string status: @@ -67,13 +69,13 @@ components: properties: error: type: string - example: "WebrpcBadRoute" + example: WebrpcBadRoute code: type: number example: -2 msg: type: string - example: "bad route" + example: bad route cause: type: string status: @@ -89,13 +91,13 @@ components: properties: error: type: string - example: "WebrpcBadMethod" + example: WebrpcBadMethod code: type: number example: -3 msg: type: string - example: "bad method" + example: bad method cause: type: string status: @@ -111,13 +113,13 @@ components: properties: error: type: string - example: "WebrpcBadRequest" + example: WebrpcBadRequest code: type: number example: -4 msg: type: string - example: "bad request" + example: bad request cause: type: string status: @@ -133,13 +135,13 @@ components: properties: error: type: string - example: "WebrpcBadResponse" + example: WebrpcBadResponse code: type: number example: -5 msg: type: string - example: "bad response" + example: bad response cause: type: string status: @@ -155,13 +157,13 @@ components: properties: error: type: string - example: "WebrpcServerPanic" + example: WebrpcServerPanic code: type: number example: -6 msg: type: string - example: "server panic" + example: server panic cause: type: string status: @@ -177,13 +179,13 @@ components: properties: error: type: string - example: "WebrpcInternalError" + example: WebrpcInternalError code: type: number example: -7 msg: type: string - example: "internal error" + example: internal error cause: type: string status: @@ -199,13 +201,13 @@ components: properties: error: type: string - example: "WebrpcClientDisconnected" + example: WebrpcClientDisconnected code: type: number example: -8 msg: type: string - example: "client disconnected" + example: client disconnected cause: type: string status: @@ -221,13 +223,13 @@ components: properties: error: type: string - example: "WebrpcStreamLost" + example: WebrpcStreamLost code: type: number example: -9 msg: type: string - example: "stream lost" + example: stream lost cause: type: string status: @@ -243,13 +245,13 @@ components: properties: error: type: string - example: "WebrpcStreamFinished" + example: WebrpcStreamFinished code: type: number example: -10 msg: type: string - example: "stream finished" + example: stream finished cause: type: string status: @@ -265,13 +267,13 @@ components: properties: error: type: string - example: "Unauthorized" + example: Unauthorized code: type: number example: 1000 msg: type: string - example: "Unauthorized access" + example: Unauthorized access cause: type: string status: @@ -287,13 +289,13 @@ components: properties: error: type: string - example: "PermissionDenied" + example: PermissionDenied code: type: number example: 1001 msg: type: string - example: "Permission denied" + example: Permission denied cause: type: string status: @@ -309,13 +311,13 @@ components: properties: error: type: string - example: "SessionExpired" + example: SessionExpired code: type: number example: 1002 msg: type: string - example: "Session expired" + example: Session expired cause: type: string status: @@ -331,13 +333,13 @@ components: properties: error: type: string - example: "Aborted" + example: Aborted code: type: number example: 1005 msg: type: string - example: "Request aborted" + example: Request aborted cause: type: string status: @@ -353,13 +355,13 @@ components: properties: error: type: string - example: "Geoblocked" + example: Geoblocked code: type: number example: 1006 msg: type: string - example: "Geoblocked region" + example: Geoblocked region cause: type: string status: @@ -375,13 +377,13 @@ components: properties: error: type: string - example: "InvalidArgument" + example: InvalidArgument code: type: number example: 2000 msg: type: string - example: "Invalid argument" + example: Invalid argument cause: type: string status: @@ -397,13 +399,13 @@ components: properties: error: type: string - example: "Unavailable" + example: Unavailable code: type: number example: 2002 msg: type: string - example: "Unavailable resource" + example: Unavailable resource cause: type: string status: @@ -419,13 +421,13 @@ components: properties: error: type: string - example: "QueryFailed" + example: QueryFailed code: type: number example: 2003 msg: type: string - example: "Query failed" + example: Query failed cause: type: string status: @@ -441,13 +443,13 @@ components: properties: error: type: string - example: "NotFound" + example: NotFound code: type: number example: 3000 msg: type: string - example: "Resource not found" + example: Resource not found cause: type: string status: @@ -526,7 +528,7 @@ components: $ref: '#/components/schemas/RuntimeChecks' numTxnsRelayed: type: object - description: 'map' + description: map additionalProperties: $ref: '#/components/schemas/NumTxnsRelayed' NumTxnsRelayed: @@ -1645,7 +1647,9 @@ paths: /rpc/API/IsValidSignature: post: summary: IsValidSignature - description: "TODO: we can add walletContext optional in the future when we need it NOTE: chainId can be either a number or canonical name" + description: >- + TODO: we can add walletContext optional in the future when we need it + NOTE: chainId can be either a number or canonical name requestBody: content: application/json: @@ -1658,7 +1662,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_IsValidSignature_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -1680,7 +1684,7 @@ paths: - $ref: '#/components/schemas/ErrorUnavailable' - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - '5XX': + 5XX: description: Server error content: application/json: @@ -1704,7 +1708,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_IsValidMessageSignature_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -1726,7 +1730,7 @@ paths: - $ref: '#/components/schemas/ErrorUnavailable' - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - '5XX': + 5XX: description: Server error content: application/json: @@ -1750,7 +1754,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_IsValidTypedDataSignature_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -1772,7 +1776,7 @@ paths: - $ref: '#/components/schemas/ErrorUnavailable' - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - '5XX': + 5XX: description: Server error content: application/json: @@ -1796,7 +1800,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_IsValidETHAuthProof_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -1818,7 +1822,7 @@ paths: - $ref: '#/components/schemas/ErrorUnavailable' - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - '5XX': + 5XX: description: Server error content: application/json: @@ -1830,12 +1834,30 @@ paths: /rpc/API/LinkWallet: post: summary: LinkWallet - description: " Linked wallets (v0 -- simple support) " + description: >- + Send a Payload to link a user wallet, this would require a signed + message from both parent wallet (Embedded Wallet) and a linking wallet + like an EOA. requestBody: content: application/json: schema: $ref: '#/components/schemas/API_LinkWallet_Request' + example: + signatureChainId: '137' + linkedWalletType: MetaMask + parentWalletAddress: '0xb33018E5C4f5A168f5560D9C05597508dA8a4E91' + parentWalletMessage: >- + child wallet with address + 0x4f8A351143A0aAec055873959b8Cb705c00a37F6 + parentWalletSignature: >- + 0x01000100000000020189e6eb0408ae08542bcc99696fba0c001f6aa3ac0000fe01000300000000060100010000740001b467851352ace0a432c71a157e6fd6b5007b86e473247919461148e5eed2bd68226f24168e61a2c1dddb3c860188dec82df140637dc765d1be3ad814853db8a91c010400002c01019cec96321d5a54df2277fe3dbb2405016a3bbf9601013f5602872eff7ef96e69ef2409e0dd3c62923bd7060200010000740001069b3fb27e49dcb5e396cac5d5b073be0d86ae1e4a591150387b98583a7a23856f3ad6e24a21cc56d5cab9f61708e88cf526de72eff8b83416de7b8cab6378f51c010400002c0101951448847a03ad1005a0e463dff0da093690ff240101e0f61b36d02be47455ce5332e9d7bb43bf8f344b030100c46d323d87fc26dad057c9a8d5faeb7112ab829e + linkedWalletAddress: '0x4f8A351143A0aAec055873959b8Cb705c00a37F6' + linkedWalletMessage: >- + Link to parent wallet with address + 0xb33018E5C4f5A168f5560D9C05597508dA8a4E91 + linkedWalletSignature: >- + 0x0d31791e6aefbd01590f846e93a7740988a6d5ffc50a59ee0941747c2740242a3ec105fddf66a8b39b49db5d13de9d68a36c5fd7e1e83da1e01657c9996d87181c responses: '200': description: OK @@ -1843,7 +1865,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_LinkWallet_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -1865,7 +1887,7 @@ paths: - $ref: '#/components/schemas/ErrorUnavailable' - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - '5XX': + 5XX: description: Server error content: application/json: @@ -1882,6 +1904,14 @@ paths: application/json: schema: $ref: '#/components/schemas/API_GetLinkedWallets_Request' + example: + parentWalletAddress: '0xb33018E5C4f5A168f5560D9C05597508dA8a4E91' + parentWalletMessage: >- + parent wallet with address + 0xb33018E5C4f5A168f5560D9C05597508dA8a4E91 + parentWalletSignature: >- + 0x01000100000000020189e6eb0408ae08542bcc99696fba0c001f6aa3ac0000fe010003000000000601000100007400019b61caaf15c224553593641f40c0ecd8d57e589dd9b04c129505d4537d979b827548ad6feef3379b0c3442e9b76ac07e06307e779c9b3a5fd4ec2ff27037eac81b010400002c01019cec96321d5a54df2277fe3dbb2405016a3bbf9601013f5602872eff7ef96e69ef2409e0dd3c62923bd7060200010000740001c0fb1a592dd8424b917820c1d8ae25bd1516df486fa6f7610999b141fac46f1e072a5c439d21eaad9521b912b68c428135117bef95bebf56d0a2dfe61fc8fddd1c010400002c0101951448847a03ad1005a0e463dff0da093690ff240101e0f61b36d02be47455ce5332e9d7bb43bf8f344b030100c46d323d87fc26dad057c9a8d5faeb7112ab829e + signatureChainId: '137' responses: '200': description: OK @@ -1889,7 +1919,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_GetLinkedWallets_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -1911,7 +1941,7 @@ paths: - $ref: '#/components/schemas/ErrorUnavailable' - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - '5XX': + 5XX: description: Server error content: application/json: @@ -1920,6 +1950,7 @@ paths: - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - $ref: '#/components/schemas/ErrorWebrpcInternalError' + description: Query all wallets that are linked /rpc/API/RemoveLinkedWallet: post: summary: RemoveLinkedWallet @@ -1928,6 +1959,20 @@ paths: application/json: schema: $ref: '#/components/schemas/API_RemoveLinkedWallet_Request' + example: + signatureChainId: '137' + parentWalletAddress: '0xb33018E5C4f5A168f5560D9C05597508dA8a4E91' + parentWalletMessage: >- + child wallet with address + 0x4f8A351143A0aAec055873959b8Cb705c00a37F6 + parentWalletSignature: >- + 0x01000100000000020189e6eb0408ae08542bcc99696fba0c001f6aa3ac0000fe01000300000000060100010000740001b467851352ace0a432c71a157e6fd6b5007b86e473247919461148e5eed2bd68226f24168e61a2c1dddb3c860188dec82df140637dc765d1be3ad814853db8a91c010400002c01019cec96321d5a54df2277fe3dbb2405016a3bbf9601013f5602872eff7ef96e69ef2409e0dd3c62923bd7060200010000740001069b3fb27e49dcb5e396cac5d5b073be0d86ae1e4a591150387b98583a7a23856f3ad6e24a21cc56d5cab9f61708e88cf526de72eff8b83416de7b8cab6378f51c010400002c0101951448847a03ad1005a0e463dff0da093690ff240101e0f61b36d02be47455ce5332e9d7bb43bf8f344b030100c46d323d87fc26dad057c9a8d5faeb7112ab829e + linkedWalletAddress: '0x4f8A351143A0aAec055873959b8Cb705c00a37F6' + linkedWalletMessage: >- + Unlink from parent wallet with address + 0xb33018E5C4f5A168f5560D9C05597508dA8a4E91 + linkedWalletSignature: >- + 0x3cb92cfae098adb135560f52158fb6fc4c02ca962b9a8721ab6203440f116464259099457f014d46b078d59a02946c3f40b6031f89efa2ac9df4ddc7f88ec1131b responses: '200': description: OK @@ -1935,7 +1980,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_RemoveLinkedWallet_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -1957,7 +2002,7 @@ paths: - $ref: '#/components/schemas/ErrorUnavailable' - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - '5XX': + 5XX: description: Server error content: application/json: @@ -1966,10 +2011,14 @@ paths: - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - $ref: '#/components/schemas/ErrorWebrpcInternalError' + description: >- + Send a Payload to link a user wallet, this would require a signed + message from both parent wallet (Embedded Wallet) and a linking wallet + like an EOA. /rpc/API/GetSwapPrice: post: summary: GetSwapPrice - description: " Currency abstraction " + description: ' Currency abstraction ' requestBody: content: application/json: @@ -1982,7 +2031,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_GetSwapPrice_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2004,7 +2053,7 @@ paths: - $ref: '#/components/schemas/ErrorUnavailable' - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - '5XX': + 5XX: description: Server error content: application/json: @@ -2021,6 +2070,11 @@ paths: application/json: schema: $ref: '#/components/schemas/API_GetSwapPrices_Request' + example: + userAddress: '0x1fEA9Fcbd1989C0f2D0Fbad08144c528c7F5ea54' + buyCurrencyAddress: '0x50ba9d89fbfa2862d0447281219a3058e7724224' + buyAmount: '1000000000000000000' + chainId: 11155111 responses: '200': description: OK @@ -2028,7 +2082,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_GetSwapPrices_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2050,7 +2104,7 @@ paths: - $ref: '#/components/schemas/ErrorUnavailable' - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - '5XX': + 5XX: description: Server error content: application/json: @@ -2059,6 +2113,10 @@ paths: - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - $ref: '#/components/schemas/ErrorWebrpcInternalError' + description: >- + Retrieve swap prices for the specified ERC20 token at the address + provided as 'buyCurrencyAddress'. The result will be 'null' if the user + lacks sufficient funds or if there is insufficient pool liquidity. /rpc/API/GetSwapQuote: post: summary: GetSwapQuote @@ -2067,6 +2125,13 @@ paths: application/json: schema: $ref: '#/components/schemas/API_GetSwapQuote_Request' + example: + userAddress: '0x1fEA9Fcbd1989C0f2D0Fbad08144c528c7F5ea54' + sellCurrencyAddress: '0x1c7d4b196cb0c7b01d743fbc6116a902379c7238' + buyCurrencyAddress: '0x50ba9d89fbfa2862d0447281219a3058e7724224' + buyAmount: '1000000000000000000' + chainId: 11155111 + includeApprove: true responses: '200': description: OK @@ -2074,7 +2139,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_GetSwapQuote_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2096,7 +2161,7 @@ paths: - $ref: '#/components/schemas/ErrorUnavailable' - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - '5XX': + 5XX: description: Server error content: application/json: @@ -2105,5 +2170,8 @@ paths: - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - $ref: '#/components/schemas/ErrorWebrpcInternalError' + description: >- + After selecting a swap price from 'GetSwapPrices', use this API to + retrieve the transaction data needed to execute the swap on-chain. security: - ApiKeyAuth: [] diff --git a/docs/pages/api/indexer/indexer.gen.yaml b/docs/pages/api/indexer/rpc.gen.yaml similarity index 80% rename from docs/pages/api/indexer/indexer.gen.yaml rename to docs/pages/api/indexer/rpc.gen.yaml index 25afa635f74..028fd7583c8 100644 --- a/docs/pages/api/indexer/indexer.gen.yaml +++ b/docs/pages/api/indexer/rpc.gen.yaml @@ -1,95 +1,97 @@ -# sequence-indexer v0.4.0 e1e4ec700d4efd018bf8617e696c5cf5189b8665 -# -- -# Code generated by webrpc-gen@v0.20.3 with openapi generator; DO NOT EDIT -# -# webrpc-gen -service=Indexer -ignore=@internal -schema=proto/indexer.ridl -target=openapi -title=Sequence Indexer -servers=https://amoy-indexer.sequence.app;Amoy Mainnet,https://apechain-mainnet-indexer.sequence.app;Apechain-Mainnet Mainnet,https://apechain-testnet-indexer.sequence.app;Apechain-Testnet Mainnet,https://arbitrum-indexer.sequence.app;Arbitrum Mainnet,https://arbitrum-nova-indexer.sequence.app;Arbitrum-Nova Mainnet,https://arbitrum-sepolia-indexer.sequence.app;Arbitrum-Sepolia Mainnet,https://astar-zkevm-indexer.sequence.app;Astar-Zkevm Mainnet,https://astar-zkyoto-indexer.sequence.app;Astar-Zkyoto Mainnet,https://avalanche-indexer.sequence.app;Avalanche Mainnet,https://avalanche-testnet-indexer.sequence.app;Avalanche-Testnet Mainnet,https://b3-indexer.sequence.app;B3 Mainnet,https://b3-sepolia-indexer.sequence.app;B3-Sepolia Mainnet,https://base-indexer.sequence.app;Base Mainnet,https://base-sepolia-indexer.sequence.app;Base-Sepolia Mainnet,https://blast-indexer.sequence.app;Blast Mainnet,https://blast-sepolia-indexer.sequence.app;Blast-Sepolia Mainnet,https://borne-testnet-indexer.sequence.app;Borne-Testnet Mainnet,https://bsc-indexer.sequence.app;Bsc Mainnet,https://bsc-testnet-indexer.sequence.app;Bsc-Testnet Mainnet,https://gnosis-indexer.sequence.app;Gnosis Mainnet,https://homeverse-indexer.sequence.app;Homeverse Mainnet,https://homeverse-testnet-indexer.sequence.app;Homeverse-Testnet Mainnet,https://immutable-zkevm-indexer.sequence.app;Immutable-Zkevm Mainnet,https://immutable-zkevm-testnet-indexer.sequence.app;Immutable-Zkevm-Testnet Mainnet,https://imx-indexer.sequence.app;Imx Mainnet,https://imx-testnet-indexer.sequence.app;Imx-Testnet Mainnet,https://mainnet-indexer.sequence.app;Mainnet Mainnet,https://optimism-indexer.sequence.app;Optimism Mainnet,https://optimism-sepolia-indexer.sequence.app;Optimism-Sepolia Mainnet,https://polygon-indexer.sequence.app;Polygon Mainnet,https://polygon-zkevm-indexer.sequence.app;Polygon-Zkevm Mainnet,https://rootnet-indexer.sequence.app;Rootnet Mainnet,https://rootnet-porcini-indexer.sequence.app;Rootnet-Porcini Mainnet,https://sepolia-indexer.sequence.app;Sepolia Mainnet,https://skale-nebula-testnet-indexer.sequence.app;Skale-Nebula-Testnet Mainnet,https://soneium-minato-indexer.sequence.app;Soneium-Minato Mainnet,https://toy-testnet-indexer.sequence.app;Toy-Testnet Mainnet,https://xai-indexer.sequence.app;Xai Mainnet,https://xai-sepolia-indexer.sequence.app;Xai-Sepolia Mainnet,https://xr-sepolia-indexer.sequence.app;Xr-Sepolia Mainnet -securityAnnotation=@auth -securitySchemes={ 'ApiKeyAuth': { 'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key' }, } -out=proto/docs/indexer.gen.yaml openapi: 3.0.0 info: - title: 'Sequence Indexer' + title: Sequence Indexer version: '' servers: - - url: 'https://amoy-indexer.sequence.app' - description: 'Amoy Mainnet' - - url: 'https://apechain-mainnet-indexer.sequence.app' - description: 'Apechain-Mainnet Mainnet' - - url: 'https://apechain-testnet-indexer.sequence.app' - description: 'Apechain-Testnet Mainnet' - - url: 'https://arbitrum-indexer.sequence.app' - description: 'Arbitrum Mainnet' - - url: 'https://arbitrum-nova-indexer.sequence.app' - description: 'Arbitrum-Nova Mainnet' - - url: 'https://arbitrum-sepolia-indexer.sequence.app' - description: 'Arbitrum-Sepolia Mainnet' - - url: 'https://astar-zkevm-indexer.sequence.app' - description: 'Astar-Zkevm Mainnet' - - url: 'https://astar-zkyoto-indexer.sequence.app' - description: 'Astar-Zkyoto Mainnet' - - url: 'https://avalanche-indexer.sequence.app' - description: 'Avalanche Mainnet' - - url: 'https://avalanche-testnet-indexer.sequence.app' - description: 'Avalanche-Testnet Mainnet' - - url: 'https://b3-indexer.sequence.app' - description: 'B3 Mainnet' - - url: 'https://b3-sepolia-indexer.sequence.app' - description: 'B3-Sepolia Mainnet' - - url: 'https://base-indexer.sequence.app' - description: 'Base Mainnet' - - url: 'https://base-sepolia-indexer.sequence.app' - description: 'Base-Sepolia Mainnet' - - url: 'https://blast-indexer.sequence.app' - description: 'Blast Mainnet' - - url: 'https://blast-sepolia-indexer.sequence.app' - description: 'Blast-Sepolia Mainnet' - - url: 'https://borne-testnet-indexer.sequence.app' - description: 'Borne-Testnet Mainnet' - - url: 'https://bsc-indexer.sequence.app' - description: 'Bsc Mainnet' - - url: 'https://bsc-testnet-indexer.sequence.app' - description: 'Bsc-Testnet Mainnet' - - url: 'https://gnosis-indexer.sequence.app' - description: 'Gnosis Mainnet' - - url: 'https://homeverse-indexer.sequence.app' - description: 'Homeverse Mainnet' - - url: 'https://homeverse-testnet-indexer.sequence.app' - description: 'Homeverse-Testnet Mainnet' - - url: 'https://immutable-zkevm-indexer.sequence.app' - description: 'Immutable-Zkevm Mainnet' - - url: 'https://immutable-zkevm-testnet-indexer.sequence.app' - description: 'Immutable-Zkevm-Testnet Mainnet' - - url: 'https://imx-indexer.sequence.app' - description: 'Imx Mainnet' - - url: 'https://imx-testnet-indexer.sequence.app' - description: 'Imx-Testnet Mainnet' - - url: 'https://mainnet-indexer.sequence.app' - description: 'Mainnet Mainnet' - - url: 'https://optimism-indexer.sequence.app' - description: 'Optimism Mainnet' - - url: 'https://optimism-sepolia-indexer.sequence.app' - description: 'Optimism-Sepolia Mainnet' - - url: 'https://polygon-indexer.sequence.app' - description: 'Polygon Mainnet' - - url: 'https://polygon-zkevm-indexer.sequence.app' - description: 'Polygon-Zkevm Mainnet' - - url: 'https://rootnet-indexer.sequence.app' - description: 'Rootnet Mainnet' - - url: 'https://rootnet-porcini-indexer.sequence.app' - description: 'Rootnet-Porcini Mainnet' - - url: 'https://sepolia-indexer.sequence.app' - description: 'Sepolia Mainnet' - - url: 'https://skale-nebula-testnet-indexer.sequence.app' - description: 'Skale-Nebula-Testnet Mainnet' - - url: 'https://soneium-minato-indexer.sequence.app' - description: 'Soneium-Minato Mainnet' - - url: 'https://toy-testnet-indexer.sequence.app' - description: 'Toy-Testnet Mainnet' - - url: 'https://xai-indexer.sequence.app' - description: 'Xai Mainnet' - - url: 'https://xai-sepolia-indexer.sequence.app' - description: 'Xai-Sepolia Mainnet' - - url: 'https://xr-sepolia-indexer.sequence.app' - description: 'Xr-Sepolia Mainnet' + - url: https://amoy-indexer.sequence.app + description: Amoy Mainnet + - url: https://apechain-mainnet-indexer.sequence.app + description: Apechain-Mainnet Mainnet + - url: https://apechain-testnet-indexer.sequence.app + description: Apechain-Testnet Mainnet + - url: https://arbitrum-indexer.sequence.app + description: Arbitrum Mainnet + - url: https://arbitrum-nova-indexer.sequence.app + description: Arbitrum-Nova Mainnet + - url: https://arbitrum-sepolia-indexer.sequence.app + description: Arbitrum-Sepolia Mainnet + - url: https://astar-zkevm-indexer.sequence.app + description: Astar-Zkevm Mainnet + - url: https://astar-zkyoto-indexer.sequence.app + description: Astar-Zkyoto Mainnet + - url: https://avalanche-indexer.sequence.app + description: Avalanche Mainnet + - url: https://avalanche-testnet-indexer.sequence.app + description: Avalanche-Testnet Mainnet + - url: https://b3-indexer.sequence.app + description: B3 Mainnet + - url: https://b3-sepolia-indexer.sequence.app + description: B3-Sepolia Mainnet + - url: https://base-indexer.sequence.app + description: Base Mainnet + - url: https://base-sepolia-indexer.sequence.app + description: Base-Sepolia Mainnet + - url: https://blast-indexer.sequence.app + description: Blast Mainnet + - url: https://blast-sepolia-indexer.sequence.app + description: Blast-Sepolia Mainnet + - url: https://borne-testnet-indexer.sequence.app + description: Borne-Testnet Mainnet + - url: https://bsc-indexer.sequence.app + description: Bsc Mainnet + - url: https://bsc-testnet-indexer.sequence.app + description: Bsc-Testnet Mainnet + - url: https://gnosis-indexer.sequence.app + description: Gnosis Mainnet + - url: https://homeverse-indexer.sequence.app + description: Homeverse Mainnet + - url: https://homeverse-testnet-indexer.sequence.app + description: Homeverse-Testnet Mainnet + - url: https://immutable-zkevm-indexer.sequence.app + description: Immutable-Zkevm Mainnet + - url: https://immutable-zkevm-testnet-indexer.sequence.app + description: Immutable-Zkevm-Testnet Mainnet + - url: https://imx-indexer.sequence.app + description: Imx Mainnet + - url: https://imx-testnet-indexer.sequence.app + description: Imx-Testnet Mainnet + - url: https://mainnet-indexer.sequence.app + description: Mainnet Mainnet + - url: https://optimism-indexer.sequence.app + description: Optimism Mainnet + - url: https://optimism-sepolia-indexer.sequence.app + description: Optimism-Sepolia Mainnet + - url: https://polygon-indexer.sequence.app + description: Polygon Mainnet + - url: https://polygon-zkevm-indexer.sequence.app + description: Polygon-Zkevm Mainnet + - url: https://rootnet-indexer.sequence.app + description: Rootnet Mainnet + - url: https://rootnet-porcini-indexer.sequence.app + description: Rootnet-Porcini Mainnet + - url: https://sepolia-indexer.sequence.app + description: Sepolia Mainnet + - url: https://skale-nebula-testnet-indexer.sequence.app + description: Skale-Nebula-Testnet Mainnet + - url: https://soneium-minato-indexer.sequence.app + description: Soneium-Minato Mainnet + - url: https://toy-testnet-indexer.sequence.app + description: Toy-Testnet Mainnet + - url: https://xai-indexer.sequence.app + description: Xai Mainnet + - url: https://xai-sepolia-indexer.sequence.app + description: Xai-Sepolia Mainnet + - url: https://xr-sepolia-indexer.sequence.app + description: Xr-Sepolia Mainnet components: - securitySchemes: {'ApiKeyAuth': {'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key'}} + securitySchemes: + ApiKeyAuth: + type: apiKey + in: header + description: >- + Project access key for authenticating requests, get an access key at + https://sequence.build + name: X-Access-Key schemas: ErrorWebrpcEndpoint: type: object @@ -101,13 +103,13 @@ components: properties: error: type: string - example: "WebrpcEndpoint" + example: WebrpcEndpoint code: type: number example: 0 msg: type: string - example: "endpoint error" + example: endpoint error cause: type: string status: @@ -123,13 +125,13 @@ components: properties: error: type: string - example: "WebrpcRequestFailed" + example: WebrpcRequestFailed code: type: number example: -1 msg: type: string - example: "request failed" + example: request failed cause: type: string status: @@ -145,13 +147,13 @@ components: properties: error: type: string - example: "WebrpcBadRoute" + example: WebrpcBadRoute code: type: number example: -2 msg: type: string - example: "bad route" + example: bad route cause: type: string status: @@ -167,13 +169,13 @@ components: properties: error: type: string - example: "WebrpcBadMethod" + example: WebrpcBadMethod code: type: number example: -3 msg: type: string - example: "bad method" + example: bad method cause: type: string status: @@ -189,13 +191,13 @@ components: properties: error: type: string - example: "WebrpcBadRequest" + example: WebrpcBadRequest code: type: number example: -4 msg: type: string - example: "bad request" + example: bad request cause: type: string status: @@ -211,13 +213,13 @@ components: properties: error: type: string - example: "WebrpcBadResponse" + example: WebrpcBadResponse code: type: number example: -5 msg: type: string - example: "bad response" + example: bad response cause: type: string status: @@ -233,13 +235,13 @@ components: properties: error: type: string - example: "WebrpcServerPanic" + example: WebrpcServerPanic code: type: number example: -6 msg: type: string - example: "server panic" + example: server panic cause: type: string status: @@ -255,13 +257,13 @@ components: properties: error: type: string - example: "WebrpcInternalError" + example: WebrpcInternalError code: type: number example: -7 msg: type: string - example: "internal error" + example: internal error cause: type: string status: @@ -277,13 +279,13 @@ components: properties: error: type: string - example: "WebrpcClientDisconnected" + example: WebrpcClientDisconnected code: type: number example: -8 msg: type: string - example: "client disconnected" + example: client disconnected cause: type: string status: @@ -299,13 +301,13 @@ components: properties: error: type: string - example: "WebrpcStreamLost" + example: WebrpcStreamLost code: type: number example: -9 msg: type: string - example: "stream lost" + example: stream lost cause: type: string status: @@ -321,13 +323,13 @@ components: properties: error: type: string - example: "WebrpcStreamFinished" + example: WebrpcStreamFinished code: type: number example: -10 msg: type: string - example: "stream finished" + example: stream finished cause: type: string status: @@ -343,13 +345,13 @@ components: properties: error: type: string - example: "Unauthorized" + example: Unauthorized code: type: number example: 1000 msg: type: string - example: "Unauthorized access" + example: Unauthorized access cause: type: string status: @@ -365,13 +367,13 @@ components: properties: error: type: string - example: "PermissionDenied" + example: PermissionDenied code: type: number example: 1001 msg: type: string - example: "Permission denied" + example: Permission denied cause: type: string status: @@ -387,13 +389,13 @@ components: properties: error: type: string - example: "SessionExpired" + example: SessionExpired code: type: number example: 1002 msg: type: string - example: "Session expired" + example: Session expired cause: type: string status: @@ -409,13 +411,13 @@ components: properties: error: type: string - example: "MethodNotFound" + example: MethodNotFound code: type: number example: 1003 msg: type: string - example: "Method not found" + example: Method not found cause: type: string status: @@ -431,13 +433,13 @@ components: properties: error: type: string - example: "RequestConflict" + example: RequestConflict code: type: number example: 1004 msg: type: string - example: "Conflict with target resource" + example: Conflict with target resource cause: type: string status: @@ -453,13 +455,13 @@ components: properties: error: type: string - example: "Aborted" + example: Aborted code: type: number example: 1005 msg: type: string - example: "Request aborted" + example: Request aborted cause: type: string status: @@ -475,13 +477,13 @@ components: properties: error: type: string - example: "Timeout" + example: Timeout code: type: number example: 2000 msg: type: string - example: "Request timed out" + example: Request timed out cause: type: string status: @@ -497,13 +499,13 @@ components: properties: error: type: string - example: "InvalidArgument" + example: InvalidArgument code: type: number example: 2001 msg: type: string - example: "Invalid argument" + example: Invalid argument cause: type: string status: @@ -519,13 +521,13 @@ components: properties: error: type: string - example: "Unavailable" + example: Unavailable code: type: number example: 2002 msg: type: string - example: "Unavailable resource" + example: Unavailable resource cause: type: string status: @@ -541,13 +543,13 @@ components: properties: error: type: string - example: "QueryFailed" + example: QueryFailed code: type: number example: 2003 msg: type: string - example: "Query failed" + example: Query failed cause: type: string status: @@ -563,13 +565,13 @@ components: properties: error: type: string - example: "ResourceExhausted" + example: ResourceExhausted code: type: number example: 2004 msg: type: string - example: "Resource exhausted" + example: Resource exhausted cause: type: string status: @@ -585,13 +587,13 @@ components: properties: error: type: string - example: "NotFound" + example: NotFound code: type: number example: 3000 msg: type: string - example: "Resource not found" + example: Resource not found cause: type: string status: @@ -607,13 +609,13 @@ components: properties: error: type: string - example: "ProjectNotFound" + example: ProjectNotFound code: type: number example: 3002 msg: type: string - example: "Project not found" + example: Project not found cause: type: string status: @@ -629,13 +631,13 @@ components: properties: error: type: string - example: "MetadataCallFailed" + example: MetadataCallFailed code: type: number example: 3003 msg: type: string - example: "Metadata service call failed" + example: Metadata service call failed cause: type: string status: @@ -732,7 +734,7 @@ components: type: string properties: type: object - description: 'map' + description: map additionalProperties: type: object attributes: @@ -740,7 +742,7 @@ components: description: '[]map' items: type: object - description: 'map' + description: map additionalProperties: type: object imageData: @@ -989,7 +991,7 @@ components: type: number dirs: type: object - description: 'map' + description: map additionalProperties: type: string Bond: @@ -1140,7 +1142,7 @@ components: $ref: '#/components/schemas/TxnInfo' rawLog: type: object - description: 'map' + description: map additionalProperties: type: object event: @@ -1417,7 +1419,7 @@ components: $ref: '#/components/schemas/ContractInfo' tokenMetadata: type: object - description: 'map' + description: map additionalProperties: $ref: '#/components/schemas/TokenMetadata' TransactionHistoryFilter: @@ -1745,7 +1747,7 @@ components: properties: tokenMap: type: object - description: 'map' + description: map additionalProperties: type: array description: '[]string' @@ -1989,7 +1991,7 @@ components: properties: supplies: type: object - description: 'map' + description: map additionalProperties: type: array description: '[]TokenSupply' @@ -2110,12 +2112,16 @@ paths: post: summary: GetEtherBalance deprecated: true - description: "Queries an ethereum node for the latest and confirm ETH balances DEPRECATED: use GetNativeTokenBalance instead" + description: >- + Queries an ethereum node for the latest and confirm ETH balances + DEPRECATED: use GetNativeTokenBalance instead requestBody: content: application/json: schema: $ref: '#/components/schemas/Indexer_GetEtherBalance_Request' + example: + accountAddress: '0x8e3e38fe7367dd3b52d1e281e4e8400447c8d8b9' responses: '200': description: OK @@ -2123,7 +2129,11 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetEtherBalance_Response' - '4XX': + example: + balance: + accountAddress: '0x8e3e38fe7367dd3b52d1e281e4e8400447c8d8b9' + balanceWei: '9429929734634710350' + 4XX: description: Client error content: application/json: @@ -2150,7 +2160,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2162,7 +2172,11 @@ paths: /rpc/Indexer/GetNativeTokenBalance: 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." + 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. requestBody: content: application/json: @@ -2175,7 +2189,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetNativeTokenBalance_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2202,7 +2216,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2214,7 +2228,16 @@ paths: /rpc/Indexer/GetTokenBalancesSummary: 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.\nIf `filter` is not provided, it will use the filter with account from the jwt session.\nIf `filter.contractStatus` is not provided, it will include verified only tokens." + description: >- + 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.contractStatus` is not provided, it will include verified + only tokens. requestBody: content: application/json: @@ -2227,7 +2250,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetTokenBalancesSummary_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2254,7 +2277,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2266,7 +2289,16 @@ paths: /rpc/Indexer/GetTokenBalancesDetails: post: summary: GetTokenBalancesDetails - description: "GetTokenBalancesDetails returns a detailed balance summary for a specific accounts. The collection ERC721 & ERC1155 tokens are represented as individual balances.\nIf `filter` is not provided, it will use the filter with account from the jwt session.\nIf `filter.contractStatus` is not provided, it will include verified only tokens." + description: >- + 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.contractStatus` is not provided, it will include verified + only tokens. requestBody: content: application/json: @@ -2279,7 +2311,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetTokenBalancesDetails_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2306,7 +2338,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2318,7 +2350,16 @@ paths: /rpc/Indexer/GetTokenBalancesByContract: post: summary: GetTokenBalancesByContract - description: "GetTokenBalancesByContract returns a balances for a specific accounts and contracts. The collection ERC721 & ERC1155 tokens are represented as individual balances.\nIf `filter` is not provided, it will error out as it requires at least contract address.\nIf `filter.contractStatus` is not provided, it will include verified only tokens." + description: >- + 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.contractStatus` is not provided, it will include verified + only tokens. requestBody: content: application/json: @@ -2330,8 +2371,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Indexer_GetTokenBalancesByContract_Response' - '4XX': + $ref: >- + #/components/schemas/Indexer_GetTokenBalancesByContract_Response + 4XX: description: Client error content: application/json: @@ -2358,7 +2400,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2370,7 +2412,16 @@ paths: /rpc/Indexer/GetTokenBalances: 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.\nAlso, 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." + 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. + + 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: @@ -2383,7 +2434,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetTokenBalances_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2410,7 +2461,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2422,12 +2473,17 @@ paths: /rpc/Indexer/GetTokenSupplies: 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." + 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. requestBody: content: application/json: schema: $ref: '#/components/schemas/Indexer_GetTokenSupplies_Request' + example: + contractAddress: '0x369db37255c76aec060d070eabeb0661e51a42a9' responses: '200': description: OK @@ -2435,7 +2491,16 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetTokenSupplies_Response' - '4XX': + example: + page: + pageSize: 200 + more: false + contractType: ERC1155 + tokenIDs: + - tokenID: '0' + supply: '9' + chainId: 1 + 4XX: description: Client error content: application/json: @@ -2462,7 +2527,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2474,7 +2539,14 @@ paths: /rpc/Indexer/GetTokenSuppliesMap: 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.\nFor 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'] }" + 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. + + 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: @@ -2487,7 +2559,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetTokenSuppliesMap_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2514,7 +2586,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2526,12 +2598,17 @@ paths: /rpc/Indexer/GetBalanceUpdates: post: summary: GetBalanceUpdates - description: "Get balance update aggregate values -- useful for syncing balance details of a contract, ie. from Skyweaver" + description: >- + Get balance update aggregate values -- useful for syncing balance + details of a contract, ie. from Skyweaver requestBody: content: application/json: schema: $ref: '#/components/schemas/Indexer_GetBalanceUpdates_Request' + example: + contractAddress: '0x369db37255c76aec060d070eabeb0661e51a42a9' + lastBlockNumber: 0 responses: '200': description: OK @@ -2539,7 +2616,57 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetBalanceUpdates_Response' - '4XX': + example: + page: + pageSize: 200 + more: false + balances: + - contractType: ERC1155 + contractAddress: '0x369db37255c76aec060d070eabeb0661e51a42a9' + accountAddress: '0xc48835421ce2651bc5f78ee59d1e10244753c7fc' + tokenID: '0' + balance: '8' + blockHash: >- + 0x4db688b03de5804dd6e916ebafbc687aa3196c99288fbc63698e92c855400ff3 + blockNumber: 20126805 + chainId: 1 + - contractType: ERC1155 + contractAddress: '0x369db37255c76aec060d070eabeb0661e51a42a9' + accountAddress: '' + tokenID: '0' + balance: '9' + blockHash: >- + 0xd5e2e041f9d292b25076a512e198d183a55d21440be15e9869c0b1b7d9b179f5 + blockNumber: 20363254 + chainId: 1 + - contractType: ERC1155 + contractAddress: '0x369db37255c76aec060d070eabeb0661e51a42a9' + accountAddress: '0x0000000000000000000000000000000000000000' + tokenID: '0' + balance: '-9' + blockHash: >- + 0xd5e2e041f9d292b25076a512e198d183a55d21440be15e9869c0b1b7d9b179f5 + blockNumber: 20363254 + chainId: 1 + - contractType: ERC1155 + contractAddress: '0x369db37255c76aec060d070eabeb0661e51a42a9' + accountAddress: '0xbabebe9fe973a5735d486bf6d31e9a027248024e' + tokenID: '0' + balance: '1' + blockHash: >- + 0x080ea6171f82705555cd1248f73ce1d61dbcbd68f5eefab44b64dec2293a695f + blockNumber: 20692108 + chainId: 1 + - contractType: ERC1155 + contractAddress: '0x369db37255c76aec060d070eabeb0661e51a42a9' + accountAddress: '0xe6eb28398ccbe46aa505b62b96822c2ce8daabf4' + tokenID: '0' + balance: '0' + blockHash: >- + 0x080ea6171f82705555cd1248f73ce1d61dbcbd68f5eefab44b64dec2293a695f + blockNumber: 20692108 + chainId: 1 + 4XX: description: Client error content: application/json: @@ -2566,7 +2693,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2578,12 +2705,17 @@ paths: /rpc/Indexer/GetTransactionHistory: 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" + description: >- + 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: schema: $ref: '#/components/schemas/Indexer_GetTransactionHistory_Request' + example: + accountAddress: '0xe6eb28398ccbe46aa505b62b96822c2ce8daabf4' responses: '200': description: OK @@ -2591,7 +2723,88 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetTransactionHistory_Response' - '4XX': + example: + page: + after: >- + rmExGgC37OVhMnhCMHhiMjMzM2NlNDliNzlmMzcyOGUwYWFjNzNlNGMwNzYzYmVjODBlYmVmZGViZWZlOWU1ZDVmZGNiNWVmNzMyZWE2YTN4KjB4ZTZlYjI4Mzk4Y2NiZTQ2YWE1MDViNjJiOTY4MjJjMmNlOGRhYWJmNGE0eCoweGRkOTAxMjY4NTY5NTdhYTFlOWM1Y2MzMzk1ZTg2NmI2ZWI4MzBhNDRhNQJhNngqMHgwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwYTd4KjB4ZTZlYjI4Mzk4Y2NiZTQ2YWE1MDViNjJiOTY4MjJjMmNlOGRhYWJmNGE4eEIweDJkNmFiZmE1MTI2NDRmYzVjMjY2Nzk2ZTg4MzMxYmY0MWNhZDc1YWFlMjE4ZDQxODk0ODU1MzU4ZDhjODlhMGRhOQBhYQFhYmBhZIFDIjAiYWWBRCI2MiJhYxpm6I0N + pageSize: 10 + more: true + transactions: + - txnHash: >- + 0x64628263b93ccad7dfd6fb1a81f1bcdadd0eb89649e0a43bdf65f639fddcd319 + blockNumber: 12215569 + blockHash: >- + 0x05a4b055603a0b0cdb9e0d1bc28088bb4fca79a83d32bdc4a98d665e06ae7564 + chainId: 80002 + metaTxnID: null + transfers: + - transferType: RECEIVE + contractAddress: '0xdd90126856957aa1e9c5cc3395e866b6eb830a44' + contractType: ERC20 + from: '0x0000000000000000000000000000000000000000' + to: '0xe6eb28398ccbe46aa505b62b96822c2ce8daabf4' + tokenIds: + - '0' + amounts: + - '33' + logIndex: 9 + contractInfo: + chainId: 80002 + address: '0xdd90126856957aa1e9c5cc3395e866b6eb830a44' + name: Oracle Token + type: ERC20 + symbol: '' + deployed: true + bytecodeHash: >- + 0x77d12b9637a99b3ba23920eea929a68cc89b49a0e1ff4d2a71b798550cc0060e + extensions: + link: '' + description: '' + ogImage: '' + originChainId: 0 + originAddress: '0xdd90126856957aa1e9c5cc3395e866b6eb830a44' + verified: true + verifiedBy: Sequence Builder + updatedAt: '0001-01-01T00:00:00Z' + timestamp: '2024-09-20T20:36:45Z' + - txnHash: >- + 0x5aae198a65b993a767bd495ea77b7825e0e884d9dcc446a1515097eb962814d6 + blockNumber: 12213913 + blockHash: >- + 0x726ccdee4ef384493f96c666e959258ba70689bd6553c098a51542b2627a8b22 + chainId: 80002 + metaTxnID: null + transfers: + - transferType: RECEIVE + contractAddress: '0xdd90126856957aa1e9c5cc3395e866b6eb830a44' + contractType: ERC20 + from: '0x0000000000000000000000000000000000000000' + to: '0xe6eb28398ccbe46aa505b62b96822c2ce8daabf4' + tokenIds: + - '0' + amounts: + - '1000' + logIndex: 1 + contractInfo: + chainId: 80002 + address: '0xdd90126856957aa1e9c5cc3395e866b6eb830a44' + name: Oracle Token + type: ERC20 + symbol: '' + deployed: true + bytecodeHash: >- + 0x77d12b9637a99b3ba23920eea929a68cc89b49a0e1ff4d2a71b798550cc0060e + extensions: + link: '' + description: '' + ogImage: '' + originChainId: 0 + originAddress: '0xdd90126856957aa1e9c5cc3395e866b6eb830a44' + verified: true + verifiedBy: Sequence Builder + updatedAt: '0001-01-01T00:00:00Z' + timestamp: '2024-09-20T19:37:18Z' + 4XX: description: Client error content: application/json: @@ -2618,7 +2831,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2630,7 +2843,7 @@ paths: /rpc/Indexer/SyncBalance: post: summary: SyncBalance - description: "Re-sync an incorrect token balance with the correct on-chain balance" + description: Re-sync an incorrect token balance with the correct on-chain balance requestBody: content: application/json: @@ -2643,7 +2856,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_SyncBalance_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2670,7 +2883,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2682,7 +2895,7 @@ paths: /rpc/Indexer/FetchTransactionReceipt: post: summary: FetchTransactionReceipt - description: "Fetches a single receipt and then will stop the subscription" + description: Fetches a single receipt and then will stop the subscription requestBody: content: application/json: @@ -2695,7 +2908,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_FetchTransactionReceipt_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2722,7 +2935,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2734,12 +2947,45 @@ paths: /rpc/Indexer/GetOrderbookOrders: 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\nUse 'filter' and these fields instead - userAddresses - excludeUserAddress'" + description: >- + 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/Indexer_GetOrderbookOrders_Request' + example: + page: + page: 1 + pageSize: 100 + orderbookContractAddress: '0xB537a160472183f2150d42EB1c3DD6684A55f74c' + collectionAddress: '0x602d5dc17490794267c7fa5f58a453eb9159a86d' + currencyAddresses: + - '0x7ceb23fd6bc0add59e62ac25578270cff1b9f619' + - '0x0000000000000000000000000000000000000000' + - '0x3c499c542cef5e3811e1192ce70d8cc03d5c3359' + filter: + isListing: null + userAddresses: null + tokenIds: null + excludeUserAddresses: null + afterBlockNumber: 0 + afterCreatedAt: 0 + beforeExpiry: 0 + userAddress: null + excludeUserAddress: null + orderStatuses: + - OPEN + filters: null + beforeExpiryTimestamp: 0 + blockNumberAfter: 0 + createdAtAfter: 0 responses: '200': description: OK @@ -2747,7 +2993,27 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetOrderbookOrders_Response' - '4XX': + example: + page: + page: 2 + pageSize: 100 + more: false + orders: + - orderId: '1198' + tokenContract: '0x602d5dc17490794267c7fa5f58a453eb9159a86d' + tokenId: '3' + isListing: true + quantity: '1' + quantityRemaining: '1' + currencyAddress: '0x3c499c542cef5e3811e1192ce70d8cc03d5c3359' + pricePerToken: '1000000' + expiry: '1729168819' + orderStatus: OPEN + createdBy: '0xf43a1defbd32243fd83fe702f7817dde3319246e' + blockNumber: 63027844 + orderbookContractAddress: '0xb537a160472183f2150d42eb1c3dd6684a55f74c' + createdAt: 1728909642 + 4XX: description: Client error content: application/json: @@ -2774,7 +3040,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2798,7 +3064,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetTopOrders_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2825,7 +3091,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2837,20 +3103,22 @@ paths: /rpc/Indexer/FetchTransactionReceiptWithFilter: post: summary: FetchTransactionReceiptWithFilter - description: "Fetches a single receipt with filter and then will stop the subscription" + description: Fetches a single receipt with filter and then will stop the subscription requestBody: content: application/json: schema: - $ref: '#/components/schemas/Indexer_FetchTransactionReceiptWithFilter_Request' + $ref: >- + #/components/schemas/Indexer_FetchTransactionReceiptWithFilter_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Indexer_FetchTransactionReceiptWithFilter_Response' - '4XX': + $ref: >- + #/components/schemas/Indexer_FetchTransactionReceiptWithFilter_Response + 4XX: description: Client error content: application/json: @@ -2877,7 +3145,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2894,6 +3162,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetAllWebhookListeners_Request' + example: + projectId: 31396 responses: '200': description: OK @@ -2901,7 +3171,26 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetAllWebhookListeners_Response' - '4XX': + example: + listeners: + - id: 160497579 + projectID: 31396 + url: >- + https://webhook.site/#!/view/a2859143-0a52-4b69-98f2-a58733e4dcf0 + filters: + events: + - >- + Transfer(address indexed from,address indexed + to,uint256 indexed tokenId) + contractAddresses: + - '0x9bec34c1f7098e278afd48fedcf13355b854364a' + accounts: + - '0xe6eb28398ccbe46aa505b62b96822c2ce8daabf4' + tokenIDs: null + name: 'webhook.site #a84730' + updatedAt: '2024-10-10T20:37:01.685037Z' + active: true + 4XX: description: Client error content: application/json: @@ -2928,7 +3217,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2945,6 +3234,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetWebhookListener_Request' + example: + id: 160497579 + projectId: 31396 responses: '200': description: OK @@ -2952,7 +3244,26 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_GetWebhookListener_Response' - '4XX': + example: + listener: + id: 160497579 + projectID: 31396 + url: >- + https://webhook.site/#!/view/a2859143-0a52-4b69-98f2-a58733e4dcf0 + filters: + events: + - >- + Transfer(address indexed from,address indexed to,uint256 + indexed tokenId) + contractAddresses: + - '0x9bec34c1f7098e278afd48fedcf13355b854364a' + accounts: + - '0xe6eb28398ccbe46aa505b62b96822c2ce8daabf4' + tokenIDs: null + name: 'webhook.site #a84730' + updatedAt: '2024-10-10T20:37:01.685037632Z' + active: true + 4XX: description: Client error content: application/json: @@ -2979,7 +3290,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -2996,6 +3307,19 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_AddWebhookListener_Request' + example: + filters: + accounts: + - '0xe6eB28398CCBe46aA505b62b96822c2Ce8DAABf4' + contractAddresses: + - '0x9bec34c1f7098e278afd48fedcf13355b854364a' + events: + - >- + Transfer(address indexed from, address indexed to, uint256 + indexed tokenId) + projectId: 31396 + url: >- + https://webhook.site/#!/view/a2859143-0a52-4b69-98f2-a58733e4dcf0 responses: '200': description: OK @@ -3003,7 +3327,27 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_AddWebhookListener_Response' - '4XX': + example: + status: true + listener: + id: 160497579 + projectID: 31396 + url: >- + https://webhook.site/#!/view/a2859143-0a52-4b69-98f2-a58733e4dcf0 + filters: + events: + - >- + Transfer(address indexed from,address indexed to,uint256 + indexed tokenId) + contractAddresses: + - '0x9bec34c1f7098e278afd48fedcf13355b854364a' + accounts: + - '0xe6eb28398ccbe46aa505b62b96822c2ce8daabf4' + tokenIDs: null + name: 'webhook.site #a84730' + updatedAt: '2024-10-10T20:37:01.685037632Z' + active: true + 4XX: description: Client error content: application/json: @@ -3030,7 +3374,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -3047,6 +3391,21 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_UpdateWebhookListener_Request' + example: + filters: + accounts: + - '0xe6eB28398CCBe46aA505b62b96822c2Ce8DAABf4' + contractAddresses: + - '0x9bec34c1f7098e278afd48fedcf13355b854364a' + tokenIDs: + - '100' + events: + - >- + Transfer(address indexed from, address indexed to, uint256 + indexed tokenId) + projectId: 31396 + url: >- + https://webhook.site/#!/view/a2859143-0a52-4b69-98f2-a58733e4dcf0 responses: '200': description: OK @@ -3054,7 +3413,28 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_UpdateWebhookListener_Response' - '4XX': + example: + status: true + listener: + id: 2435835685 + projectID: 31396 + url: >- + https://webhook.site/#!/view/a2859143-0a52-4b69-98f2-a58733e4dcf0 + filters: + events: + - >- + Transfer(address indexed from,address indexed to,uint256 + indexed tokenId) + contractAddresses: + - '0x9bec34c1f7098e278afd48fedcf13355b854364a' + accounts: + - '0xe6eb28398ccbe46aa505b62b96822c2ce8daabf4' + tokenIDs: + - '100' + name: 'webhook.site #b5cf2f' + updatedAt: '2024-10-10T20:52:58.924369913Z' + active: true + 4XX: description: Client error content: application/json: @@ -3081,7 +3461,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -3098,6 +3478,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_RemoveWebhookListener_Request' + example: + id: 160497579 + projectId: 31396 responses: '200': description: OK @@ -3105,7 +3488,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_RemoveWebhookListener_Response' - '4XX': + example: + status: true + 4XX: description: Client error content: application/json: @@ -3132,7 +3517,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -3156,7 +3541,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_ToggleWebhookListener_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -3183,7 +3568,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -3207,7 +3592,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_PauseAllWebhookListeners_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -3234,7 +3619,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -3257,8 +3642,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Indexer_ResumeAllWebhookListeners_Response' - '4XX': + $ref: >- + #/components/schemas/Indexer_ResumeAllWebhookListeners_Response + 4XX: description: Client error content: application/json: @@ -3285,7 +3671,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -3309,7 +3695,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_SubscribeReceipts_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -3336,7 +3722,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -3348,7 +3734,9 @@ paths: /rpc/Indexer/SubscribeEvents: post: summary: SubscribeEvents - description: "TODO: pass optional block ... can pass too, reorg true, etc. or stay behind, etc." + description: >- + TODO: pass optional block ... can pass too, reorg true, etc. or stay + behind, etc. requestBody: content: application/json: @@ -3361,7 +3749,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_SubscribeEvents_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -3388,7 +3776,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: @@ -3412,7 +3800,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Indexer_SubscribeBalanceUpdates_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -3439,7 +3827,7 @@ paths: - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorMetadataCallFailed' - '5XX': + 5XX: description: Server error content: application/json: diff --git a/docs/pages/api/marketplace/marketplace.gen.yaml b/docs/pages/api/marketplace/rpc.gen.yaml similarity index 84% rename from docs/pages/api/marketplace/marketplace.gen.yaml rename to docs/pages/api/marketplace/rpc.gen.yaml index 00e1e8caa98..4c4626deb8c 100644 --- a/docs/pages/api/marketplace/marketplace.gen.yaml +++ b/docs/pages/api/marketplace/rpc.gen.yaml @@ -1,91 +1,93 @@ -# marketplace-api 13b9e0ed8d94fdfd214b9619eaec2a8985e9c08d -# -- -# Code generated by webrpc-gen@v0.20.3 with openapi generator; DO NOT EDIT -# -# webrpc-gen -service=Marketplace -ignore=@internal -schema=proto/marketplace.ridl -target=openapi -title=Marketplace Api -servers=https://marketplace-api.sequence.app/amoy;Amoy Marketplace API,https://marketplace-api.sequence.app/apechain;Apechain Marketplace API,https://marketplace-api.sequence.app/apechain-testnet;Apechain-Testnet Marketplace API,https://marketplace-api.sequence.app/arbitrum;Arbitrum Marketplace API,https://marketplace-api.sequence.app/arbitrum-nova;Arbitrum-Nova Marketplace API,https://marketplace-api.sequence.app/arbitrum-sepolia;Arbitrum-Sepolia Marketplace API,https://marketplace-api.sequence.app/astar-zkevm;Astar-Zkevm Marketplace API,https://marketplace-api.sequence.app/astar-zkyoto;Astar-Zkyoto Marketplace API,https://marketplace-api.sequence.app/avalanche;Avalanche Marketplace API,https://marketplace-api.sequence.app/avalanche-testnet;Avalanche-Testnet Marketplace API,https://marketplace-api.sequence.app/b3;B3 Marketplace API,https://marketplace-api.sequence.app/b3-sepolia;B3-Sepolia Marketplace API,https://marketplace-api.sequence.app/base;Base Marketplace API,https://marketplace-api.sequence.app/base-sepolia;Base-Sepolia Marketplace API,https://marketplace-api.sequence.app/blast;Blast Marketplace API,https://marketplace-api.sequence.app/blast-sepolia;Blast-Sepolia Marketplace API,https://marketplace-api.sequence.app/borne-testnet;Borne-Testnet Marketplace API,https://marketplace-api.sequence.app/bsc;Bsc Marketplace API,https://marketplace-api.sequence.app/bsc-testnet;Bsc-Testnet Marketplace API,https://marketplace-api.sequence.app/gnosis;Gnosis Marketplace API,https://marketplace-api.sequence.app/homeverse;Homeverse Marketplace API,https://marketplace-api.sequence.app/homeverse-testnet;Homeverse-Testnet Marketplace API,https://marketplace-api.sequence.app/immutable-zkevm;Immutable-Zkevm Marketplace API,https://marketplace-api.sequence.app/immutable-zkevm-testnet;Immutable-Zkevm-Testnet Marketplace API,https://marketplace-api.sequence.app/mainnet;Mainnet Marketplace API,https://marketplace-api.sequence.app/optimism;Optimism Marketplace API,https://marketplace-api.sequence.app/optimism-sepolia;Optimism-Sepolia Marketplace API,https://marketplace-api.sequence.app/polygon;Polygon Marketplace API,https://marketplace-api.sequence.app/polygon-zkevm;Polygon-Zkevm Marketplace API,https://marketplace-api.sequence.app/rootnet;Rootnet Marketplace API,https://marketplace-api.sequence.app/rootnet-porcini;Rootnet-Porcini Marketplace API,https://marketplace-api.sequence.app/sepolia;Sepolia Marketplace API,https://marketplace-api.sequence.app/skale-nebula-testnet;Skale-Nebula-Testnet Marketplace API,https://marketplace-api.sequence.app/soneium-minato;Soneium-Minato Marketplace API,https://marketplace-api.sequence.app/toy-testnet;Toy-Testnet Marketplace API,https://marketplace-api.sequence.app/xai;Xai Marketplace API,https://marketplace-api.sequence.app/xai-sepolia;Xai-Sepolia Marketplace API,https://marketplace-api.sequence.app/xr-sepolia;Xr-Sepolia Marketplace API -securityAnnotation=@auth -securitySchemes={ 'ApiKeyAuth': { 'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key' }, } -out=proto/docs/marketplace.gen.yaml openapi: 3.0.0 info: - title: 'Marketplace Api' + title: Marketplace Api version: '' servers: - - url: 'https://marketplace-api.sequence.app/amoy' - description: 'Amoy Marketplace API' - - url: 'https://marketplace-api.sequence.app/apechain' - description: 'Apechain Marketplace API' - - url: 'https://marketplace-api.sequence.app/apechain-testnet' - description: 'Apechain-Testnet Marketplace API' - - url: 'https://marketplace-api.sequence.app/arbitrum' - description: 'Arbitrum Marketplace API' - - url: 'https://marketplace-api.sequence.app/arbitrum-nova' - description: 'Arbitrum-Nova Marketplace API' - - url: 'https://marketplace-api.sequence.app/arbitrum-sepolia' - description: 'Arbitrum-Sepolia Marketplace API' - - url: 'https://marketplace-api.sequence.app/astar-zkevm' - description: 'Astar-Zkevm Marketplace API' - - url: 'https://marketplace-api.sequence.app/astar-zkyoto' - description: 'Astar-Zkyoto Marketplace API' - - url: 'https://marketplace-api.sequence.app/avalanche' - description: 'Avalanche Marketplace API' - - url: 'https://marketplace-api.sequence.app/avalanche-testnet' - description: 'Avalanche-Testnet Marketplace API' - - url: 'https://marketplace-api.sequence.app/b3' - description: 'B3 Marketplace API' - - url: 'https://marketplace-api.sequence.app/b3-sepolia' - description: 'B3-Sepolia Marketplace API' - - url: 'https://marketplace-api.sequence.app/base' - description: 'Base Marketplace API' - - url: 'https://marketplace-api.sequence.app/base-sepolia' - description: 'Base-Sepolia Marketplace API' - - url: 'https://marketplace-api.sequence.app/blast' - description: 'Blast Marketplace API' - - url: 'https://marketplace-api.sequence.app/blast-sepolia' - description: 'Blast-Sepolia Marketplace API' - - url: 'https://marketplace-api.sequence.app/borne-testnet' - description: 'Borne-Testnet Marketplace API' - - url: 'https://marketplace-api.sequence.app/bsc' - description: 'Bsc Marketplace API' - - url: 'https://marketplace-api.sequence.app/bsc-testnet' - description: 'Bsc-Testnet Marketplace API' - - url: 'https://marketplace-api.sequence.app/gnosis' - description: 'Gnosis Marketplace API' - - url: 'https://marketplace-api.sequence.app/homeverse' - description: 'Homeverse Marketplace API' - - url: 'https://marketplace-api.sequence.app/homeverse-testnet' - description: 'Homeverse-Testnet Marketplace API' - - url: 'https://marketplace-api.sequence.app/immutable-zkevm' - description: 'Immutable-Zkevm Marketplace API' - - url: 'https://marketplace-api.sequence.app/immutable-zkevm-testnet' - description: 'Immutable-Zkevm-Testnet Marketplace API' - - url: 'https://marketplace-api.sequence.app/mainnet' - description: 'Mainnet Marketplace API' - - url: 'https://marketplace-api.sequence.app/optimism' - description: 'Optimism Marketplace API' - - url: 'https://marketplace-api.sequence.app/optimism-sepolia' - description: 'Optimism-Sepolia Marketplace API' - - url: 'https://marketplace-api.sequence.app/polygon' - description: 'Polygon Marketplace API' - - url: 'https://marketplace-api.sequence.app/polygon-zkevm' - description: 'Polygon-Zkevm Marketplace API' - - url: 'https://marketplace-api.sequence.app/rootnet' - description: 'Rootnet Marketplace API' - - url: 'https://marketplace-api.sequence.app/rootnet-porcini' - description: 'Rootnet-Porcini Marketplace API' - - url: 'https://marketplace-api.sequence.app/sepolia' - description: 'Sepolia Marketplace API' - - url: 'https://marketplace-api.sequence.app/skale-nebula-testnet' - description: 'Skale-Nebula-Testnet Marketplace API' - - url: 'https://marketplace-api.sequence.app/soneium-minato' - description: 'Soneium-Minato Marketplace API' - - url: 'https://marketplace-api.sequence.app/toy-testnet' - description: 'Toy-Testnet Marketplace API' - - url: 'https://marketplace-api.sequence.app/xai' - description: 'Xai Marketplace API' - - url: 'https://marketplace-api.sequence.app/xai-sepolia' - description: 'Xai-Sepolia Marketplace API' - - url: 'https://marketplace-api.sequence.app/xr-sepolia' - description: 'Xr-Sepolia Marketplace API' + - url: https://marketplace-api.sequence.app/amoy + description: Amoy Marketplace API + - url: https://marketplace-api.sequence.app/apechain + description: Apechain Marketplace API + - url: https://marketplace-api.sequence.app/apechain-testnet + description: Apechain-Testnet Marketplace API + - url: https://marketplace-api.sequence.app/arbitrum + description: Arbitrum Marketplace API + - url: https://marketplace-api.sequence.app/arbitrum-nova + description: Arbitrum-Nova Marketplace API + - url: https://marketplace-api.sequence.app/arbitrum-sepolia + description: Arbitrum-Sepolia Marketplace API + - url: https://marketplace-api.sequence.app/astar-zkevm + description: Astar-Zkevm Marketplace API + - url: https://marketplace-api.sequence.app/astar-zkyoto + description: Astar-Zkyoto Marketplace API + - url: https://marketplace-api.sequence.app/avalanche + description: Avalanche Marketplace API + - url: https://marketplace-api.sequence.app/avalanche-testnet + description: Avalanche-Testnet Marketplace API + - url: https://marketplace-api.sequence.app/b3 + description: B3 Marketplace API + - url: https://marketplace-api.sequence.app/b3-sepolia + description: B3-Sepolia Marketplace API + - url: https://marketplace-api.sequence.app/base + description: Base Marketplace API + - url: https://marketplace-api.sequence.app/base-sepolia + description: Base-Sepolia Marketplace API + - url: https://marketplace-api.sequence.app/blast + description: Blast Marketplace API + - url: https://marketplace-api.sequence.app/blast-sepolia + description: Blast-Sepolia Marketplace API + - url: https://marketplace-api.sequence.app/borne-testnet + description: Borne-Testnet Marketplace API + - url: https://marketplace-api.sequence.app/bsc + description: Bsc Marketplace API + - url: https://marketplace-api.sequence.app/bsc-testnet + description: Bsc-Testnet Marketplace API + - url: https://marketplace-api.sequence.app/gnosis + description: Gnosis Marketplace API + - url: https://marketplace-api.sequence.app/homeverse + description: Homeverse Marketplace API + - url: https://marketplace-api.sequence.app/homeverse-testnet + description: Homeverse-Testnet Marketplace API + - url: https://marketplace-api.sequence.app/immutable-zkevm + description: Immutable-Zkevm Marketplace API + - url: https://marketplace-api.sequence.app/immutable-zkevm-testnet + description: Immutable-Zkevm-Testnet Marketplace API + - url: https://marketplace-api.sequence.app/mainnet + description: Mainnet Marketplace API + - url: https://marketplace-api.sequence.app/optimism + description: Optimism Marketplace API + - url: https://marketplace-api.sequence.app/optimism-sepolia + description: Optimism-Sepolia Marketplace API + - url: https://marketplace-api.sequence.app/polygon + description: Polygon Marketplace API + - url: https://marketplace-api.sequence.app/polygon-zkevm + description: Polygon-Zkevm Marketplace API + - url: https://marketplace-api.sequence.app/rootnet + description: Rootnet Marketplace API + - url: https://marketplace-api.sequence.app/rootnet-porcini + description: Rootnet-Porcini Marketplace API + - url: https://marketplace-api.sequence.app/sepolia + description: Sepolia Marketplace API + - url: https://marketplace-api.sequence.app/skale-nebula-testnet + description: Skale-Nebula-Testnet Marketplace API + - url: https://marketplace-api.sequence.app/soneium-minato + description: Soneium-Minato Marketplace API + - url: https://marketplace-api.sequence.app/toy-testnet + description: Toy-Testnet Marketplace API + - url: https://marketplace-api.sequence.app/xai + description: Xai Marketplace API + - url: https://marketplace-api.sequence.app/xai-sepolia + description: Xai-Sepolia Marketplace API + - url: https://marketplace-api.sequence.app/xr-sepolia + description: Xr-Sepolia Marketplace API components: - securitySchemes: {ApiKeyAuth: {type: apiKey, in: header, description: 'Project access key for authenticating requests, get an access key at https://sequence.build', name: X-Access-Key}} + securitySchemes: + ApiKeyAuth: + type: apiKey + in: header + description: >- + Project access key for authenticating requests, get an access key at + https://sequence.build + name: X-Access-Key schemas: ErrorWebrpcEndpoint: type: object @@ -97,13 +99,13 @@ components: properties: error: type: string - example: "WebrpcEndpoint" + example: WebrpcEndpoint code: type: number example: 0 msg: type: string - example: "endpoint error" + example: endpoint error cause: type: string status: @@ -119,13 +121,13 @@ components: properties: error: type: string - example: "WebrpcRequestFailed" + example: WebrpcRequestFailed code: type: number example: -1 msg: type: string - example: "request failed" + example: request failed cause: type: string status: @@ -141,13 +143,13 @@ components: properties: error: type: string - example: "WebrpcBadRoute" + example: WebrpcBadRoute code: type: number example: -2 msg: type: string - example: "bad route" + example: bad route cause: type: string status: @@ -163,13 +165,13 @@ components: properties: error: type: string - example: "WebrpcBadMethod" + example: WebrpcBadMethod code: type: number example: -3 msg: type: string - example: "bad method" + example: bad method cause: type: string status: @@ -185,13 +187,13 @@ components: properties: error: type: string - example: "WebrpcBadRequest" + example: WebrpcBadRequest code: type: number example: -4 msg: type: string - example: "bad request" + example: bad request cause: type: string status: @@ -207,13 +209,13 @@ components: properties: error: type: string - example: "WebrpcBadResponse" + example: WebrpcBadResponse code: type: number example: -5 msg: type: string - example: "bad response" + example: bad response cause: type: string status: @@ -229,13 +231,13 @@ components: properties: error: type: string - example: "WebrpcServerPanic" + example: WebrpcServerPanic code: type: number example: -6 msg: type: string - example: "server panic" + example: server panic cause: type: string status: @@ -251,13 +253,13 @@ components: properties: error: type: string - example: "WebrpcInternalError" + example: WebrpcInternalError code: type: number example: -7 msg: type: string - example: "internal error" + example: internal error cause: type: string status: @@ -273,13 +275,13 @@ components: properties: error: type: string - example: "WebrpcClientDisconnected" + example: WebrpcClientDisconnected code: type: number example: -8 msg: type: string - example: "client disconnected" + example: client disconnected cause: type: string status: @@ -295,13 +297,13 @@ components: properties: error: type: string - example: "WebrpcStreamLost" + example: WebrpcStreamLost code: type: number example: -9 msg: type: string - example: "stream lost" + example: stream lost cause: type: string status: @@ -317,13 +319,13 @@ components: properties: error: type: string - example: "WebrpcStreamFinished" + example: WebrpcStreamFinished code: type: number example: -10 msg: type: string - example: "stream finished" + example: stream finished cause: type: string status: @@ -339,13 +341,13 @@ components: properties: error: type: string - example: "Unauthorized" + example: Unauthorized code: type: number example: 1000 msg: type: string - example: "Unauthorized access" + example: Unauthorized access cause: type: string status: @@ -361,13 +363,13 @@ components: properties: error: type: string - example: "PermissionDenied" + example: PermissionDenied code: type: number example: 1001 msg: type: string - example: "Permission denied" + example: Permission denied cause: type: string status: @@ -383,13 +385,13 @@ components: properties: error: type: string - example: "SessionExpired" + example: SessionExpired code: type: number example: 1002 msg: type: string - example: "Session expired" + example: Session expired cause: type: string status: @@ -405,13 +407,13 @@ components: properties: error: type: string - example: "MethodNotFound" + example: MethodNotFound code: type: number example: 1003 msg: type: string - example: "Method not found" + example: Method not found cause: type: string status: @@ -427,13 +429,13 @@ components: properties: error: type: string - example: "Timeout" + example: Timeout code: type: number example: 2000 msg: type: string - example: "Request timed out" + example: Request timed out cause: type: string status: @@ -449,13 +451,13 @@ components: properties: error: type: string - example: "InvalidArgument" + example: InvalidArgument code: type: number example: 2001 msg: type: string - example: "Invalid argument" + example: Invalid argument cause: type: string status: @@ -471,13 +473,13 @@ components: properties: error: type: string - example: "NotFound" + example: NotFound code: type: number example: 3000 msg: type: string - example: "Resource not found" + example: Resource not found cause: type: string status: @@ -493,13 +495,13 @@ components: properties: error: type: string - example: "UserNotFound" + example: UserNotFound code: type: number example: 3001 msg: type: string - example: "User not found" + example: User not found cause: type: string status: @@ -515,13 +517,13 @@ components: properties: error: type: string - example: "ProjectNotFound" + example: ProjectNotFound code: type: number example: 3002 msg: type: string - example: "Project not found" + example: Project not found cause: type: string status: @@ -537,13 +539,13 @@ components: properties: error: type: string - example: "InvalidTier" + example: InvalidTier code: type: number example: 3003 msg: type: string - example: "Invalid subscription tier" + example: Invalid subscription tier cause: type: string status: @@ -559,13 +561,13 @@ components: properties: error: type: string - example: "ProjectLimitReached" + example: ProjectLimitReached code: type: number example: 3005 msg: type: string - example: "Project limit reached" + example: Project limit reached cause: type: string status: @@ -581,13 +583,13 @@ components: properties: error: type: string - example: "NotImplemented" + example: NotImplemented code: type: number example: 9999 msg: type: string - example: "Not Implemented" + example: Not Implemented cause: type: string status: @@ -614,7 +616,7 @@ components: type: string properties: type: object - description: 'map' + description: map additionalProperties: type: object attributes: @@ -622,7 +624,7 @@ components: description: '[]map' items: type: object - description: 'map' + description: map additionalProperties: type: object imageData: @@ -1159,7 +1161,7 @@ components: properties: lastSynced: type: object - description: 'map' + description: map additionalProperties: $ref: '#/components/schemas/CollectionLastSynced' collectiblesSynced: @@ -1928,7 +1930,51 @@ paths: application/json: schema: $ref: '#/components/schemas/Marketplace_ListCurrencies_Response' - '4XX': + example: + currencies: + - chainId: 137 + contractAddress: '0x3c499c542cef5e3811e1192ce70d8cc03d5c3359' + name: '' + symbol: '' + decimals: 18 + imageUrl: '' + exchangeRate: 0 + defaultChainCurrency: true + nativeCurrency: false + sardineSupported: false + transakSupported: false + createdAt: '2024-10-10T14:09:23.649572Z' + updatedAt: '2024-10-10T14:09:23.649572Z' + - chainId: 137 + contractAddress: '0x7ceb23fd6bc0add59e62ac25578270cff1b9f619' + name: '' + symbol: '' + decimals: 18 + imageUrl: '' + exchangeRate: 0 + defaultChainCurrency: true + nativeCurrency: false + sardineSupported: false + transakSupported: false + createdAt: '2024-10-10T14:09:23.649578Z' + updatedAt: '2024-10-10T14:09:23.649578Z' + - chainId: 137 + contractAddress: '0x0000000000000000000000000000000000000000' + name: Matic + symbol: MATIC + decimals: 18 + imageUrl: >- + https://assets.sequence.info/images/networks/medium/137.webp + exchangeRate: 0 + defaultChainCurrency: false + nativeCurrency: true + sardineSupported: false + transakSupported: false + createdAt: '2024-10-10T14:09:24.295951Z' + updatedAt: '2024-10-10T14:09:24Z' + external_url: https://boomland.io + updatedAt: '2024-10-10T14:25:44.332280097Z' + 4XX: description: Client error content: application/json: @@ -1952,7 +1998,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -1970,6 +2016,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Marketplace_GetCollectible_Request' + example: + contractAddress: '0x44B3F42E2BF34F62868FF9E9DAB7C2F807BA97CB' + tokenId: '0' responses: '200': description: OK @@ -1977,7 +2026,21 @@ paths: application/json: schema: $ref: '#/components/schemas/Marketplace_GetCollectible_Response' - '4XX': + example: + metadata: + tokenId: '0' + name: Elf Archer Shard - Common + description: Shards for the Hunters On-Chain game + image: https://hunt-nft.cdn.boombit.cloud/Shards/0.png + properties: null + attributes: + - trait_type: Rarity + value: Common + - trait_type: Type + value: Elf Archer + external_url: https://boomland.io + updatedAt: '2024-10-10T14:25:44.332280097Z' + 4XX: description: Client error content: application/json: @@ -2001,7 +2064,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2018,15 +2081,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetLowestPriceOfferForCollectible_Request' + $ref: >- + #/components/schemas/Marketplace_GetLowestPriceOfferForCollectible_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetLowestPriceOfferForCollectible_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_GetLowestPriceOfferForCollectible_Response + 4XX: description: Client error content: application/json: @@ -2050,7 +2115,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2067,15 +2132,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetHighestPriceOfferForCollectible_Request' + $ref: >- + #/components/schemas/Marketplace_GetHighestPriceOfferForCollectible_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetHighestPriceOfferForCollectible_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_GetHighestPriceOfferForCollectible_Response + 4XX: description: Client error content: application/json: @@ -2099,7 +2166,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2116,15 +2183,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetLowestPriceListingForCollectible_Request' + $ref: >- + #/components/schemas/Marketplace_GetLowestPriceListingForCollectible_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetLowestPriceListingForCollectible_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_GetLowestPriceListingForCollectible_Response + 4XX: description: Client error content: application/json: @@ -2148,7 +2217,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2165,15 +2234,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetHighestPriceListingForCollectible_Request' + $ref: >- + #/components/schemas/Marketplace_GetHighestPriceListingForCollectible_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetHighestPriceListingForCollectible_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_GetHighestPriceListingForCollectible_Response + 4XX: description: Client error content: application/json: @@ -2197,7 +2268,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2214,15 +2285,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_ListListingsForCollectible_Request' + $ref: >- + #/components/schemas/Marketplace_ListListingsForCollectible_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_ListListingsForCollectible_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_ListListingsForCollectible_Response + 4XX: description: Client error content: application/json: @@ -2246,7 +2319,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2263,15 +2336,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_ListOffersForCollectible_Request' + $ref: >- + #/components/schemas/Marketplace_ListOffersForCollectible_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_ListOffersForCollectible_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_ListOffersForCollectible_Response + 4XX: description: Client error content: application/json: @@ -2295,7 +2370,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2315,15 +2390,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetCollectibleLowestOffer_Request' + $ref: >- + #/components/schemas/Marketplace_GetCollectibleLowestOffer_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetCollectibleLowestOffer_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_GetCollectibleLowestOffer_Response + 4XX: description: Client error content: application/json: @@ -2347,7 +2424,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2361,20 +2438,24 @@ paths: post: summary: GetCollectibleHighestOffer deprecated: true - description: "This endpoint is deprecated. Please use GetHighestPriceOfferForCollectible()" + description: >- + This endpoint is deprecated. Please use + GetHighestPriceOfferForCollectible() requestBody: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetCollectibleHighestOffer_Request' + $ref: >- + #/components/schemas/Marketplace_GetCollectibleHighestOffer_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetCollectibleHighestOffer_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_GetCollectibleHighestOffer_Response + 4XX: description: Client error content: application/json: @@ -2398,7 +2479,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2412,20 +2493,24 @@ paths: post: summary: GetCollectibleLowestListing deprecated: true - description: "This endpoint is deprecated. Please use GetLowestPriceListingForCollectible()" + description: >- + This endpoint is deprecated. Please use + GetLowestPriceListingForCollectible() requestBody: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetCollectibleLowestListing_Request' + $ref: >- + #/components/schemas/Marketplace_GetCollectibleLowestListing_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetCollectibleLowestListing_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_GetCollectibleLowestListing_Response + 4XX: description: Client error content: application/json: @@ -2449,7 +2534,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2463,20 +2548,24 @@ paths: post: summary: GetCollectibleHighestListing deprecated: true - description: "This endpoint is deprecated. Please use GetHighestPriceListingForCollectible()" + description: >- + This endpoint is deprecated. Please use + GetHighestPriceListingForCollectible() requestBody: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetCollectibleHighestListing_Request' + $ref: >- + #/components/schemas/Marketplace_GetCollectibleHighestListing_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GetCollectibleHighestListing_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_GetCollectibleHighestListing_Response + 4XX: description: Client error content: application/json: @@ -2500,7 +2589,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2514,7 +2603,7 @@ paths: post: summary: ListCollectibleListings deprecated: true - description: "This endpoint is deprecated. Please use ListListingsForCollectible()" + description: This endpoint is deprecated. Please use ListListingsForCollectible() requestBody: content: application/json: @@ -2526,8 +2615,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_ListCollectibleListings_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_ListCollectibleListings_Response + 4XX: description: Client error content: application/json: @@ -2551,7 +2641,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2565,7 +2655,7 @@ paths: post: summary: ListCollectibleOffers deprecated: true - description: "This endpoint is deprecated. Please use ListOffersForCollectible()" + description: This endpoint is deprecated. Please use ListOffersForCollectible() requestBody: content: application/json: @@ -2577,8 +2667,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_ListCollectibleOffers_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_ListCollectibleOffers_Response + 4XX: description: Client error content: application/json: @@ -2602,7 +2693,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2615,20 +2706,40 @@ paths: /rpc/Marketplace/GenerateBuyTransaction: post: summary: GenerateBuyTransaction - description: "checkout process" + description: checkout process requestBody: content: application/json: schema: $ref: '#/components/schemas/Marketplace_GenerateBuyTransaction_Request' + example: + collectionAddress: '0x44b3f42e2bf34f62868ff9e9dab7c2f807ba97cb' + buyer: '0xD2eFbb2f18bfE3D265b26D2ACe83400A65335a07' + marketplace: magic_eden + ordersData: + - orderId: >- + 0xdb10541c97abdf95eaf55e77b619c58ed06d6b14469131badc657dabb2a823f0 + quantity: '18' + walletType: sequence responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GenerateBuyTransaction_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_GenerateBuyTransaction_Response + example: + steps: + - id: tokenApproval + data: >- + 0xe7acab24000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000006c00000007b02230091a7ed01230072f7006a004d60a8d4e71d599b8104250f0000000000000000000000000000d2efbb2f18bfe3d265b26d2ace83400a65335a0700000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000052000000000000000000000000000000000000000000000000000000000000005a00000000000000000000000004cefda7eb55d6f7dd913032d4ee88ac5609594380000000000000000000000002d1a340cd83434243d090931afabf95b7d3078b00000000000000000000000000000000000000000000000000000000000000160000000000000000000000000000000000000000000000000000000000000022000000000000000000000000000000000000000000000000000000000000000030000000000000000000000000000000000000000000000000000000066fe1db4000000000000000000000000000000000000000000000000000000006726fc7000000000000000000000000000000000000000000000000000000000000000000e1c0c381d4da48b0000000000000000d467a7aec379c278c0ddc9a86b559e5a87328c9043e7bf343695554eaaf5a8892f7205e300000000000000000000000000000000000000000000000000000000000000000000000000000000000000030000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000300000000000000000000000044b3f42e2bf34f62868ff9e9dab7c2f807ba97cb0000000000000000000000000000000000000000000000000000000000000096000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000d3751fe908000000000000000000000000000000000000000000000000000000d3751fe9080000000000000000000000000004cefda7eb55d6f7dd913032d4ee88ac5609594380000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000b5e620f480000000000000000000000000000000000000000000000000000000b5e620f4800000000000000000000000000099f1117f13e072b299942037e6a5d1469912b47a000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000048c273950000000000000000000000000000000000000000000000000000000048c2739500000000000000000000000000006fa303e72bed54f515a513496f922bc331e2f27e00000000000000000000000000000000000000000000000000000000000000413cc3ca6b43ab8b01102879bf64a0311a4d92a6727904c2f29a475bf163d77f3900e2fea71f1b616059f353a17e39ccc6c65b289c52aeb971bc0b2dea67d0380c1b00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000007e000000000000000000000000000000000000000000000000006707e6368b5bfbd9116608291be1bb6c97bb58d16839d624521f85dd1c8a09368e7d4c7d5d8ce5d60813788e5f08aae22963c5af59a51f087b98ff8a5181cba8ab8278e300c3d56aceec35c08a9a2ed624c39a99054544aa5ccdaba5b2792fce5025476b31000000000000000000000000000000000000000000000000000000000000000000001d4da48b00000000 + to: '0x0000000000000068F116a894984e2DB1123eB395' + value: '0x038d7ea4c68000' + signature: null + post: null + executeType: null + 4XX: description: Client error content: application/json: @@ -2652,7 +2763,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2676,8 +2787,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GenerateSellTransaction_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_GenerateSellTransaction_Response + 4XX: description: Client error content: application/json: @@ -2701,7 +2813,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2718,15 +2830,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GenerateListingTransaction_Request' + $ref: >- + #/components/schemas/Marketplace_GenerateListingTransaction_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GenerateListingTransaction_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_GenerateListingTransaction_Response + 4XX: description: Client error content: application/json: @@ -2750,7 +2864,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2767,15 +2881,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GenerateOfferTransaction_Request' + $ref: >- + #/components/schemas/Marketplace_GenerateOfferTransaction_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_GenerateOfferTransaction_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_GenerateOfferTransaction_Response + 4XX: description: Client error content: application/json: @@ -2799,7 +2915,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2812,7 +2928,9 @@ paths: /rpc/Marketplace/Execute: post: summary: Execute - description: "only used in a case of external transactions ( when we create off-chain transactions ) for instance opensea market" + description: >- + only used in a case of external transactions ( when we create off-chain + transactions ) for instance opensea market requestBody: content: application/json: @@ -2825,7 +2943,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Marketplace_Execute_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2849,7 +2967,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2874,7 +2992,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Marketplace_ListCollectibles_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2898,7 +3016,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2923,7 +3041,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Marketplace_GetFloorOrder_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -2947,7 +3065,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -2961,20 +3079,22 @@ paths: post: summary: ListCollectiblesWithLowestListing deprecated: true - description: "Deprecated use ListCollectibles() with OrderSide = Listing" + description: Deprecated use ListCollectibles() with OrderSide = Listing requestBody: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_ListCollectiblesWithLowestListing_Request' + $ref: >- + #/components/schemas/Marketplace_ListCollectiblesWithLowestListing_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_ListCollectiblesWithLowestListing_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_ListCollectiblesWithLowestListing_Response + 4XX: description: Client error content: application/json: @@ -2998,7 +3118,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -3012,20 +3132,22 @@ paths: post: summary: ListCollectiblesWithHighestOffer deprecated: true - description: "Deprecated use ListCollectibles() with OrderSide = Offer" + description: Deprecated use ListCollectibles() with OrderSide = Offer requestBody: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_ListCollectiblesWithHighestOffer_Request' + $ref: >- + #/components/schemas/Marketplace_ListCollectiblesWithHighestOffer_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_ListCollectiblesWithHighestOffer_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_ListCollectiblesWithHighestOffer_Response + 4XX: description: Client error content: application/json: @@ -3049,7 +3171,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -3074,7 +3196,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Marketplace_GetOrders_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -3098,7 +3220,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -3115,15 +3237,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_CheckoutOptionsMarketplace_Request' + $ref: >- + #/components/schemas/Marketplace_CheckoutOptionsMarketplace_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_CheckoutOptionsMarketplace_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_CheckoutOptionsMarketplace_Response + 4XX: description: Client error content: application/json: @@ -3147,7 +3271,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: @@ -3164,15 +3288,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Marketplace_CheckoutOptionsSalesContract_Request' + $ref: >- + #/components/schemas/Marketplace_CheckoutOptionsSalesContract_Request responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Marketplace_CheckoutOptionsSalesContract_Response' - '4XX': + $ref: >- + #/components/schemas/Marketplace_CheckoutOptionsSalesContract_Response + 4XX: description: Client error content: application/json: @@ -3196,7 +3322,7 @@ paths: - $ref: '#/components/schemas/ErrorProjectNotFound' - $ref: '#/components/schemas/ErrorInvalidTier' - $ref: '#/components/schemas/ErrorProjectLimitReached' - '5XX': + 5XX: description: Server error content: application/json: diff --git a/docs/pages/api/metadata/rest.gen.yaml b/docs/pages/api/metadata/rest.gen.yaml new file mode 100644 index 00000000000..837190926e6 --- /dev/null +++ b/docs/pages/api/metadata/rest.gen.yaml @@ -0,0 +1,227 @@ +openapi: 3.0.1 +info: + title: Metadata rest endpoints + version: "1.0.0" + description: API for managing projects, collections, assets, and tokens. +paths: + /projects/{projectId}: + get: + summary: Retrieve a project + description: Fetches a project by its ID. + parameters: + - name: projectId + in: path + required: true + schema: + type: string + description: The ID of the project to retrieve. + responses: + "200": + description: Project retrieved successfully + content: + application/json: + schema: + type: object + properties: + project: + type: object + properties: + id: + type: string + "400": + description: Bad request, wrong format for projectId + "403": + description: Forbidden, access denied to project + + /projects/{projectId}/collections/{collectionId}/private: + get: + summary: Retrieve a private collection + description: Fetches private collection details within a project. + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: collectionId + in: path + required: true + schema: + type: string + responses: + "200": + description: Collection retrieved successfully + content: + application/json: + schema: + type: object + "403": + description: Forbidden, access denied to collection + + /projects/{projectId}/collections/{collectionId}/private/{assetType}: + get: + summary: Download private collection asset + description: Downloads a private asset from a collection. + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: collectionId + in: path + required: true + schema: + type: string + - name: assetType + in: path + required: true + schema: + type: string + responses: + "200": + description: Asset downloaded successfully + content: + application/octet-stream: + schema: + type: string + format: binary + "403": + description: Forbidden, access denied to asset + + /projects/{projectId}/collections/{collectionId}/assets/{assetId}/upload: + put: + summary: Upload an asset + description: Uploads an asset file to a specified collection. + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: collectionId + in: path + required: true + schema: + type: string + - name: assetId + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/octet-stream: + schema: + type: string + format: binary + responses: + "200": + description: Asset uploaded successfully + "403": + description: Forbidden, access denied to upload + + /projects/{projectId}/collections/{collectionId}/tokens/{tokenId}/private: + get: + summary: Retrieve a private token + description: Fetches a private token within a collection in a project. + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: collectionId + in: path + required: true + schema: + type: string + - name: tokenId + in: path + required: true + schema: + type: string + responses: + "200": + description: Token retrieved successfully + content: + application/json: + schema: + type: object + "403": + description: Forbidden, access denied to token + + /projects/{projectId}/collections/{collectionId}/tokens/{tokenId}/upload/{assetIdOrAssetType}: + put: + summary: Upload a token asset + description: Uploads an asset to a token within a collection. + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: collectionId + in: path + required: true + schema: + type: string + - name: tokenId + in: path + required: true + schema: + type: string + - name: assetIdOrAssetType + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/octet-stream: + schema: + type: string + format: binary + responses: + "200": + description: Asset uploaded successfully + "403": + description: Forbidden, access denied to upload + + /projects/{projectId}/collections/{collectionId}/tokens/{tokenId}/asset/{assetType}: + get: + summary: Download a token asset + description: Downloads an asset of a specified type from a token. + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: collectionId + in: path + required: true + schema: + type: string + - name: tokenId + in: path + required: true + schema: + type: string + - name: assetType + in: path + required: true + schema: + type: string + responses: + "200": + description: Asset downloaded successfully + content: + application/octet-stream: + schema: + type: string + format: binary + "403": + description: Forbidden, access denied to asset \ No newline at end of file diff --git a/docs/pages/api/metadata/metadata.gen.yaml b/docs/pages/api/metadata/rpc.gen.yaml similarity index 99% rename from docs/pages/api/metadata/metadata.gen.yaml rename to docs/pages/api/metadata/rpc.gen.yaml index a91910acdb5..d6e9d43e7b1 100644 --- a/docs/pages/api/metadata/metadata.gen.yaml +++ b/docs/pages/api/metadata/rpc.gen.yaml @@ -2,7 +2,7 @@ # -- # Code generated by webrpc-gen@v0.20.3 with openapi generator; DO NOT EDIT # -# webrpc-gen -service=Metadata,Collections -ignore=@internal -schema=proto/metadata.ridl -target=openapi -title=Sequence Metadata -servers=https://metadata.sequence.app/;Metadata -securityAnnotation=@auth -securitySchemes={ 'ApiKeyAuth': { 'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key' }, 'BearerAuth': { 'type': 'http', 'scheme': 'bearer', 'bearerFormat': 'JWT', 'description': 'JWT Service Token generated from Sequence Builder', }, } -out=proto/docs/metadata.gen.yaml +# webrpc-gen -service=Metadata,Collections -ignore=@internal -schema=proto/metadata.ridl -target=openapi -title=Sequence Metadata -servers=https://metadata.sequence.app/;Metadata -securityAnnotation=@auth -securitySchemes={ 'ApiKeyAuth': { 'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key' }, 'BearerAuth': { 'type': 'http', 'scheme': 'bearer', 'bearerFormat': 'JWT', 'description': 'JWT Service Token generated from Sequence Builder', }, } -out=proto/docs/rpc.gen.yaml openapi: 3.0.0 info: title: 'Sequence Metadata' diff --git a/docs/pages/api/relayer/relayer.gen.yaml b/docs/pages/api/relayer/rpc.gen.yaml similarity index 77% rename from docs/pages/api/relayer/relayer.gen.yaml rename to docs/pages/api/relayer/rpc.gen.yaml index 8441c554ff1..289576bb2c1 100644 --- a/docs/pages/api/relayer/relayer.gen.yaml +++ b/docs/pages/api/relayer/rpc.gen.yaml @@ -1,87 +1,89 @@ -# sequence-relayer v0.4.1 31f2cfa0e54929f4347a88712954de9b9a29f0fb -# -- -# Code generated by webrpc-gen@v0.20.3 with openapi generator; DO NOT EDIT -# -# webrpc-gen -service=Relayer -match=@public -schema=proto/relayer.ridl -target=openapi -title=Relayer Api -servers=https://amoy-relayer.sequence.app;Amoy Relayer,https://apechain-relayer.sequence.app;Apechain Relayer,https://apechain-testnet-relayer.sequence.app;Apechain-Testnet Relayer,https://arbitrum-relayer.sequence.app;Arbitrum Relayer,https://arbitrum-nova-relayer.sequence.app;Arbitrum-Nova Relayer,https://arbitrum-sepolia-relayer.sequence.app;Arbitrum-Sepolia Relayer,https://avalanche-relayer.sequence.app;Avalanche Relayer,https://avalanche-testnet-relayer.sequence.app;Avalanche-Testnet Relayer,https://b3-relayer.sequence.app;B3 Relayer,https://b3-sepolia-relayer.sequence.app;B3-Sepolia Relayer,https://base-relayer.sequence.app;Base Relayer,https://base-sepolia-relayer.sequence.app;Base-Sepolia Relayer,https://blast-relayer.sequence.app;Blast Relayer,https://blast-sepolia-relayer.sequence.app;Blast-Sepolia Relayer,https://borne-testnet-relayer.sequence.app;Borne-Testnet Relayer,https://bsc-relayer.sequence.app;Bsc Relayer,https://bsc-testnet-relayer.sequence.app;Bsc-Testnet Relayer,https://gnosis-relayer.sequence.app;Gnosis Relayer,https://homeverse-relayer.sequence.app;Homeverse Relayer,https://homeverse-testnet-relayer.sequence.app;Homeverse-Testnet Relayer,https://immutable-zkevm-relayer.sequence.app;Immutable-Zkevm Relayer,https://immutable-zkevm-testnet-relayer.sequence.app;Immutable-Zkevm-Testnet Relayer,https://mainnet-relayer.sequence.app;Mainnet Relayer,https://optimism-relayer.sequence.app;Optimism Relayer,https://optimism-sepolia-relayer.sequence.app;Optimism-Sepolia Relayer,https://polygon-relayer.sequence.app;Polygon Relayer,https://polygon-zkevm-relayer.sequence.app;Polygon-Zkevm Relayer,https://rootnet-relayer.sequence.app;Rootnet Relayer,https://rootnet-porcini-relayer.sequence.app;Rootnet-Porcini Relayer,https://sepolia-relayer.sequence.app;Sepolia Relayer,https://skale-nebula-testnet-relayer.sequence.app;Skale-Nebula-Testnet Relayer,https://soneium-minato-relayer.sequence.app;Soneium-Minato Relayer,https://toy-testnet-relayer.sequence.app;Toy-Testnet Relayer,https://xai-relayer.sequence.app;Xai Relayer,https://xai-sepolia-relayer.sequence.app;Xai-Sepolia Relayer,https://xr-sepolia-relayer.sequence.app;Xr-Sepolia Relayer -securityAnnotation=@auth -securitySchemes={ 'ApiKeyAuth': { 'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key' }, } -out=proto/docs/relayer.gen.yaml openapi: 3.0.0 info: - title: 'Relayer Api' + title: Relayer Api version: '' servers: - - url: 'https://amoy-relayer.sequence.app' - description: 'Amoy Relayer' - - url: 'https://apechain-relayer.sequence.app' - description: 'Apechain Relayer' - - url: 'https://apechain-testnet-relayer.sequence.app' - description: 'Apechain-Testnet Relayer' - - url: 'https://arbitrum-relayer.sequence.app' - description: 'Arbitrum Relayer' - - url: 'https://arbitrum-nova-relayer.sequence.app' - description: 'Arbitrum-Nova Relayer' - - url: 'https://arbitrum-sepolia-relayer.sequence.app' - description: 'Arbitrum-Sepolia Relayer' - - url: 'https://avalanche-relayer.sequence.app' - description: 'Avalanche Relayer' - - url: 'https://avalanche-testnet-relayer.sequence.app' - description: 'Avalanche-Testnet Relayer' - - url: 'https://b3-relayer.sequence.app' - description: 'B3 Relayer' - - url: 'https://b3-sepolia-relayer.sequence.app' - description: 'B3-Sepolia Relayer' - - url: 'https://base-relayer.sequence.app' - description: 'Base Relayer' - - url: 'https://base-sepolia-relayer.sequence.app' - description: 'Base-Sepolia Relayer' - - url: 'https://blast-relayer.sequence.app' - description: 'Blast Relayer' - - url: 'https://blast-sepolia-relayer.sequence.app' - description: 'Blast-Sepolia Relayer' - - url: 'https://borne-testnet-relayer.sequence.app' - description: 'Borne-Testnet Relayer' - - url: 'https://bsc-relayer.sequence.app' - description: 'Bsc Relayer' - - url: 'https://bsc-testnet-relayer.sequence.app' - description: 'Bsc-Testnet Relayer' - - url: 'https://gnosis-relayer.sequence.app' - description: 'Gnosis Relayer' - - url: 'https://homeverse-relayer.sequence.app' - description: 'Homeverse Relayer' - - url: 'https://homeverse-testnet-relayer.sequence.app' - description: 'Homeverse-Testnet Relayer' - - url: 'https://immutable-zkevm-relayer.sequence.app' - description: 'Immutable-Zkevm Relayer' - - url: 'https://immutable-zkevm-testnet-relayer.sequence.app' - description: 'Immutable-Zkevm-Testnet Relayer' - - url: 'https://mainnet-relayer.sequence.app' - description: 'Mainnet Relayer' - - url: 'https://optimism-relayer.sequence.app' - description: 'Optimism Relayer' - - url: 'https://optimism-sepolia-relayer.sequence.app' - description: 'Optimism-Sepolia Relayer' - - url: 'https://polygon-relayer.sequence.app' - description: 'Polygon Relayer' - - url: 'https://polygon-zkevm-relayer.sequence.app' - description: 'Polygon-Zkevm Relayer' - - url: 'https://rootnet-relayer.sequence.app' - description: 'Rootnet Relayer' - - url: 'https://rootnet-porcini-relayer.sequence.app' - description: 'Rootnet-Porcini Relayer' - - url: 'https://sepolia-relayer.sequence.app' - description: 'Sepolia Relayer' - - url: 'https://skale-nebula-testnet-relayer.sequence.app' - description: 'Skale-Nebula-Testnet Relayer' - - url: 'https://soneium-minato-relayer.sequence.app' - description: 'Soneium-Minato Relayer' - - url: 'https://toy-testnet-relayer.sequence.app' - description: 'Toy-Testnet Relayer' - - url: 'https://xai-relayer.sequence.app' - description: 'Xai Relayer' - - url: 'https://xai-sepolia-relayer.sequence.app' - description: 'Xai-Sepolia Relayer' - - url: 'https://xr-sepolia-relayer.sequence.app' - description: 'Xr-Sepolia Relayer' + - url: https://amoy-relayer.sequence.app + description: Amoy Relayer + - url: https://apechain-relayer.sequence.app + description: Apechain Relayer + - url: https://apechain-testnet-relayer.sequence.app + description: Apechain-Testnet Relayer + - url: https://arbitrum-relayer.sequence.app + description: Arbitrum Relayer + - url: https://arbitrum-nova-relayer.sequence.app + description: Arbitrum-Nova Relayer + - url: https://arbitrum-sepolia-relayer.sequence.app + description: Arbitrum-Sepolia Relayer + - url: https://avalanche-relayer.sequence.app + description: Avalanche Relayer + - url: https://avalanche-testnet-relayer.sequence.app + description: Avalanche-Testnet Relayer + - url: https://b3-relayer.sequence.app + description: B3 Relayer + - url: https://b3-sepolia-relayer.sequence.app + description: B3-Sepolia Relayer + - url: https://base-relayer.sequence.app + description: Base Relayer + - url: https://base-sepolia-relayer.sequence.app + description: Base-Sepolia Relayer + - url: https://blast-relayer.sequence.app + description: Blast Relayer + - url: https://blast-sepolia-relayer.sequence.app + description: Blast-Sepolia Relayer + - url: https://borne-testnet-relayer.sequence.app + description: Borne-Testnet Relayer + - url: https://bsc-relayer.sequence.app + description: Bsc Relayer + - url: https://bsc-testnet-relayer.sequence.app + description: Bsc-Testnet Relayer + - url: https://gnosis-relayer.sequence.app + description: Gnosis Relayer + - url: https://homeverse-relayer.sequence.app + description: Homeverse Relayer + - url: https://homeverse-testnet-relayer.sequence.app + description: Homeverse-Testnet Relayer + - url: https://immutable-zkevm-relayer.sequence.app + description: Immutable-Zkevm Relayer + - url: https://immutable-zkevm-testnet-relayer.sequence.app + description: Immutable-Zkevm-Testnet Relayer + - url: https://mainnet-relayer.sequence.app + description: Mainnet Relayer + - url: https://optimism-relayer.sequence.app + description: Optimism Relayer + - url: https://optimism-sepolia-relayer.sequence.app + description: Optimism-Sepolia Relayer + - url: https://polygon-relayer.sequence.app + description: Polygon Relayer + - url: https://polygon-zkevm-relayer.sequence.app + description: Polygon-Zkevm Relayer + - url: https://rootnet-relayer.sequence.app + description: Rootnet Relayer + - url: https://rootnet-porcini-relayer.sequence.app + description: Rootnet-Porcini Relayer + - url: https://sepolia-relayer.sequence.app + description: Sepolia Relayer + - url: https://skale-nebula-testnet-relayer.sequence.app + description: Skale-Nebula-Testnet Relayer + - url: https://soneium-minato-relayer.sequence.app + description: Soneium-Minato Relayer + - url: https://toy-testnet-relayer.sequence.app + description: Toy-Testnet Relayer + - url: https://xai-relayer.sequence.app + description: Xai Relayer + - url: https://xai-sepolia-relayer.sequence.app + description: Xai-Sepolia Relayer + - url: https://xr-sepolia-relayer.sequence.app + description: Xr-Sepolia Relayer components: - securitySchemes: {'ApiKeyAuth': {'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key'}} + securitySchemes: + ApiKeyAuth: + type: apiKey + in: header + description: >- + Project access key for authenticating requests, get an access key at + https://sequence.build + name: X-Access-Key schemas: ErrorWebrpcEndpoint: type: object @@ -93,13 +95,13 @@ components: properties: error: type: string - example: "WebrpcEndpoint" + example: WebrpcEndpoint code: type: number example: 0 msg: type: string - example: "endpoint error" + example: endpoint error cause: type: string status: @@ -115,13 +117,13 @@ components: properties: error: type: string - example: "WebrpcRequestFailed" + example: WebrpcRequestFailed code: type: number example: -1 msg: type: string - example: "request failed" + example: request failed cause: type: string status: @@ -137,13 +139,13 @@ components: properties: error: type: string - example: "WebrpcBadRoute" + example: WebrpcBadRoute code: type: number example: -2 msg: type: string - example: "bad route" + example: bad route cause: type: string status: @@ -159,13 +161,13 @@ components: properties: error: type: string - example: "WebrpcBadMethod" + example: WebrpcBadMethod code: type: number example: -3 msg: type: string - example: "bad method" + example: bad method cause: type: string status: @@ -181,13 +183,13 @@ components: properties: error: type: string - example: "WebrpcBadRequest" + example: WebrpcBadRequest code: type: number example: -4 msg: type: string - example: "bad request" + example: bad request cause: type: string status: @@ -203,13 +205,13 @@ components: properties: error: type: string - example: "WebrpcBadResponse" + example: WebrpcBadResponse code: type: number example: -5 msg: type: string - example: "bad response" + example: bad response cause: type: string status: @@ -225,13 +227,13 @@ components: properties: error: type: string - example: "WebrpcServerPanic" + example: WebrpcServerPanic code: type: number example: -6 msg: type: string - example: "server panic" + example: server panic cause: type: string status: @@ -247,13 +249,13 @@ components: properties: error: type: string - example: "WebrpcInternalError" + example: WebrpcInternalError code: type: number example: -7 msg: type: string - example: "internal error" + example: internal error cause: type: string status: @@ -269,13 +271,13 @@ components: properties: error: type: string - example: "WebrpcClientDisconnected" + example: WebrpcClientDisconnected code: type: number example: -8 msg: type: string - example: "client disconnected" + example: client disconnected cause: type: string status: @@ -291,13 +293,13 @@ components: properties: error: type: string - example: "WebrpcStreamLost" + example: WebrpcStreamLost code: type: number example: -9 msg: type: string - example: "stream lost" + example: stream lost cause: type: string status: @@ -313,13 +315,13 @@ components: properties: error: type: string - example: "WebrpcStreamFinished" + example: WebrpcStreamFinished code: type: number example: -10 msg: type: string - example: "stream finished" + example: stream finished cause: type: string status: @@ -335,13 +337,13 @@ components: properties: error: type: string - example: "Unauthorized" + example: Unauthorized code: type: number example: 1000 msg: type: string - example: "Unauthorized access" + example: Unauthorized access cause: type: string status: @@ -357,13 +359,13 @@ components: properties: error: type: string - example: "PermissionDenied" + example: PermissionDenied code: type: number example: 1001 msg: type: string - example: "Permission denied" + example: Permission denied cause: type: string status: @@ -379,13 +381,13 @@ components: properties: error: type: string - example: "MethodNotFound" + example: MethodNotFound code: type: number example: 1003 msg: type: string - example: "Method not found" + example: Method not found cause: type: string status: @@ -401,13 +403,13 @@ components: properties: error: type: string - example: "Aborted" + example: Aborted code: type: number example: 1005 msg: type: string - example: "Request aborted" + example: Request aborted cause: type: string status: @@ -423,13 +425,13 @@ components: properties: error: type: string - example: "Geoblocked" + example: Geoblocked code: type: number example: 1006 msg: type: string - example: "Geoblocked region" + example: Geoblocked region cause: type: string status: @@ -445,13 +447,13 @@ components: properties: error: type: string - example: "InvalidArgument" + example: InvalidArgument code: type: number example: 2001 msg: type: string - example: "Invalid argument" + example: Invalid argument cause: type: string status: @@ -467,13 +469,13 @@ components: properties: error: type: string - example: "Unavailable" + example: Unavailable code: type: number example: 2002 msg: type: string - example: "Unavailable resource" + example: Unavailable resource cause: type: string status: @@ -489,13 +491,13 @@ components: properties: error: type: string - example: "QueryFailed" + example: QueryFailed code: type: number example: 2003 msg: type: string - example: "Query failed" + example: Query failed cause: type: string status: @@ -511,13 +513,13 @@ components: properties: error: type: string - example: "NotFound" + example: NotFound code: type: number example: 3000 msg: type: string - example: "Resource not found" + example: Resource not found cause: type: string status: @@ -533,13 +535,13 @@ components: properties: error: type: string - example: "InsufficientFee" + example: InsufficientFee code: type: number example: 3004 msg: type: string - example: "Insufficient fee" + example: Insufficient fee cause: type: string status: @@ -859,12 +861,12 @@ components: type: string txnArgs: type: object - description: 'map' + description: map additionalProperties: type: object txnReceipt: type: object - description: 'map' + description: map additionalProperties: type: object walletAddress: @@ -963,7 +965,7 @@ components: $ref: '#/components/schemas/TxnLogTransfer' users: type: object - description: 'map' + description: map additionalProperties: $ref: '#/components/schemas/TxnLogUser' timestamp: @@ -1161,7 +1163,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Relayer_GetChainID_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -1184,7 +1186,7 @@ paths: - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorInsufficientFee' - '5XX': + 5XX: description: Server error content: application/json: @@ -1208,7 +1210,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Relayer_FeeTokens_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -1231,7 +1233,7 @@ paths: - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorInsufficientFee' - '5XX': + 5XX: description: Server error content: application/json: @@ -1255,7 +1257,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Relayer_FeeOptions_Response' - '4XX': + 4XX: description: Client error content: application/json: @@ -1278,7 +1280,7 @@ paths: - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorInsufficientFee' - '5XX': + 5XX: description: Server error content: application/json: diff --git a/libs/example_merger.js b/libs/example_merger.js index 610b0271368..690a992b9a7 100644 --- a/libs/example_merger.js +++ b/libs/example_merger.js @@ -1,3 +1,5 @@ +#!/usr/bin/env node + import * as fs from 'node:fs' import path from 'node:path' import * as yaml from 'js-yaml' @@ -73,7 +75,7 @@ const addExamplesToOpenAPI = (doc, examples) => { } export const merge = (openApiFilepath) => { - // /docs/pages/api/marketplace/marketplace.gen.yaml + // /docs/pages/api/marketplace/rpc.gen.yaml const openAPIDoc = loadOpenAPIDocument(openApiFilepath) const dir = path.dirname(openApiFilepath) diff --git a/libs/openapi_merger.js b/libs/openapi_merger.js new file mode 100755 index 00000000000..5fdc4e41604 --- /dev/null +++ b/libs/openapi_merger.js @@ -0,0 +1,84 @@ +#!/usr/bin/env node + +import fs from 'fs'; +import yaml from 'js-yaml'; +import yargs from 'yargs' +import {hideBin} from 'yargs/helpers' + +function loadOpenApiDoc(filePath) { + const data = fs.readFileSync(filePath, 'utf8'); + return yaml.load(data); +} + +const saveOpenAPIDocument = (filePath, document) => { + try { + const yamlStr = yaml.dump(document) + fs.writeFileSync(filePath, yamlStr, 'utf8') + console.log('OpenAPI document updated!') + } catch (error) { + console.error(`Error saving OpenAPI document to ${filePath}:`, error) + throw error + } +} + +const result = { + openapi: "3.0.0", + info: { + title: "", + version: "", + }, + servers: [], + components: { + schemas: {}, + securitySchemes: {}, + }, + paths: {}, + security: [] +} + +yargs(hideBin(process.argv)) + .command( + 'merge ', + 'merge multiple openapi schema', + (yargs) => { + yargs.option('output', { + alias: 'o', + type: 'string', + description: 'Specify output file for merged OpenAPI schema', + default: 'openapi.gen.yaml', // default output file name + }); + }, + (argv) => { + argv.input.forEach((filePath, index) => { + const confData = loadOpenApiDoc(filePath); + + // first file take precedence in general info about openapi schema + if (index === 0) { + result["openapi"] = confData.openapi + result["info"] = confData.info + result["servers"] = confData.servers + result["security"] = confData.security + } + + for (const path in confData.paths) { + result["paths"][path] = confData.paths[path] + } + + if (confData.components) { + if (confData.components.securitySchemes) { + result["components"]["securitySchemes"] = confData.components.securitySchemes + } + + if (confData.components.schemas) { + for (const schema in confData.components.schemas) { + result["components"]["schemas"][schema] = confData.components.schemas[schema] + } + } + } + }) + + saveOpenAPIDocument(argv.output, result) + }, + ) + .demandCommand(1) + .parse() diff --git a/package.json b/package.json index ca3182a383c..9ba47c30cf5 100644 --- a/package.json +++ b/package.json @@ -4,11 +4,12 @@ "type": "module", "scripts": { "dev": "vocs dev", - "build": "vocs build --searchIndex false", + "build": "pnpm run prepare-openapi-docs && vocs build --searchIndex false", "preview": "vocs preview", "format": "biome format . --write", "lint": "biome lint . --write --unsafe", - "update-examples": "node libs/example_merger.js merge docs/pages/api/indexer/indexer.gen.yaml docs/pages/api/marketplace/marketplace.gen.yaml docs/pages/api/metadata/metadata.gen.yaml docs/pages/api/api/api.gen.yaml docs/pages/api/relayer/relayer.gen.yaml" + "prepare-openapi-docs": "./scripts/prepare-openapi-docs.sh", + "openapi-security": "./scripts/security-scheme.sh" }, "dependencies": { "0xsequence": "^2.0.10", diff --git a/scripts/prepare-openapi-docs.sh b/scripts/prepare-openapi-docs.sh new file mode 100755 index 00000000000..2851574730b --- /dev/null +++ b/scripts/prepare-openapi-docs.sh @@ -0,0 +1,18 @@ +#!/bin/bash + +node libs/openapi_merger.js merge -o docs/pages/api/analytics/analytics.gen.yaml docs/pages/api/analytics/rpc.gen.yaml +node libs/openapi_merger.js merge -o docs/pages/api/api/api.gen.yaml docs/pages/api/api/rpc.gen.yaml +node libs/openapi_merger.js merge -o docs/pages/api/indexer/indexer.gen.yaml docs/pages/api/indexer/rpc.gen.yaml +node libs/openapi_merger.js merge -o docs/pages/api/marketplace/marketplace.gen.yaml docs/pages/api/marketplace/rpc.gen.yaml +node libs/openapi_merger.js merge -o docs/pages/api/metadata/metadata.gen.yaml docs/pages/api/metadata/rpc.gen.yaml docs/pages/api/metadata/rest.gen.yaml +node libs/openapi_merger.js merge -o docs/pages/api/relayer/relayer.gen.yaml docs/pages/api/relayer/rpc.gen.yaml + +node libs/example_merger.js merge \ + docs/pages/api/analytics/analytics.gen.yaml \ + docs/pages/api/api/api.gen.yaml \ + docs/pages/api/indexer/indexer.gen.yaml \ + docs/pages/api/marketplace/marketplace.gen.yaml \ + docs/pages/api/metadata/metadata.gen.yaml \ + docs/pages/api/relayer/relayer.gen.yaml + + diff --git a/scripts/security-scheme.sh b/scripts/security-scheme.sh new file mode 100755 index 00000000000..dbc1d5e4731 --- /dev/null +++ b/scripts/security-scheme.sh @@ -0,0 +1,15 @@ +#!/bin/bash + +# Check if yq is installed +if ! command -v yq &> /dev/null; then + echo "yq is not installed. Please install yq[https://github.com/mikefarah/yq] to continue." + exit 1 +fi + +# Run yq commands +yq -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/api/api.gen.yaml && echo "updated docs/pages/api/api/api.gen.yaml" +yq -e -i '.security=[{"BearerAuth":[]}]' docs/pages/api/analytics/analytics.gen.yaml && echo "updated docs/pages/api/analytics/analytics.gen.yaml" +yq -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/marketplace/marketplace.gen.yaml && echo "updated docs/pages/api/marketplace/marketplace.gen.yaml" +yq -e -i '.security=[{"ApiKeyAuth":[]}, {"BearerAuth":[]}]' docs/pages/api/metadata/metadata.gen.yaml && echo "updated docs/pages/api/metadata/metadata.gen.yaml" +yq -e -i '.security=[{"ApiKeyAuth":[]}, {"BearerAuth":[]}]' docs/pages/api/indexer/indexer.gen.yaml && echo "updated docs/pages/api/indexer/indexer.gen.yaml" +yq -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/relayer/relayer.gen.yaml && echo "updated docs/pages/api/relayer/relayer.gen.yaml"