Skip to content

Interface: iClaimBuilderDoc<T>

T extends NumberType

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1311

Extends

Type Parameters

T

T extends NumberType

Properties

_docId

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:13

A unique stringified document ID

Inherited from

Doc._docId

_id?

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:16

A unique document ID (Mongo DB ObjectID)

Inherited from

Doc._id

action

action: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1371

Details for the action to perform if the criteria is correct

seedCode?

optional seedCode?: string

siwbbClaim?

optional siwbbClaim?: boolean

approach?

optional approach?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1354

The expected approach for the claim. This is for display purposes for the frontend.

Available options:

  • in-site: The claim is expected to be completed in-site.
  • api: The claim is expected to be completed via an API call.
  • zapier: The claim is expected to be completed via Zapier auto-completion.

assignMethod?

optional assignMethod?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1365

Algorithm to determine the claaim number indices

cachePolicy?

optional cachePolicy?: iClaimCachePolicy<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1405

For on-demand claims, we cache the result per user for a short period.

To help optimize performance, please provide a cache policy.

This is only applicable to on-demand claims.

categories?

optional categories?: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1389

The categories of the claim

cid

cid: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1313

The CID (content ID) of the document. This is used behind the scenes to handle off-chain vs on-chain data races.

collectionId

collectionId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1321

The collection ID of the document

createdAt

createdAt: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1392

createdBy

createdBy: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1316

The BitBadges address of the user who created this password

deletedAt?

optional deletedAt?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1330

Deleted at timestamp

docClaimed

docClaimed: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1318

True if the document is claimed by the collection

estimatedCost?

optional estimatedCost?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1382

Estimated cost for the user

estimatedTime?

optional estimatedTime?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1384

Estimated time to satisfy the claim's requirements

lastUpdated

lastUpdated: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1391

managedBy

managedBy: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1324

The BitBadges address of the user who is currently managing this

manualDistribution?

optional manualDistribution?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1344

If true, the claim codes are to be distributed manually. This doc will only be used for storage purposes. Only in use for legacy on-chain claims.

Deprecated

metadata?

optional metadata?: iMetadata<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1357

Metadata for the claim

pluginIds?

optional pluginIds?: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1336

For query purposes, the plugin IDs

plugins

plugins: IntegrationPluginParams<string>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1333

Dynamic checks to run in the form of plugins

rewards?

optional rewards?: iClaimReward<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1379

Rewards to be shown upon a successful claim. If you need further gating, you can do this in two-steps.

satisfyMethod?

optional satisfyMethod?: iSatisfyMethod

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1368

Custom success logic. If not provided, we will default to AND logic with all plugins.

showInSearchResults?

optional showInSearchResults?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1387

If true, the claim will be shown in search results

state

state: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1360

The current state of each plugin

Index Signature

[pluginId: string]: any

testOnly?

optional testOnly?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1396

trackerDetails?

optional trackerDetails?: iChallengeTrackerIdDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1327

Which challenge tracker is it tied to

version

version: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1394

Edit this page on GitHub