bitbadgesjs-sdk 0.22.6 → 0.23.0

package/README.md

@@ -21,6 +21,8 @@ This SDK is designed to be compatible with specific BitBadges chain versions. Us
 | v13                     | 0.19.x            | ✅ Current |
 | v14                     | 0.20.x            | ✅ Current |
 | v15                     | 0.20.x            | ✅ Current |
+| v16                     | 0.21.x            | ✅ Current |
+| v18                     | 0.23.x            | ✅ Current |
 
 **Recommendation:** Always use the latest patch version within your compatible major.minor version range. For example, if you're using BitBadges v12, use the latest `0.18.x` version.
 

package/dist/cjs/api-indexer/BitBadgesApi.d.ts

@@ -8,17 +8,17 @@ import type { DynamicDataHandlerType, NativeAddress, iChallengeTrackerIdDetails
 import { FilterSuggestionsSuccessResponse, FilterTokensInCollectionSuccessResponse, GetBalanceByAddressSuccessResponse, GetOwnersSuccessResponse, GetTokenActivitySuccessResponse, RefreshMetadataSuccessResponse, RefreshStatusSuccessResponse, iFilterSuggestionsPayload, iFilterTokensInCollectionPayload, iGetBalanceByAddressPayload, iGetOwnersPayload, iGetTokenActivityPayload, iRefreshMetadataPayload } from './requests/collections.js';
 import { GetMapSuccessResponse, GetMapValueSuccessResponse, GetMapValuesSuccessResponse, GetMapsSuccessResponse, iGetMapPayload, iGetMapValuesPayload, iGetMapsPayload } from './requests/maps.js';
 import { AddApprovalDetailsToOffChainStorageSuccessResponse, AddToIpfsSuccessResponse, BatchStoreActionSuccessResponse, BroadcastTxSuccessResponse, CalculatePointsSuccessResponse, CheckClaimSuccessSuccessResponse, CheckSignInStatusSuccessResponse, CompleteClaimSuccessResponse, CreateApiKeySuccessResponse, CreateApplicationSuccessResponse, CreateClaimSuccessResponse, CreateDeveloperAppSuccessResponse, CreateDynamicDataStoreSuccessResponse, CreatePaymentIntentSuccessResponse, CreatePluginSuccessResponse, CreateSIWBBRequestSuccessResponse, CreateUtilityPageSuccessResponse, DeleteApiKeySuccessResponse, DeleteApplicationSuccessResponse, DeleteClaimSuccessResponse, DeleteDeveloperAppSuccessResponse, DeleteDynamicDataStoreSuccessResponse, DeletePluginSuccessResponse, DeleteSIWBBRequestSuccessResponse, DeleteUtilityPageSuccessResponse, ExchangeSIWBBAuthorizationCodeSuccessResponse, FetchMetadataDirectlySuccessResponse, GenericBlockinVerifySuccessResponse, GenericVerifyAssetsSuccessResponse, GetActiveAuthorizationsSuccessResponse, GetApiKeysSuccessResponse, GetApplicationSuccessResponse, GetApplicationsSuccessResponse, GetAttemptDataFromRequestBinSuccessResponse, GetBrowseSuccessResponse, GetClaimAttemptStatusSuccessResponse, GetClaimAttemptsSuccessResponse, GetClaimSuccessResponse, GetClaimsSuccessResponse, GetCollectionAmountTrackerByIdSuccessResponse, GetCollectionChallengeTrackerByIdSuccessResponse, GetDeveloperAppSuccessResponse, GetDeveloperAppsSuccessResponse, GetDynamicDataActivitySuccessResponse, GetDynamicDataStoreSuccessResponse, GetDynamicDataStoreValueSuccessResponse, GetDynamicDataStoreValuesPaginatedSuccessResponse, GetDynamicDataStoresSuccessResponse, GetGatedContentForClaimSuccessResponse, GetPluginErrorsSuccessResponse, GetPluginSuccessResponse, GetPluginsSuccessResponse, GetPointsActivitySuccessResponse, GetReservedClaimCodesSuccessResponse, GetSIWBBRequestsForDeveloperAppSuccessResponse, GetSearchSuccessResponse, GetSignInChallengeSuccessResponse, GetStatusSuccessResponse, GetTokensFromFaucetSuccessResponse, GetUtilityPageSuccessResponse, GetUtilityPagesSuccessResponse, OauthRevokeSuccessResponse, PerformStoreActionSuccessResponse, RotateApiKeySuccessResponse, RotateSIWBBRequestSuccessResponse, ScheduleTokenRefreshSuccessResponse, SearchApplicationsSuccessResponse, SearchClaimsSuccessResponse, SearchDeveloperAppsSuccessResponse, SearchDynamicDataStoresSuccessResponse, SearchPluginsSuccessResponse, SearchUtilityPagesSuccessResponse, SignOutSuccessResponse, SimulateClaimSuccessResponse, SimulateTxSuccessResponse, UpdateAccountInfoSuccessResponse, UpdateApplicationSuccessResponse, UpdateClaimSuccessResponse, UpdateDeveloperAppSuccessResponse, UpdateDynamicDataStoreSuccessResponse, UpdatePluginSuccessResponse, UpdateUtilityPageSuccessResponse, VerifySignInSuccessResponse, iAddApprovalDetailsToOffChainStoragePayload, iAddToIpfsPayload, iBroadcastTxPayload, iCalculatePointsPayload, iCheckSignInStatusPayload, iCompleteClaimPayload, iCreateApiKeyPayload, iCreateApplicationPayload, iCreateClaimPayload, iCreateDeveloperAppPayload, iCreateDynamicDataStorePayload, iCreatePaymentIntentPayload, iCreatePluginPayload, iCreateSIWBBRequestPayload, iCreateUtilityPagePayload, iDeleteApiKeyPayload, iDeleteApplicationPayload, iDeleteClaimPayload, iDeleteDeveloperAppPayload, iDeleteDynamicDataStorePayload, iDeletePluginPayload, iDeleteSIWBBRequestPayload, iDeleteUtilityPagePayload, iExchangeSIWBBAuthorizationCodePayload, iFetchMetadataDirectlyPayload, iGenericBlockinVerifyPayload, iGenericVerifyAssetsPayload, iGetActiveAuthorizationsPayload, iGetApiKeysPayload, iGetApplicationPayload, iGetApplicationsPayload, iGetAttemptDataFromRequestBinPayload, iGetBrowsePayload, iGetClaimAttemptsPayload, iGetClaimPayload, iGetClaimsPayloadV1, iGetDeveloperAppPayload, iGetDeveloperAppsPayload, iGetDynamicDataActivityPayload, iGetDynamicDataStorePayload, iGetDynamicDataStoreValuePayload, iGetDynamicDataStoreValuesPaginatedPayload, iGetDynamicDataStoresPayload, iGetGatedContentForClaimPayload, iGetPluginErrorsPayload, iGetPluginPayload, iGetPluginsPayload, iGetPointsActivityPayload, iGetReservedClaimCodesPayload, iGetSIWBBRequestsForDeveloperAppPayload, iGetSearchPayload, iGetSignInChallengePayload, iGetStatusPayload, iGetTokensFromFaucetPayload, iGetUtilityPagePayload, iGetUtilityPagesPayload, iOauthRevokePayload, iPerformStoreActionBatchWithBodyAuthPayload, iPerformStoreActionSingleWithBodyAuthPayload, iRotateApiKeyPayload, iRotateSIWBBRequestPayload, iScheduleTokenRefreshPayload, iSearchApplicationsPayload, iSearchClaimsPayload, iSearchDeveloperAppsPayload, iSearchDynamicDataStoresPayload, iSearchPluginsPayload, iSearchUtilityPagesPayload, iSignOutPayload, iSimulateClaimPayload, iSimulateTxPayload, iUpdateAccountInfoPayload, iUpdateApplicationPayload, iUpdateClaimPayload, iUpdateDeveloperAppPayload, iUpdateDynamicDataStorePayload, iUpdatePluginPayload, iUpdateUtilityPagePayload, iVerifySignInPayload } from './requests/requests.js';
-import { GetBadgeMetadataSuccessResponse, GetBadgesViewForUserSuccessResponse, GetClaimActivityForUserSuccessResponse, GetCollectionAmountTrackersSuccessResponse, GetCollectionChallengeTrackersSuccessResponse, GetCollectionClaimsSuccessResponse, GetCollectionListingsSuccessResponse, GetCollectionOwnersSuccessResponse, GetCollectionSuccessResponse, GetCollectionTransferActivitySuccessResponse, GetPointsActivityForUserSuccessResponse, GetSiwbbRequestsForUserSuccessResponse, GetTransferActivityForUserSuccessResponse, iGetBadgesViewForUserPayload, iGetClaimActivityForUserPayload, iGetCollectionAmountTrackersPayload, iGetCollectionChallengeTrackersPayload, iGetCollectionListingsPayload, iGetCollectionOwnersPayload, iGetCollectionPayload, iGetCollectionTransferActivityPayload, iGetPointsActivityForUserPayload, iGetSiwbbRequestsForUserPayload, iGetTransferActivityForUserPayload } from './requests/wrappers.js';
+import { GetTokenMetadataSuccessResponse, GetTokensViewForUserSuccessResponse, GetClaimActivityForUserSuccessResponse, GetCollectionAmountTrackersSuccessResponse, GetCollectionChallengeTrackersSuccessResponse, GetCollectionClaimsSuccessResponse, GetCollectionListingsSuccessResponse, GetCollectionOwnersSuccessResponse, GetCollectionSuccessResponse, GetCollectionTransferActivitySuccessResponse, GetPointsActivityForUserSuccessResponse, GetSiwbbRequestsForUserSuccessResponse, GetTransferActivityForUserSuccessResponse, iGetTokensViewForUserPayload, iGetClaimActivityForUserPayload, iGetCollectionAmountTrackersPayload, iGetCollectionChallengeTrackersPayload, iGetCollectionListingsPayload, iGetCollectionOwnersPayload, iGetCollectionPayload, iGetCollectionTransferActivityPayload, iGetPointsActivityForUserPayload, iGetSiwbbRequestsForUserPayload, iGetTransferActivityForUserPayload } from './requests/wrappers.js';
 import { DeleteConnectedAccountSuccessResponse, GetConnectedAccountsSuccessResponse } from './responses/stripe.js';
 export declare class BitBadgesAPI<T extends NumberType> extends BaseBitBadgesApi<T> {
     constructor(apiDetails: iBitBadgesApi<T>);
     getStatus(payload?: iGetStatusPayload): Promise<GetStatusSuccessResponse<T>>;
     getSearchResults(searchValue: string, payload?: iGetSearchPayload<NumberType>): Promise<GetSearchSuccessResponse<T>>;
     getCollections(payload: iGetCollectionsPayload): Promise<GetCollectionsSuccessResponse<T>>;
-    getOwners(collectionId: CollectionId, badgeId: NumberType, payload: iGetOwnersPayload): Promise<GetOwnersSuccessResponse<T>>;
+    getOwners(collectionId: CollectionId, tokenId: NumberType, payload: iGetOwnersPayload): Promise<GetOwnersSuccessResponse<T>>;
     getBalanceByAddress(collectionId: CollectionId, address: NativeAddress, payload?: iGetBalanceByAddressPayload): Promise<GetBalanceByAddressSuccessResponse<T>>;
-    getBalanceByAddressSpecificToken(collectionId: CollectionId, badgeId: NumberType, address: NativeAddress, payload?: iGetBalanceByAddressPayload): Promise<GetBalanceByAddressSuccessResponse<T>>;
-    getTokenActivity(collectionId: CollectionId, badgeId: NumberType, payload: iGetTokenActivityPayload): Promise<GetTokenActivitySuccessResponse<T>>;
+    getBalanceByAddressSpecificToken(collectionId: CollectionId, tokenId: NumberType, address: NativeAddress, payload?: iGetBalanceByAddressPayload): Promise<GetBalanceByAddressSuccessResponse<T>>;
+    getTokenActivity(collectionId: CollectionId, tokenId: NumberType, payload: iGetTokenActivityPayload): Promise<GetTokenActivitySuccessResponse<T>>;
     refreshMetadata(collectionId: CollectionId, payload?: iRefreshMetadataPayload): Promise<RefreshMetadataSuccessResponse>;
     completeClaim(claimId: string, address: string, payload: iCompleteClaimPayload): Promise<CompleteClaimSuccessResponse>;
     simulateClaim(claimId: string, address: string, payload: iSimulateClaimPayload): Promise<SimulateClaimSuccessResponse>;
@@ -68,12 +68,12 @@ export declare class BitBadgesAPI<T extends NumberType> extends BaseBitBadgesApi
     checkClaimSuccess(claimId: string, address: NativeAddress): Promise<CheckClaimSuccessSuccessResponse>;
     getSiwbbRequestsForUser(address: NativeAddress, payload: iGetSiwbbRequestsForUserPayload): Promise<GetSiwbbRequestsForUserSuccessResponse<T>>;
     getTransferActivityForUser(address: NativeAddress, payload: iGetTransferActivityForUserPayload): Promise<GetTransferActivityForUserSuccessResponse<T>>;
-    getBadgesViewForUser(address: NativeAddress, payload: iGetBadgesViewForUserPayload): Promise<GetBadgesViewForUserSuccessResponse<T>>;
+    getTokensViewForUser(address: NativeAddress, payload: iGetTokensViewForUserPayload): Promise<GetTokensViewForUserSuccessResponse<T>>;
     getClaimActivityForUser(address: NativeAddress, payload: iGetClaimActivityForUserPayload): Promise<GetClaimActivityForUserSuccessResponse<T>>;
     getPointsActivityForUser(address: NativeAddress, payload: iGetPointsActivityForUserPayload): Promise<GetPointsActivityForUserSuccessResponse<T>>;
     getCollectionOwners(collectionId: CollectionId, payload: iGetCollectionOwnersPayload): Promise<GetCollectionOwnersSuccessResponse<T>>;
     getCollection(collectionId: CollectionId, payload?: iGetCollectionPayload): Promise<GetCollectionSuccessResponse<T>>;
-    getBadgeMetadata(collectionId: CollectionId, badgeId: NumberType): Promise<GetBadgeMetadataSuccessResponse<T>>;
+    getTokenMetadata(collectionId: CollectionId, tokenId: NumberType): Promise<GetTokenMetadataSuccessResponse<T>>;
     getCollectionTransferActivity(collectionId: CollectionId, payload: iGetCollectionTransferActivityPayload): Promise<GetCollectionTransferActivitySuccessResponse<T>>;
     getCollectionChallengeTrackers(collectionId: CollectionId, payload: iGetCollectionChallengeTrackersPayload): Promise<GetCollectionChallengeTrackersSuccessResponse<T>>;
     getCollectionAmountTrackers(collectionId: CollectionId, payload: iGetCollectionAmountTrackersPayload): Promise<GetCollectionAmountTrackersSuccessResponse<T>>;