baseapi.md

fiken › BaseAPI

Class: BaseAPI

This is the base class for all generated API classes.

Hierarchy

• BaseAPI

  ↳ AccountsApi

  ↳ BankAccountsApi

  ↳ CompaniesApi

  ↳ ContactsApi

  ↳ CreditNotesApi

  ↳ InboxApi

  ↳ InvoicesApi

  ↳ JournalEntriesApi

  ↳ OffersApi

  ↳ OrderConfirmationsApi

  ↳ ProductsApi

  ↳ ProjectsApi

  ↳ PurchasesApi

  ↳ SalesApi

  ↳ TransactionsApi

  ↳ UserApi

Index

Constructors

• constructor

Properties

• configuration
• middleware

Methods

• clone
• createFetchParams
• fetchApi
• request
• withMiddleware
• withPostMiddleware
• withPreMiddleware

Constructors

constructor

+ new BaseAPI(configuration: Configuration‹›): BaseAPI

Parameters:

Name	Type	Default
configuration	Configuration‹›	new Configuration()

Returns: BaseAPI

Properties

Protected configuration

• configuration: Configuration‹›

---

Private middleware

• middleware: Middleware[]

Methods

Private clone

▸ clone‹T›(this: T): T

Create a shallow clone of this by constructing a new instance and then shallow cloning data members.

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T

Returns: T

---

Private createFetchParams

▸ createFetchParams(context: RequestOpts): object

Parameters:

Name	Type
context	RequestOpts

Returns: object

• init(): object

  • body: any

  • credentials: RequestCredentials = this.configuration.credentials

  • headers: HTTPHeaders = headers

  • method: HTTPMethod = context.method

• url: string

---

Private fetchApi

▸ fetchApi(url: string, init: RequestInit): Promise‹Response›

Parameters:

Name	Type
url	string
init	RequestInit

Returns: Promise‹Response›

---

Protected request

▸ request(context: RequestOpts): Promise‹Response›

Parameters:

Name	Type
context	RequestOpts

Returns: Promise‹Response›

---

withMiddleware

▸ withMiddleware‹T›(this: T, ...middlewares: Middleware[]): T

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...middlewares	Middleware[]

Returns: T

---

withPostMiddleware

▸ withPostMiddleware‹T›(this: T, ...postMiddlewares: Array‹Middleware["post"]›): T

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...postMiddlewares	Array‹Middleware["post"]›

Returns: T

---

withPreMiddleware

▸ withPreMiddleware‹T›(this: T, ...preMiddlewares: Array‹Middleware["pre"]›): T

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...preMiddlewares	Array‹Middleware["pre"]›

Returns: T