@xoxno/sdk-js 1.0.25 → 1.0.26

package/README.md

@@ -1,41 +1,922 @@
 # XOXNO SDK
 
-XOXNO SDK is a JavaScript library that simplifies the interaction with the XOXNO Protocol for developers. It includes a set of helper functions and modules that make it easy to fetch, filter, and interact with data from the XOXNO Protocol and its NFT marketplace.
+## Basic usage
 
-## Table of Contents
+```typescript
+// sdk.ts
+import { buildSdk, Chain, XOXNOClient } from '../src'
 
-- [Installation](#installation)
-- [Usage](#usage)
-- [Documentation](#docs)
+// It's not expensive to build the sdk, so you can safely call `getSdk()` wherever you need it
+export function getSdk() {
+  XOXNOClient.init({ apiUrl: 'https://api.xoxno.com', chain: Chain.MAINNET })
 
-## Installation
+  return buildSdk(XOXNOClient.getInstance())
+}
 
-To install the XOXNO SDK, simply run the following command in your project's root directory:
+async function main() {
+  const sdk = getSdk()
 
-```bash
-npm install @xoxno/sdk-js
+  /* Calling public endpoints ✅ */
+
+  const trendingCollections = await sdk.collection.query({
+    filter: {
+      top: 10,
+      orderBy: ['statistics.tradeData.weekEgldVolume desc'],
+      filters: {
+        isVerified: true,
+      },
+    },
+  })
+
+  console.log(trendingCollections.resources) // CollectionProfileDoc[]
+
+  const collectionProfile = await sdk.collection
+    .collection('BOOGAS-afc98d')
+    .profile()
+
+  console.log(collectionProfile.description) // string
+
+  // ... and many more! Just call sdk. and you will get type support
+}
+
+main()
+```
+
+## Calling restricted endpoints
+
+Apart from the public endpoints that anyone can call, The XOXNO SDK also exposes `POST`, `PUT`, `PATCH` and `DELETE` endpoints that can be called by the respective logged in user. Here's how a flow looks like that obtains a _XOXNO Auth Token_ when logging in with a MultiversX wallet, that can be used for 24h to make authenticated requests:
+
+```typescript
+// native-auth.ts
+import { getSdk } from './sdk'
+
+export class NativeAuthClient {
+  async initialize(extraInfo: object) {
+    const token = await getSdk().user.nativeToken({
+      originalUrl: 'https://yourdomain.com',
+      extraInfo: JSON.stringify({
+        ...extraInfo,
+        timestamp: Date.now(),
+        // ... and any other properties you want to have encoded in the JWT for your later usage
+      }),
+    })
+
+    return { token }
+  }
+  getToken(address: string, token: string, signature: string) {
+    const encodedAddress = this.encodeValue(address)
+
+    const encodedToken = this.encodeValue(token)
+
+    const loginToken = `${encodedAddress}.${encodedToken}.${signature}`
+
+    return { loginToken }
+  }
+  private encodeValue(str: string) {
+    return this.escape(Buffer.from(str, 'utf8').toString('base64'))
+  }
+  private escape(str: string) {
+    return str.replace(/\+/g, '-').replace(/\//g, '_').replace(/=/g, '')
+  }
+}
 ```
 
-## Usage
+```typescript
+import { ExtensionProvider } from '@multiversx/sdk-extension-provider'
+import { setCookie } from 'cookies-next'
+
+import { NativeAuthClient } from './native-auth'
+import { getSdk } from './sdk'
+
+async function main() {
+  const sdk = getSdk()
+
+  const provider = ExtensionProvider.getInstance()
 
-The SDK follows a scheleton model where the API configuration has to be initiated only once anywhere in your application
+  await provider.init()
 
-```javascript
-import { XOXNOClient } from '@xoxno/sdk-js';
-XOXNOClient.init();
-// By default calling init() without arguments will set the entire SDK to the mainnet ENV using the public API https://api.xoxno.com
+  const nativeAuthClient = new NativeAuthClient()
+
+  const loginMethod = 'extension'
+
+  const { token } = await nativeAuthClient.initialize({
+    loginMethod,
+  })
+
+  /* every time you login with a MultiversX provider, be it Extension, xPortal, Web Wallet or Ledger,
+     you have the possibility to pass a loginToken, and get back address and signature */
+  const { address, signature } = await provider.login({ token })
+
+  // obtain the accessToken that is exchanged for a XOXNO Auth Token
+  const { loginToken } = nativeAuthClient.getToken(address, token, signature!)
+
+  const { access_token, expires } = await sdk.user.login.POST({
+    body: {
+      loginToken,
+      signature: signature,
+      address: address,
+    },
+  })
+
+  // store the access_token for later usage
+  setCookie('xoxno-auth', access_token, {
+    expires: new Date(expires * 1000),
+    sameSite: 'strict',
+    secure: true,
+  })
+
+  // from now on you can call protected endpoints on behalf of `address`
+
+  const newUserProfile = await sdk.user.address(address).profile.PATCH({
+    body: {
+      description: 'XOXNO SDK rocks!',
+    },
+    auth: access_token,
+  })
+
+  console.log(newUserProfile.description) // XOXNO SDK rocks!
+}
+
+main()
 ```
 
-After the client has been created you can now import different modules anywhere in the application:
+## List of endpoints to call
+
+The list of available SDK endpoints gets extracted from https://api.xoxno.com/swagger.yaml and parsed into a Typescript definition that you can [view here](https://github.com/XOXNO/sdk-js/blob/alpha/src/sdk/swagger.ts)
+
+`buildSdk` then converts them in the following way:
 
-```javascript
-import { CollectionModule } from '@xoxno/sdk-js';
-const collection = new CollectionModule(); // In case the above .init() call was not set before creating any module instance will throw an error
-const profile = await collection.getCollectionProfile('MONKEY-ac9bdf');
-// or similar with 
-const profile = await new CollectionModule().getCollectionProfile('MONKEY-ac9bdf');
+```typescript
+// /collection/:collection/profile
+sdk.collection.collection('BOOGAS-afc98d').profile()
+
+// /drops/:creatorTag/:collectionTag/drop-info
+sdk.drops.creatorTag('MiceCityClub').collectionTag('MiceCity').dropInfo()
 ```
 
-## Docs
+For your reference, here is a list of all endpoints that are available:
+
+```typescript
+// DELETE /event/:eventId/description/image/:imageId
+sdk.event.eventId("...").description.image.imageId("...").DELETE(...); // SuccessDto
+
+// DELETE /event/:eventId/guest
+sdk.event.eventId("...").guest.DELETE(...); // SuccessDto
+
+// DELETE /event/:eventId/invite/:inviteId
+sdk.event.eventId("...").invite.inviteId("...").DELETE(...); // EventInvitationDoc
+
+// DELETE /event/:eventId/question/:questionId
+sdk.event.eventId("...").question.questionId("...").DELETE(...); // SuccessDto
+
+// DELETE /event/:eventId/referral-config/:configId
+sdk.event.eventId("...").referralConfig.configId("...").DELETE(...); // EventReferralConfigDoc
+
+// DELETE /event/:eventId/referral/:referralCode
+sdk.event.eventId("...").referral.referralCode("...").DELETE(...); // EventReferralDoc
+
+// DELETE /event/:eventId/role/:address
+sdk.event.eventId("...").role.address("...").DELETE(...); // SuccessDto
+
+// DELETE /event/:eventId/stage/:stageId
+sdk.event.eventId("...").stage.stageId("...").DELETE(...); // SuccessDto
+
+// DELETE /event/:eventId/voucher/:voucherCode
+sdk.event.eventId("...").voucher.voucherCode("...").DELETE(...); // EventVoucherDoc
+
+// DELETE /mobile/device/:deviceId
+sdk.mobile.device.deviceId("...").DELETE(...); // SuccessDto
+
+// DELETE /mobile/history/clear-all
+sdk.mobile.history.clearAll.DELETE(...); // NotificationSuccessResponseDto
+
+// DELETE /mobile/history/clear-id/:notificationId
+sdk.mobile.history.clearId.notificationId("...").DELETE(...); // NotificationSuccessResponseDto
+
+// DELETE /user/chat/conversation/:conversationId
+sdk.user.chat.conversation.conversationId("...").DELETE(...); // SuccessDto
+
+// DELETE /user/chat/conversation/:conversationId/message/:messageId
+sdk.user.chat.conversation.conversationId("...").message.messageId("...").DELETE(...); // SuccessDto
+
+// DELETE /user/me/settings/email
+sdk.user.me.settings.email.DELETE(...); // UserSettingsDoc
+
+// DELETE /user/notifications/clear
+sdk.user.notifications.clear.DELETE(...); // SuccessDto
+
+// DELETE /user/web2/:index/wallet-link
+sdk.user.web2.index("...").walletLink.DELETE(...); // Web2UserDoc
+
+// GET /activity/:identifier
+sdk.activity.identifier("...")(...); // NftActivityDocHydrated
+
+// GET /activity/query
+sdk.activity.query(...); // NftActivityPaginated
+
+// GET /analytics/marketplace-unique-users
+sdk.analytics.marketplaceUniqueUsers(...); // AnalyticsMarketplaceUniqueUsers[]
+
+// GET /analytics/overview
+sdk.analytics.overview(...); // GlobalAnalyticsOverviewResponseDto
+
+// GET /analytics/volume
+sdk.analytics.volume(...); // VolumeGraph[]
+
+// GET /arda/max-token-quantity
+sdk.arda.maxTokenQuantity(...); // ArdaSwapResultDto
+
+// GET /arda/min-token-quantity
+sdk.arda.minTokenQuantity(...); // ArdaSwapResultDto
+
+// GET /ash/max-token-quantity
+sdk.ash.maxTokenQuantity(...); // FetchSwapRoutesResponseDto
+
+// GET /ash/min-token-quantity
+sdk.ash.minTokenQuantity(...); // FetchSwapRoutesResponseDto
+
+// GET /collection/:collection/analytics/volume
+sdk.collection.collection("...").analytics.volume(...); // AnalyticsVolumeDto[]
+
+// GET /collection/:collection/attributes
+sdk.collection.collection("...").attributes(...); // Record<string
+
+// GET /collection/:collection/drop-info
+sdk.collection.collection("...").dropInfo(...); // CollectionMintProfileDocWithStages
+
+// GET /collection/:collection/floor-price
+sdk.collection.collection("...").floorPrice(...); // FloorPriceDto
+
+// GET /collection/:collection/holders
+sdk.collection.collection("...").holders(...); // CollectionHoldersDto
+
+// GET /collection/:collection/holders/export
+sdk.collection.collection("...").holders.export(...); // CollectionHoldersExportDto[]
+
+// GET /collection/:collection/listings
+sdk.collection.collection("...").listings(...); // ListingsResponseDto
+
+// GET /collection/:collection/owner
+sdk.collection.collection("...").owner(...); // CollectionOwnerDto
+
+// GET /collection/:collection/pinned
+sdk.collection.collection("...").pinned(...); // CollectionPinnedStatusDto
+
+// GET /collection/:collection/pinned-drops
+sdk.collection.collection("...").pinnedDrops(...); // CollectionPinnedStatusDto
+
+// GET /collection/:collection/profile
+sdk.collection.collection("...").profile(...); // CollectionProfileDoc
+
+// GET /collection/:collection/ranks
+sdk.collection.collection("...").ranks(...); // CollectionRanksDTO[]
+
+// GET /collection/:collection/staking/delegators
+sdk.collection.collection("...").staking.delegators(...); // string[]
+
+// GET /collection/:collection/staking/summary
+sdk.collection.collection("...").staking.summary(...); // StakingSummary[]
+
+// GET /collection/:collection/stats
+sdk.collection.collection("...").stats(...); // CollectionStatsDocHydrated
+
+// GET /collection/:creatorTag/:collectionTag/drop-info
+sdk.collection.creatorTag("...").collectionTag("...").dropInfo(...); // CollectionMintProfileDocWithStages
+
+// GET /collection/drops/query
+sdk.collection.drops.query(...); // CollectionMintProfilePaginated
+
+// GET /collection/drops/search
+sdk.collection.drops.search(...); // CollectionMintProfilePaginated
+
+// GET /collection/floor-price
+sdk.collection.floorPrice(...); // Record<string
+
+// GET /collection/global-offer/query
+sdk.collection.globalOffer.query(...); // GlobalOfferPaginated
+
+// GET /collection/pinned
+sdk.collection.pinned(...); // PinnedCollectionDto[]
+
+// GET /collection/pinned-drops
+sdk.collection.pinnedDrops(...); // CollectionMintProfileDocHydrated[]
+
+// GET /collection/query
+sdk.collection.query(...); // CollectionProfilePaginated
+
+// GET /collection/search
+sdk.collection.search(...); // GlobalSearchResourcesPaginated
+
+// GET /collection/staking/explore
+sdk.collection.staking.explore(...); // StakingExploreDtoHydrated[]
+
+// GET /collection/stats/query
+sdk.collection.stats.query(...); // CollectionStatsPaginated
+
+// GET /countries
+sdk.countries(...); // string[]
+
+// GET /event/:eventId
+sdk.event.eventId("...")(...); // EventProfile
+
+// GET /event/:eventId/answered-questions/:address
+sdk.event.eventId("...").answeredQuestions.address("...")(...); // AnsweredQuestionWithDetails[]
+
+// GET /event/:eventId/google-pass/:address
+sdk.event.eventId("...").googlePass.address("...")(...); // string[]
+
+// GET /event/:eventId/guest-export
+sdk.event.eventId("...").guestExport(...); // EventGuestExport[]
+
+// GET /event/:eventId/guest/:address
+sdk.event.eventId("...").guest.address("...")(...); // EventGuestProfile
+
+// GET /event/:eventId/guest/query
+sdk.event.eventId("...").guest.query(...); // EventGuestProfileQuery
+
+// GET /event/:eventId/invite/:inviteId
+sdk.event.eventId("...").invite.inviteId("...")(...); // EventInvitation
+
+// GET /event/:eventId/invite/query
+sdk.event.eventId("...").invite.query(...); // EventInvitationQuery
+
+// GET /event/:eventId/questions
+sdk.event.eventId("...").questions(...); // EventQuestionDoc[]
+
+// GET /event/:eventId/referral-configs
+sdk.event.eventId("...").referralConfigs(...); // EventReferralConfigPaginated
+
+// GET /event/:eventId/referrals
+sdk.event.eventId("...").referrals(...); // EventReferralPaginated
+
+// GET /event/:eventId/referrals/self-serviced
+sdk.event.eventId("...").referrals.selfServiced(...); // EventReferralDoc[]
+
+// GET /event/:eventId/role
+sdk.event.eventId("...").role(...); // EventUserRole[]
+
+// GET /event/:eventId/role/:address
+sdk.event.eventId("...").role.address("...")(...); // EventUserRoleDoc
+
+// GET /event/:eventId/roleId/:roleId
+sdk.event.eventId("...").roleId.roleId("...")(...); // EventUserRoleDoc
+
+// GET /event/:eventId/stage
+sdk.event.eventId("...").stage(...); // EventStageProfileDoc[]
+
+// GET /event/:eventId/stage/:stageId
+sdk.event.eventId("...").stage.stageId("...")(...); // EventStageProfileDoc
+
+// GET /event/:eventId/ticket
+sdk.event.eventId("...").ticket(...); // EventTicketProfileDoc[]
+
+// GET /event/:eventId/ticket/:ticketId
+sdk.event.eventId("...").ticket.ticketId("...")(...); // EventTicketProfileDoc
+
+// GET /event/:eventId/voucher/query
+sdk.event.eventId("...").voucher.query(...); // EventVoucherQuery
+
+// GET /event/profile/location
+sdk.event.profile.location(...); // EventCountGroupedByCountry[]
+
+// GET /event/profile/query
+sdk.event.profile.query(...); // EventProfileQuery
+
+// GET /launchpad/:scAddress/shareholders/collection/:collectionTag
+sdk.launchpad.scAddress("...").shareholders.collection.collectionTag("...")(...); // ShareholderDto[]
+
+// GET /launchpad/:scAddress/shareholders/royalties
+sdk.launchpad.scAddress("...").shareholders.royalties(...); // ShareholderDto[]
+
+// GET /lending/leaderboard
+sdk.lending.leaderboard(...); // LendingPositionStatus[]
+
+// GET /lending/market-sc
+sdk.lending.marketSc(...); // string[]
+
+// GET /lending/market/:token/analytics
+sdk.lending.market.token("...").analytics(...); // LendingMarketAnalyticsGraph[]
+
+// GET /lending/market/:token/emode-categories
+sdk.lending.market.token("...").emodeCategories(...); // LendingEModeCategoryProfile[]
+
+// GET /lending/market/:token/price/egld
+sdk.lending.market.token("...").price.egld(...); // LendingTokenPriceDto
+
+// GET /lending/market/:token/profile
+sdk.lending.market.token("...").profile(...); // LendingMarketProfile
+
+// GET /lending/market/emode-categories
+sdk.lending.market.emodeCategories(...); // LendingEModeCategoryProfile[]
+
+// GET /lending/market/indexes
+sdk.lending.market.indexes(...); // Record<string
+
+// GET /lending/market/prices
+sdk.lending.market.prices(...); // Record<string
+
+// GET /lending/market/query
+sdk.lending.market.query(...); // LendingMarketProfileQuery
+
+// GET /lending/stats
+sdk.lending.stats(...); // LendingOverallStats
+
+// GET /liquid/egld/execute-delegate
+sdk.liquid.egld.executeDelegate(...); // string
+
+// GET /liquid/egld/execute-undelegate
+sdk.liquid.egld.executeUndelegate(...); // string
+
+// GET /liquid/egld/liquid-supply
+sdk.liquid.egld.liquidSupply(...); // string
+
+// GET /liquid/egld/pending-delegate
+sdk.liquid.egld.pendingDelegate(...); // string
+
+// GET /liquid/egld/pending-fees
+sdk.liquid.egld.pendingFees(...); // string
+
+// GET /liquid/egld/pending-undelegate
+sdk.liquid.egld.pendingUndelegate(...); // string
+
+// GET /liquid/egld/protocol-apr
+sdk.liquid.egld.protocolApr(...); // ProtocolAprType
+
+// GET /liquid/egld/providers
+sdk.liquid.egld.providers(...); // ProviderDto[]
+
+// GET /liquid/egld/rate
+sdk.liquid.egld.rate(...); // RateType
+
+// GET /liquid/egld/staked
+sdk.liquid.egld.staked(...); // string
+
+// GET /liquid/egld/stats
+sdk.liquid.egld.stats(...); // XoxnoLiquidStatsDto
+
+// GET /liquid/xoxno/liquid-supply
+sdk.liquid.xoxno.liquidSupply(...); // string
+
+// GET /liquid/xoxno/rate
+sdk.liquid.xoxno.rate(...); // RateType
+
+// GET /liquid/xoxno/staked
+sdk.liquid.xoxno.staked(...); // string
+
+// GET /liquid/xoxno/stats
+sdk.liquid.xoxno.stats(...); // XoxnoLiquidStatsDto
+
+// GET /mobile/device/:deviceId
+sdk.mobile.device.deviceId("...")(...); // MobileDeviceDoc
+
+// GET /mobile/history
+sdk.mobile.history(...); // PushNotificationResponse
+
+// GET /mobile/history/unread-count
+sdk.mobile.history.unreadCount(...); // PushNotificationCountResponse
+
+// GET /nft/:identifier
+sdk.nft.identifier("...")(...); // NftDocFull
+
+// GET /nft/:identifier/offers
+sdk.nft.identifier("...").offers(...); // NftOfferPaginated
+
+// GET /nft/offer/:identifier
+sdk.nft.offer.identifier("...")(...); // NftOfferDocHydrated[]
+
+// GET /nft/offer/query
+sdk.nft.offer.query(...); // NftOfferPaginated
+
+// GET /nft/pinned
+sdk.nft.pinned(...); // NftDocHydrated[]
+
+// GET /nft/query
+sdk.nft.query(...); // NftPaginated
+
+// GET /nft/search/query
+sdk.nft.search.query(...); // NftPaginated
+
+// GET /pool/:poolId/profile
+sdk.pool.poolId("...").profile(...); // StakingSummary
+
+// GET /pool/:poolId/whitelist
+sdk.pool.poolId("...").whitelist(...); // NftDocHydrated[]
+
+// GET /search
+sdk.search(...); // GlobalSearchResourcesPaginated
+
+// GET /tokens
+sdk.tokens(...); // TokenDataDocHydrated[]
+
+// GET /tokens/egld
+sdk.tokens.egld(...); // IMetrics
+
+// GET /tokens/egld/fiat-price
+sdk.tokens.egld.fiatPrice(...); // Record<string
+
+// GET /tokens/sui
+sdk.tokens.sui(...); // IMetrics
+
+// GET /tokens/swap
+sdk.tokens.swap(...); // TokenDataDocHydrated[]
+
+// GET /tokens/usd-price
+sdk.tokens.usdPrice(...); // Record<string
+
+// GET /tokens/xoxno
+sdk.tokens.xoxno(...); // IMetrics
+
+// GET /tokens/xoxno/info
+sdk.tokens.xoxno.info(...); // XoxnoInfo
+
+// GET /transactions/:txHash
+sdk.transactions.txHash("...")(...); // TransactionDetailed
+
+// GET /transactions/:txHash/status
+sdk.transactions.txHash("...").status(...); // TransactionProcessStatus
+
+// GET /user/:address/analytics/volume
+sdk.user.address("...").analytics.volume(...); // UserAnalyticsDto
+
+// GET /user/:address/creator/details
+sdk.user.address("...").creator.details(...); // CreatorDetailsDto
+
+// GET /user/:address/creator/events
+sdk.user.address("...").creator.events(...); // CreatorDetailsDto
+
+// GET /user/:address/creator/listing
+sdk.user.address("...").creator.listing(...); // CreatorDetailsDto
+
+// GET /user/:address/creator/profile
+sdk.user.address("...").creator.profile(...); // CreatorProfileDto
+
+// GET /user/:address/favorite/collections
+sdk.user.address("...").favorite.collections(...); // CollectionStatsPaginated
+
+// GET /user/:address/favorite/nfts
+sdk.user.address("...").favorite.nfts(...); // NftPaginated
+
+// GET /user/:address/favorite/users
+sdk.user.address("...").favorite.users(...); // string[]
+
+// GET /user/:address/inventory-summary
+sdk.user.address("...").inventorySummary(...); // InventorySummaryDtoHydrated[]
+
+// GET /user/:address/network-account
+sdk.user.address("...").networkAccount(...); // UserNetworkInfoDto
+
+// GET /user/:address/offers
+sdk.user.address("...").offers(...); // NftOfferPaginated
+
+// GET /user/:address/profile
+sdk.user.address("...").profile(...); // UserProfileDoc
+
+// GET /user/:address/staking/available-pools
+sdk.user.address("...").staking.availablePools(...); // StakingSummary[]
+
+// GET /user/:address/staking/collection/:collection
+sdk.user.address("...").staking.collection.collection("...")(...); // StakingSummary[]
+
+// GET /user/:address/staking/creator
+sdk.user.address("...").staking.creator(...); // StakingCreatorDoc
+
+// GET /user/:address/staking/owned-collections
+sdk.user.address("...").staking.ownedCollections(...); // OwnedCollectionsDto
+
+// GET /user/:address/staking/owned-pools
+sdk.user.address("...").staking.ownedPools(...); // StakingSummary[]
+
+// GET /user/:address/staking/pool/:poolId/nfts
+sdk.user.address("...").staking.pool.poolId("...").nfts(...); // StakingUserPoolNfts
+
+// GET /user/:address/staking/summary
+sdk.user.address("...").staking.summary(...); // UserStakingSummaryDto[]
+
+// GET /user/:address/token-inventory
+sdk.user.address("...").tokenInventory(...); // UserTokenInventoryResponseDto
+
+// GET /user/:creatorTag/owned-services
+sdk.user.creatorTag("...").ownedServices(...); // OwnedServicesDto
+
+// GET /user/:tag/creator/is-registered
+sdk.user.tag("...").creator.isRegistered(...); // SuccessDto
+
+// GET /user/chat/block
+sdk.user.chat.block(...); // UserBlockPaginated
+
+// GET /user/chat/conversation
+sdk.user.chat.conversation(...); // UserConversationPaginated
+
+// GET /user/chat/conversation-summary
+sdk.user.chat.conversationSummary(...); // GlobalConversationSummaryDto
+
+// GET /user/chat/conversation/:conversationId
+sdk.user.chat.conversation.conversationId("...")(...); // ChatMessagePaginated
+
+// GET /user/favorite/:favoriteId
+sdk.user.favorite.favoriteId("...")(...); // CheckLikeStatusResponseDto
+
+// GET /user/lending/:address
+sdk.user.lending.address("...")(...); // LendingAccountProfile[]
+
+// GET /user/lending/image/:nonce
+sdk.user.lending.image.nonce("...")(...); // string
+
+// GET /user/lending/position/:identifier
+sdk.user.lending.position.identifier("...")(...); // LendingAccountProfile[]
+
+// GET /user/me
+sdk.user.me(...); // UserProfileDto
+
+// GET /user/me/event
+sdk.user.me.event(...); // EventProfile[]
+
+// GET /user/me/event/badge
+sdk.user.me.event.badge(...); // string
+
+// GET /user/me/event/badge/payload
+sdk.user.me.event.badge.payload(...); // BageQRData
+
+// GET /user/me/events/hosted
+sdk.user.me.events.hosted(...); // EventProfile[]
+
+// GET /user/me/events/past
+sdk.user.me.events.past(...); // EventProfile[]
+
+// GET /user/me/events/upcoming
+sdk.user.me.events.upcoming(...); // EventProfile[]
+
+// GET /user/me/settings
+sdk.user.me.settings(...); // UserSettingsDoc
+
+// GET /user/me/xoxno-drop
+sdk.user.me.xoxnoDrop(...); // AirdropDtoHydrated[]
+
+// GET /user/native-token
+sdk.user.nativeToken(...); // string
+
+// GET /user/notifications
+sdk.user.notifications(...); // NotificationPaginated
+
+// GET /user/notifications/unread-count
+sdk.user.notifications.unreadCount(...); // PushNotificationCountResponse
+
+// GET /user/search
+sdk.user.search(...); // GlobalSearchResourcesPaginated
+
+// GET /user/stats
+sdk.user.stats(...); // UserStatsDto[]
+
+// GET /user/web2
+sdk.user.web2(...); // Web2UserDoc
+
+// GET /user/web2/shards
+sdk.user.web2.shards(...); // Web2UserShardsDto
+
+// GET /user/xoxno-drop
+sdk.user.xoxnoDrop(...); // AirdropDtoHydrated[]
+
+// PATCH /collection/:collection/profile
+sdk.collection.collection("...").profile.PATCH(...); // CollectionProfileDoc
+
+// PATCH /event/:eventId
+sdk.event.eventId("...").PATCH(...); // EventProfile
+
+// PATCH /event/:eventId/guest/approve
+sdk.event.eventId("...").guest.approve.PATCH(...); // EventGuestProfile[]
+
+// PATCH /event/:eventId/question/:questionId
+sdk.event.eventId("...").question.questionId("...").PATCH(...); // EventQuestionDoc
+
+// PATCH /event/:eventId/referral-config/:configId
+sdk.event.eventId("...").referralConfig.configId("...").PATCH(...); // EventReferralConfigDoc
+
+// PATCH /event/:eventId/referral/:referralCode
+sdk.event.eventId("...").referral.referralCode("...").PATCH(...); // EventReferralDoc
+
+// PATCH /event/:eventId/stage/:stageId
+sdk.event.eventId("...").stage.stageId("...").PATCH(...); // EventStageProfileDoc
+
+// PATCH /event/:eventId/ticket/:ticketId
+sdk.event.eventId("...").ticket.ticketId("...").PATCH(...); // EventTicketProfileDoc
+
+// PATCH /event/:eventId/voucher/:voucherCode
+sdk.event.eventId("...").voucher.voucherCode("...").PATCH(...); // EventVoucherDoc
+
+// PATCH /pool/:poolId/profile
+sdk.pool.poolId("...").profile.PATCH(...); // StakingPoolDoc
+
+// PATCH /user/:address/creator/profile
+sdk.user.address("...").creator.profile.PATCH(...); // CreatorProfileDoc
+
+// PATCH /user/:address/profile
+sdk.user.address("...").profile.PATCH(...); // UserProfileDoc
+
+// PATCH /user/me/settings/billing
+sdk.user.me.settings.billing.PATCH(...); // UserSettingsDoc
+
+// PATCH /user/me/settings/email
+sdk.user.me.settings.email.PATCH(...); // UserSettingsDoc
+
+// PATCH /user/me/settings/notification-preferences
+sdk.user.me.settings.notificationPreferences.PATCH(...); // UserSettingsDoc
+
+// PATCH /user/me/settings/phone
+sdk.user.me.settings.phone.PATCH(...); // UserSettingsDoc
+
+// PATCH /user/notifications/read
+sdk.user.notifications.read.PATCH(...); // NotificationDoc|SuccessDto
+
+// POST /collection/:collection/follow
+sdk.collection.collection("...").follow.POST(...); // FollowCollectionDto
+
+// POST /collection/:collection/sign-mint
+sdk.collection.collection("...").signMint.POST(...); // SignDataDto
+
+// POST /collection/:collection/sign-offer
+sdk.collection.collection("...").signOffer.POST(...); // SignDataDto
+
+// POST /event
+sdk.event.POST(...); // EventProfile
+
+// POST /event/:eventId/calculate-prices
+sdk.event.eventId("...").calculatePrices.POST(...); // TicketPricesResponse
+
+// POST /event/:eventId/invite
+sdk.event.eventId("...").invite.POST(...); // EventInvitationDoc[]
+
+// POST /event/:eventId/invite/:inviteId
+sdk.event.eventId("...").invite.inviteId("...").POST(...); // EventInvitation
+
+// POST /event/:eventId/manual-check-in
+sdk.event.eventId("...").manualCheckIn.POST(...); // TicketValidationResult
+
+// POST /event/:eventId/notify-attendees
+sdk.event.eventId("...").notifyAttendees.POST(...); // SuccessWithMessageDto
+
+// POST /event/:eventId/question
+sdk.event.eventId("...").question.POST(...); // EventQuestionDoc
+
+// POST /event/:eventId/referral
+sdk.event.eventId("...").referral.POST(...); // EventReferralDoc
+
+// POST /event/:eventId/referral-config
+sdk.event.eventId("...").referralConfig.POST(...); // EventReferralConfigDoc
+
+// POST /event/:eventId/register
+sdk.event.eventId("...").register.POST(...); // EventRegistrationResponseDto
+
+// POST /event/:eventId/role
+sdk.event.eventId("...").role.POST(...); // EventUserRole
+
+// POST /event/:eventId/role/:roleId/accept
+sdk.event.eventId("...").role.roleId("...").accept.POST(...); // EventUserRoleDoc
+
+// POST /event/:eventId/scan
+sdk.event.eventId("...").scan.POST(...); // TicketValidationResult
+
+// POST /event/:eventId/stage
+sdk.event.eventId("...").stage.POST(...); // EventStageProfileDoc
+
+// POST /event/:eventId/ticket
+sdk.event.eventId("...").ticket.POST(...); // EventTicketProfileDoc
+
+// POST /event/:eventId/ticket/:ticketId
+sdk.event.eventId("...").ticket.ticketId("...").POST(...); // SuccessDto
+
+// POST /event/:eventId/validate-discount
+sdk.event.eventId("...").validateDiscount.POST(...); // DiscountCodeValidationResponse
+
+// POST /event/:eventId/voucher
+sdk.event.eventId("...").voucher.POST(...); // EventVoucherDoc
+
+// POST /eventNotifications/creator/marketing
+sdk.eventNotifications.creator.marketing.POST(...); // NotificationSuccessResponseDto
+
+// POST /eventNotifications/event/:eventId/reminder
+sdk.eventNotifications.event.eventId("...").reminder.POST(...); // NotificationSuccessResponseDto
+
+// POST /eventNotifications/event/:eventId/update
+sdk.eventNotifications.event.eventId("...").update.POST(...); // NotificationSuccessResponseDto
+
+// POST /eventNotifications/user/:userId/direct
+sdk.eventNotifications.user.userId("...").direct.POST(...); // NotificationSuccessResponseDto
+
+// POST /faucet
+sdk.faucet.POST(...); // SuccessDto
+
+// POST /mobile/device/register
+sdk.mobile.device.register.POST(...); // MobileDeviceDoc
+
+// POST /nft/:identifier/like
+sdk.nft.identifier("...").like.POST(...); // LikeNftDto
+
+// POST /nft/sign-withdraw
+sdk.nft.signWithdraw.POST(...); // SignDataDto
+
+// POST /notify/global-broadcast
+sdk.notify.globalBroadcast.POST(...); // SuccessWithMessageDto
+
+// POST /transactions
+sdk.transactions.POST(...); // TransactionSendResult
+
+// POST /transactions/batch
+sdk.transactions.batch.POST(...); // TransactionSendResult[]
+
+// POST /user/:address/follow
+sdk.user.address("...").follow.POST(...); // UserFavoriteResponseDto
+
+// POST /user/buy/signature
+sdk.user.buy.signature.POST(...); // TradesilvaniaSignature
+
+// POST /user/chat/block/:address
+sdk.user.chat.block.address("...").POST(...); // SuccessDto
+
+// POST /user/chat/message
+sdk.user.chat.message.POST(...); // ChatMessageDocHydrated
+
+// POST /user/chat/token
+sdk.user.chat.token.POST(...); // WebSocketTokenDto
+
+// POST /user/login
+sdk.user.login.POST(...); // LoginAccessDto
+
+// POST /user/me/settings/verify-email
+sdk.user.me.settings.verifyEmail.POST(...); // UserSettingsDoc
+
+// POST /user/network-account
+sdk.user.networkAccount.POST(...); // UserNetworkInfoDto[]
+
+// POST /user/web2/session-cookie
+sdk.user.web2.sessionCookie.POST(...); // SuccessWithMessageDto
+
+// POST /user/web2/wallet
+sdk.user.web2.wallet.POST(...); // Web2UserDoc
+
+// POST /user/web2/wallet-link
+sdk.user.web2.walletLink.POST(...); // Web2UserDoc
+
+// POST /user/web2/wallet-switch
+sdk.user.web2.walletSwitch.POST(...); // Web2UserDoc
+
+// PUT /collection/:collection/reset-banner
+sdk.collection.collection("...").resetBanner.PUT(...); // CollectionProfileDoc
+
+// PUT /collection/:collection/reset-picture
+sdk.collection.collection("...").resetPicture.PUT(...); // CollectionProfileDoc
+
+// PUT /collection/:collection/upload-banner
+sdk.collection.collection("...").uploadBanner.PUT(...); // CollectionProfileDoc
+
+// PUT /collection/:collection/upload-picture
+sdk.collection.collection("...").uploadPicture.PUT(...); // CollectionProfileDoc
+
+// PUT /event/:eventId/background
+sdk.event.eventId("...").background.PUT(...); // EventProfile
+
+// PUT /event/:eventId/description
+sdk.event.eventId("...").description.PUT(...); // EventProfile
+
+// PUT /event/:eventId/description/image
+sdk.event.eventId("...").description.image.PUT(...); // string
+
+// PUT /event/:eventId/profile
+sdk.event.eventId("...").profile.PUT(...); // EventProfile
+
+// PUT /event/:eventId/ticket/:ticketId
+sdk.event.eventId("...").ticket.ticketId("...").PUT(...); // EventTicketProfileDoc
+
+// PUT /mobile/history/:notificationId/read
+sdk.mobile.history.notificationId("...").read.PUT(...); // PushNotificationDoc
+
+// PUT /mobile/history/read-all
+sdk.mobile.history.readAll.PUT(...); // NotificationSuccessResponseDto
+
+// PUT /pool/:poolId/upload-picture
+sdk.pool.poolId("...").uploadPicture.PUT(...); // StakingPoolDoc
+
+// PUT /user/:address/creator/reset-banner
+sdk.user.address("...").creator.resetBanner.PUT(...); // CreatorProfileDoc
+
+// PUT /user/:address/creator/reset-picture
+sdk.user.address("...").creator.resetPicture.PUT(...); // CreatorProfileDoc
+
+// PUT /user/:address/creator/upload-banner
+sdk.user.address("...").creator.uploadBanner.PUT(...); // CreatorProfileDoc
+
+// PUT /user/:address/creator/upload-picture
+sdk.user.address("...").creator.uploadPicture.PUT(...); // CreatorProfileDoc
+
+// PUT /user/:address/reset-banner
+sdk.user.address("...").resetBanner.PUT(...); // UserProfileDoc
+
+// PUT /user/:address/reset-picture
+sdk.user.address("...").resetPicture.PUT(...); // UserProfileDoc
+
+// PUT /user/:address/upload-banner
+sdk.user.address("...").uploadBanner.PUT(...); // UserProfileDoc
+
+// PUT /user/:address/upload-picture
+sdk.user.address("...").uploadPicture.PUT(...); // UserProfileDoc
 
-For more modules and typescript interfaces you can check our documentation at [https://sdk.xoxno.com](https://sdk.xoxno.com)
+```