Class CustomerAPI

Hierarchy

APIWrapper
- CustomerAPI

Index

Constructors

constructor

Properties

Accessors

paymentMethod

Methods

Constructors

constructor

new CustomerAPI(iugu: Iugu): CustomerAPI

Inherited from APIWrapper.constructor
- Defined in api/api-wrapper.ts:14
Parameters
- iugu: Iugu
Returns CustomerAPI

Properties

Protected iugu

iugu: Iugu

Private paymentMethodInstance

paymentMethodInstance: PaymentMethodAPI

Accessors

paymentMethod

get paymentMethod(): PaymentMethodAPI

- Defined in api/customer/index.ts:21
Access the payment method API

Returns PaymentMethodAPI

Methods

create

create(customer: Customer): Promise<Customer>

- Defined in api/customer/index.ts:54
Creates a new Customer

Parameters
- customer: Customer
  
  the customer to be created
Returns Promise<Customer>

delete

delete(id: string): Promise<void>

- Defined in api/customer/index.ts:88
Deletes an existing Customer

Parameters
- id: string
Returns Promise<void>

get

get(id: string): Promise<Customer>

- Defined in api/customer/index.ts:41
Retrieves information of a single Customer

Parameters
- id: string
Returns Promise<Customer>

a promise resulting in a Customer

list

list(): PagedRequest<void, Customer>

- Defined in api/customer/index.ts:32
Returns a PagedRequest for all Customers

Returns PagedRequest<void, Customer>

update

update(customer: Customer): Promise<Customer>

- Defined in api/customer/index.ts:67
Updates an existing Customer

Parameters
- customer: Customer
  
  the customer to be updated
Returns Promise<Customer>

Generated using TypeDoc