mailerlite-ruby 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d5f532e0ab219dc826f2a5cda903ab683f270525335e58d2b615a0d737421a7
-  data.tar.gz: f1dca6e4e42b67cc04c7be3145aef81eb742d2e5d128fa0613eb5e4c1a0bf74b
+  metadata.gz: ca13a21a170a5491fc4131d379f7f9618e7d75938956c04799f48daa030e6248
+  data.tar.gz: e490234cdda5ceeb25769b2d64cbdc4b3c132d8afcdae30f902ea276c64da628
 SHA512:
-  metadata.gz: 70fb10981c957b5b8eb6d3e476e5e3d08bd6d66a62bca007c0f66da9aacc5c85b0cb7c25ffbc4e4fe2c96839205a5a1774ff4cc7ecfaabe4e7558e65b8db2d07
-  data.tar.gz: 5489f2134e17d7197880e09762df17e7e737fb89b20a6a88d5b7cdc0dbbc61364de7820e96459b13034b386b987049eaa34402dc9f00a0900b020218caa58f8d
+  metadata.gz: 141af02c1a738eaadfb3e79fc7f4e83400a59b860013cbbbc0ad04efd26049e9a18007a1d93f0fdb5506e78027cd6c902065dd954ddb1c2f74a084b3f4b3e3a8
+  data.tar.gz: 216f1ae8efebc7a8978ea8807e455e343a0faaf6c2304befdb25324891ac249a295d8c5db9f9b9262ddf08f0cc56a5dc424be2595036afc975c38917f83c2c47

data/.github/workflows/publish_gem.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Release Gem
         if: contains(github.ref, 'refs/tags/v')

data/CHANGELOG.md

@@ -1 +1,16 @@
-## [Unreleased]
+## [1.0.4] - 2023-11-20
+- Update subscribers update
+- Add forget subscriber method
+
+## [1.0.3] - 2023-06-02
+- Documentation update
+- mailerlite.rb missing version
+
+## [1.0.2] - 2023-03-22
+- Gemfile.lock removed
+
+## [1.0.1] - 2023-03-22
+- Version update
+
+## [1.0.0] - 2023-03-06
+- Initial release

data/README.md

@@ -103,9 +103,9 @@ This SDK requires that you either have `.env` file with `MAILERLITE_API_TOKEN` e
 require "mailerlite-ruby"
 
 # Intialize the class
-subscribers = Mailerlite::Subscribers.new
+subscribers = MailerLite::Subscribers.new
 
-response = subscribers.list(filter: { status: 'active' })
+subscribers.fetch(filter: { status: 'active' })
 ```
 
 ### Create a subscriber
@@ -116,9 +116,9 @@ response = subscribers.list(filter: { status: 'active' })
 require "mailerlite-ruby"
 
 # Intialize the class
-subscribers = Mailerlite::Subscribers.new
+subscribers = MailerLite::Subscribers.new
 
-response = subscribers.create(email:'some@email.com', fields: {'name': 'John', 'last_name': 'Doe'}, ip_address:'1.2.3.4', optin_ip:'1.2.3.4')
+subscribers.create(email:'some@email.com', fields: {'name': 'John', 'last_name': 'Doe'}, ip_address:'1.2.3.4', optin_ip:'1.2.3.4')
 ```
 
 ### Update a subscriber
@@ -129,9 +129,9 @@ response = subscribers.create(email:'some@email.com', fields: {'name': 'John', '
 require "mailerlite-ruby"
 
 # Intialize the class
-subscribers = Mailerlite::Subscribers.new
+subscribers = MailerLite::Subscribers.new
 
-response = subscribers.update(email:'some@email.com', fields: {'name': 'John', 'last_name': 'Doe'}, ip_address:'1.2.3.4', optin_ip:'1.2.3.4')
+subscribers.update(email:'some@email.com', fields: {'name': 'John', 'last_name': 'Doe'}, ip_address:'1.2.3.4', optin_ip:'1.2.3.4')
 ```
 
 ### Get a subscriber
@@ -142,9 +142,9 @@ response = subscribers.update(email:'some@email.com', fields: {'name': 'John', '
 require "mailerlite-ruby"
 
 # Intialize the class
-subscribers = Mailerlite::Subscribers.new
+subscribers = MailerLite::Subscribers.new
 
-response = subscribers.get('some@email.com')
+subscribers.get('some@email.com')
 ```
 
 ### Delete a subscriber
@@ -155,11 +155,11 @@ response = subscribers.get('some@email.com')
 require "mailerlite-ruby"
 
 # Intialize the class
-subscribers = Mailerlite::Subscribers.new
+subscribers = MailerLite::Subscribers.new
 
 subscriber_id = 1234567890
 
-response = subscribers.delete(subscriber_id)
+subscribers.delete(subscriber_id)
 ```
 
 ## Groups
@@ -174,9 +174,9 @@ response = subscribers.delete(subscriber_id)
 require "mailerlite-ruby"
 
 # Intialize the class
-groups = Mailerlite::Groups.new
+groups = MailerLite::Groups.new
 
-response = groups.list(limit:10, page:1, filter:{'name': 'My'}, sort:'name')
+groups.list(limit:10, page:1, filter:{'name': 'My'}, sort:'name')
 ```
 
 ### Create a group
@@ -187,9 +187,9 @@ response = groups.list(limit:10, page:1, filter:{'name': 'My'}, sort:'name')
 require "mailerlite-ruby"
 
 # Intialize the class
-groups = Mailerlite::Groups.new
+groups = MailerLite::Groups.new
 
-response = groups.create(name:'Group Name')
+groups.create(name:'Group Name')
 ```
 
 ### Update a group
@@ -200,9 +200,9 @@ response = groups.create(name:'Group Name')
 require "mailerlite-ruby"
 
 # Intialize the class
-groups = Mailerlite::Groups.new
+groups = MailerLite::Groups.new
 
-response = groups.update(group_id:1234567, name:'My New Group')
+groups.update(group_id:1234567, name:'My New Group')
 ```
 
 ### Delete a group
@@ -213,11 +213,11 @@ response = groups.update(group_id:1234567, name:'My New Group')
 require "mailerlite-ruby"
 
 # Intialize the class
-groups = Mailerlite::Groups.new
+groups = MailerLite::Groups.new
 
 group_id = 1234567
 
-response = groups.delete(group_id)
+groups.delete(group_id)
 ```
 
 ### Get subscribers belonging to a group
@@ -228,9 +228,9 @@ response = groups.delete(group_id)
 require "mailerlite-ruby"
 
 # Intialize the class
-groups = Mailerlite::Groups.new
+groups = MailerLite::Groups.new
 
-response = groups.get_subscribers(group_id:1234567, page:1, limit:10, filter:{'status': 'active'})
+groups.get_subscribers(group_id:1234567, page:1, limit:10, filter:{'status': 'active'})
 ```
 
 ### Assign subscriber to a group
@@ -241,9 +241,9 @@ response = groups.get_subscribers(group_id:1234567, page:1, limit:10, filter:{'s
 require "mailerlite-ruby"
 
 # Intialize the class
-groups = Mailerlite::Groups.new
+groups = MailerLite::Groups.new
 
-response = subscribers.assign_subscriber(subscriber_id:111222, group_id:1234567)
+groups.assign_subscriber(subscriber:111222, group_id:1234567)
 ```
 
 ### Unassign subscriber from a group
@@ -254,9 +254,9 @@ response = subscribers.assign_subscriber(subscriber_id:111222, group_id:1234567)
 require "mailerlite-ruby"
 
 # Intialize the class
-groups = Mailerlite::Groups.new
+groups = MailerLite::Groups.new
 
-response = subscribers.unassign_subscriber(subscriber_id:111222, group_id:1234567)
+groups.unassign_subscriber(subscriber:111222, group_id:1234567)
 ```
 
 ## Segments
@@ -271,9 +271,9 @@ response = subscribers.unassign_subscriber(subscriber_id:111222, group_id:123456
 require "mailerlite-ruby"
 
 # Intialize the class
-segments = Mailerlite::Segments.new
+segments = MailerLite::Segments.new
 
-response = segments.list(limit:10, page:1)
+segments.list(limit:10, page:1)
 ```
 
 ### Update a segment
@@ -284,9 +284,9 @@ response = segments.list(limit:10, page:1)
 require "mailerlite-ruby"
 
 # Intialize the class
-segments = Mailerlite::Segments.new
+segments = MailerLite::Segments.new
 
-response = segments.update(segment_id: 123456, name:'My New Segment Name')
+segments.update(segment_id: 123456, name:'My New Segment Name')
 ```
 
 ### Delete a segment
@@ -297,10 +297,10 @@ response = segments.update(segment_id: 123456, name:'My New Segment Name')
 require "mailerlite-ruby"
 
 # Intialize the class
-segments = Mailerlite::Segments.new
+segments = MailerLite::Segments.new
 segment_id = 123456
 
-response = segments.delete(segment_id)
+segments.delete(segment_id)
 ```
 
 ### Get subscribers belonging to a segment
@@ -311,9 +311,9 @@ response = segments.delete(segment_id)
 require "mailerlite-ruby"
 
 # Intialize the class
-segments = Mailerlite::Segments.new
+segments = MailerLite::Segments.new
 
-response = segments.get_subscribers(segment_id:123456, limit:10, filter:{'status': 'active'})
+segments.get_subscribers(segment_id:123456, limit:10, filter:{'status': 'active'})
 ```
 
 ## Fields
@@ -328,9 +328,9 @@ response = segments.get_subscribers(segment_id:123456, limit:10, filter:{'status
 require "mailerlite-ruby"
 
 # Intialize the class
-fields = Mailerlite::Fields.new
+fields = MailerLite::Fields.new
 
-response = fields.list(limit:10, page:1, sort:'name', filter:{'keyword': 'abc', 'type': 'text'})
+fields.get(limit:10, page:1, sort:'name', filter:{'keyword': 'abc', 'type': 'text'})
 ```
 
 ### Create a field
@@ -341,9 +341,9 @@ response = fields.list(limit:10, page:1, sort:'name', filter:{'keyword': 'abc',
 require "mailerlite-ruby"
 
 # Intialize the class
-fields = Mailerlite::Fields.new
+fields = MailerLite::Fields.new
 
-response = fields.create(name:'My Field', type:'text')
+fields.create(name:'My Field', type:'text')
 ```
 
 ### Update a field
@@ -354,9 +354,9 @@ response = fields.create(name:'My Field', type:'text')
 require "mailerlite-ruby"
 
 # Intialize the class
-fields = Mailerlite::Fields.new
+fields = MailerLite::Fields.new
 
-response = fields.update(field_id:123345, name:'My New Field')
+fields.update(field_id:123345, name:'My New Field')
 ```
 
 ### Delete a field
@@ -367,11 +367,11 @@ response = fields.update(field_id:123345, name:'My New Field')
 require "mailerlite-ruby"
 
 # Intialize the class
-fields = Mailerlite::Fields.new
+fields = MailerLite::Fields.new
 
 field_id = 123456
 
-response = fields.delete(field_id)
+fields.delete(field_id)
 ```
 
 ## Automations
@@ -386,9 +386,9 @@ response = fields.delete(field_id)
 require "mailerlite-ruby"
 
 # Intialize the class
-automations = Mailerlite::Automations.new
+automations = MailerLite::Automations.new
 
-response = automations.list(limit:10, page:1, filter:{'status': true, 'name': 'some name', 'group': 123456})
+automations.get(limit:10, page:1, filter:{'status': true, 'name': 'some name', 'group': 123456})
 ```
 
 ### Get an automation
@@ -399,11 +399,11 @@ response = automations.list(limit:10, page:1, filter:{'status': true, 'name': 's
 require "mailerlite-ruby"
 
 # Intialize the class
-automations = Mailerlite::Automations.new
+automations = MailerLite::Automations.new
 
 automation_id = 123456
 
-response = automations.get(automation_id)
+automations.fetch(automation_id)
 ```
 
 ### Get subscribers activity for an automation
@@ -414,9 +414,9 @@ response = automations.get(automation_id)
 require "mailerlite-ruby"
 
 # Intialize the class
-automations = Mailerlite::Automations.new
+automations = MailerLite::Automations.new
 
-response = automations.activity(automation_id:123456, page:1, limit:10, filter:{'status': 'active', 'date_from': '2022-12-20', 'date_to': '2022-12-31'})
+automations.get_subscriber_activity(automation_id:123456, page:1, limit:10, filter:{'status': 'active', 'date_from': '2022-12-20', 'date_to': '2022-12-31'})
 ```
 
 ## Campaigns
@@ -431,9 +431,9 @@ response = automations.activity(automation_id:123456, page:1, limit:10, filter:{
 require "mailerlite-ruby"
 
 # Intialize the class
-campaigns = Mailerlite::Campaigns.new
+campaigns = MailerLite::Campaigns.new
 
-response = campaigns.list(limit:10, page:1, filter:{'status': 'ready', 'type': 'regular'})
+campaigns.get(limit:10, page:1, filter:{'status': 'ready', 'type': 'regular'})
 ```
 
 ### Get a campaign
@@ -444,9 +444,9 @@ response = campaigns.list(limit:10, page:1, filter:{'status': 'ready', 'type': '
 require "mailerlite-ruby"
 
 # Intialize the class
-campaigns = Mailerlite::Campaigns.new
+campaigns = MailerLite::Campaigns.new
 
-response = campaigns.get(campaign_id:123456)
+campaigns.fetch(campaign_id:123456)
 ```
 
 ### Create a campaign
@@ -457,9 +457,9 @@ response = campaigns.get(campaign_id:123456)
 require "mailerlite-ruby"
 
 # Intialize the class
-campaigns = Mailerlite::Campaigns.new
+campaigns = MailerLite::Campaigns.new
 
-response = campaigns.create(
+campaigns.create(
     name: "Test Campaign",
     language_id: 1,
     type: "regular",
@@ -480,9 +480,9 @@ response = campaigns.create(
 require "mailerlite-ruby"
 
 # Intialize the class
-campaigns = Mailerlite::Campaigns.new
+campaigns = MailerLite::Campaigns.new
 
-response = campaigns.update(
+campaigns.update(
   campaign_id: 1233455, 
   name: "New Campaign Name",
   language_id: 2,
@@ -503,9 +503,9 @@ response = campaigns.update(
 require "mailerlite-ruby"
 
 # Intialize the class
-campaigns = Mailerlite::Campaigns.new
+campaigns = MailerLite::Campaigns.new
 
-response = campaigns.schedule(
+campaigns.schedule(
   campaign_id: 123456,
   delivery: "scheduled",
   schedule: {
@@ -524,11 +524,11 @@ response = campaigns.schedule(
 require "mailerlite-ruby"
 
 # Intialize the class
-campaigns = Mailerlite::Campaigns.new
+campaigns = MailerLite::Campaigns.new
 
 campaign_id = 123456
 
-response = campaigns.cancel(campaign_id)
+campaigns.cancel(campaign_id)
 ```
 
 ### Delete a campaign
@@ -539,11 +539,11 @@ response = campaigns.cancel(campaign_id)
 require "mailerlite-ruby"
 
 # Intialize the class
-campaigns = Mailerlite::Campaigns.new
+campaigns = MailerLite::Campaigns.new
 
 campaign_id = 123456
 
-response = campaigns.delete(campaign_id)
+campaigns.delete(campaign_id)
 ```
 
 ### Get subscribers activity for a campaign
@@ -554,11 +554,11 @@ response = campaigns.delete(campaign_id)
 require "mailerlite-ruby"
 
 # Intialize the class
-campaigns = Mailerlite::Campaigns.new
+campaigns = MailerLite::Campaigns.new
 
 campaign_id = 123456
 
-response = campaigns.activity(campaign_id)
+campaigns.activity(campaign_id)
 ```
 
 ## Forms
@@ -573,9 +573,9 @@ response = campaigns.activity(campaign_id)
 require "mailerlite-ruby"
 
 # Intialize the class
-forms = Mailerlite::Forms.new
+forms = MailerLite::Forms.new
 
-response = forms.list(limit:10, page:1, sort:'name', filter:{'name': 'form name'})
+forms.list(limit:10, page:1, sort:'name', filter:{'name': 'form name'})
 ```
 
 ### Get a form
@@ -586,11 +586,11 @@ response = forms.list(limit:10, page:1, sort:'name', filter:{'name': 'form name'
 require "mailerlite-ruby"
 
 # Intialize the class
-forms = Mailerlite::Forms.new
+forms = MailerLite::Forms.new
 
 form_id = 123456
 
-response = forms.get(form_id)
+forms.fetch(form_id)
 ```
 
 ### Update a form
@@ -601,9 +601,9 @@ response = forms.get(form_id)
 require "mailerlite-ruby"
 
 # Intialize the class
-forms = Mailerlite::Forms.new
+forms = MailerLite::Forms.new
 
-response = forms.update(form_id:123456, name: 'My form Name')
+forms.update(form_id:123456, name: 'My form Name')
 ```
 
 ### Delete a form
@@ -614,11 +614,11 @@ response = forms.update(form_id:123456, name: 'My form Name')
 require "mailerlite-ruby"
 
 # Intialize the class
-forms = Mailerlite::Forms.new
+forms = MailerLite::Forms.new
 
 form_id = 123456
 
-response = forms.delete(form_id)
+forms.delete(form_id)
 ```
 
 ### Get subscribers who signed up to a specific form
@@ -629,9 +629,9 @@ response = forms.delete(form_id)
 require "mailerlite-ruby"
 
 # Intialize the class
-forms = Mailerlite::Forms.new
+forms = MailerLite::Forms.new
 
-response = forms.get_subscribers(form_id:123345, page:1, limit:10, filter:{'status': 'active'})
+forms.fetch_subscribers(form_id:123345, page:1, limit:10, filter:{'status': 'active'})
 ```
 
 ## Batching
@@ -646,9 +646,9 @@ response = forms.get_subscribers(form_id:123345, page:1, limit:10, filter:{'stat
 require "mailerlite-ruby"
 
 # Intialize the class
-batch = Mailerlite::Batch.new
+batch = MailerLite::Batch.new
 
-response = batch.request(
+batch.request(
           requests: [
             { method: 'GET', path: 'api/subscribers/list' },
             { method: 'GET', path: 'api/campaigns/list' }
@@ -668,9 +668,9 @@ response = batch.request(
 require "mailerlite-ruby"
 
 # Intialize the class
-subscribers = Mailerlite::Subscribers.new
+subscribers = MailerLite::Subscribers.new
 
-response = webhooks.list()
+webhooks.list()
 ```
 
 ### Get a webhook
@@ -681,11 +681,11 @@ response = webhooks.list()
 require "mailerlite-ruby"
 
 # Intialize the class
-subscribers = Mailerlite::Subscribers.new
+subscribers = MailerLite::Subscribers.new
 
 webhook_id = 123456
 
-response = webhooks.get(webhook_id)
+webhooks.get(webhook_id)
 ```
 
 ### Create a webhook
@@ -696,9 +696,9 @@ response = webhooks.get(webhook_id)
 require "mailerlite-ruby"
 
 # Intialize the class
-webhooks = Mailerlite::Webhooks.new
+webhooks = MailerLite::Webhooks.new
 
-response = webhooks.create(
+webhooks.create(
   events:[
     'subscriber.created',
     'subscriber.updated',
@@ -717,9 +717,9 @@ response = webhooks.create(
 require "mailerlite-ruby"
 
 # Intialize the class
-webhooks = Mailerlite::Webhooks.new
+webhooks = MailerLite::Webhooks.new
 
-response = webhooks.update(
+webhooks.update(
   webhook_id: 123456, 
   events:[
     'subscriber.created',
@@ -740,11 +740,11 @@ response = webhooks.update(
 require "mailerlite-ruby"
 
 # Intialize the class
-webhooks = Mailerlite::Webhooks.new
+webhooks = MailerLite::Webhooks.new
 
 webhook_id = 123456
 
-response = webhooks.delete(webhook_id)
+webhooks.delete(webhook_id)
 ```
 
 ## Timezones
@@ -759,9 +759,9 @@ response = webhooks.delete(webhook_id)
 require "mailerlite-ruby"
 
 # Intialize the class
-timezones = Mailerlite::Timezones.new
+timezones = MailerLite::Timezones.new
 
-response = timezones.list()
+timezones.list()
 ```
 
 ## Campaign languages
@@ -776,9 +776,9 @@ response = timezones.list()
 require "mailerlite-ruby"
 
 # Intialize the class
-campaigns = Mailerlite::Campaigns.new
+campaigns = MailerLite::Campaigns.new
 
-response = campaigns.languages()
+campaigns.languages()
 ```
 
 # Testing
@@ -798,4 +798,4 @@ bundle i
 bundle exec yardoc 'lib/**/*.rb'
 ```
 
-This will generate html docs in the doc directory which can be opened up in any browser. Navigate to index.html and open it up.
+This will generate html docs in the doc directory which can be opened up in any browser. Navigate to index.html and open it up.

data/fixtures/subscribers/forget.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://connect.mailerlite.com/api/subscribers/98121614828242796/forget
+    body:
+      encoding: ASCII-8BIT
+      string: ''
+    headers:
+      Authorization:
+      - "<AUTH>"
+      User-Agent:
+      - MailerLite-client-ruby/1.0.3
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Connection:
+      - close
+      Host:
+      - connect.mailerlite.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 01 Sep 2023 13:48:18 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Cache-Control:
+      - no-cache, private
+      X-Locale:
+      - en
+      X-Ratelimit-Limit:
+      - '120'
+      X-Ratelimit-Remaining:
+      - '117'
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains
+      Via:
+      - Ingress
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 7ffdf84ede2b1096-HKG
+    body:
+      encoding: UTF-8
+      string: '{"data":{"id":"98121614828242796","email":"test@mail.com","status":"active","source":"api","sent":0,"opens_count":0,"clicks_count":0,"open_rate":0,"click_rate":0,"ip_address":null,"subscribed_at":"2023-09-01
+        13:47:44","unsubscribed_at":null,"created_at":"2023-09-01 13:47:43","updated_at":"2023-09-01
+        13:48:17","deleted_at":"2023-09-01 13:48:17","forget_at":"2023-10-01 13:48:17","fields":{"name":null,"last_name":null,"company":null,"country":null,"city":null,"phone":null,"state":null,"z_i_p":null,"github_handle":null},"groups":[],"location":null,"opted_in_at":null,"optin_ip":null},"message":"Subscriber
+        data will be completely deleted and forgotten within 30 days."}'
+  recorded_at: Fri, 01 Sep 2023 13:48:18 GMT
+recorded_with: VCR 6.2.0

data/fixtures/subscribers/update.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://connect.mailerlite.com/api/subscribers/98112484192290662
+    body:
+      encoding: ASCII-8BIT
+      string: '{"email":"updated@email.com"}'
+    headers:
+      Authorization:
+      - "<AUTH>"
+      User-Agent:
+      - MailerLite-client-ruby/1.0.3
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Connection:
+      - close
+      Host:
+      - connect.mailerlite.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 01 Sep 2023 11:24:29 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Cache-Control:
+      - no-cache, private
+      X-Locale:
+      - en
+      X-Ratelimit-Limit:
+      - '120'
+      X-Ratelimit-Remaining:
+      - '119'
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains
+      Via:
+      - Ingress
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 7ffd25a40bf22118-HKG
+    body:
+      encoding: UTF-8
+      string: '{"data":{"id":"98112484192290662","email":"updated@email.com","status":"active","source":"api","sent":0,"opens_count":0,"clicks_count":0,"open_rate":0,"click_rate":0,"ip_address":null,"subscribed_at":"2023-09-01
+        11:22:36","unsubscribed_at":null,"created_at":"2023-09-01 11:22:36","updated_at":"2023-09-01
+        11:24:29","fields":{"name":null,"last_name":null,"company":null,"country":null,"city":null,"phone":null,"state":null,"z_i_p":null,"github_handle":null},"groups":[],"location":null,"opted_in_at":null,"optin_ip":null}}'
+  recorded_at: Fri, 01 Sep 2023 11:24:29 GMT
+recorded_with: VCR 6.2.0

data/lib/mailerlite/subscribers/subscribers.rb

@@ -55,8 +55,9 @@ module MailerLite
       client.http.post("#{API_URL}/subscribers", json: params.compact)
     end
 
-    # Creates a new subscriber with the specified details.
+    # Updates an existing subscriber with the specified details.
     #
+    # @param subscriber_id [String] the ID of the subscriber to update
     # @param email [String] the email address of the new subscriber
     # @param fields [Hash] a hash of custom fields and their values for the subscriber
     # @param groups [Array] an array of group IDs to add the subscriber to
@@ -67,9 +68,10 @@ module MailerLite
     # @param optin_ip [String] the IP address of the subscriber when they confirmed their subscription
     # @param unsubscribed_at [DateTime] the date and time when the subscriber was unsubscribed
     # @return [HTTP::Response] the response from the API
-    def update(email:, fields: nil, groups: nil, status: nil, subscribed_at: nil, ip_address: nil, opted_in_at: nil, optin_ip: nil, unsubscribed_at: nil)
-      params = { 'email' => email }
+    def update(subscriber_id, email: nil, fields: nil, groups: nil, status: nil, subscribed_at: nil, ip_address: nil, opted_in_at: nil, optin_ip: nil, unsubscribed_at: nil)
+      params = {}
 
+      params['email'] = email if email
       params['fields'] = fields if fields
       params['groups'] = groups if groups
       params['status'] = status if status
@@ -79,7 +81,7 @@ module MailerLite
       params['optin_ip'] = optin_ip if optin_ip
       params['unsubscribed_at'] = unsubscribed_at if unsubscribed_at
 
-      client.http.post("#{API_URL}/subscribers", json: params.compact)
+      client.http.put("#{API_URL}/subscribers/#{subscriber_id}", json: params.compact)
     end
 
     # Returns the details of the specified subscribers
@@ -112,5 +114,13 @@ module MailerLite
     def delete(subscriber_id)
       client.http.delete("#{API_URL}/subscribers/#{subscriber_id}")
     end
+
+    # Forgets the specified subscriber.
+    #
+    # @param subscriber_id [String] the ID of the subscriber to forget
+    # @return [HTTP::Response] the response from the API
+    def forget(subscriber_id)
+      client.http.post("#{API_URL}/subscribers/#{subscriber_id}/forget")
+    end
   end
 end

data/lib/mailerlite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MailerLite
-  VERSION = '1.0.2'
+  VERSION = '1.0.4'
 end

data/lib/mailerlite.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'mailerlite/client'
+require_relative 'mailerlite/version'
 require_relative 'mailerlite/subscribers/subscribers'
 require_relative 'mailerlite/campaigns/campaigns'
 require_relative 'mailerlite/forms/forms'

data/mailerlite-ruby.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.4.7'
+  spec.add_development_dependency 'bundler', '~> 2.4.1'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 1.7'
   spec.add_dependency 'dotenv', '~> 2.7'

data/spec/subscribers_rspec.rb

@@ -72,6 +72,18 @@ RSpec.describe MailerLite::Subscribers do
     end
   end
 
+  describe '#update' do
+    # Use VCR to record and replay the HTTP request
+    it 'updates a subscriber' do
+      VCR.use_cassette('subscribers/update') do
+        response = subscribers.update(98_112_484_192_290_662, email: 'updated@email.com')
+        body = JSON.parse(response.body)
+        expect(response.status).to eq 200
+        expect(body['data']['email']).to eq 'updated@email.com'
+      end
+    end
+  end
+
   describe '#delete' do
     # Use VCR to record and replay the HTTP request
     it 'deletes a subscriber' do
@@ -81,4 +93,16 @@ RSpec.describe MailerLite::Subscribers do
       end
     end
   end
+
+  describe '#forget' do
+    # Use VCR to record and replay the HTTP request
+    it 'forgets a subscriber' do
+      VCR.use_cassette('subscribers/forget') do
+        response = subscribers.forget(98_121_614_828_242_796)
+        body = JSON.parse(response.body)
+        expect(response.status).to eq 200
+        expect(body['message']).to eq 'Subscriber data will be completely deleted and forgotten within 30 days.'
+      end
+    end
+  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mailerlite-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Nikola Milojević
 - Ahsan Gondal
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.7
+        version: 2.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.7
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -238,7 +238,9 @@ files:
 - fixtures/subscribers/delete.yml
 - fixtures/subscribers/fetch.yml
 - fixtures/subscribers/fetch_count.yml
+- fixtures/subscribers/forget.yml
 - fixtures/subscribers/get.yml
+- fixtures/subscribers/update.yml
 - fixtures/timezones/list.yml
 - fixtures/webhooks/create.yml
 - fixtures/webhooks/delete.yml
@@ -281,7 +283,7 @@ metadata:
   source_code_uri: https://github.com/mailerlite/mailerlite-ruby
   changelog_uri: https://github.com/mailerlite/mailerlite-ruby/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -296,8 +298,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: MailerLite's official Ruby SDK
 test_files: []