Class CouponAPI

Hierarchy

Base
- CouponAPI

Index

Constructors

Properties

_agent _receiptsEndpoint _serviceConf

Accessors

Methods

_invocationConfig issue redeem

Constructors

constructor

new CouponAPI(agentData, options?): CouponAPI
Parameters
- agentData: AgentData
- Optional options: {
  receiptsEndpoint: undefined | URL;
  serviceConf: undefined | ServiceConf;
  } = {}
  - receiptsEndpoint: undefined | URL
  - serviceConf: undefined | ServiceConf
Returns CouponAPI
Inherited from Base.constructor
- Defined in packages/w3up-client/src/base.js:23

Properties

`Protected` _agent

_agent: Agent<Service>

_receiptsEndpoint

_receiptsEndpoint: string | URL

`Protected` _serviceConf

_serviceConf: ServiceConf

Accessors

agent

get agent(): Agent<Service>
The current user agent (this device).

Returns Agent<Service>
Inherited from Base.agent
- Defined in packages/w3up-client/src/base.js:39

Methods

`Protected` _invocationConfig

_invocationConfig(abilities): Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:key:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:key:${string}`;
}>
Protected
Parameters
- abilities: Ability[]
Returns Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:key:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:key:${string}`;
}>
Inherited from Base._invocationConfig
- Defined in packages/w3up-client/src/base.js:47

issue

issue(options): Promise<Coupon>
Issues a coupon for the given delegation.
Parameters
- options: Omit<CouponOptions, "issuer">
Returns Promise<Coupon>
- Defined in packages/w3up-client/src/coupon.js:28

redeem

redeem(archive, options?): Promise<GrantedAccess>
Redeems coupon from the the the archive. Throws an error if the coupon password is invalid or if provided archive is not a valid.
Parameters
- archive: Uint8Array
- Optional options: {
  password: undefined | string;
  } = {}
  - password: undefined | string
Returns Promise<GrantedAccess>
- Defined in packages/w3up-client/src/coupon.js:17

Generated using TypeDoc