UNPKG

@basetime/a2w-api-ts

Version:

Client library that communicates with the addtowallet API.

25 lines (24 loc) 760 B
import { Claim } from '../../types/Claim'; import Endpoint from '../Endpoint'; /** * Communicate with the `/campaigns/:campaignId/claims` sub-endpoint. * * Accessed via `client.campaigns.claims`. Distinct from the top-level * {@link ../ClaimsEndpoint | ClaimsEndpoint} which handles `/claim` (pkpass downloads). */ export default class CampaignClaimsEndpoint extends Endpoint { /** * Constructor. * * @param parent The parent `CampaignsEndpoint` whose `req`, `do`, and `qb` are * reused. */ constructor(parent: Endpoint); /** * Returns the claims for a campaign. * * @param campaignId The ID of the campaign. * @returns The claims. */ getAll: (campaignId: string) => Promise<Claim[]>; }