subscriptions

Types

SubscriptionFilter

Filter for subscriptions.list.

pub type SubscriptionFilter {
  ByChannelId(channel_id: String)
  ById(ids: List(String))
  Mine
  MyRecentSubscribers
  MySubscribers
}

Constructors

```
ByChannelId(channel_id: String)
```
```
ById(ids: List(String))
```
```
Mine
```
```
MyRecentSubscribers
```
```
MySubscribers
```

SubscriptionOrder

</>

Order for subscription list results.

pub type SubscriptionOrder {
  Alphabetical
  Relevance
  Unread
}

Constructors

```
Alphabetical
```
```
Relevance
```
```
Unread
```

SubscriptionPart

</>

Valid part values for the subscriptions resource.

pub type SubscriptionPart {
  ContentDetails
  Id
  Snippet
  SubscriberSnippet
}

Constructors

```
ContentDetails
```
```
Id
```
```
Snippet
```
```
SubscriberSnippet
```

Values

delete

</>

pub fn delete(
  client: client.Client,
  subscription_id subscription_id: String,
) -> Result(Nil, error.GleeTubeError)

Delete a subscription.

insert

</>

pub fn insert(
  client: client.Client,
  parts parts: List(SubscriptionPart),
  body body: json.Json,
) -> Result(subscription.Subscription, error.GleeTubeError)

Insert a new subscription.

list

</>

pub fn list(
  client: client.Client,
  parts parts: List(SubscriptionPart),
  filter filter: SubscriptionFilter,
  for_channel_id for_channel_id: option.Option(String),
  max_results max_results: option.Option(Int),
  on_behalf_of_content_owner on_behalf_of_content_owner: option.Option(
    String,
  ),
  on_behalf_of_content_owner_channel on_behalf_of_content_owner_channel: option.Option(
    String,
  ),
  order order: option.Option(SubscriptionOrder),
  page_token page_token: option.Option(String),
) -> Result(
  subscription.SubscriptionListResponse,
  error.GleeTubeError,
)

List subscriptions matching the given filter.

list_all

</>

pub fn list_all(
  client: client.Client,
  parts parts: List(SubscriptionPart),
  filter filter: SubscriptionFilter,
  for_channel_id for_channel_id: option.Option(String),
  on_behalf_of_content_owner on_behalf_of_content_owner: option.Option(
    String,
  ),
  on_behalf_of_content_owner_channel on_behalf_of_content_owner_channel: option.Option(
    String,
  ),
  order order: option.Option(SubscriptionOrder),
) -> Result(List(subscription.Subscription), error.GleeTubeError)

Fetch all subscriptions across all pages.