@sumup/sdk
Version:
The official TypeScript SDK for the SumUp API
34 lines • 1.56 kB
text/typescript
import { APIResource, type RequestOptions, type WithResponse } from "../../core";
import type { ListPersonsResponseBody, Merchant, Person } from "../../types";
export type GetMerchantQueryParams = {
version?: string;
};
export type ListPersonsQueryParams = {
version?: string;
};
export type GetPersonQueryParams = {
version?: string;
};
/**
* API resource for the Merchants endpoints.
*
* Merchant account represents a single business entity at SumUp.
*/
export declare class Merchants extends APIResource {
/**
* Retrieve a merchant.
*/
get(merchantCode: string, query?: GetMerchantQueryParams, options?: RequestOptions): Promise<Merchant>;
getWithResponse(merchantCode: string, query?: GetMerchantQueryParams, options?: RequestOptions): Promise<WithResponse<Merchant>>;
/**
* Returns a list of persons related to the merchant.
*/
listPersons(merchantCode: string, query?: ListPersonsQueryParams, options?: RequestOptions): Promise<ListPersonsResponseBody>;
listPersonsWithResponse(merchantCode: string, query?: ListPersonsQueryParams, options?: RequestOptions): Promise<WithResponse<ListPersonsResponseBody>>;
/**
* Returns a single person related to the merchant.
*/
getPerson(merchantCode: string, personId: string, query?: GetPersonQueryParams, options?: RequestOptions): Promise<Person>;
getPersonWithResponse(merchantCode: string, personId: string, query?: GetPersonQueryParams, options?: RequestOptions): Promise<WithResponse<Person>>;
}
//# sourceMappingURL=index.d.cts.map