Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PlanAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected iugu

iugu: Iugu

Methods

create

  • Creates a new Plan

    Parameters

    • planData: NewPlan

      the data for the plan that will be created

    Returns Promise<Plan>

    a promise that may resolve to the created object

delete

  • delete(id: string): Promise<void>

  • Deletes an existing Plan

    Parameters

    • id: string

    Returns Promise<void>

    a promise that will resolve if the removal was successful and be rejected otherwise

get

  • get(id: string): Promise<Plan>

  • Returns information of an existing Plan

    Parameters

    • id: string

      the ID of the Plan

    Returns Promise<Plan>

    a promise that may resolve to the desired object or be rejected if the id is invalid

getByIdentifier

  • getByIdentifier(identifier: string): Promise<Plan>

  • Returns information of an existing Plan

    Parameters

    • identifier: string

      the identifier of the Plan

    Returns Promise<Plan>

    a promise that may resolve to the desired object or be rejected if the identifier is invalid

list

update

  • Updates an existing Plan

    Parameters

    Returns Promise<Plan>

    a promise that may resolve to the updated object

Generated using TypeDoc