Class SumUp

Hierarchy

HTTPClient
- SumUp

Index

Constructors

Properties

apiKey? baseParams checkouts customers host members memberships merchant payouts readers receipts roles subaccounts transactions SumUp

Methods

delete do get patch post put request stringifyQuery

Constructors

constructor

new SumUp(__namedParameters?: APIConfig): SumUp
Parameters
- __namedParameters: APIConfig = {}
Returns SumUp
Inherited from HTTPClient.constructor
- Defined in client.ts:17

Properties

`Optional`apiKey

apiKey?: string

baseParams

baseParams: FetchParams

checkouts

checkouts: SumUp.Checkouts = ...

customers

customers: SumUp.Customers = ...

host

host: string

members

members: SumUp.Members = ...

memberships

memberships: SumUp.Memberships = ...

merchant

merchant: SumUp.Merchant = ...

payouts

payouts: SumUp.Payouts = ...

readers

readers: SumUp.Readers = ...

receipts

receipts: SumUp.Receipts = ...

roles

roles: SumUp.Roles = ...

subaccounts

subaccounts: SumUp.Subaccounts = ...

transactions

transactions: SumUp.Transactions = ...

`Static`SumUp

SumUp: typeof SumUp = ...

Methods

delete

delete<R, E = APIError<unknown>>(
__namedParameters: Omit<FullParams, "method">,
): APIPromise<R>
Type Parameters
- R
- E = APIError<unknown>
Parameters
- __namedParameters: Omit<FullParams, "method">
Returns APIPromise<R>
Inherited from HTTPClient.delete
- Defined in client.ts:72

`Protected`do

do<E>(input: URL, init: RequestInit): Promise<Response>
Type Parameters
- E
Parameters
- input: URL
- init: RequestInit
Returns Promise<Response>
Inherited from HTTPClient.do
- Defined in client.ts:103

get

get<R, E = APIError<unknown>>(
__namedParameters: Omit<FullParams, "method">,
): APIPromise<R>
Type Parameters
- R
- E = APIError<unknown>
Parameters
- __namedParameters: Omit<FullParams, "method">
Returns APIPromise<R>
Inherited from HTTPClient.get
- Defined in client.ts:36

patch

patch<R, E = APIError<unknown>>(
__namedParameters: Omit<FullParams, "method">,
): APIPromise<R>
Type Parameters
- R
- E = APIError<unknown>
Parameters
- __namedParameters: Omit<FullParams, "method">
Returns APIPromise<R>
Inherited from HTTPClient.patch
- Defined in client.ts:63

post

post<R, E = APIError<unknown>>(
__namedParameters: Omit<FullParams, "method">,
): APIPromise<R>
Type Parameters
- R
- E = APIError<unknown>
Parameters
- __namedParameters: Omit<FullParams, "method">
Returns APIPromise<R>
Inherited from HTTPClient.post
- Defined in client.ts:45

put

put<R, E = APIError<unknown>>(
__namedParameters: Omit<FullParams, "method">,
): APIPromise<R>
Type Parameters
- R
- E = APIError<unknown>
Parameters
- __namedParameters: Omit<FullParams, "method">
Returns APIPromise<R>
Inherited from HTTPClient.put
- Defined in client.ts:54

request

request<T, E = APIError<unknown>>(__namedParameters: FullParams): APIPromise<T>
Type Parameters
- T
- E = APIError<unknown>
Parameters
- __namedParameters: FullParams
Returns APIPromise<T>
Inherited from HTTPClient.request
- Defined in client.ts:81

`Protected`stringifyQuery

stringifyQuery(query: Record<string, unknown>): string
Parameters
- query: Record<string, unknown>
Returns string
Inherited from HTTPClient.stringifyQuery
- Defined in client.ts:119