Skip to main content

CommunityApiClientInterface

Methods

getCommunities()

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

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

Parameters

ParameterTypeDescription
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCommunityType>>


getCommunity()

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

Get Community

Parameters

ParameterTypeDescription
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCCommunityType>