subscription

Types

Subscription

pub type Subscription {
  Subscription(
    id: String,
    subscription_status: SubscriptionStatus,
    subscription_type: SubscriptionType,
    version: String,
    cost: Int,
    condition: Condition,
    transport: Transport,
  )
}

Constructors

Subscription(
  id: String,
  subscription_status: SubscriptionStatus,
  subscription_type: SubscriptionType,
  version: String,
  cost: Int,
  condition: Condition,
  transport: Transport,
)

SubscriptionStatus

</>

pub type SubscriptionStatus {
  Enabled
  WebHookCallbackVerificationPending
}

Constructors

```
Enabled
```
```
WebHookCallbackVerificationPending
```

SubscriptionType

</>

pub type SubscriptionType {
  AutomodMessageHold
  AutomodMessageUpdate
  AutomodSettingsUpdate
  AutomodTermsUpdate
  ChannelUpdate
  ChannelFollow
  ChannelAdBreakBegin
  ChannelChatClear
  ChannelChatClearUserMessages
  ChannelChatMessage
  ChannelChatMessageDelete
  ChannelChatNotification
  ChannelChatSettingsUpdate
  ChannelChatUserMessageHold
  ChannelChatUserMessageUpdate
  ChannelSubscribe
  ChannelSubscriptionEnd
  ChannelSubscriptionGift
  ChannelSubscriptionMessage
  ChannelCheer
  ChannelRaid
  ChannelBan
  ChannelUnban
  ChannelUnbanRequestCreate
  ChannelUnbanRequestResolve
  ChannelModerate
  ChannelModeratorAdd
  ChannelModeratorRemove
  ChannelGuestStarSessionBegin
  ChannelGuestStarSessionEnd
  ChannelGuestStarGuestUpdate
  ChannelGuestStarSettingsUpdate
  ChannelPointsAutomaticRewardRedemption
  ChannelPointsCustomRewardAdd
  ChannelPointsCustomRewardUpdate
  ChannelPointsCustomRewardRemove
  ChannelPointsCustomRewardRedemptionAdd
  ChannelPointsCustomRewardRedemptionUpdate
  ChannelPollBegin
  ChannelPollProgress
  ChannelPollEnd
  ChannelPredictionBegin
  ChannelPredictionProgress
  ChannelPredictionLock
  ChannelPredictionEnd
  ChannelSuspiciousUserMessage
  ChannelSuspiciousUserUpdate
  ChannelVIPAdd
  ChannelVIPRemove
  CharityDonation
  CharityCampaignStart
  CharityCampaignProgress
  CharityCampaignStop
  ConduitShardDisabled
  DropEntitlementGrant
  ExtensionBitsTransactionCreate
  GoalBegin
  GoalProgress
  GoalEnd
  HypeTrainBegin
  HypeTrainProgress
  HypeTrainEnd
  ShieldModeBegin
  ShieldModeEnd
  ShoutoutCreate
  ShoutoutReceived
  StreamOnline
  StreamOffline
  UserAuthorizationGrant
  UserAuthorizationRevoke
  UserUpdate
  WhisperReceived
}

Constructors

```
AutomodMessageHold
```
```
AutomodMessageUpdate
```
```
AutomodSettingsUpdate
```
```
AutomodTermsUpdate
```
```
ChannelUpdate
```
```
ChannelFollow
```
```
ChannelAdBreakBegin
```
```
ChannelChatClear
```
```
ChannelChatClearUserMessages
```
```
ChannelChatMessage
```
```
ChannelChatMessageDelete
```
```
ChannelChatNotification
```
```
ChannelChatSettingsUpdate
```
```
ChannelChatUserMessageHold
```
```
ChannelChatUserMessageUpdate
```
```
ChannelSubscribe
```
```
ChannelSubscriptionEnd
```
```
ChannelSubscriptionGift
```
```
ChannelSubscriptionMessage
```
```
ChannelCheer
```
```
ChannelRaid
```
```
ChannelBan
```
```
ChannelUnban
```
```
ChannelUnbanRequestCreate
```
```
ChannelUnbanRequestResolve
```
```
ChannelModerate
```
```
ChannelModeratorAdd
```
```
ChannelModeratorRemove
```
```
ChannelGuestStarSessionBegin
```
```
ChannelGuestStarSessionEnd
```
```
ChannelGuestStarGuestUpdate
```
```
ChannelGuestStarSettingsUpdate
```
```
ChannelPointsAutomaticRewardRedemption
```
```
ChannelPointsCustomRewardAdd
```
```
ChannelPointsCustomRewardUpdate
```
```
ChannelPointsCustomRewardRemove
```
```
ChannelPointsCustomRewardRedemptionAdd
```

ChannelPointsCustomRewardRedemptionUpdate

```
ChannelPollBegin
```
```
ChannelPollProgress
```
```
ChannelPollEnd
```
```
ChannelPredictionBegin
```
```
ChannelPredictionProgress
```
```
ChannelPredictionLock
```
```
ChannelPredictionEnd
```
```
ChannelSuspiciousUserMessage
```
```
ChannelSuspiciousUserUpdate
```
```
ChannelVIPAdd
```
```
ChannelVIPRemove
```
```
CharityDonation
```
```
CharityCampaignStart
```
```
CharityCampaignProgress
```
```
CharityCampaignStop
```
```
ConduitShardDisabled
```
```
DropEntitlementGrant
```
```
ExtensionBitsTransactionCreate
```
```
GoalBegin
```
```
GoalProgress
```
```
GoalEnd
```
```
HypeTrainBegin
```
```
HypeTrainProgress
```
```
HypeTrainEnd
```
```
ShieldModeBegin
```
```
ShieldModeEnd
```
```
ShoutoutCreate
```
```
ShoutoutReceived
```
```
StreamOnline
```
```
StreamOffline
```
```
UserAuthorizationGrant
```
```
UserAuthorizationRevoke
```
```
UserUpdate
```
```
WhisperReceived
```

Functions

decoder

</>

pub fn decoder() -> fn(Dynamic) ->
  Result(Subscription, List(DecodeError))

subscription_status_decoder

</>

pub fn subscription_status_decoder() -> fn(Dynamic) ->
  Result(SubscriptionStatus, List(DecodeError))

subscription_status_from_json

</>

pub fn subscription_status_from_json(
  json_string: String,
) -> Result(SubscriptionStatus, DecodeError)

subscription_status_from_string

</>

pub fn subscription_status_from_string(
  str: String,
) -> Result(SubscriptionStatus, Nil)

subscription_status_to_json

</>

pub fn subscription_status_to_json(
  subscription_status: SubscriptionStatus,
) -> Json

subscription_status_to_string

</>

pub fn subscription_status_to_string(
  status: SubscriptionStatus,
) -> String

subscription_type_decoder

</>

pub fn subscription_type_decoder() -> fn(Dynamic) ->
  Result(SubscriptionType, List(DecodeError))

subscription_type_from_json

</>

pub fn subscription_type_from_json(
  json_string: String,
) -> Result(SubscriptionType, DecodeError)

subscription_type_from_string

</>

pub fn subscription_type_from_string(
  str: String,
) -> Result(SubscriptionType, Nil)

subscription_type_to_json

</>

pub fn subscription_type_to_json(
  subscription_type: SubscriptionType,
) -> Json

subscription_type_to_string

</>

pub fn subscription_type_to_string(
  subscription_type: SubscriptionType,
) -> String