loops_sdk 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aeb0e30d4d199706208e701f31340143aa7eae407b04f561b6bc14fa94f05346
-  data.tar.gz: f48c5dc9e2e5c69314656fc20f0e49402ad803b57a01cb00ad9079a837601ce8
+  metadata.gz: b5f428ed70457f4a5545ae8db80c8c1184053851702186b93e4181de19826bac
+  data.tar.gz: 273c41adcdfc013281b38e6e7fbf9d1d5f754e3e0e34979b660284689c26d9a6
 SHA512:
-  metadata.gz: 526bec40bd9353f5c7c62adc9c049e70cee26eead9d81619ffe9933f5054aa4d416447a18b5d5aea966cf795784b3bf0446d132fa5c2963e16e1a975cffc5d8a
-  data.tar.gz: d178e957e3b3287ce91e2598d2e871fb91e4075e9d7dbd8a6002d5d4a11cb91b11e0355c031a38e71ab18c7093320ec4d8619792e4aa628411347f3d1d5b87a3
+  metadata.gz: cf08a088e5a500fe82ff04a7e432c4bae832a9414ba693c69f9d13ba381a85dcad63e554b09449f3c2f79c1e150a7309f5071b98c4a5a022820f044e93e8216b
+  data.tar.gz: fa693592b67828b4c1a351a938f2c16bc058f29830f442cab2d009383b9e07a108df1c1fb836c54066c067d0bce222a26f975994b16d1d3348a91780fc783fd5

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,12 +108,25 @@ 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)
 - [Events.send()](#eventssend)
 - [Transactional.send()](#transactionalsend)
 - [Transactional.list()](#transactionallist)
+- [DedicatedSendingIps.list()](#dedicatedsendingipslist)
+- [Themes.list()](#themeslist)
+- [Themes.get()](#themesget)
+- [Components.list()](#componentslist)
+- [Components.get()](#componentsget)
+- [Campaigns.list()](#campaignslist)
+- [Campaigns.create()](#campaignscreate)
+- [Campaigns.get()](#campaignsget)
+- [Campaigns.update()](#campaignsupdate)
+- [EmailMessages.get()](#emailmessagesget)
+- [EmailMessages.update()](#emailmessagesupdate)
 
 ---
 
@@ -209,7 +223,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 +248,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 +326,7 @@ If no contact is found, an empty list will be returned.
     "mailingLists": {
       "cm06f5v0e45nf0ml5754o9cix": true
     },
+    "optInStatus": null,
     "favoriteColor": "Blue" /* Custom property */
   }
 ]
@@ -364,6 +377,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.
@@ -770,6 +881,256 @@ response = LoopsSdk::Transactional.list(perPage: 15)
 
 ---
 
+### DedicatedSendingIps.list()
+
+Get Loops' dedicated sending IP addresses.
+
+[API Reference](https://loops.so/docs/api-reference/list-dedicated-sending-ips)
+
+#### Parameters
+
+None
+
+#### Example
+
+```ruby
+response = LoopsSdk::DedicatedSendingIps.list
+```
+
+#### Response
+
+Returns an array of IP address strings.
+
+```json
+["1.2.3.4", "5.6.7.8"]
+```
+
+---
+
+### Themes.list()
+
+List email themes.
+
+[API Reference](https://loops.so/docs/api-reference/list-themes)
+
+#### Parameters
+
+| Name      | Type    | Required | Notes                                                                                                                         |
+| --------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `perPage` | integer | No       | How many results to return per page. Must be between 10 and 50. Defaults to 20 if omitted.                                    |
+| `cursor`  | string  | No       | A cursor, to return a specific page of results. Cursors can be found from the `pagination.nextCursor` value in each response. |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Themes.list
+
+response = LoopsSdk::Themes.list(perPage: 15, cursor: "cursor_value")
+```
+
+---
+
+### Themes.get()
+
+Get a single theme by ID.
+
+[API Reference](https://loops.so/docs/api-reference/get-theme)
+
+#### Parameters
+
+| Name       | Type   | Required | Notes |
+| ---------- | ------ | -------- | ----- |
+| `theme_id` | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Themes.get(theme_id: "theme_123")
+```
+
+---
+
+### Components.list()
+
+List email components.
+
+[API Reference](https://loops.so/docs/api-reference/list-components)
+
+#### Parameters
+
+| Name      | Type    | Required | Notes                                                                                                                         |
+| --------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `perPage` | integer | No       | How many results to return per page. Must be between 10 and 50. Defaults to 20 if omitted.                                    |
+| `cursor`  | string  | No       | A cursor, to return a specific page of results. Cursors can be found from the `pagination.nextCursor` value in each response. |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Components.list
+```
+
+---
+
+### Components.get()
+
+Get a single component by ID.
+
+[API Reference](https://loops.so/docs/api-reference/get-component)
+
+#### Parameters
+
+| Name           | Type   | Required | Notes |
+| -------------- | ------ | -------- | ----- |
+| `component_id` | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Components.get(component_id: "component_123")
+```
+
+---
+
+### Campaigns.list()
+
+List campaigns.
+
+[API Reference](https://loops.so/docs/api-reference/list-campaigns)
+
+#### Parameters
+
+| Name      | Type    | Required | Notes                                                                                                                         |
+| --------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `perPage` | integer | No       | How many results to return per page. Must be between 10 and 50. Defaults to 20 if omitted.                                    |
+| `cursor`  | string  | No       | A cursor, to return a specific page of results. Cursors can be found from the `pagination.nextCursor` value in each response. |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Campaigns.list
+```
+
+---
+
+### Campaigns.create()
+
+Create a draft campaign. An empty email message is created automatically.
+
+[API Reference](https://loops.so/docs/api-reference/create-campaign)
+
+#### Parameters
+
+| Name   | Type   | Required | Notes |
+| ------ | ------ | -------- | ----- |
+| `name` | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Campaigns.create(name: "Spring announcement")
+```
+
+---
+
+### Campaigns.get()
+
+Get a single campaign by ID.
+
+[API Reference](https://loops.so/docs/api-reference/get-campaign)
+
+#### Parameters
+
+| Name          | Type   | Required | Notes |
+| ------------- | ------ | -------- | ----- |
+| `campaign_id` | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Campaigns.get(campaign_id: "campaign_123")
+```
+
+---
+
+### Campaigns.update()
+
+Update a draft campaign's name.
+
+[API Reference](https://loops.so/docs/api-reference/update-campaign)
+
+#### Parameters
+
+| Name          | Type   | Required | Notes |
+| ------------- | ------ | -------- | ----- |
+| `campaign_id` | string | Yes      |       |
+| `name`        | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Campaigns.update(
+  campaign_id: "campaign_123",
+  name: "Updated campaign name"
+)
+```
+
+---
+
+### EmailMessages.get()
+
+Get an email message, including its LMX content.
+
+[API Reference](https://loops.so/docs/api-reference/get-email-message)
+
+#### Parameters
+
+| Name                | Type   | Required | Notes |
+| ------------------- | ------ | -------- | ----- |
+| `email_message_id`  | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::EmailMessages.get(email_message_id: "message_123")
+```
+
+---
+
+### EmailMessages.update()
+
+Update an email message for a draft campaign.
+
+[API Reference](https://loops.so/docs/api-reference/update-email-message)
+
+#### Parameters
+
+| Name                     | Type   | Required | Notes                                                                                                      |
+| ------------------------ | ------ | -------- | ---------------------------------------------------------------------------------------------------------- |
+| `email_message_id`       | string | Yes      |                                                                                                            |
+| `expected_revision_id`   | string | No       | The `contentRevisionId` from your last fetch. Required to avoid stale concurrent updates.                  |
+| `subject`                | string | No       |                                                                                                            |
+| `preview_text`           | string | No       |                                                                                                            |
+| `from_name`              | string | No       |                                                                                                            |
+| `from_email`             | string | No       | Sender username without `@` or domain. The team's sending domain is appended automatically.                |
+| `reply_to_email`         | string | No       | Must be empty or a valid email address.                                                                    |
+| `lmx`                    | string | No       | Email body serialized as LMX. Styles must be embedded in the LMX `<Style />` tag.                          |
+
+#### Example
+
+```ruby
+response = LoopsSdk::EmailMessages.update(
+  email_message_id: "message_123",
+  expected_revision_id: "revision_123",
+  subject: "Spring announcement",
+  preview_text: "See what's new",
+  from_name: "Loops",
+  from_email: "hello",
+  lmx: "<Email><Style /></Email>"
+)
+```
+
+---
+
 ## Testing
 
 Run tests with `bundle exec rspec`.

data/lib/loops_sdk/base.rb

@@ -7,13 +7,13 @@ module LoopsSdk
 
       def handle_response(response)
         case response.status
-        when 200
+        when 200, 201
           JSON.parse(response.body)
         when 429
           limit = response.headers["x-ratelimit-limit"]
           remaining = response.headers["x-ratelimit-remaining"]
           raise RateLimitError.new(limit, remaining)
-        when 400, 404, 405, 409, 500
+        when 400, 401, 404, 405, 409, 413, 422, 500
           raise APIError.new(response.status, response.body)
         else
           raise APIError.new(response.status, "Unexpected error occurred")

data/lib/loops_sdk/campaigns.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class Campaigns < Base
+    class << self
+      def list(perPage: 20, cursor: nil)
+        make_request(method: :get, path: "v1/campaigns", params: { perPage: perPage, cursor: cursor })
+      end
+
+      def create(name:)
+        make_request(method: :post, path: "v1/campaigns", body: { name: name })
+      end
+
+      def get(campaign_id:)
+        make_request(method: :get, path: "v1/campaigns/#{campaign_id}")
+      end
+
+      def update(campaign_id:, name:)
+        make_request(method: :post, path: "v1/campaigns/#{campaign_id}", body: { name: name })
+      end
+    end
+  end
+end

data/lib/loops_sdk/components.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class Components < Base
+    class << self
+      def list(perPage: 20, cursor: nil)
+        make_request(method: :get, path: "v1/components", params: { perPage: perPage, cursor: cursor })
+      end
+
+      def get(component_id:)
+        make_request(method: :get, path: "v1/components/#{component_id}")
+      end
+    end
+  end
+end

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/dedicated_sending_ips.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class DedicatedSendingIps < Base
+    class << self
+      def list
+        make_request(method: :get, path: "v1/dedicated-sending-ips")
+      end
+    end
+  end
+end

data/lib/loops_sdk/email_messages.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class EmailMessages < Base
+    class << self
+      def get(email_message_id:)
+        make_request(method: :get, path: "v1/email-messages/#{email_message_id}")
+      end
+
+      def update(email_message_id:, expected_revision_id: nil, subject: nil, preview_text: nil, from_name: nil, from_email: nil, reply_to_email: nil, lmx: nil)
+        body = {
+          expectedRevisionId: expected_revision_id,
+          subject: subject,
+          previewText: preview_text,
+          fromName: from_name,
+          fromEmail: from_email,
+          replyToEmail: reply_to_email,
+          lmx: lmx
+        }.compact
+        make_request(method: :post, path: "v1/email-messages/#{email_message_id}", body: body)
+      end
+    end
+  end
+end

data/lib/loops_sdk/themes.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class Themes < Base
+    class << self
+      def list(perPage: 20, cursor: nil)
+        make_request(method: :get, path: "v1/themes", params: { perPage: perPage, cursor: cursor })
+      end
+
+      def get(theme_id:)
+        make_request(method: :get, path: "v1/themes/#{theme_id}")
+      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.2.0"
 end

data/lib/loops_sdk.rb

@@ -11,6 +11,11 @@ require_relative "loops_sdk/mailing_lists"
 require_relative "loops_sdk/transactional"
 require_relative "loops_sdk/contact_properties"
 require_relative "loops_sdk/api_key"
+require_relative "loops_sdk/dedicated_sending_ips"
+require_relative "loops_sdk/themes"
+require_relative "loops_sdk/components"
+require_relative "loops_sdk/campaigns"
+require_relative "loops_sdk/email_messages"
 
 module LoopsSdk
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loops_sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Dan Rowden
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-22 00:00:00.000000000 Z
+date: 2026-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -36,11 +36,16 @@ files:
 - lib/loops_sdk.rb
 - lib/loops_sdk/api_key.rb
 - lib/loops_sdk/base.rb
+- lib/loops_sdk/campaigns.rb
+- lib/loops_sdk/components.rb
 - lib/loops_sdk/configuration.rb
 - lib/loops_sdk/contact_properties.rb
 - lib/loops_sdk/contacts.rb
+- lib/loops_sdk/dedicated_sending_ips.rb
+- lib/loops_sdk/email_messages.rb
 - lib/loops_sdk/events.rb
 - lib/loops_sdk/mailing_lists.rb
+- lib/loops_sdk/themes.rb
 - lib/loops_sdk/transactional.rb
 - lib/loops_sdk/version.rb
 homepage: https://loops.so/docs/api-reference
@@ -65,7 +70,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.