penicillin/blue.starry.penicillin.endpoints/WelcomeMessageRules

WelcomeMessageRules

class WelcomeMessageRules(val client: ApiClient) : Endpoint
Content copied to clipboard

Collection of api endpoints related to Welcome Message Rules.

See also

Parameters

client

Current ApiClient instance.

Constructors

Link copied to clipboard
fun WelcomeMessageRules(client: ApiClient)
Content copied to clipboard

Creates new WelcomeMessageRules endpoint instance.

Properties

Link copied to clipboard
open override val client: ApiClient
Content copied to clipboard

Extensions

Link copied to clipboard
fun WelcomeMessageRules.create(id: String, vararg options: Option): JsonObjectApiAction<WelcomeMessageRule.Single>
Content copied to clipboard

Creates a new Welcome Message Rule that determines which Welcome Message will be shown in a given conversation. Returns the created rule if successful. Requires a JSON POST body and Content-Type header to be set to application/json. Setting Content-Length may also be required if it is not automatically. Additional rule configurations are forthcoming. For the initial beta release, the most recently created Rule will always take precedence, and the assigned Welcome Message will be displayed in the conversation. See the Welcome Messages overview to learn how to work with Welcome Messages.

Link copied to clipboard
fun WelcomeMessageRules.delete(id: Long, vararg options: Option): EmptyApiAction
Content copied to clipboard

Deletes a Welcome Message Rule by the given id.

Link copied to clipboard
val WelcomeMessageRules.list: JsonObjectApiAction<WelcomeMessageRule.List>
Content copied to clipboard

Shorthand property to WelcomeMessageRules.list.

fun WelcomeMessageRules.list(    count: Int? = null,     cursor: String? = null,     vararg options: Option): JsonObjectApiAction<WelcomeMessageRule.List>
Content copied to clipboard

Returns a list of Welcome Message Rules.

Link copied to clipboard
fun WelcomeMessageRules.show(id: Long, vararg options: Option): JsonObjectApiAction<WelcomeMessageRule.Single>
Content copied to clipboard

Returns a Welcome Message Rule by the given id.