Class SumUp

Hierarchy

HTTPClient
- SumUp

Index

Constructors

constructor

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

Properties

`Optional`apiKey

apiKey?: string

baseParams

baseParams: RequestOptions

checkouts

checkouts: Checkouts = ...

Access the Checkouts API endpoints.

customers

customers: Customers = ...

Access the Customers API endpoints.

host

host: string

members

members: Members = ...

Access the Members API endpoints.

memberships

memberships: Memberships = ...

Access the Memberships API endpoints.

merchants

merchants: Merchants = ...

Access the Merchants API endpoints.

payouts

payouts: Payouts = ...

Access the Payouts API endpoints.

readers

readers: Readers = ...

Access the Readers API endpoints.

receipts

receipts: Receipts = ...

Access the Receipts API endpoints.

roles

roles: Roles = ...

Access the Roles API endpoints.

transactions

transactions: Transactions = ...

Access the Transactions API endpoints.

Methods

delete

delete<R>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): Promise<R>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<R>
Inherited from HTTPClient.delete
- Defined in src/client.ts:114

deleteWithResponse

deleteWithResponse<R>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): Promise<WithResponse<R>>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<WithResponse<R>>
Inherited from HTTPClient.deleteWithResponse
- Defined in src/client.ts:123

`Protected`do

do(
    input: URL,
    init: RequestInit,
    options: {
        maxRetries?: number;
        signal?: AbortSignal | null;
        timeout?: number;
    },
): Promise<Response>
Parameters
- input: URL
- init: RequestInit
- options: { maxRetries?: number; signal?: AbortSignal | null; timeout?: number }
Returns Promise<Response>
Inherited from HTTPClient.do
- Defined in src/client.ts:167

get

get<R>(__namedParameters: Omit<Core.FullRequestOptions, "method">): Promise<R>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<R>
Inherited from HTTPClient.get
- Defined in src/client.ts:42

getWithResponse

getWithResponse<R>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): Promise<WithResponse<R>>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<WithResponse<R>>
Inherited from HTTPClient.getWithResponse
- Defined in src/client.ts:51

patch

patch<R>(__namedParameters: Omit<Core.FullRequestOptions, "method">): Promise<R>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<R>
Inherited from HTTPClient.patch
- Defined in src/client.ts:96

patchWithResponse

patchWithResponse<R>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): Promise<WithResponse<R>>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<WithResponse<R>>
Inherited from HTTPClient.patchWithResponse
- Defined in src/client.ts:105

post

post<R>(__namedParameters: Omit<Core.FullRequestOptions, "method">): Promise<R>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<R>
Inherited from HTTPClient.post
- Defined in src/client.ts:60

postWithResponse

postWithResponse<R>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): Promise<WithResponse<R>>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<WithResponse<R>>
Inherited from HTTPClient.postWithResponse
- Defined in src/client.ts:69

put

put<R>(__namedParameters: Omit<Core.FullRequestOptions, "method">): Promise<R>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<R>
Inherited from HTTPClient.put
- Defined in src/client.ts:78

putWithResponse

putWithResponse<R>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): Promise<WithResponse<R>>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<WithResponse<R>>
Inherited from HTTPClient.putWithResponse
- Defined in src/client.ts:87

request

request<T>(__namedParameters: FullRequestOptions): Promise<T>
Type Parameters
- T
Parameters
- __namedParameters: FullRequestOptions
Returns Promise<T>
Inherited from HTTPClient.request
- Defined in src/client.ts:132

requestWithResponse

requestWithResponse<T>(
__namedParameters: FullRequestOptions,
): Promise<WithResponse<T>>
Type Parameters
- T
Parameters
- __namedParameters: FullRequestOptions
Returns Promise<WithResponse<T>>
Inherited from HTTPClient.requestWithResponse
- Defined in src/client.ts:136

`Protected`stringifyQuery

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