loops_sdk 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aeb0e30d4d199706208e701f31340143aa7eae407b04f561b6bc14fa94f05346
-  data.tar.gz: f48c5dc9e2e5c69314656fc20f0e49402ad803b57a01cb00ad9079a837601ce8
+  metadata.gz: 65b81eba842a1765bb2bc99006cbcaab839e442b3ee90ea92076cef8fba8f942
+  data.tar.gz: 3e544adfb4c2ed0b1069fc1a455773397a27a8254d9e8fe75ebbc33be2dfa9e8
 SHA512:
-  metadata.gz: 526bec40bd9353f5c7c62adc9c049e70cee26eead9d81619ffe9933f5054aa4d416447a18b5d5aea966cf795784b3bf0446d132fa5c2963e16e1a975cffc5d8a
-  data.tar.gz: d178e957e3b3287ce91e2598d2e871fb91e4075e9d7dbd8a6002d5d4a11cb91b11e0355c031a38e71ab18c7093320ec4d8619792e4aa628411347f3d1d5b87a3
+  metadata.gz: 565a16854a58cf5510b8c6c189394f7b62bea1aa6b1448e41dbb1759268d6f25fe9f366190a29896b974a49648e2068478db8e4622c9db3bbb2a29ef25aba855
+  data.tar.gz: cd2b0f20ad57991723c3ca2bb68efe71b3759a0669a602be1c71583368fb7f3ae79dabbbb068ba9392918081edf9e465fcd4ee1f50c721ea5cbbcd2cc866d010

data/README.md

@@ -95,6 +95,7 @@ Each contact in Loops has a set of default properties. These will always be retu
 - `subscribed`
 - `userGroup`
 - `userId`
+- `optInStatus`
 
 ## Custom contact properties
 
@@ -107,6 +108,8 @@ You can use custom contact properties in API calls. Please make sure to [add cus
 - [Contacts.update()](#contactsupdate)
 - [Contacts.find()](#contactsfind)
 - [Contacts.delete()](#contactsdelete)
+- [Contacts.check_suppression()](#contactscheck_suppression)
+- [Contacts.remove_suppression()](#contactsremove_suppression)
 - [ContactProperties.create()](#contactpropertiescreate)
 - [ContactProperties.list()](#contactpropertieslist)
 - [MailingLists.list()](#mailinglistslist)
@@ -209,7 +212,7 @@ This method will return a success or error message:
 
 Update a contact. This method will create a contact if one doesn't already exist.
 
-Note: To update a contact's email address, the contact requires a `userId` value. Then you can make a request with their `userId` and an updated email address.
+Note: To update a contact's email address, the contact requires a `user_id` value. Then you can make a request with their `user_id` and an updated email address.
 
 [API Reference](https://loops.so/docs/api-reference/update-contact)
 
@@ -234,12 +237,10 @@ response = LoopsSdk::Contacts.update(
   properties: contact_properties
 )
 
-# Updating a contact's email address using userId
+# Updating a contact's email address using user_id
 response = LoopsSdk::Contacts.update(
   email: "newemail@gmail.com",
-  properties: {
-    userId: "1234",
-  }
+  user_id: "1234"
 )
 
 # Subscribing a contact to a mailing list
@@ -314,6 +315,7 @@ If no contact is found, an empty list will be returned.
     "mailingLists": {
       "cm06f5v0e45nf0ml5754o9cix": true
     },
+    "optInStatus": null,
     "favoriteColor": "Blue" /* Custom property */
   }
 ]
@@ -364,6 +366,104 @@ This method will return a success or error message:
 
 ---
 
+### Contacts.check_suppression()
+
+Check if a contact is suppressed.
+
+[API Reference](https://loops.so/docs/api-reference/check-contact-suppression)
+
+#### Parameters
+
+You must use one parameter in the request.
+
+| Name      | Type   | Required | Notes |
+| --------- | ------ | -------- | ----- |
+| `email`   | string | No       |       |
+| `user_id` | string | No       |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Contacts.check_suppression(email: "hello@gmail.com")
+
+response = LoopsSdk::Contacts.check_suppression(user_id: "12345")
+```
+
+#### Response
+
+This method will return the suppression status for a contact and the suppression removal quota.
+
+```json
+{
+  "contact": {
+    "id": "cll6b3i8901a9jx0oyktl2m4u",
+    "email": "hello@gmail.com",
+    "userId": "12345"
+  },
+  "isSuppressed": true,
+  "removalQuota": {
+    "limit": 100,
+    "remaining": 4
+  }
+}
+```
+
+```json
+{
+  "success": false,
+  "message": "An email or userId is required."
+}
+```
+
+---
+
+### Contacts.remove_suppression()
+
+Remove suppression for a contact.
+
+[API Reference](https://loops.so/docs/api-reference/remove-contact-suppression)
+
+#### Parameters
+
+You must use one parameter in the request.
+
+| Name      | Type   | Required | Notes |
+| --------- | ------ | -------- | ----- |
+| `email`   | string | No       |       |
+| `user_id` | string | No       |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Contacts.remove_suppression(email: "hello@gmail.com")
+
+response = LoopsSdk::Contacts.remove_suppression(user_id: "12345")
+```
+
+#### Response
+
+This method will return a success or error message:
+
+```json
+{
+  "success": true,
+  "message": "Email removed from suppression list.",
+  "removalQuota": {
+    "limit": 100,
+    "remaining": 4
+  }
+}
+```
+
+```json
+{
+  "success": false,
+  "message": "This contact is not suppressed."
+}
+```
+
+---
+
 ### ContactProperties.create()
 
 Create a new contact property.

data/lib/loops_sdk/contacts.rb

@@ -37,6 +37,22 @@ module LoopsSdk
         body = email ? { email: email } : { userId: user_id }
         make_request(method: :post, path: "v1/contacts/delete", body: body)
       end
+
+      def check_suppression(email: nil, user_id: nil)
+        raise ArgumentError, "Only one parameter is permitted." if email && user_id
+        raise ArgumentError, "You must provide an email or user_id value." if email.nil? && user_id.nil?
+
+        params = email ? { email: email } : { userId: user_id }
+        make_request(method: :get, path: "v1/contacts/suppression", params: params)
+      end
+
+      def remove_suppression(email: nil, user_id: nil)
+        raise ArgumentError, "Only one parameter is permitted." if email && user_id
+        raise ArgumentError, "You must provide an email or user_id value." if email.nil? && user_id.nil?
+
+        params = email ? { email: email } : { userId: user_id }
+        make_request(method: :delete, path: "v1/contacts/suppression", params: params)
+      end
     end
   end
 end

data/lib/loops_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LoopsSdk
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loops_sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Dan Rowden
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-22 00:00:00.000000000 Z
+date: 2026-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: The official Ruby SDK for Loops.