@sumup/sdk
Version:
The official TypeScript SDK for the SumUp API
31 lines • 1.24 kB
text/typescript
import { APIResource, type RequestOptions, type WithResponse } from "../../core";
import type { Membership, MembershipStatus, ResourceType } from "../../types";
export type ListMembershipsQueryParams = {
offset?: number;
limit?: number;
kind?: ResourceType;
status?: MembershipStatus;
"resource.type"?: ResourceType;
"resource.attributes.sandbox"?: boolean;
"resource.name"?: string;
"resource.parent.id"?: string | null;
"resource.parent.type"?: ResourceType | null;
roles?: string[];
};
export type ListMembershipsResponse = {
items: Membership[];
total_count: number;
};
/**
* API resource for the Memberships endpoints.
*
* Endpoints to manage user's memberships. Memberships are used to connect the user to merchant accounts and to grant them access to the merchant's resources via roles.
*/
export declare class Memberships extends APIResource {
/**
* List memberships of the current user.
*/
list(query?: ListMembershipsQueryParams, options?: RequestOptions): Promise<ListMembershipsResponse>;
listWithResponse(query?: ListMembershipsQueryParams, options?: RequestOptions): Promise<WithResponse<ListMembershipsResponse>>;
}
//# sourceMappingURL=index.d.cts.map