mailerlite ruby

MailerLite Ruby SDK

Erste Schritte

Weitere Informationen zur MailerLite-API finden Sie unter folgendem Link:

Authentifizierung

API-Schlüssel sind eine schnelle Möglichkeit, die Maschine-zu-Maschine-Authentifizierung ohne direkte Eingaben eines Menschen über die Ersteinrichtung hinaus zu implementieren.

Weitere Informationen zum Erhalten eines API-Schlüssels finden Sie unter dem folgenden Link

Inhaltsverzeichnis

• MailerLite Ruby SDK
  • Erste Schritte
    • Authentifizierung
  • Inhaltsverzeichnis
  • Installation
  • Verwendung
    • MailerLite-Client
  • Abonnenten
    • Listen Sie alle Abonnenten auf
    • Erstellen Sie einen Abonnenten
    • Aktualisieren Sie einen Abonnenten
    • Holen Sie sich einen Abonnenten
    • Einen Abonnenten löschen
  • Gruppen
    • Listen Sie alle Gruppen auf
    • Erstellen Sie eine Gruppe
    • Aktualisieren Sie eine Gruppe
    • Eine Gruppe löschen
    • Holen Sie sich Abonnenten, die einer Gruppe angehören
    • Abonnenten einer Gruppe zuordnen
    • Zuweisung eines Abonnenten zu einer Gruppe aufheben
  • Segmente
    • Listen Sie alle Segmente auf
    • Aktualisieren Sie ein Segment
    • Löschen Sie ein Segment
    • Holen Sie sich Abonnenten, die zu einem Segment gehören
  • Felder
    • Listen Sie alle Felder auf
    • Erstellen Sie ein Feld
    • Aktualisieren Sie ein Feld
    • Ein Feld löschen
  • Automatisierungen
    • Listen Sie alle Automatisierungen auf
    • Holen Sie sich eine Automatisierung
    • Erhalten Sie Abonnentenaktivitäten für eine Automatisierung
  • Kampagnen
    • Listen Sie alle Kampagnen auf
    • Holen Sie sich eine Kampagne
    • Erstellen Sie eine Kampagne
    • Aktualisieren Sie eine Kampagne
    • Planen Sie eine Kampagne
    • Brechen Sie eine Kampagne ab
    • Löschen Sie eine Kampagne
    • Erhalten Sie Abonnentenaktivitäten für eine Kampagne
  • Formulare
    • Listen Sie alle Formulare auf
    • Holen Sie sich ein Formular
    • Aktualisieren Sie ein Formular
    • Ein Formular löschen
    • Gewinnen Sie Abonnenten, die sich für ein bestimmtes Formular angemeldet haben
  • Stapeln
    • Erstellen Sie einen neuen Stapel
  • Webhooks
    • Listen Sie alle Webhooks auf
    • Holen Sie sich einen Webhook
    • Erstellen Sie einen Webhook
    • Aktualisieren Sie einen Webhook
    • Löschen Sie einen Webhook
  • Zeitzonen
    • Holen Sie sich eine Liste der Zeitzonen
  • Kampagnensprachen
    • Holen Sie sich eine Liste der Sprachen

Aufstellen

gem install mailerlite-ruby

Sie müssen es in Ihrer Ruby-Datei mit require "mailerlite-ruby" initialisieren.

Verwendung

Dieses SDK erfordert, dass Sie entweder über .env Datei mit der Umgebungsvariablen MAILERLITE_API_TOKEN verfügen oder dass Ihre Variable systemweit aktiviert ist (nützlich für Docker/Kubernetes). Das Beispiel dafür, wie MAILERLITE_API_TOKEN aussehen sollte, finden Sie in .env.example .

Abonnenten

Listen Sie alle Abonnenten auf

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

subscribers . fetch ( filter : { status : 'active' } )

Erstellen Sie einen Abonnenten

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

subscribers . create ( email : '[email protected]' , fields : { 'name' : 'John' , 'last_name' : 'Doe' } , ip_address : '1.2.3.4' , optin_ip : '1.2.3.4' )

Aktualisieren Sie einen Abonnenten

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

subscribers . update ( email : '[email protected]' , fields : { 'name' : 'John' , 'last_name' : 'Doe' } , ip_address : '1.2.3.4' , optin_ip : '1.2.3.4' )

Holen Sie sich einen Abonnenten

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

subscribers . get ( '[email protected]' )

Einen Abonnenten löschen

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

subscriber_id = 1234567890

subscribers . delete ( subscriber_id ) 

Gruppen

Listen Sie alle Gruppen auf

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

groups . list ( limit : 10 , page : 1 , filter : { 'name' : 'My' } , sort : 'name' )

Erstellen Sie eine Gruppe

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

groups . create ( name : 'Group Name' )

Aktualisieren Sie eine Gruppe

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

groups . update ( group_id : 1234567 , name : 'My New Group' )

Eine Gruppe löschen

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

group_id = 1234567

groups . delete ( group_id )

Holen Sie sich Abonnenten, die einer Gruppe angehören

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

groups . get_subscribers ( group_id : 1234567 , page : 1 , limit : 10 , filter : { 'status' : 'active' } )

Abonnenten einer Gruppe zuordnen

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

groups . assign_subscriber ( subscriber : 111222 , group_id : 1234567 )

Zuweisung eines Abonnenten zu einer Gruppe aufheben

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

groups . unassign_subscriber ( subscriber : 111222 , group_id : 1234567 ) 

Segmente

Listen Sie alle Segmente auf

 require "mailerlite-ruby"

# Intialize the class
segments = MailerLite :: Segments . new

segments . list ( limit : 10 , page : 1 )

Aktualisieren Sie ein Segment

 require "mailerlite-ruby"

# Intialize the class
segments = MailerLite :: Segments . new

segments . update ( segment_id : 123456 , name : 'My New Segment Name' )

Löschen Sie ein Segment

 require "mailerlite-ruby"

# Intialize the class
segments = MailerLite :: Segments . new
segment_id = 123456

segments . delete ( segment_id )

Holen Sie sich Abonnenten, die zu einem Segment gehören

 require "mailerlite-ruby"

# Intialize the class
segments = MailerLite :: Segments . new

segments . get_subscribers ( segment_id : 123456 , limit : 10 , filter : { 'status' : 'active' } ) 

Felder

Listen Sie alle Felder auf

 require "mailerlite-ruby"

# Intialize the class
fields = MailerLite :: Fields . new

fields . get ( limit : 10 , page : 1 , sort : 'name' , filter : { 'keyword' : 'abc' , 'type' : 'text' } )

Erstellen Sie ein Feld

 require "mailerlite-ruby"

# Intialize the class
fields = MailerLite :: Fields . new

fields . create ( name : 'My Field' , type : 'text' )

Aktualisieren Sie ein Feld

 require "mailerlite-ruby"

# Intialize the class
fields = MailerLite :: Fields . new

fields . update ( field_id : 123345 , name : 'My New Field' )

Ein Feld löschen

 require "mailerlite-ruby"

# Intialize the class
fields = MailerLite :: Fields . new

field_id = 123456

fields . delete ( field_id ) 

Automatisierungen

Listen Sie alle Automatisierungen auf

 require "mailerlite-ruby"

# Intialize the class
automations = MailerLite :: Automations . new

automations . get ( limit : 10 , page : 1 , filter : { 'status' : true , 'name' : 'some name' , 'group' : 123456 } )

Holen Sie sich eine Automatisierung

 require "mailerlite-ruby"

# Intialize the class
automations = MailerLite :: Automations . new

automation_id = 123456

automations . fetch ( automation_id )

Erhalten Sie Abonnentenaktivitäten für eine Automatisierung

 require "mailerlite-ruby"

# Intialize the class
automations = MailerLite :: Automations . new

automations . get_subscriber_activity ( automation_id : 123456 , page : 1 , limit : 10 , filter : { 'status' : 'active' , 'date_from' : '2022-12-20' , 'date_to' : '2022-12-31' } ) 

Kampagnen

Listen Sie alle Kampagnen auf

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaigns . get ( limit : 10 , page : 1 , filter : { 'status' : 'ready' , 'type' : 'regular' } )

Holen Sie sich eine Kampagne

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaigns . fetch ( campaign_id : 123456 )

Erstellen Sie eine Kampagne

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaigns . create (
    name : "Test Campaign" ,
    language_id : 1 ,
    type : "regular" ,
    emails : [ {
        "subject" : "This is a test campaign" ,
        "from_name" : "Test Man" ,
        "from" : "[email protected]" ,
        "content" : "Hi there, this is a test campaign!"
    } ]
  )

Aktualisieren Sie eine Kampagne

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaigns . update (
  campaign_id : 1233455 , 
  name : "New Campaign Name" ,
  language_id : 2 ,
  emails : [ {
      "subject" : "This is a test campaign" ,
      "from_name" : "Test Man" ,
      "from" : "[email protected]" ,
      "content" : "Hi there, this is a test campaign!"
  } ]
  )

Planen Sie eine Kampagne

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaigns . schedule (
  campaign_id : 123456 ,
  delivery : "scheduled" ,
  schedule : {
      "date" : "2022-12-31" ,
      "hours" : "22" ,
      "minutes" : "00"
  }
)

Brechen Sie eine Kampagne ab

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaign_id = 123456

campaigns . cancel ( campaign_id )

Löschen Sie eine Kampagne

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaign_id = 123456

campaigns . delete ( campaign_id )

Erhalten Sie Abonnentenaktivitäten für eine Kampagne

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaign_id = 123456

campaigns . activity ( campaign_id ) 

Formulare

Listen Sie alle Formulare auf

 require "mailerlite-ruby"

# Intialize the class
forms = MailerLite :: Forms . new

forms . list ( limit : 10 , page : 1 , sort : 'name' , filter : { 'name' : 'form name' } )

Holen Sie sich ein Formular

 require "mailerlite-ruby"

# Intialize the class
forms = MailerLite :: Forms . new

form_id = 123456

forms . fetch ( form_id )

Aktualisieren Sie ein Formular

 require "mailerlite-ruby"

# Intialize the class
forms = MailerLite :: Forms . new

forms . update ( form_id : 123456 , name : 'My form Name' )

Ein Formular löschen

 require "mailerlite-ruby"

# Intialize the class
forms = MailerLite :: Forms . new

form_id = 123456

forms . delete ( form_id )

Gewinnen Sie Abonnenten, die sich für ein bestimmtes Formular angemeldet haben

 require "mailerlite-ruby"

# Intialize the class
forms = MailerLite :: Forms . new

forms . fetch_subscribers ( form_id : 123345 , page : 1 , limit : 10 , filter : { 'status' : 'active' } ) 

Stapeln

Erstellen Sie einen neuen Stapel

 require "mailerlite-ruby"

# Intialize the class
batch = MailerLite :: Batch . new

batch . request (
          requests : [
            { method : 'GET' , path : 'api/subscribers/list' } ,
            { method : 'GET' , path : 'api/campaigns/list' }
          ]
        ) 

Webhooks

Listen Sie alle Webhooks auf

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

webhooks . list ( )

Holen Sie sich einen Webhook

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

webhook_id = 123456

webhooks . get ( webhook_id )

Erstellen Sie einen Webhook

 require "mailerlite-ruby"

# Intialize the class
webhooks = MailerLite :: Webhooks . new

webhooks . create (
  events : [
    'subscriber.created' ,
    'subscriber.updated' ,
    'subscriber.unsubscribed'
  ] , 
  url : 'https://my-url.com' ,
  name : 'Webhook name'
)

Aktualisieren Sie einen Webhook

 require "mailerlite-ruby"

# Intialize the class
webhooks = MailerLite :: Webhooks . new

webhooks . update (
  webhook_id : 123456 , 
  events : [
    'subscriber.created' ,
    'subscriber.updated' ,
    'subscriber.unsubscribed'
  ] , 
  url : 'https://my-url.com' ,
  name : 'Webhook name' ,
  enabled : false
)

Löschen Sie einen Webhook

 require "mailerlite-ruby"

# Intialize the class
webhooks = MailerLite :: Webhooks . new

webhook_id = 123456

webhooks . delete ( webhook_id ) 

Zeitzonen

Holen Sie sich eine Liste der Zeitzonen

 require "mailerlite-ruby"

# Intialize the class
timezones = MailerLite :: Timezones . new

timezones . list ( ) 

Kampagnensprachen

Holen Sie sich eine Liste der Sprachen

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaigns . languages ( )

Testen

bundle i 
bundle exec rspec spec/ * rspec.rb

Um Tests auszuführen, müssten Sie Gems mit Bundle installieren und dann rspec über Bundle ausführen, um alle Tests auszuführen. Die Fixtures für den Test wurden mit vcr aufgezeichnet und sind im Verzeichnis ./fixtures verfügbar

Dokumente generieren

bundle i 
bundle exec yardoc ' lib/**/*.rb '

Dadurch werden HTML-Dokumente im Dokumentverzeichnis generiert, die in jedem Browser geöffnet werden können. Navigieren Sie zu index.html und öffnen Sie es.