Class TierWithClock

The Tier client, main interface provided by the SDK.

All methods are re-exported as top level functions by the main package export, in such a way that they create a client and spin up a Tier sidecar process on demand.

Hierarchy

Tier
- TierWithClock

Index

Constructors

constructor

new TierWithClock(options: TierWithClockOptions): TierWithClock
Parameters
- options: TierWithClockOptions
Returns TierWithClock
Overrides Tier.constructor
- Defined in src/client.ts:783

Properties

`Readonly` apiKey

apiKey: string

API key for use with the hosted service on tier.run

`Readonly` baseURL

baseURL: string

The URL to the sidecar providing API endpoints

clockID

clockID: string

The ID of a stripe test clock. Set via withClock

`Readonly` fetch

fetch: ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)

Type declaration

- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
- The fetch() implementation in use. Will default to the Node built-in fetch if available, otherwise node-fetch will be used.
  Parameters
  - input: URL | RequestInfo
  - Optional init: RequestInit
  Returns Promise<Response>

`Optional` onError

onError?: ((er: TierError) => any)

Type declaration

- (er: TierError): any
- A method which is called on all errors, useful for logging, or handling 401 responses from a public tier API.
  Parameters
  - er: TierError
  Returns any

`Optional` signal

signal?: AbortSignal

AbortSignal used to cancel all requests from this client.

`Optional` userAgent

userAgent?: string | false

The User-Agent header that Tier sends.

Set to false to not send a user agent header. Leave blank to send the default User-Agent header, which includes the Tier client version, along with either Node.js process.version or browser's navigator.userAgent

Accessors

`Protected` debug

set debug(d: boolean): void
Parameters
- d: boolean
Returns void
Inherited from Tier.debug
- Defined in src/client.ts:371

Methods

`Private` #awaitClockReady

#awaitClockReady(): Promise<void>
Returns Promise<void>
- Defined in src/client.ts:801

`Private` #syncClock

#syncClock(): Promise<ClockResponse>
Returns Promise<ClockResponse>
- Defined in src/client.ts:812

advance

advance(t: Date): Promise<void>
Parameters
- t: Date
Returns Promise<void>
- Defined in src/client.ts:793

`Protected` apiGet

apiGet<T>(path: string, query?: {
[k: string]: string | string[];
}): Promise<T>
Type Parameters
- T
Parameters
- path: string
- Optional query: {
  [k: string]: string | string[];
  }
  - [k: string]: string | string[]
Returns Promise<T>
Inherited from Tier.apiGet
- Defined in src/client.ts:379

`Protected` apiPost

apiPost<TReq, TRes>(path: string, body: TReq): Promise<TRes>
Type Parameters
- TReq
- TRes = {}
Parameters
- path: string
- body: TReq
Returns Promise<TRes>
Inherited from Tier.apiPost
- Defined in src/client.ts:432

can

can(org: `org:${string}`, feature: `feature:${string}`): Promise<Answer>
Return an Answer indicating whether an org can access a feature, or if they are at their plan limit.
Parameters
- org: `org:${string}`
- feature: `feature:${string}`
Returns Promise<Answer>
Inherited from Tier.can
- Defined in src/client.ts:737

cancel

cancel(org: `org:${string}`): Promise<ScheduleResponse>
Cancel an org's subscriptions
Parameters
- org: `org:${string}`
Returns Promise<ScheduleResponse>
Inherited from Tier.cancel
- Defined in src/client.ts:589

checkout

checkout(org: `org:${string}`, successUrl: string, params?: CheckoutParams): Promise<CheckoutResponse>
Generate a checkout URL to set an org's payment info, and optionally to create a subscription on completion.

successUrl param should be a URL within your application where the user will be redirected upon completion.
Parameters
- org: `org:${string}`
- successUrl: string
- params: CheckoutParams = {}
Returns Promise<CheckoutResponse>
Inherited from Tier.checkout
- Defined in src/client.ts:545

`Protected` debugLog

debugLog(..._: any[]): void
Parameters
- Rest ..._: any[]
Returns void
Inherited from Tier.debugLog
- Defined in src/client.ts:369

limit

limit(org: `org:${string}`, feature: `feature:${string}`): Promise<Usage>
Deprecated
alias for lookupLimit
Parameters
- org: `org:${string}`
- feature: `feature:${string}`
Returns Promise<Usage>
Inherited from Tier.limit
- Defined in src/client.ts:763

limits

limits(org: `org:${string}`): Promise<Limits>
Deprecated
alias for lookupLimits
Parameters
- org: `org:${string}`
Returns Promise<Limits>
Inherited from Tier.limits
- Defined in src/client.ts:756

lookupLimit

lookupLimit(org: `org:${string}`, feature: `feature:${string}`): Promise<Usage>
Look up limits for a given FeatureName and OrgName
Parameters
- org: `org:${string}`
- feature: `feature:${string}`
Returns Promise<Usage>
Inherited from Tier.lookupLimit
- Defined in src/client.ts:504

lookupLimits

lookupLimits(org: `org:${string}`): Promise<Limits>
Look up the limits for all features for a given OrgName
Parameters
- org: `org:${string}`
Returns Promise<Limits>
Inherited from Tier.lookupLimits
- Defined in src/client.ts:486

lookupOrg

lookupOrg(org: `org:${string}`): Promise<LookupOrgResponse>
Look up all OrgInfo metadata about an org
Parameters
- org: `org:${string}`
Returns Promise<LookupOrgResponse>
Inherited from Tier.lookupOrg
- Defined in src/client.ts:646

lookupPaymentMethods

lookupPaymentMethods(org: `org:${string}`): Promise<PaymentMethodsResponse>
Look up the payment methods on file for a given OrgName
Parameters
- org: `org:${string}`
Returns Promise<PaymentMethodsResponse>
Inherited from Tier.lookupPaymentMethods
- Defined in src/client.ts:493

lookupPhase

lookupPhase(org: `org:${string}`): Promise<CurrentPhase>
Fetch the current phase for an org
Parameters
- org: `org:${string}`
Returns Promise<CurrentPhase>
Inherited from Tier.lookupPhase
- Defined in src/client.ts:658

phase

phase(org: `org:${string}`): Promise<CurrentPhase>
Deprecated
alias for lookupPhase
Parameters
- org: `org:${string}`
Returns Promise<CurrentPhase>
Inherited from Tier.phase
- Defined in src/client.ts:770

pull

pull(): Promise<Model>
Pull the full Model pushed to Tier

Returns Promise<Model>
Inherited from Tier.pull
- Defined in src/client.ts:677

pullLatest

pullLatest(): Promise<Model>
Similar to pull, but filters plans to only include the highest version of each plan. Plan versions are sorted numerically if they are decimal integers, or lexically in the en locale otherwise.

So, for example, the plan version 20test will be considered "lower" than 9test, because the non-numeric string causes it to be lexically sorted. But the plan version 20 sill be considered "higher" than the plan version 9, because both are strictly numeric.

Note Plan versions are inherently arbitrary, and as such, they really should not be sorted or given any special priority by being "latest".

This method will be removed in version 6 of this SDK.

Deprecated

Returns Promise<Model>
Inherited from Tier.pullLatest
- Defined in src/client.ts:698

push

push(model: Model): Promise<PushResponse>
Push a new Model to Tier

Any previously pushed PlanName will be ignored, new plans will be added.
Parameters
- model: Model
Returns Promise<PushResponse>
Inherited from Tier.push
- Defined in src/client.ts:722

report

report(org: `org:${string}`, feature: `feature:${string}`, n?: number, __namedParameters?: ReportParams): Promise<{}>
Report metered feature usage
Parameters
- org: `org:${string}`
- feature: `feature:${string}`
- n: number = 1
- __namedParameters: ReportParams = {}
Returns Promise<{}>
Inherited from Tier.report
- Defined in src/client.ts:520

schedule

schedule(org: `org:${string}`, phases?: Phase[], __namedParameters?: ScheduleParams): Promise<ScheduleResponse>
Advanced interface for creating arbitrary schedule phases in any order.
Parameters
- org: `org:${string}`
- Optional phases: Phase[]
- __namedParameters: ScheduleParams = {}
Returns Promise<ScheduleResponse>
Inherited from Tier.schedule
- Defined in src/client.ts:602

subscribe(org: `org:${string}`, features: Features | Features[], __namedParameters?: SubscribeParams): Promise<ScheduleResponse>
Simple interface for creating a new phase in the org's subscription schedule.

Setting trialDays will cause it to prepend a "trial" phase on the effective date, and delay the creation of the actual non-trial subscription phase by the specified number of days.
Parameters
- org: `org:${string}`
- features: Features | Features[]
- __namedParameters: SubscribeParams = {}
Returns Promise<ScheduleResponse>
Inherited from Tier.subscribe
- Defined in src/client.ts:574

`Protected` tryGet

tryGet<T>(path: string, query?: {
[k: string]: string | string[];
}): Promise<T>
Type Parameters
- T
Parameters
- path: string
- Optional query: {
  [k: string]: string | string[];
  }
  - [k: string]: string | string[]
Returns Promise<T>
Inherited from Tier.tryGet
- Defined in src/client.ts:423

`Protected` tryPost

tryPost<TReq, TRes>(path: string, body: TReq): Promise<TRes>
Type Parameters
- TReq
- TRes = {}
Parameters
- path: string
- body: TReq
Returns Promise<TRes>
Inherited from Tier.tryPost
- Defined in src/client.ts:474

updateOrg

updateOrg(org: `org:${string}`, info: OrgInfo): Promise<ScheduleResponse>
Update an org's metadata. Note that any fields not set (other than metadata) will be reset to empty '' values on any update.
Parameters
- org: `org:${string}`
- info: OrgInfo
Returns Promise<ScheduleResponse>
Inherited from Tier.updateOrg
- Defined in src/client.ts:623

whoami

whoami(): Promise<WhoAmIResponse>
Get information about the current sidecare API in use

Returns Promise<WhoAmIResponse>
Inherited from Tier.whoami
- Defined in src/client.ts:729

whois

whois(org: `org:${string}`): Promise<WhoIsResponse>
Get an org's billing provider identifier
Parameters
- org: `org:${string}`
Returns Promise<WhoIsResponse>
Inherited from Tier.whois
- Defined in src/client.ts:637

withClock

withClock(name: string, start?: Date): Promise<TierWithClock>
Parameters
- name: string
- start: Date = ...
Returns Promise<TierWithClock>
Inherited from Tier.withClock
- Defined in src/client.ts:349

Class TierWithClock

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: TierWithClockOptions

Returns TierWithClock

Properties

Readonly apiKey

Readonly baseURL

clockID

Readonly fetch

Type declaration

Parameters

input: URL | RequestInfo

Optional init: RequestInit

Returns Promise<Response>

Optional onError

Type declaration

Parameters

er: TierError

Returns any

Optional signal

Optional userAgent

Accessors

Protected debug

Parameters

d: boolean

Returns void

Methods

Private #awaitClockReady

Returns Promise<void>

Private #syncClock

Returns Promise<ClockResponse>

advance

Parameters

t: Date

Returns Promise<void>

Protected apiGet

Type Parameters

T

Parameters

path: string

Optional query: { [k: string]: string | string[]; }

[k: string]: string | string[]

Returns Promise<T>

Protected apiPost

Type Parameters

TReq

TRes = {}

Parameters

path: string

body: TReq

Returns Promise<TRes>

can

Parameters

org: `org:${string}`

feature: `feature:${string}`

Returns Promise<Answer>

cancel

Parameters

org: `org:${string}`

Returns Promise<ScheduleResponse>

checkout

Parameters

org: `org:${string}`

successUrl: string

params: CheckoutParams = {}

Returns Promise<CheckoutResponse>

Protected debugLog

Parameters

Rest ..._: any[]

Returns void

limit

Deprecated

`Readonly` apiKey

`Readonly` baseURL

`Readonly` fetch

`Optional` init: RequestInit

`Optional` onError

`Optional` signal

`Optional` userAgent

`Protected` debug

`Private` #awaitClockReady

`Private` #syncClock

`Protected` apiGet

`Optional` query: {
[k: string]: string | string[];
}

`Protected` apiPost

`Protected` debugLog

`Rest` ..._: any[]

`Optional` phases: Phase[]

`Protected` tryGet

`Optional` query: {
[k: string]: string | string[];
}