# Class: BitBadgesCollection\ Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:204](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L204) BitBadgesCollection is the type for collections returned by the BitBadges API. It extends the base CollectionDoc type and adds additional accompanying Docrmation such as metadata, activity, balances, preferred chain, etc. ## Extends - [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc)\<`T`\> ## Type Parameters ### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) ## Implements - [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection)\<`T`\> - [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`BitBadgesCollection`\<`T`\>\> ## Constructors ### Constructor > **new BitBadgesCollection**\<`T`\>(`data`): `BitBadgesCollection`\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:256](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L256) #### Parameters ##### data [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection)\<`T`\> #### Returns `BitBadgesCollection`\<`T`\> #### Overrides [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`constructor`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#constructor) ## Properties ### \_docId > **\_docId**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:353](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L353) A unique stringified document ID #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`_docId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#_docid) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`_docId`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#_docid) *** ### \_id? > `optional` **\_id?**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:354](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L354) A unique document ID (Mongo DB ObjectID) #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`_id`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#_id) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`_id`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#_id) *** ### activity > **activity**: [`TransferActivityDoc`](https://docs.bitbadges.io/sdk/reference/classes/transfer-activity-doc)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:214](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L214) The fetched activity for this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`activity`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#activity) *** ### aliasPaths > **aliasPaths**: [`AliasPathWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/alias-path-with-details)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:242](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L242) The alias (non-wrapping) paths for the collection, with off-chain metadata populated. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`aliasPaths`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#aliaspaths) #### Overrides [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`aliasPaths`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#aliaspaths) *** ### approvalTrackers > **approvalTrackers**: [`ApprovalTrackerDoc`](https://docs.bitbadges.io/sdk/reference/classes/approval-tracker-doc)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:217](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L217) The fetched approval trackers for this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`approvalTrackers`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#approvaltrackers) *** ### challengeTrackers > **challengeTrackers**: [`MerkleChallengeTrackerDoc`](https://docs.bitbadges.io/sdk/reference/classes/merkle-challenge-tracker-doc)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:216](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L216) The fetched merkle challenge trackers for this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`challengeTrackers`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#challengetrackers) *** ### claims > **claims**: [`ClaimDetails`](https://docs.bitbadges.io/sdk/reference/classes/claim-details)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:221](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L221) Details about any off-chain claims for this collection. Only applicable when outsourced to BitBadges. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`claims`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#claims) *** ### collectionApprovals > **collectionApprovals**: [`CollectionApprovalWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-approval-with-details)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:208](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L208) The collection approvals for this collection, with off-chain metadata populated. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`collectionApprovals`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#collectionapprovals) #### Overrides [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`collectionApprovals`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#collectionapprovals) *** ### collectionId > **collectionId**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:355](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L355) The collection ID #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`collectionId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#collectionid) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`collectionId`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#collectionid) *** ### collectionMetadata > **collectionMetadata**: [`CollectionMetadataDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-metadata-details)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:212](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L212) The collection metadata for this collection, with off-chain metadata populated. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`collectionMetadata`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#collectionmetadata) #### Overrides [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`collectionMetadata`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#collectionmetadata) *** ### collectionPermissions > **collectionPermissions**: [`CollectionPermissionsWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-permissions-with-details)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:209](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L209) The collection permissions for this collection, with off-chain metadata populated. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`collectionPermissions`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#collectionpermissions) #### Overrides [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`collectionPermissions`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#collectionpermissions) *** ### cosmosCoinWrapperPaths > **cosmosCoinWrapperPaths**: [`CosmosCoinWrapperPathWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/cosmos-coin-wrapper-path-with-details)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:240](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L240) The IBC wrapper paths for the collection, with off-chain metadata populated. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`cosmosCoinWrapperPaths`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#cosmoscoinwrapperpaths) #### Overrides [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`cosmosCoinWrapperPaths`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#cosmoscoinwrapperpaths) *** ### createdBlock > **createdBlock**: `T` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:366](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L366) The block number when this collection was created #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`createdBlock`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#createdblock) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`createdBlock`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#createdblock) *** ### createdBy > **createdBy**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:365](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L365) The BitBadges address of the user who created this collection #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`createdBy`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#createdby) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`createdBy`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#createdby) *** ### createdTimestamp > **createdTimestamp**: `T` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:367](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L367) The timestamp when this collection was created (milliseconds since epoch) #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`createdTimestamp`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#createdtimestamp) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`createdTimestamp`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#createdtimestamp) *** ### customData > **customData**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:358](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L358) The custom data #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`customData`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#customdata) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`customData`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#customdata) *** ### defaultBalances > **defaultBalances**: [`UserBalanceStoreWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/user-balance-store-with-details)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:210](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L210) The default balances for users upon genesis, with off-chain metadata populated. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`defaultBalances`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#defaultbalances) #### Overrides [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`defaultBalances`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#defaultbalances) *** ### invariants > **invariants**: [`CollectionInvariantsWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-invariants-with-details)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:244](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L244) Collection-level invariants with EVM query challenge metadata populated (WithDetails). #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`invariants`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#invariants) #### Overrides [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`invariants`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#invariants) *** ### isArchived > **isArchived**: `boolean` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:363](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L363) The is archived flag #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`isArchived`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#isarchived) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`isArchived`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#isarchived) *** ### listings > **listings**: [`UtilityPageDoc`](https://docs.bitbadges.io/sdk/reference/classes/utility-page-doc)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:219](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L219) The listings for this collection. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`listings`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#listings) *** ### manager > **manager**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:359](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L359) The manager #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`manager`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#manager) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`manager`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#manager) *** ### mintEscrowAddress > **mintEscrowAddress**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:370](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L370) Mint escrow address #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`mintEscrowAddress`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#mintescrowaddress) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`mintEscrowAddress`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#mintescrowaddress) *** ### nsfw? > `optional` **nsfw?**: `object` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:223](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L223) The token IDs in this collection that are marked as NSFW. #### reason > **reason**: `string` #### tokenIds > **tokenIds**: [`UintRangeArray`](https://docs.bitbadges.io/sdk/reference/classes/uint-range-array)\<`T`\> #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`nsfw`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#nsfw) *** ### owners > **owners**: [`BalanceDocWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/balance-doc-with-details)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:215](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L215) The fetched owners of this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`owners`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#owners) *** ### reported? > `optional` **reported?**: `object` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:224](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L224) The token IDs in this collection that have been reported. #### reason > **reason**: `string` #### tokenIds > **tokenIds**: [`UintRangeArray`](https://docs.bitbadges.io/sdk/reference/classes/uint-range-array)\<`T`\> #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`reported`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#reported) *** ### standards > **standards**: `string`[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:362](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L362) The standards #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`standards`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#standards) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`standards`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#standards) *** ### standardsConformance? > `optional` **standardsConformance?**: `object` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:246](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L246) Standards conformance results for this collection. Populated by the indexer after evaluating each declared standard (e.g. NFTMarketplace, NFTPricingDenom) against the on-chain collection state. Conformance is deterministic, so the indexer recomputes on each fetch rather than caching. The key is the standard name (e.g. "NFTMarketplace"); the value is a `{ conforms, errors?, warnings? }` object where `errors` lists rule violations that cause `conforms` to be false, and `warnings` lists soft advisories that do not affect conformance. #### Index Signature \[`standardName`: `string`\]: `object` #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`standardsConformance`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#standardsconformance) *** ### standardsInfo? > `optional` **standardsInfo?**: [`iStandardsInfo`](https://docs.bitbadges.io/sdk/reference/interfaces/i-standards-info) Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:254](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L254) Per-standard core-details object attached by the indexer. Companion to `standardsConformance`. Only contains data that requires an extra fetch (e.g. an escrow balance) or is a derived status enum — does NOT duplicate data already on the collection doc (approvals, metadata, amounts), which is derivable client-side. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`standardsInfo`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#standardsinfo) *** ### stats? > `optional` **stats?**: [`CollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-stats-doc)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:236](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L236) The stats for this collection. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`stats`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#stats) *** ### tokenFloorPrices? > `optional` **tokenFloorPrices?**: [`iTokenFloorPriceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-token-floor-price-doc)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:238](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L238) The floor prices for this collection. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`tokenFloorPrices`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#tokenfloorprices) *** ### tokenMetadata > **tokenMetadata**: [`TokenMetadataDetails`](https://docs.bitbadges.io/sdk/reference/classes/token-metadata-details)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:213](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L213) The token metadata for this collection, with off-chain metadata populated. #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`tokenMetadata`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#tokenmetadata) #### Overrides [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`tokenMetadata`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#tokenmetadata) *** ### updateHistory > **updateHistory**: [`UpdateHistory`](https://docs.bitbadges.io/sdk/reference/classes/update-history)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:368](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L368) The update history of this collection #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`updateHistory`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#updatehistory) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`updateHistory`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#updatehistory) *** ### validTokenIds > **validTokenIds**: [`UintRangeArray`](https://docs.bitbadges.io/sdk/reference/classes/uint-range-array)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:369](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L369) Valid token IDs for the collection #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`validTokenIds`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#validtokenids) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`validTokenIds`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#validtokenids) *** ### views > **views**: `object` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:226](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L226) The views for this collection and their pagination Doc. Views will only include the doc _ids. Use the pagination to fetch more. For example, if you want to fetch the activity for a view, you would use the view's pagination to fetch the doc _ids, then use the corresponding activity array to find the matching docs. #### Index Signature \[`viewId`: `string`\]: \{ `ids`: `string`[]; `pagination`: [`PaginationInfo`](https://docs.bitbadges.io/sdk/reference/interfaces/pagination-info); `type`: `string`; \} \| `undefined` #### Implementation of [`iBitBadgesCollection`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection).[`views`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-collection#views) ## Methods ### checkCanAddMoreAliasPaths() > **checkCanAddMoreAliasPaths**(`time?`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:714](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L714) Checks if this permission is executable at a specific time (Date.now() by default). Wrapper for [ActionPermission.check](https://docs.bitbadges.io/sdk/reference/classes/action-permission#check). #### Parameters ##### time? [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Error` \| `null` *** ### checkCanAddMoreCosmosCoinWrapperPaths() > **checkCanAddMoreCosmosCoinWrapperPaths**(`time?`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:723](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L723) Checks if this permission is executable at a specific time (Date.now() by default). Wrapper for [ActionPermission.check](https://docs.bitbadges.io/sdk/reference/classes/action-permission#check). #### Parameters ##### time? [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Error` \| `null` *** ### checkCanArchiveCollection() > **checkCanArchiveCollection**(`time?`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:601](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L601) Checks if this permission is executable for the provided values at a specific time (Date.now() by default). Wrapper for [ActionPermission.check](https://docs.bitbadges.io/sdk/reference/classes/action-permission#check). #### Parameters ##### time? [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Error` \| `null` *** ### checkCanDeleteCollection() > **checkCanDeleteCollection**(`time?`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:592](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L592) Checks if this permission is executable at a specific time (Date.now() by default). Wrapper for [ActionPermission.check](https://docs.bitbadges.io/sdk/reference/classes/action-permission#check). #### Parameters ##### time? [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Error` \| `null` *** ### checkCanUpdateCollectionApprovals() > **checkCanUpdateCollectionApprovals**(`details`, `time?`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:673](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L673) Checks if this permission is executable for the provided values at a specific time (Date.now() by default). Wrapper for [CollectionApprovalPermission.check](https://docs.bitbadges.io/sdk/reference/classes/collection-approval-permission#check). #### Parameters ##### details `object`[] ##### time? [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Error` \| `null` *** ### checkCanUpdateCollectionMetadata() > **checkCanUpdateCollectionMetadata**(`time?`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:635](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L635) Checks if this permission is executable for the provided values at a specific time (Date.now() by default). Wrapper for [ActionPermission.check](https://docs.bitbadges.io/sdk/reference/classes/action-permission#check). #### Parameters ##### time? [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Error` \| `null` *** ### checkCanUpdateCustomData() > **checkCanUpdateCustomData**(`time?`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:627](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L627) Checks if this permission is executable for the provided values at a specific time (Date.now() by default). Wrapper for [ActionPermission.check](https://docs.bitbadges.io/sdk/reference/classes/action-permission#check). #### Parameters ##### time? [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Error` \| `null` *** ### checkCanUpdateManager() > **checkCanUpdateManager**(`time?`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:610](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L610) Checks if this permission is executable for the provided values at a specific time (Date.now() by default). Wrapper for [ActionPermission.check](https://docs.bitbadges.io/sdk/reference/classes/action-permission#check). #### Parameters ##### time? [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Error` \| `null` *** ### checkCanUpdateStandards() > **checkCanUpdateStandards**(`time?`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:619](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L619) Checks if this permission is executable for the provided values at a specific time (Date.now() by default). Wrapper for [ActionPermission.check](https://docs.bitbadges.io/sdk/reference/classes/action-permission#check). #### Parameters ##### time? [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Error` \| `null` *** ### checkCanUpdateTokenMetadata() > **checkCanUpdateTokenMetadata**(`tokenIds`, `time?`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:658](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L658) Checks if this permission is executable for the provided values at a specific time (Date.now() by default). #### Parameters ##### tokenIds [`iUintRange`](https://docs.bitbadges.io/sdk/reference/interfaces/i-uint-range)\<`T`\>[] ##### time? [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Error` \| `null` *** ### checkCanUpdateValidTokenIds() > **checkCanUpdateValidTokenIds**(`tokenIds`, `time?`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:646](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L646) Checks if this permission is executable for the provided values at a specific time (Date.now() by default). Wrapper for TimedUpdatePermission.check. #### Parameters ##### tokenIds [`iUintRange`](https://docs.bitbadges.io/sdk/reference/interfaces/i-uint-range)\<`T`\>[] ##### time? [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Error` \| `null` *** ### clone() > **clone**(): `BitBadgesCollection`\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:289](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L289) Deep copies the object and returns a new instance. #### Returns `BitBadgesCollection`\<`T`\> #### Implementation of [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type).[`clone`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type#clone) #### Overrides [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`clone`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#clone) *** ### convert() > **convert**\<`U`\>(`convertFunction`, `options?`): `BitBadgesCollection`\<`U`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:285](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L285) Converts the object to a different NumberType equivalent. #### Type Parameters ##### U `U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### convertFunction (`item`) => `U` ##### options? [`ConvertOptions`](https://docs.bitbadges.io/sdk/reference/interfaces/convert-options) #### Returns `BitBadgesCollection`\<`U`\> #### Implementation of [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type).[`convert`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type#convert) #### Overrides [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`convert`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#convert) *** ### equals() > **equals**\<`U`\>(`other`, `normalizeNumberTypes?`): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:147](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L147) Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects. If `normalizeNumberTypes` is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1"). #### Type Parameters ##### U `U` *extends* [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\> #### Parameters ##### other [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\> \| `null` \| `undefined` ##### normalizeNumberTypes? `boolean` #### Returns `boolean` #### Implementation of [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type).[`equals`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type#equals) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`equals`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#equals) *** ### fetchAllForView() > **fetchAllForView**(`api`, `viewType`, `viewId`, `oldestFirst?`, `address?`): `Promise`\<`void`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1001](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1001) Fetches the entire view (all pages) for a specific view. This will update the current collection with the new response information. There is a 1 second delay between each page fetch to prevent rate limiting. #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### viewType [`CollectionViewKey`](https://docs.bitbadges.io/sdk/reference/type-aliases/collection-view-key) ##### viewId `string` ##### oldestFirst? `boolean` ##### address? `string` #### Returns `Promise`\<`void`\> *** ### fetchAndUpdate() > **fetchAndUpdate**(`api`, `options`, `forceful?`): `Promise`\<`void`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:909](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L909) Specify a new fetch request for the current collection. This will update the current collection with the new response information. For example, paginations, metadata, views, etc. will all be handled automatically. #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### options [`GetMetadataForCollectionPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-metadata-for-collection-payload) & [`GetAdditionalCollectionDetailsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-additional-collection-details-payload) ##### forceful? `boolean` #### Returns `Promise`\<`void`\> *** ### fetchBalances() > **fetchBalances**(`api`, `address`, `forceful?`): `Promise`\<[`BalanceDocWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/balance-doc-with-details)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:808](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L808) Fetches the owner information (balances) for a specific address for the current collection. This will update the current collection with the new response information. #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### address `string` ##### forceful? `boolean` #### Returns `Promise`\<[`BalanceDocWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/balance-doc-with-details)\<`T`\>\> #### Remarks Returns the cached value if already fetched. Use forceful to force a new fetch. *** ### fetchMetadata() > **fetchMetadata**(`api`, `options`, `forceful?`): `Promise`\<`void`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:946](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L946) Wrapper for [fetchAndUpdate](#fetchandupdate) that fetches collection metadata. #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### options [`GetMetadataForCollectionPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-metadata-for-collection-payload) ##### forceful? `boolean` #### Returns `Promise`\<`void`\> *** ### fetchNextForView() > **fetchNextForView**(`api`, `viewType`, `viewId`, `oldestFirst?`, `address?`): `Promise`\<`void`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:980](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L980) Fetches the next page for a specific view. This will update the current collection with the new response information (handling paginations). If the view has no more pages, this will do nothing. #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### viewType [`CollectionViewKey`](https://docs.bitbadges.io/sdk/reference/type-aliases/collection-view-key) ##### viewId `string` ##### oldestFirst? `boolean` ##### address? `string` #### Returns `Promise`\<`void`\> *** ### FilterTokensInCollection() > **FilterTokensInCollection**(`api`, `bodyOptions`): `Promise`\<[`FilterTokensInCollectionSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/filter-tokens-in-collection-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1275](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1275) Execute a filter query for the collection. You have to handle the pagination yourself. #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### bodyOptions `Omit`\<[`iFilterTokensInCollectionPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-filter-tokens-in-collection-payload), `"collectionId"`\> #### Returns `Promise`\<[`FilterTokensInCollectionSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/filter-tokens-in-collection-success-response)\<`T`\>\> *** ### generateAliasForTokenId() > **generateAliasForTokenId**(`tokenId`): `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1088](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1088) Generates the alias for a specific token ID. Collection alias is stored in the root of the collection. Wrapper for [generateAlias](https://docs.bitbadges.io/sdk/reference/functions/generate-alias). #### Parameters ##### tokenId `T` #### Returns `string` *** ### getActivityView() > **getActivityView**(`viewId`): [`TransferActivityDoc`](https://docs.bitbadges.io/sdk/reference/classes/transfer-activity-doc)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1033](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1033) Gets the documents for a specific view. #### Parameters ##### viewId `string` #### Returns [`TransferActivityDoc`](https://docs.bitbadges.io/sdk/reference/classes/transfer-activity-doc)\<`T`\>[] *** ### getApprovalTrackersView() > **getApprovalTrackersView**(`viewId`): [`ApprovalTrackerDoc`](https://docs.bitbadges.io/sdk/reference/classes/approval-tracker-doc)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1068](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1068) Gets the documents for a specific view. #### Parameters ##### viewId `string` #### Returns [`ApprovalTrackerDoc`](https://docs.bitbadges.io/sdk/reference/classes/approval-tracker-doc)\<`T`\>[] *** ### getBalanceAmountForToken() > **getBalanceAmountForToken**(`address`, `tokenId`): `T` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:448](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L448) Returns the balance amount for a specific token ID at the current time for a given address. Uses the cached balance data. Returns 0 if no balance info is found. #### Parameters ##### address `string` The address to look up. ##### tokenId `T` The token ID to look up. #### Returns `T` *** ### getBalanceInfo() > **getBalanceInfo**(`address`): [`BalanceDocWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/balance-doc-with-details)\<`T`\> \| `undefined` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:401](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L401) Gets the balance document for a specific address from the cached owners array. Returns undefined if not fetched yet. The balance document includes the balances, outgoing approvals, and other details. Use getBalances to only get the balances. #### Parameters ##### address `string` #### Returns [`BalanceDocWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/balance-doc-with-details)\<`T`\> \| `undefined` #### Remarks This does not fetch the balance from the API. It only returns the cached balance. To fetch the balance, this can either be done directly, or if the collection balances are indexable then the balances can also be fetched via the views and / or the other fetch methods. #### Example ```ts const collection: BitBadgesCollection = { ... } const address = 'bb1...' const balance = collection.getBalance(address) console.log(balance?.balances) console.log(balance?.outgoingApprovals) ``` *** ### getBalances() > **getBalances**(`address`): [`BalanceArray`](https://docs.bitbadges.io/sdk/reference/classes/balance-array)\<`T`\> \| `undefined` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:430](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L430) Gets the balances for a specific address from the cached owners array. Returns undefined if not fetched yet. This returns the balances only, not the other details. Use getBalanceInfo to get the other details for a user balance store (approvals, etc.). #### Parameters ##### address `string` #### Returns [`BalanceArray`](https://docs.bitbadges.io/sdk/reference/classes/balance-array)\<`T`\> \| `undefined` #### Remarks This does not fetch the balance from the API. It only returns the cached balance. To fetch the balance, this can either be done directly, or if the collection balances are indexable (i.e. balances type is anything but Off-Chain - Non-Indexed), then the balances can also be fetched via the views and / or the other fetch methods. #### Example ```ts const collection: BitBadgesCollection = { ... } const address = 'bb1...' const balances = collection.getBalances(address) console.log(balances) ``` *** ### getChallengeTrackersView() > **getChallengeTrackersView**(`viewId`): [`MerkleChallengeTrackerDoc`](https://docs.bitbadges.io/sdk/reference/classes/merkle-challenge-tracker-doc)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1051](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1051) Gets the documents for a specific view. #### Parameters ##### viewId `string` #### Returns [`MerkleChallengeTrackerDoc`](https://docs.bitbadges.io/sdk/reference/classes/merkle-challenge-tracker-doc)\<`T`\>[] *** ### getCollectionMetadata() > **getCollectionMetadata**(): [`Metadata`](https://docs.bitbadges.io/sdk/reference/classes/metadata)\<`T`\> \| `undefined` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:303](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L303) Get the cached collection metadata. This is the fetched metadata, not the timeline values. #### Returns [`Metadata`](https://docs.bitbadges.io/sdk/reference/classes/metadata)\<`T`\> \| `undefined` #### Example ```ts const collection: BitBadgesCollection = { ... } const metadata = collection.getCollectionMetadata() const metadataImage = metadata.image ``` *** ### getCollectionMetadataDetails() > **getCollectionMetadataDetails**(): [`CollectionMetadataDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-metadata-details)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:307](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L307) #### Returns [`CollectionMetadataDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-metadata-details)\<`T`\> *** ### getDefaultDisplayCurrency() > **getDefaultDisplayCurrency**(): `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:357](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L357) Gets default display currency, if set. Defaults to ubadge. #### Returns `string` *** ### getDefaultUserBalance() > **getDefaultUserBalance**(): [`UserBalanceStore`](https://docs.bitbadges.io/sdk/reference/classes/user-balance-store)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:404](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L404) Creates a blank balance object with the genesis default approvals and balances. #### Returns [`UserBalanceStore`](https://docs.bitbadges.io/sdk/reference/classes/user-balance-store)\<`T`\> #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`getDefaultUserBalance`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#getdefaultuserbalance) *** ### getListingsView() > **getListingsView**(`viewId`): [`UtilityPageDoc`](https://docs.bitbadges.io/sdk/reference/classes/utility-page-doc)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1060](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1060) Gets the documents for a specific view. #### Parameters ##### viewId `string` #### Returns [`UtilityPageDoc`](https://docs.bitbadges.io/sdk/reference/classes/utility-page-doc)\<`T`\>[] *** ### getMaxTokenId() > **getMaxTokenId**(): `bigint` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:459](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L459) Gets the maximum token ID for the collection. Checks both the circulating supplys + genesis default balances. Precondition: The Total balance must be fetched. #### Returns `bigint` *** ### getMintCollectionApprovals() > **getMintCollectionApprovals**(): [`CollectionApprovalWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-approval-with-details)\<`bigint`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1117](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1117) Returns all the mint collection approvals. Wrapper for [getMintApprovals](https://docs.bitbadges.io/sdk/reference/functions/get-mint-approvals). #### Returns [`CollectionApprovalWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-approval-with-details)\<`bigint`\>[] *** ### getNonMintCollectionApprovals() > **getNonMintCollectionApprovals**(): [`CollectionApprovalWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-approval-with-details)\<`bigint`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1108](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1108) Returns all the non-mint collection approvals. Wrapper for [getNonMintApprovals](https://docs.bitbadges.io/sdk/reference/functions/get-non-mint-approvals). #### Returns [`CollectionApprovalWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-approval-with-details)\<`bigint`\>[] *** ### getNumberFieldNames() > **getNumberFieldNames**(): `string`[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:281](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L281) Internal helper method to convert the number fields of the object to a different NumberType equivalent. #### Returns `string`[] #### Implementation of [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type).[`getNumberFieldNames`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type#getnumberfieldnames) #### Overrides [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`getNumberFieldNames`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#getnumberfieldnames) *** ### getOwners() > **getOwners**(`api`, `tokenId`, `body`): `Promise`\<[`GetOwnersSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-owners-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1243](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1243) Gets the owners for a specific token. You have to handle the pagination yourself. #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### tokenId `T` ##### body [`iGetOwnersPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-owners-payload) #### Returns `Promise`\<[`GetOwnersSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-owners-success-response)\<`T`\>\> *** ### getOwnersView() > **getOwnersView**(`viewId`): [`BalanceDocWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/balance-doc-with-details)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1042](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1042) Gets the documents for a specific view. #### Parameters ##### viewId `string` #### Returns [`BalanceDocWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/balance-doc-with-details)\<`T`\>[] *** ### getRefreshStatus() > **getRefreshStatus**(`api`): `Promise`\<[`RefreshStatusSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/refresh-status-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1141](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1141) Check the refresh queue status for the collection via the API. #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> #### Returns `Promise`\<[`RefreshStatusSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/refresh-status-success-response)\<`T`\>\> *** ### getTokenActivity() > **getTokenActivity**(`api`, `tokenId`, `body`): `Promise`\<[`GetTokenActivitySuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-token-activity-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1207](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1207) Get the token activity for a specific token ID. You have to handle the pagination yourself. #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### tokenId `T` ##### body [`iGetTokenActivityPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-token-activity-payload) #### Returns `Promise`\<[`GetTokenActivitySuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-token-activity-success-response)\<`T`\>\> *** ### getTokenFloorPricesView() > **getTokenFloorPricesView**(`viewId`): [`TokenFloorPriceDoc`](https://docs.bitbadges.io/sdk/reference/classes/token-floor-price-doc)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1077](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1077) Gets the documents for a specific view. #### Parameters ##### viewId `string` #### Returns [`TokenFloorPriceDoc`](https://docs.bitbadges.io/sdk/reference/classes/token-floor-price-doc)\<`T`\>[] *** ### getTokenIdRange() > **getTokenIdRange**(): [`UintRangeArray`](https://docs.bitbadges.io/sdk/reference/classes/uint-range-array)\<`bigint`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:350](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L350) Gets a UintRangeArray of 1 - Max Token ID for the collection (i.e. [{ start: 1n, end: maxTokenId }]). #### Returns [`UintRangeArray`](https://docs.bitbadges.io/sdk/reference/classes/uint-range-array)\<`bigint`\> *** ### getTokenMetadata() > **getTokenMetadata**(): [`TokenMetadataDetails`](https://docs.bitbadges.io/sdk/reference/classes/token-metadata-details)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:316](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L316) Gets the token metadata at a specific time (Date.now() by default). This gets the timeline value. For the actual fetched value, use `getTokenMetadataForTokenId()` instead. #### Returns [`TokenMetadataDetails`](https://docs.bitbadges.io/sdk/reference/classes/token-metadata-details)\<`T`\>[] *** ### getTokenMetadataDetails() > **getTokenMetadataDetails**(`tokenId`): [`TokenMetadataDetails`](https://docs.bitbadges.io/sdk/reference/classes/token-metadata-details)\<`T`\> \| `undefined` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:343](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L343) Gets the details for a specific token ID. This includes the metadata, URI, and custom data. If you only want the metadata, use getTokenMetadata, or you can access it via result.metadata. #### Parameters ##### tokenId `T` #### Returns [`TokenMetadataDetails`](https://docs.bitbadges.io/sdk/reference/classes/token-metadata-details)\<`T`\> \| `undefined` *** ### getTokenMetadataForTokenId() > **getTokenMetadataForTokenId**(`tokenId`): [`Metadata`](https://docs.bitbadges.io/sdk/reference/classes/metadata)\<`T`\> \| `undefined` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:334](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L334) Get the metadata for a specific token ID. This is the fetched metadata, not the timeline values. This only returns the metadata object (name, image, etc.) and not the URI or other accompanying details. For those, use getTokenMetadataDetails. #### Parameters ##### tokenId `T` #### Returns [`Metadata`](https://docs.bitbadges.io/sdk/reference/classes/metadata)\<`T`\> \| `undefined` #### Example ```ts const collection: BitBadgesCollection = { ... } const tokenId = 123n const metadata = collection.getTokenMetadataForTokenId(tokenId) const metadataImage = metadata.image ``` *** ### getUnhandledCollectionApprovals() > **getUnhandledCollectionApprovals**(): [`CollectionApprovalWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-approval-with-details)\<`bigint`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1099](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1099) Returns all the unhandled collection approvals. Unhandled means disapproved. Wrapper for [getUnhandledCollectionApprovals](https://docs.bitbadges.io/sdk/reference/functions/get-unhandled-collection-approvals). #### Returns [`CollectionApprovalWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-approval-with-details)\<`bigint`\>[] *** ### getView() > **getView**\<`KeyType`\>(`viewType`, `viewId`): `CollectionViewData`\<`T`\>\[`KeyType`\] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1011](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1011) Type agnostic get view function. Uses the viewType to determine the type of view to fetch. #### Type Parameters ##### KeyType `KeyType` *extends* [`CollectionViewKey`](https://docs.bitbadges.io/sdk/reference/type-aliases/collection-view-key) #### Parameters ##### viewType `KeyType` ##### viewId `string` #### Returns `CollectionViewData`\<`T`\>\[`KeyType`\] *** ### getViewBookmark() > **getViewBookmark**(`viewId`): `string` \| `undefined` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:971](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L971) Returns the bookmark for a specific view. This is used to fetch the next page. #### Parameters ##### viewId `string` #### Returns `string` \| `undefined` *** ### getViewPagination() > **getViewPagination**(`viewId`): [`PaginationInfo`](https://docs.bitbadges.io/sdk/reference/interfaces/pagination-info) \| `undefined` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:964](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L964) Returns the pagination information for a specific view ({ hasMore, bookmark }). #### Parameters ##### viewId `string` #### Returns [`PaginationInfo`](https://docs.bitbadges.io/sdk/reference/interfaces/pagination-info) \| `undefined` *** ### hasNFTMarketplaceStandard() > **hasNFTMarketplaceStandard**(): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:370](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L370) Checks if collection has the NFT marketplace standard (accepts both new 'NFTMarketplace' and legacy 'Tradable' names). #### Returns `boolean` *** ### hasNumberFields() > **hasNumberFields**(): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:161](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L161) Checks if the object has number fields. #### Returns `boolean` #### Implementation of [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type).[`hasNumberFields`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type#hasnumberfields) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`hasNumberFields`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#hasnumberfields) *** ### isRedundantRequest() > **isRedundantRequest**(`options`): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:821](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L821) Returns if a new collection API request body is redundant (meaning we already have the data cached). #### Parameters ##### options [`GetMetadataForCollectionPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-metadata-for-collection-payload) & [`GetAdditionalCollectionDetailsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-additional-collection-details-payload) #### Returns `boolean` *** ### mustGetBalanceInfo() > **mustGetBalanceInfo**(`address`): [`BalanceDocWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/balance-doc-with-details)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:408](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L408) Wrapper for [getBalanceInfo](#getbalanceinfo) that throws an error if the balance is not found in the document. #### Parameters ##### address `string` #### Returns [`BalanceDocWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/balance-doc-with-details)\<`T`\> *** ### mustGetBalances() > **mustGetBalances**(`address`): [`BalanceArray`](https://docs.bitbadges.io/sdk/reference/classes/balance-array)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:437](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L437) Wrapper for [getBalances](#getbalances) that throws an error if the balance is not found in the document. #### Parameters ##### address `string` #### Returns [`BalanceArray`](https://docs.bitbadges.io/sdk/reference/classes/balance-array)\<`T`\> *** ### pruneMetadataToFetch() > **pruneMetadataToFetch**(`metadataToFetch`): `object` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:480](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L480) For a metadata fetch request, prune the request to only request the metadata that is not already fetched. #### Parameters ##### metadataToFetch [`MetadataFetchOptions`](https://docs.bitbadges.io/sdk/reference/interfaces/metadata-fetch-options) #### Returns `object` ##### doNotFetchCollectionMetadata > **doNotFetchCollectionMetadata**: `boolean` ##### uris > **uris**: `string`[] #### Example ```ts const collection: BitBadgesCollection = { ... } const metadataToFetch = collection.pruneMetadataToFetch({ tokenIds: [1n, 2n, 3n], uris: ['ipfs://...'] }) console.log(metadataToFetch) ``` *** ### prunePayload() > **prunePayload**(`options`): [`GetMetadataForCollectionPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-metadata-for-collection-payload) & [`GetAdditionalCollectionDetailsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-additional-collection-details-payload) & `object` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:870](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L870) Prunes a new collection API request body to only request the data that is not already fetched. #### Parameters ##### options [`GetMetadataForCollectionPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-metadata-for-collection-payload) & [`GetAdditionalCollectionDetailsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-additional-collection-details-payload) #### Returns [`GetMetadataForCollectionPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-metadata-for-collection-payload) & [`GetAdditionalCollectionDetailsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-additional-collection-details-payload) & `object` *** ### refresh() > **refresh**(`api`): `Promise`\<[`RefreshMetadataSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/refresh-metadata-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1171](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1171) Trigger a refresh for the collection via the API. Note there is a cooldown period for refreshing. #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> #### Returns `Promise`\<[`RefreshMetadataSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/refresh-metadata-success-response)\> *** ### toJson() > **toJson**(): `JsonObject` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:139](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L139) Converts the object to a JSON object with all primitive types. #### Returns `JsonObject` #### Implementation of [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type).[`toJson`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type#tojson) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`toJson`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#tojson) *** ### toJsonString() > **toJsonString**(): `string` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:143](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L143) Converts the object to a JSON string. #### Returns `string` #### Implementation of [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type).[`toJsonString`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type#tojsonstring) #### Inherited from [`CollectionDoc`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc).[`toJsonString`](https://docs.bitbadges.io/sdk/reference/classes/collection-doc#tojsonstring) *** ### updateWithNewResponse() > **updateWithNewResponse**(`newResponse`, `forceful?`): `void` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:931](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L931) Updates the current collection with a new response from the API. If forceful is true, we fully overwrite the current collection with the new response. Else, we will append the new response to the current collection while handling duplicates, paginations, etc. #### Parameters ##### newResponse `BitBadgesCollection`\<`T`\> ##### forceful? `boolean` #### Returns `void` *** ### validateCollectionApprovalsUpdate() > **validateCollectionApprovalsUpdate**(`newApprovals`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:521](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L521) Validates if a state transition (old approvals -> new approvals) is valid, given the current state of the collection and its permissions. Wrapper for [CollectionApprovalWithDetails.validateUpdate](https://docs.bitbadges.io/sdk/reference/classes/collection-approval-with-details#validateupdate). #### Parameters ##### newApprovals [`CollectionApprovalWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-approval-with-details)\<`T`\>[] #### Returns `Error` \| `null` *** ### validateCollectionMetadataUpdate() > **validateCollectionMetadataUpdate**(`newCollectionMetadata`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:582](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L582) Validates if a state transition (old collection metadata -> new collection metadata) is valid, given the current state of the collection and its permissions. Wrapper for [validateCollectionMetadataUpdate](https://docs.bitbadges.io/sdk/reference/functions/validate-collection-metadata-update). #### Parameters ##### newCollectionMetadata [`iCollectionMetadata`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-metadata) #### Returns `Error` \| `null` *** ### validateCustomDataUpdate() > **validateCustomDataUpdate**(`newCustomData`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:546](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L546) Validates if a state transition (old custom data -> new custom data) is valid, given the current state of the collection and its permissions. Wrapper for [validateCustomDataUpdate](https://docs.bitbadges.io/sdk/reference/functions/validate-custom-data-update). #### Parameters ##### newCustomData `string` #### Returns `Error` \| `null` *** ### validateIsArchivedUpdate() > **validateIsArchivedUpdate**(`newIsArchived`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:564](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L564) Validates if a state transition (old isArchived -> new isArchived) is valid, given the current state of the collection and its permissions. Wrapper for [validateIsArchivedUpdate](https://docs.bitbadges.io/sdk/reference/functions/validate-is-archived-update). #### Parameters ##### newIsArchived `boolean` #### Returns `Error` \| `null` *** ### validateManagerUpdate() > **validateManagerUpdate**(`newManager`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:573](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L573) Validates if a state transition (old manager -> new manager) is valid, given the current state of the collection and its permissions. Wrapper for [validateManagerUpdate](https://docs.bitbadges.io/sdk/reference/functions/validate-manager-update). #### Parameters ##### newManager `string` #### Returns `Error` \| `null` *** ### validatePermissionsUpdate() > **validatePermissionsUpdate**(`newPermissions`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:496](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L496) Validates if a state transition (old permissions -> new permissions) is valid. Must not update any permanently frozen permissions. Wrapper for [CollectionPermissionsWithDetails.validateUpdate](https://docs.bitbadges.io/sdk/reference/classes/collection-permissions-with-details#validateupdate). #### Parameters ##### newPermissions [`CollectionPermissionsWithDetails`](https://docs.bitbadges.io/sdk/reference/classes/collection-permissions-with-details)\<`T`\> #### Returns `Error` \| `null` #### See [Permissions Docs](https://docs.bitbadges.io/for-developers/core-concepts/permissions) #### Remarks This is validating the updatability of the permissions. To validate whether a permission is executable, use the checkCan* functions. *** ### validatePermissionUpdate() > **validatePermissionUpdate**(`permissionName`, `newPermissions`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:509](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L509) Validates if a single permission type is updated correctly. Cannot edit anything permanently frozen. This is validating the updatability of the permissions. To validate whether a permission is executable, use the checkCan* functions. #### Parameters ##### permissionName [`PermissionNameString`](https://docs.bitbadges.io/sdk/reference/type-aliases/permission-name-string) ##### newPermissions `any`[] #### Returns `Error` \| `null` #### See [Permissions Docs](https://docs.bitbadges.io/for-developers/core-concepts/permissions) *** ### validateStandardsUpdate() > **validateStandardsUpdate**(`newStandards`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:555](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L555) Validates if a state transition (old standards -> new standards) is valid, given the current state of the collection and its permissions. Wrapper for [validateStandardsUpdate](https://docs.bitbadges.io/sdk/reference/functions/validate-standards-update). #### Parameters ##### newStandards `string`[] #### Returns `Error` \| `null` *** ### validateTokenMetadataUpdate() > **validateTokenMetadataUpdate**(`newTokenMetadata`): `Error` \| `null` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:535](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L535) Validates if a state transition (old token metadata -> new token metadata) is valid, given the current state of the collection and its permissions. Wrapper for [validateTokenMetadataUpdate](https://docs.bitbadges.io/sdk/reference/functions/validate-token-metadata-update). #### Parameters ##### newTokenMetadata [`iTokenMetadata`](https://docs.bitbadges.io/sdk/reference/interfaces/i-token-metadata)\<`T`\>[] #### Returns `Error` \| `null` *** ### viewHasMore() > **viewHasMore**(`viewId`): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:957](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L957) Returns if the view has more pages to fetch. #### Parameters ##### viewId `string` #### Returns `boolean` *** ### FetchAndInitialize() > `static` **FetchAndInitialize**\<`T`\>(`api`, `options`): `Promise`\<`BitBadgesCollection`\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:733](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L733) Fetches and initializes a new BitBadgesCollection object from an API request. Must pass in a valid API instance. #### Type Parameters ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### options `object` & [`GetMetadataForCollectionPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-metadata-for-collection-payload) & [`GetAdditionalCollectionDetailsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-additional-collection-details-payload) #### Returns `Promise`\<`BitBadgesCollection`\<`T`\>\> *** ### FetchAndInitializeBatch() > `static` **FetchAndInitializeBatch**\<`T`\>(`api`, `collectionsToFetch`): `Promise`\<(`BitBadgesCollection`\<`T`\> \| `undefined`)[]\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:794](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L794) Fetches and initializes a batch of new BitBadgesCollection objects from an API request. Must pass in a valid API instance. #### Type Parameters ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### collectionsToFetch `object` & [`GetMetadataForCollectionPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-metadata-for-collection-payload) & [`GetAdditionalCollectionDetailsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/get-additional-collection-details-payload)[] #### Returns `Promise`\<(`BitBadgesCollection`\<`T`\> \| `undefined`)[]\> *** ### FilterTokensInCollection() > `static` **FilterTokensInCollection**\<`T`\>(`api`, `collectionId`, `body`): `Promise`\<[`FilterTokensInCollectionSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/filter-tokens-in-collection-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1250](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1250) Execute a filter query for the collection. You have to handle the pagination yourself. #### Type Parameters ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### collectionId `string` ##### body [`iFilterTokensInCollectionPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-filter-tokens-in-collection-payload) #### Returns `Promise`\<[`FilterTokensInCollectionSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/filter-tokens-in-collection-success-response)\<`T`\>\> *** ### GetBalanceByAddress() > `static` **GetBalanceByAddress**\<`T`\>(`api`, `collectionId`, `address`, `payload?`): `Promise`\<[`GetBalanceByAddressSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-balance-by-address-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:766](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L766) Gets the balance for a specific address for a specific collection. Must pass in a valid API instance. #### Type Parameters ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### collectionId `string` ##### address `string` ##### payload? [`iGetBalanceByAddressPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-balance-by-address-payload) #### Returns `Promise`\<[`GetBalanceByAddressSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-balance-by-address-success-response)\<`T`\>\> *** ### GetCollections() > `static` **GetCollections**\<`T`\>(`api`, `body`): `Promise`\<[`GetCollectionsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collections-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:745](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L745) Gets collections from the API. Must pass in a valid API instance. #### Type Parameters ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### body [`iGetCollectionsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-collections-payload) #### Returns `Promise`\<[`GetCollectionsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collections-success-response)\<`T`\>\> *** ### GetOwners() > `static` **GetOwners**\<`T`\>(`api`, `collectionId`, `tokenId`, `payload?`): `Promise`\<[`GetOwnersSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-owners-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1214](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1214) Gets owners for a specific token ID. You have to handle the pagination yourself. #### Type Parameters ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### collectionId `string` ##### tokenId [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) ##### payload? [`iGetOwnersPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-owners-payload) #### Returns `Promise`\<[`GetOwnersSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-owners-success-response)\<`T`\>\> *** ### GetRefreshStatus() > `static` **GetRefreshStatus**\<`T`\>(`api`, `collectionId`): `Promise`\<[`RefreshStatusSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/refresh-status-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1124](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1124) Returns the status of this collection in the refresh queue. #### Type Parameters ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### collectionId `string` #### Returns `Promise`\<[`RefreshStatusSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/refresh-status-success-response)\<`T`\>\> *** ### GetTokenActivity() > `static` **GetTokenActivity**\<`T`\>(`api`, `collectionId`, `tokenId`, `payload?`): `Promise`\<[`GetTokenActivitySuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-token-activity-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1178](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1178) Gets activity for a specific token ID. You have to handle the pagination yourself. #### Type Parameters ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### collectionId `string` ##### tokenId [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) ##### payload? [`iGetTokenActivityPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-token-activity-payload) #### Returns `Promise`\<[`GetTokenActivitySuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-token-activity-success-response)\<`T`\>\> *** ### RefreshMetadata() > `static` **RefreshMetadata**\<`T`\>(`api`, `collectionId`, `body?`): `Promise`\<[`RefreshMetadataSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/refresh-metadata-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:1148](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts#L1148) Trigger a refresh for the collection via the API. Note there is a cooldown period for refreshing. #### Type Parameters ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### api [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ##### collectionId `string` ##### body? [`iRefreshMetadataPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-refresh-metadata-payload) #### Returns `Promise`\<[`RefreshMetadataSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/refresh-metadata-success-response)\>