Variable defaultConst

Type declaration

• Tier: typeof Tier

• can: ((org: `org:${string}`, feature: `feature:${string}`, clientOptions?: TierGetClientOptions) => Promise<Answer>)

  • • (org: `org:${string}`, feature: `feature:${string}`, clientOptions?: TierGetClientOptions): Promise<Answer>

    • Return an Answer indicating whether an org can access a feature, or if they are at their plan limit.

      Convenience wrapper for Tier.can

      Parameters

      • org: `org:${string}`

      • feature: `feature:${string}`

      • Optional clientOptions: TierGetClientOptions

      Returns Promise<Answer>

• cancel: ((org: `org:${string}`, clientOptions?: TierGetClientOptions) => Promise<ScheduleResponse>)

  • • (org: `org:${string}`, clientOptions?: TierGetClientOptions): Promise<ScheduleResponse>

    • Cancel an org's subscriptions

      Convenience wrapper for Tier.cancel

      Parameters

      • org: `org:${string}`

      • Optional clientOptions: TierGetClientOptions

      Returns Promise<ScheduleResponse>

• checkout: ((org: `org:${string}`, successUrl: string, __namedParameters?: CheckoutParams, clientOptions?: TierGetClientOptions) => Promise<CheckoutResponse>)

  • • (org: `org:${string}`, successUrl: string, __namedParameters?: CheckoutParams, clientOptions?: TierGetClientOptions): 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.

      Convenience wrapper for Tier.checkout

      Parameters

      • org: `org:${string}`

      • successUrl: string

      • __namedParameters: CheckoutParams = {}

      • Optional clientOptions: TierGetClientOptions

      Returns Promise<CheckoutResponse>

• fromEnv: ((options?: TierGetClientOptions) => Promise<Tier>)

  • • (options?: TierGetClientOptions): Promise<Tier>

    • Get a client with the settings from the environment

      Parameters

      • options: TierGetClientOptions = {}

      Returns Promise<Tier>

• isErrorResponse: ((e: any) => e is ErrorResponse)

  • • (e: any): e is ErrorResponse
    • Internal

      Test whether a value is a valid ErrorResponse

      Parameters

      • e: any

      Returns e is ErrorResponse

• isFeatureName: ((f: any) => f is `feature:${string}`)

  • • (f: any): f is `feature:${string}`

    • Test whether a value is a valid FeatureName

      Parameters

      • f: any

      Returns f is `feature:${string}`

• isFeatureNameVersioned: ((f: any) => f is `feature:${string}@plan:${string}@${string}`)

  • • (f: any): f is `feature:${string}@plan:${string}@${string}`

    • Test whether a value is a valid FeatureNameVersioned

      Parameters

      • f: any

      Returns f is `feature:${string}@plan:${string}@${string}`

• isFeatures: ((f: any) => f is Features)

  • • (f: any): f is Features

    • Test whether a value is a valid Features

      Parameters

      • f: any

      Returns f is Features

• isOrgName: ((o: any) => o is `org:${string}`)

  • • (o: any): o is `org:${string}`

    • Test whether a value is a valid OrgName

      Parameters

      • o: any

      Returns o is `org:${string}`

• isPhase: ((p: any) => p is Phase)

  • • (p: any): p is Phase

    • Test whether a value is a valid Phase

      Parameters

      • p: any

      Returns p is Phase

• isPlanName: ((p: any) => p is `plan:${string}@${string}`)

  • • (p: any): p is `plan:${string}@${string}`

    • Test whether a value is a valid PlanName

      Parameters

      • p: any

      Returns p is `plan:${string}@${string}`

• isTierError: ((e: any) => e is TierError)

  • • (e: any): e is TierError

    • Test whether a value is a valid TierError

      Parameters

      • e: any

      Returns e is TierError

• limit: ((org: `org:${string}`, feature: `feature:${string}`) => Promise<Usage>)

  • • (org: `org:${string}`, feature: `feature:${string}`): Promise<Usage>

    • Deprecated

      alias for lookupLimit

      Parameters

      • org: `org:${string}`

      • feature: `feature:${string}`

      Returns Promise<Usage>

• limits: ((org: `org:${string}`) => Promise<Limits>)

  • • (org: `org:${string}`): Promise<Limits>

    • Deprecated

      alias for lookupLimits

      Parameters

      • org: `org:${string}`

      Returns Promise<Limits>

• lookupLimit: ((org: `org:${string}`, feature: `feature:${string}`, clientOptions?: TierGetClientOptions) => Promise<Usage>)

  • • (org: `org:${string}`, feature: `feature:${string}`, clientOptions?: TierGetClientOptions): Promise<Usage>

    • Look up limits for a given FeatureName and OrgName

      Convenience wrapper for Tier.lookupLimit

      Parameters

      • org: `org:${string}`

      • feature: `feature:${string}`

      • Optional clientOptions: TierGetClientOptions

      Returns Promise<Usage>

• lookupLimits: ((org: `org:${string}`, clientOptions?: TierGetClientOptions) => Promise<Limits>)

  • • (org: `org:${string}`, clientOptions?: TierGetClientOptions): Promise<Limits>

    • Look up the limits for all features for a given OrgName

      Convenience wrapper for Tier.lookupLimits

      Parameters

      • org: `org:${string}`

      • Optional clientOptions: TierGetClientOptions

      Returns Promise<Limits>

• lookupOrg: ((org: `org:${string}`) => Promise<LookupOrgResponse>)

  • • (org: `org:${string}`): Promise<LookupOrgResponse>

    • Look up all OrgInfo metadata about an org

      Convenience wrapper for Tier.lookupOrg

      Parameters

      • org: `org:${string}`

      Returns Promise<LookupOrgResponse>

• lookupPaymentMethods: ((org: `org:${string}`) => Promise<PaymentMethodsResponse>)

  • • (org: `org:${string}`): Promise<PaymentMethodsResponse>

    • Look up all the Payment Methods available for a given OrgName

      Convenience wrapper for Tier.lookupPaymentMethods

      Parameters

      • org: `org:${string}`

      Returns Promise<PaymentMethodsResponse>

• lookupPhase: ((org: `org:${string}`) => Promise<CurrentPhase>)

  • • (org: `org:${string}`): Promise<CurrentPhase>

    • Fetch the current phase for an org

      Convenience wrapper for Tier.lookupPhase

      Parameters

      • org: `org:${string}`

      Returns Promise<CurrentPhase>

• phase: ((org: `org:${string}`) => Promise<CurrentPhase>)

  • • (org: `org:${string}`): Promise<CurrentPhase>

    • Deprecated

      alias for lookupPhase

      Parameters

      • org: `org:${string}`

      Returns Promise<CurrentPhase>

• pull: ((clientOptions?: TierGetClientOptions) => Promise<Model>)

  • • (clientOptions?: TierGetClientOptions): Promise<Model>

    • Pull the full Model pushed to Tier

      Convenience wrapper for Tier.pull

      Parameters

      • Optional clientOptions: TierGetClientOptions

      Returns Promise<Model>

• pullLatest: ((clientOptions?: TierGetClientOptions) => Promise<Model>)

  • • (clientOptions?: TierGetClientOptions): 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.

      Convenience wrapper for Tier.pullLatest

      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

      Parameters

      • Optional clientOptions: TierGetClientOptions

      Returns Promise<Model>

• push: ((model: Model) => Promise<PushResponse>)

  • • (model: Model): Promise<PushResponse>

    • Push a new Model to Tier

      Any previously pushed PlanName will be ignored, new plans will be added.

      Convenience wrapper for Tier.push

      Parameters

      • model: Model

      Returns Promise<PushResponse>

• report: ((org: `org:${string}`, feature: `feature:${string}`, n?: number, options?: ReportParams, clientOptions?: TierGetClientOptions) => Promise<{}>)

  • • (org: `org:${string}`, feature: `feature:${string}`, n?: number, options?: ReportParams, clientOptions?: TierGetClientOptions): Promise<{}>

    • Report metered feature usage

      Convenience wrapper for Tier.report

      Parameters

      • org: `org:${string}`

      • feature: `feature:${string}`

      • n: number = 1

      • Optional options: ReportParams

      • Optional clientOptions: TierGetClientOptions

      Returns Promise<{}>

• schedule: ((org: `org:${string}`, phases?: Phase[], __namedParameters?: ScheduleParams, clientOptions?: TierGetClientOptions) => Promise<ScheduleResponse>)

  • • (org: `org:${string}`, phases?: Phase[], __namedParameters?: ScheduleParams, clientOptions?: TierGetClientOptions): Promise<ScheduleResponse>

    • Advanced interface for creating arbitrary schedule phases in any order.

      Convenience wrapper for Tier.schedule

      Parameters

      • org: `org:${string}`

      • Optional phases: Phase[]

      • __namedParameters: ScheduleParams = {}

      • Optional clientOptions: TierGetClientOptions

      Returns Promise<ScheduleResponse>

• subscribe: ((org: `org:${string}`, features: Features | Features[], __namedParameters?: SubscribeParams, clientOptions?: TierGetClientOptions) => Promise<ScheduleResponse>)

  • • (org: `org:${string}`, features: Features | Features[], __namedParameters?: SubscribeParams, clientOptions?: TierGetClientOptions): 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.

      Convenience wrapper for Tier.subscribe

      Parameters

      • org: `org:${string}`

      • features: Features | Features[]

      • __namedParameters: SubscribeParams = {}

      • Optional clientOptions: TierGetClientOptions

      Returns Promise<ScheduleResponse>

• updateOrg: ((org: `org:${string}`, info: OrgInfo) => Promise<ScheduleResponse>)

  • • (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.

      Convenience wrapper for Tier.updateOrg

      Parameters

      • org: `org:${string}`

      • info: OrgInfo

      Returns Promise<ScheduleResponse>

• validateFeatureDefinition: ((f: any) => void)

  • • (f: any): void

    • Asserts that a value is a valid FeatureDefinition

      If not, a string is thrown indicating the source of the problem.

      Parameters

      • f: any

      Returns void

• validateFeatureTier: ((t: any) => void)

  • • (t: any): void

    • Validate that a value is a valid FeatureTier

      If not, a string is thrown indicating the source of the problem.

      Parameters

      • t: any

      Returns void

• validateModel: ((m: any) => asserts m is Model)

  • • (m: any): asserts m is Model

    • Asserts that a value is a valid Model

      If it is not, then a string is thrown indicating the problem.

      Parameters

      • m: any

      Returns asserts m is Model

• validatePlan: ((p: any) => void)

  • • (p: any): void

    • Asserts that a value is a valid Plan

      If not, throws a string indicating the source of the problem.

      Parameters

      • p: any

      Returns void

• whoami: (() => Promise<WhoAmIResponse>)

  • • (): Promise<WhoAmIResponse>

    • Get information about the current sidecare API in use

      Convenience wrapper for Tier.whoami

      Returns Promise<WhoAmIResponse>

• whois: ((org: `org:${string}`) => Promise<WhoIsResponse>)

  • • (org: `org:${string}`): Promise<WhoIsResponse>

    • Get an org's billing provider identifier

      Convenience wrapper for Tier.whois

      Parameters

      • org: `org:${string}`

      Returns Promise<WhoIsResponse>

• withClock: ((name: string, start?: Date, options?: TierGetClientOptions) => Promise<TierWithClock>)

  • • (name: string, start?: Date, options?: TierGetClientOptions): Promise<TierWithClock>

    • Return a new Tier client that has a test clock

      Parameters

      • name: string

      • start: Date = ...

      • options: TierGetClientOptions = {}

      Returns Promise<TierWithClock>