CommunityApiClient

Contains all the endpoints needed to manage payments.

Constructors

Constructor

new CommunityApiClient(): CommunityApiClient

Returns

CommunityApiClient

Methods

getCommunities()

static getCommunities(params?, config?): Promise<SCPaginatedResponse<SCCommunityType>>

Get list of communities. Used to get the payment products related to the community (aka paywalls)

Parameters

Parameter	Type	Description
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCommunityType>>

---

getCommunity()

static getCommunity(id, config?): Promise<SCCommunityType>

Get Community

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCCommunityType>