首頁>編程相關>其他源碼
下載

MailerLite Ruby SDK

入門

有關 MailerLite API 的更多信息，請訪問以下連結：

驗證

API 金鑰是一種實現機器對機器身份驗證的快速方法，除了初始設定之外，無需人工直接輸入。

有關如何獲取 API 密鑰的更多信息，請訪問以下鏈接

目錄

  • MailerLite Ruby SDK
    • 入門
      • 驗證
    • 目錄
    • 安裝
    • 用法
      • MailerLite客戶端
    • 訂閱者
      • 列出所有訂閱者
      • 建立訂閱者
      • 更新訂閱者
      • 獲取訂閱者
      • 刪除訂閱者
    • 團體
      • 列出所有組
      • 建立一個群組
      • 更新一個群組
      • 刪除群組
      • 獲取屬於某個群組的訂閱者
      • 將訂閱者分配到群組
      • 從群組中取消分配訂閱者
    • 段
      • 列出所有段落
      • 更新一個片段
      • 刪除一個段
      • 獲取屬於某個細分的訂閱者
    • 領域
      • 列出所有字段
      • 建立一個字段
      • 更新一個字段
      • 刪除字段
    • 自動化
      • 列出所有自動化
      • 獲得自動化
      • 自動化獲取訂閱者活動
    • 活動
      • 列出所有行銷活動
      • 開展活動
      • 建立活動
      • 更新活動
      • 安排活動
      • 取消活動
      • 刪除行銷活動
      • 獲取活動的訂閱者活動
    • 表格
      • 列出所有表格
      • 取得表格
      • 更新表格
      • 刪除表格
      • 取得註冊特定表單的訂閱者
    • 食材
      • 建立新批次
    • 網路鉤子
      • 列出所有網路鉤子
      • 取得網路鉤子
      • 創建網路鉤子
      • 更新網路鉤子
      • 刪除網路鉤子
    • 時區
      • 取得時區列表
    • 活動語言
      • 取得語言列表

設定

gem install mailerlite-ruby

您必須使用require "mailerlite-ruby"在 Ruby 檔案中初始化它。

用法

此 SDK 要求您擁有具有MAILERLITE_API_TOKEN env 變數的.env文件，或您的變數在系統範圍內啟用（對於 Docker/Kubernetes 有用）。 MAILERLITE_API_TOKEN的範例位於.env.example 。

訂閱者

列出所有訂閱者

 require "mailerlite-ruby"

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

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

建立訂閱者

 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' )

更新訂閱者

 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' )

獲取訂閱者

 require "mailerlite-ruby"

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

subscribers . get ( '[email protected]' )

刪除訂閱者

 require "mailerlite-ruby"

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

subscriber_id = 1234567890

subscribers . delete ( subscriber_id )

團體

列出所有組

 require "mailerlite-ruby"

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

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

建立一個群組

 require "mailerlite-ruby"

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

groups . create ( name : 'Group Name' )

更新一個群組

 require "mailerlite-ruby"

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

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

刪除群組

 require "mailerlite-ruby"

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

group_id = 1234567

groups . delete ( group_id )

獲取屬於某個群組的訂閱者

 require "mailerlite-ruby"

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

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

將訂閱者分配到群組

 require "mailerlite-ruby"

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

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

從群組中取消分配訂閱者

 require "mailerlite-ruby"

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

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

段

列出所有段落

 require "mailerlite-ruby"

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

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

更新一個片段

 require "mailerlite-ruby"

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

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

刪除一個段

 require "mailerlite-ruby"

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

segments . delete ( segment_id )

獲取屬於某個細分的訂閱者

 require "mailerlite-ruby"

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

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

領域

列出所有字段

 require "mailerlite-ruby"

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

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

建立一個字段

 require "mailerlite-ruby"

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

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

更新一個字段

 require "mailerlite-ruby"

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

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

刪除字段

 require "mailerlite-ruby"

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

field_id = 123456

fields . delete ( field_id )

自動化

列出所有自動化

 require "mailerlite-ruby"

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

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

獲得自動化

 require "mailerlite-ruby"

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

automation_id = 123456

automations . fetch ( automation_id )

自動化獲取訂閱者活動

 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' } )

活動

列出所有行銷活動

 require "mailerlite-ruby"

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

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

開展活動

 require "mailerlite-ruby"

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

campaigns . fetch ( campaign_id : 123456 )

建立活動

 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!"
    } ]
  )

更新活動

 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!"
  } ]
  )

安排活動

 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"
  }
)

取消活動

 require "mailerlite-ruby"

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

campaign_id = 123456

campaigns . cancel ( campaign_id )

刪除行銷活動

 require "mailerlite-ruby"

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

campaign_id = 123456

campaigns . delete ( campaign_id )

獲取活動的訂閱者活動

 require "mailerlite-ruby"

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

campaign_id = 123456

campaigns . activity ( campaign_id )

表格

列出所有表格

 require "mailerlite-ruby"

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

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

取得表格

 require "mailerlite-ruby"

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

form_id = 123456

forms . fetch ( form_id )

更新表格

 require "mailerlite-ruby"

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

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

刪除表格

 require "mailerlite-ruby"

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

form_id = 123456

forms . delete ( form_id )

取得註冊特定表單的訂閱者

 require "mailerlite-ruby"

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

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

食材

建立新批次

 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' }
          ]
        )

網路鉤子

列出所有網路鉤子

 require "mailerlite-ruby"

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

webhooks . list ( )

取得網路鉤子

 require "mailerlite-ruby"

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

webhook_id = 123456

webhooks . get ( webhook_id )

創建網路鉤子

 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'
)

更新網路鉤子

 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
)

刪除網路鉤子

 require "mailerlite-ruby"

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

webhook_id = 123456

webhooks . delete ( webhook_id )

時區

取得時區列表

 require "mailerlite-ruby"

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

timezones . list ( )

活動語言

取得語言列表

 require "mailerlite-ruby"

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

campaigns . languages ( )

測試

bundle i 
bundle exec rspec spec/ * rspec.rb

要執行測試，您需要使用bundle安裝gems，然後透過bundle執行rspec來執行所有測試。測試的裝置已使用 vcr 錄製，可在 ./fixtures 目錄中找到

產生文件

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

這將在 doc 目錄中產生 html 文檔，可以在任何瀏覽器中開啟該文檔。導航到index.html 並將其開啟。

展開
附加信息
相關應用
爲您推薦
相關資訊 全部