plunk/contacts

Types

Action

pub type Action =
  definitions.Action

ActionResult

</>

pub type ActionResult {
  GetContactResult(ExtendedContact)
  ListContactsResult(List(Contact))
  CountContactsResult(Count)
  CreateContactResult(CreatedContact)
  SubscriptionResult(Subscription)
  DeleteContactResult(DeletedContact)
}

Constructors

```
GetContactResult(ExtendedContact)
```
```
ListContactsResult(List(Contact))
```
```
CountContactsResult(Count)
```
```
CreateContactResult(CreatedContact)
```
```
SubscriptionResult(Subscription)
```
```
DeleteContactResult(DeletedContact)
```

Contact

</>

pub type Contact =
  definitions.Contact

Count

</>

pub type Count =
  definitions.Count

CreateContactData

</>

pub type CreateContactData {
  CreateContactData(
    email: String,
    subscribed: Bool,
    data: Option(List(#(String, String))),
  )
}

Constructors

CreateContactData(
  email: String,
  subscribed: Bool,
  data: Option(List(#(String, String))),
)

CreatedContact

</>

pub type CreatedContact =
  definitions.CreatedContact

DeletedContact

</>

pub type DeletedContact =
  definitions.DeletedContact

Email

</>

pub type Email =
  definitions.Email

Event

</>

pub type Event =
  definitions.Event

ExtendedContact

</>

pub type ExtendedContact =
  definitions.ExtendedContact

For

</>

pub type For {
  GetContact
  ListContacts
  CountContacts
  CreateContact
  Subscribe
  Unsubscribe
  DeleteContact
}

Constructors

```
GetContact
```
```
ListContacts
```
```
CountContacts
```
```
CreateContact
```
```
Subscribe
```
```
Unsubscribe
```
```
DeleteContact
```

Subscription

</>

pub type Subscription =
  definitions.Subscription

SubscriptionData

</>

pub type SubscriptionData {
  Subscription(id: String)
}

Constructors

```
Subscription(id: String)
```

Trigger

</>

pub type Trigger =
  definitions.Trigger

Functions

count

</>

pub fn count(instance: Instance) -> Request(String)

Get count of all contacts

create

</>

pub fn create(
  instance: Instance,
  contact: CreateContactData,
) -> Request(String)

Create a contact

decode

</>

pub fn decode(
  res: Response(String),
  for for: For,
) -> Result(ActionResult, PlunkError)

This function decodes all the responses related to this resource albeit a bit differently from the other decode functions (but, still type-safe)

Example

import gleam/io
import gleam/hackney
import plunk
import plunk/contacts.{GetContact, GetContactResult}

fn main() {
  let instance = plunk.new("API_KEY")
  let req = contacts.get(instance, "some-uuid-for-your-contact")
  let assert Ok(resp) = hackney.send(req)
  let assert Ok(data) = contacts.decode(resp, for: GetContact)
  let assert GetContactResult(contact) = data
  io.println(contact.id)
}

delete

</>

pub fn delete(instance: Instance, id: String) -> Request(String)

Delete a contact

get

</>

pub fn get(
  instance: Instance,
  id contact_id: String,
) -> Request(String)

Get a contact by ID

list

</>

pub fn list(instance: Instance) -> Request(String)

Get all contacts

</>

pub fn subscribe(
  instance: Instance,
  id: String,
) -> Request(String)

Subscribe a contact

unsubscribe

</>

pub fn unsubscribe(
  instance: Instance,
  id: String,
) -> Request(String)

Unsubscribe a contact