loops_sdk 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65b81eba842a1765bb2bc99006cbcaab839e442b3ee90ea92076cef8fba8f942
-  data.tar.gz: 3e544adfb4c2ed0b1069fc1a455773397a27a8254d9e8fe75ebbc33be2dfa9e8
+  metadata.gz: 5a4fac371d3bbc89f778265ecb287032e0ce08846a688b61887a64f27e30f8f4
+  data.tar.gz: 4c0647edf1dcebf7927232332ad5d92d8114c5ce8b291b1cbffc0c4dd145455e
 SHA512:
-  metadata.gz: 565a16854a58cf5510b8c6c189394f7b62bea1aa6b1448e41dbb1759268d6f25fe9f366190a29896b974a49648e2068478db8e4622c9db3bbb2a29ef25aba855
-  data.tar.gz: cd2b0f20ad57991723c3ca2bb68efe71b3759a0669a602be1c71583368fb7f3ae79dabbbb068ba9392918081edf9e465fcd4ee1f50c721ea5cbbcd2cc866d010
+  metadata.gz: 592a434bc0dd7d9c19c2b209eacd2463373cbeca1ed6d67e8fb376443084ae1e3c24ef95b2ee85d225e6c4ee544badd16fe34b6b80c262192817c77d501cf8a3
+  data.tar.gz: 2e979c1b6ddd315fd3adc6d28fedd69bf19322207ca66bf85eef4ea799d4f94dce01ffb55205fe23dcd7da872e132e976a83f11fcb6d0755744388b990a528a9

data/README.md

@@ -114,8 +114,39 @@ You can use custom contact properties in API calls. Please make sure to [add cus
 - [ContactProperties.list()](#contactpropertieslist)
 - [MailingLists.list()](#mailinglistslist)
 - [Events.send()](#eventssend)
-- [Transactional.send()](#transactionalsend)
 - [Transactional.list()](#transactionallist)
+- [Transactional.create()](#transactionalcreate)
+- [Transactional.get()](#transactionalget)
+- [Transactional.update()](#transactionalupdate)
+- [Transactional.ensure_draft()](#transactionalensure_draft)
+- [Transactional.publish()](#transactionalpublish)
+- [Transactional.send()](#transactionalsend)
+- [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)
+- [CampaignGroups.list()](#campaigngroupslist)
+- [CampaignGroups.create()](#campaigngroupscreate)
+- [CampaignGroups.get()](#campaigngroupsget)
+- [CampaignGroups.update()](#campaigngroupsupdate)
+- [AudienceSegments.list()](#audiencesegmentslist)
+- [AudienceSegments.get()](#audiencesegmentsget)
+- [Workflows.list()](#workflowslist)
+- [Workflows.get()](#workflowsget)
+- [Workflows.get_node()](#workflowsget_node)
+- [EmailMessages.get()](#emailmessagesget)
+- [EmailMessages.update()](#emailmessagesupdate)
+- [EmailMessages.preview()](#emailmessagespreview)
+- [TransactionalGroups.list()](#transactionalgroupslist)
+- [TransactionalGroups.create()](#transactionalgroupscreate)
+- [TransactionalGroups.get()](#transactionalgroupsget)
+- [TransactionalGroups.update()](#transactionalgroupsupdate)
+- [Uploads.upload()](#uploadsupload)
 
 ---
 
@@ -195,7 +226,7 @@ This method will return a success or error message:
 ```json
 {
   "success": true,
-  "id": "id_of_contact"
+  "id": "cll6b3i8901a9jx0oyktl2m4u"
 }
 ```
 
@@ -259,7 +290,7 @@ This method will return a success or error message:
 ```json
 {
   "success": true,
-  "id": "id_of_contact"
+  "id": "cll6b3i8901a9jx0oyktl2m4u"
 }
 ```
 
@@ -715,6 +746,180 @@ This method will return a success or error:
 
 ---
 
+### Transactional.list()
+
+List transactional emails, most recently created first.
+
+[API Reference](https://loops.so/docs/api-reference/list-transactional-emails)
+
+#### 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::Transactional.list
+
+response = LoopsSdk::Transactional.list(perPage: 15, cursor: "cursor_value")
+```
+
+#### Response
+
+```json
+{
+  "pagination": {
+    "totalResults": 23,
+    "returnedResults": 20,
+    "perPage": 20,
+    "totalPages": 2,
+    "nextCursor": "clyo0q4wo01p59fsecyxqsh38",
+    "nextPage": "https://app.loops.so/api/v1/transactional-emails?cursor=clyo0q4wo01p59fsecyxqsh38&perPage=20"
+  },
+  "data": [
+    {
+      "id": "clfn0k1yg001imo0fdeqg30i8",
+      "name": "Welcome email",
+      "draftEmailMessageId": null,
+      "publishedEmailMessageId": "cly8k3m0n0044jpx2bghepq45",
+      "createdAt": "2023-11-06T17:48:07.249Z",
+      "updatedAt": "2023-11-06T17:48:07.249Z",
+      "dataVariables": ["confirmationUrl"]
+    }
+  ]
+}
+```
+
+---
+
+### Transactional.create()
+
+Create a transactional email. An empty draft email message is created automatically.
+
+[API Reference](https://loops.so/docs/api-reference/create-transactional-email)
+
+#### Parameters
+
+| Name                     | Type   | Required | Notes                                                   |
+| ------------------------ | ------ | -------- | ------------------------------------------------------- |
+| `name`                   | string | Yes      |                                                         |
+| `transactional_group_id` | string | No       | The ID of the group to add this transactional email to. |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Transactional.create(name: "Welcome email")
+```
+
+#### Response
+
+Returns the transactional email with `draftEmailMessageId` and `draftEmailMessageContentRevisionId`. Use these when updating the draft via `EmailMessages.update()`.
+
+```json
+{
+  "id": "clfq6dinn000yl70fgwwyp82l",
+  "name": "Welcome email",
+  "draftEmailMessageId": "cly8k3m0n0044jpx2bghepq45",
+  "draftEmailMessageContentRevisionId": "clm9n4o6p0088lrz4dijslt67",
+  "publishedEmailMessageId": null,
+  "createdAt": "2023-11-06T17:48:07.249Z",
+  "updatedAt": "2023-11-06T17:48:07.249Z",
+  "dataVariables": []
+}
+```
+
+---
+
+### Transactional.get()
+
+Get a single transactional email by ID.
+
+[API Reference](https://loops.so/docs/api-reference/get-transactional-email)
+
+#### Parameters
+
+| Name               | Type   | Required | Notes |
+| ------------------ | ------ | -------- | ----- |
+| `transactional_id`               | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Transactional.get(transactional_id: "clfq6dinn000yl70fgwwyp82l")
+```
+
+---
+
+### Transactional.update()
+
+Update a transactional email's name.
+
+[API Reference](https://loops.so/docs/api-reference/update-transactional-email)
+
+#### Parameters
+
+| Name                     | Type   | Required | Notes                                                        |
+| ------------------------ | ------ | -------- | ------------------------------------------------------------ |
+| `transactional_id`                     | string | Yes      |                                                              |
+| `name`                   | string | No       |                                                              |
+| `transactional_group_id` | string | No       | The ID of the group to move this transactional email to.     |
+
+At least one field must be provided.
+
+#### Example
+
+```ruby
+response = LoopsSdk::Transactional.update(
+  transactional_id: "clfq6dinn000yl70fgwwyp82l",
+  name: "Updated name"
+)
+```
+
+---
+
+### Transactional.ensure_draft()
+
+Ensure a transactional email has a draft email message. If a draft already exists it is returned unchanged; otherwise a new empty draft is created.
+
+[API Reference](https://loops.so/docs/api-reference/ensure-transactional-email-draft)
+
+#### Parameters
+
+| Name               | Type   | Required | Notes |
+| ------------------ | ------ | -------- | ----- |
+| `transactional_id`               | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Transactional.ensure_draft(transactional_id: "clfq6dinn000yl70fgwwyp82l")
+```
+
+---
+
+### Transactional.publish()
+
+Publish a transactional email's current draft. The draft becomes the published version and the draft is cleared.
+
+[API Reference](https://loops.so/docs/api-reference/publish-transactional-email)
+
+#### Parameters
+
+| Name               | Type   | Required | Notes |
+| ------------------ | ------ | -------- | ----- |
+| `transactional_id`               | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Transactional.publish(transactional_id: "clfq6dinn000yl70fgwwyp82l")
+```
+
+---
+
 ### Transactional.send()
 
 Send a transactional email to a contact. [Learn about sending transactional email](https://loops.so/docs/transactional/guide)
@@ -725,7 +930,7 @@ Send a transactional email to a contact. [Learn about sending transactional emai
 
 | Name                         | Type     | Required | Notes                                                                                                                                                                                            |
 | ---------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `transactional_id`           | string   | Yes      | The ID of the transactional email to send.                                                                                                                                                       |
+| `transactional_id`                         | string   | Yes      | The ID of the transactional email to send.                                                                                                                                                       |
 | `email`                      | string   | Yes      | The email address of the recipient.                                                                                                                                                              |
 | `add_to_audience`            | boolean  | No       | If `true`, a contact will be created in your audience using the `email` value (if a matching contact doesn't already exist).                                                                     |
 | `data_variables`             | object   | No       | An object containing data as defined by the data variables added to the transactional email template.<br />Values can be of type `string` or `number`.                                           |
@@ -808,11 +1013,37 @@ If there is a problem with the request, a descriptive error message will be retu
 
 ---
 
-### Transactional.list()
+### DedicatedSendingIps.list()
 
-Get a list of published transactional emails.
+Get Loops' dedicated sending IP addresses.
 
-[API Reference](https://loops.so/docs/api-reference/list-transactional-emails)
+[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
 
@@ -824,47 +1055,578 @@ Get a list of published transactional emails.
 #### Example
 
 ```ruby
-response = LoopsSdk::Transactional.list
+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: "clo5p8q0r0132ntx6flkunw89")
+```
+
+---
+
+### 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: "clp6q9r1s0154ouy7gmlovx90")
+```
+
+---
+
+### Campaigns.list()
+
+List campaigns.
 
-response = LoopsSdk::Transactional.list(perPage: 15)
+[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      |                                                                                                       |
+| `campaign_group_id`    | string | No       | The ID of the group to add this campaign to.                                                          |
+| `mailing_list_id`      | string | No       | The ID of the mailing list to send to.                                                                |
+| `audience_segment_id`  | string | No       | The ID of an audience segment. Setting this clears any `audience_filter`.                             |
+| `audience_filter`      | object | No       | A tree of audience conditions. See the API reference for the filter schema.                           |
+| `scheduling`           | object | No       | When the campaign should send. Use `{ method: "now" }` or `{ method: "schedule", timestamp: "..." }`. |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Campaigns.create(name: "Spring announcement")
+
+response = LoopsSdk::Campaigns.create(
+  name: "Spring announcement",
+  mailing_list_id: "cm06f5v0e45nf0ml5754o9cix",
+  scheduling: { method: "schedule", timestamp: "2026-06-01T10:00:00Z" }
+)
+```
+
+---
+
+### 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: "cln4o7p9q0110msw5ekjtmv78")
+```
+
+---
+
+### Campaigns.update()
+
+Update a draft campaign's name, group, audience, or scheduling.
+
+[API Reference](https://loops.so/docs/api-reference/update-campaign)
+
+#### Parameters
+
+| Name                  | Type   | Required | Notes                                                                                                 |
+| --------------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------- |
+| `campaign_id`                  | string | Yes      |                                                                                                       |
+| `name`                | string | No       |                                                                                                       |
+| `campaign_group_id`   | string | No       | The ID of the group to move this campaign to.                                                         |
+| `mailing_list_id`     | string | No       | The ID of the mailing list to send to.                                                                |
+| `audience_segment_id` | string | No       | The ID of an audience segment. Setting this clears any `audience_filter`.                             |
+| `audience_filter`     | object | No       | A tree of audience conditions. See the API reference for the filter schema.                           |
+| `scheduling`          | object | No       | When the campaign should send. Use `{ method: "now" }` or `{ method: "schedule", timestamp: "..." }`. |
+
+At least one field must be provided.
+
+#### Example
+
+```ruby
+response = LoopsSdk::Campaigns.update(
+  campaign_id: "cln4o7p9q0110msw5ekjtmv78",
+  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: "cly8k3m0n0044jpx2bghepq45")
+```
+
+---
+
+### 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.                                                                    |
+| `cc_email`                     | string | No       | CC email address. Requires the team to have CC/BCC enabled.                                                |
+| `bcc_email`                    | string | No       | BCC email address. Requires the team to have CC/BCC enabled.                                               |
+| `language_code`                | string | No       | Language code for the email. Requires translation to be enabled for the team.                              |
+| `email_format`                 | string | No       | The rendering format of the email. One of `styled` or `plain`.                                             |
+| `lmx`                          | string | No       | Email body serialized as LMX. Styles must be embedded in the LMX `<Style />` tag.                          |
+| `contact_properties_fallbacks` | object | No       | Fallback values for contact properties. A null value deletes the fallback.                                 |
+| `event_properties_fallbacks`   | object | No       | Fallback values for event properties. A null value deletes the fallback.                                   |
+| `data_variables_fallbacks`     | object | No       | Fallback values for data variables. A null value deletes the fallback.                                     |
+
+#### Example
+
+```ruby
+response = LoopsSdk::EmailMessages.update(
+  email_message_id: "cly8k3m0n0044jpx2bghepq45",
+  expected_revision_id: "clm9n4o6p0088lrz4dijslt67",
+  subject: "Spring announcement",
+  preview_text: "See what's new",
+  from_name: "Loops",
+  from_email: "hello",
+  lmx: "<Email><Style /></Email>"
+)
+```
+
+---
+
+### EmailMessages.preview()
+
+Send a test preview of an email message to one or more addresses.
+
+[API Reference](https://loops.so/docs/api-reference/preview-email-message)
+
+#### Parameters
+
+| Name                 | Type     | Required | Notes                                                                             |
+| -------------------- | -------- | -------- | --------------------------------------------------------------------------------- |
+| `email_message_id`                 | string   | Yes      |                                                                                   |
+| `emails`             | string[] | Yes      | One or more addresses to send the preview to.                                     |
+| `contact_properties` | object   | No       | Contact property values to render. Accepted for campaign and workflow previews.   |
+| `event_properties`   | object   | No       | Event property values to render. Accepted for workflow previews only.             |
+| `data_variables`     | object   | No       | Transactional data variables to render. Accepted for transactional previews only. |
+
+#### Example
+
+```ruby
+response = LoopsSdk::EmailMessages.preview(
+  email_message_id: "cly8k3m0n0044jpx2bghepq45",
+  emails: ["test@example.com"],
+  contact_properties: { firstName: "Alex" }
+)
+```
+
+---
+
+### CampaignGroups.list()
+
+List campaign groups.
+
+[API Reference](https://loops.so/docs/api-reference/list-campaign-groups)
+
+#### 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::CampaignGroups.list
+```
+
+---
+
+### CampaignGroups.create()
+
+Create a campaign group.
+
+[API Reference](https://loops.so/docs/api-reference/create-campaign-group)
+
+#### Parameters
+
+| Name          | Type   | Required | Notes                                   |
+| ------------- | ------ | -------- | --------------------------------------- |
+| `name`        | string | Yes      | Cannot be the reserved name "Unsorted". |
+| `description` | string | No       | An optional description for the group.  |
+
+#### Example
+
+```ruby
+response = LoopsSdk::CampaignGroups.create(name: "Newsletters", description: "Monthly updates")
+```
+
+---
+
+### CampaignGroups.get()
+
+Get a campaign group by ID.
+
+[API Reference](https://loops.so/docs/api-reference/get-campaign-group)
+
+#### Parameters
+
+| Name | Type   | Required | Notes |
+| ---- | ------ | -------- | ----- |
+| `campaign_group_id` | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::CampaignGroups.get(campaign_group_id: "clq7r0s2t0176pvz8hnmpwy01")
+```
+
+---
+
+### CampaignGroups.update()
+
+Update a campaign group's name or description.
+
+[API Reference](https://loops.so/docs/api-reference/update-campaign-group)
+
+#### Parameters
+
+| Name          | Type   | Required | Notes                                   |
+| ------------- | ------ | -------- | --------------------------------------- |
+| `campaign_group_id`          | string | Yes      |                                         |
+| `name`        | string | No       | Cannot be the reserved name "Unsorted". |
+| `description` | string | No       |                                         |
+
+At least one field must be provided.
+
+#### Example
+
+```ruby
+response = LoopsSdk::CampaignGroups.update(
+  campaign_group_id: "clq7r0s2t0176pvz8hnmpwy01",
+  name: "Updated name"
+)
+```
+
+---
+
+### AudienceSegments.list()
+
+List audience segments.
+
+[API Reference](https://loops.so/docs/api-reference/list-audience-segments)
+
+#### 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::AudienceSegments.list
+```
+
+---
+
+### AudienceSegments.get()
+
+Get an audience segment by ID.
+
+[API Reference](https://loops.so/docs/api-reference/get-audience-segment)
+
+#### Parameters
+
+| Name | Type   | Required | Notes |
+| ---- | ------ | -------- | ----- |
+| `audience_segment_id` | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::AudienceSegments.get(audience_segment_id: "clr8s1t3u0198qw09iotqzx12")
+```
+
+---
+
+### Workflows.list()
+
+List workflows.
+
+[API Reference](https://loops.so/docs/api-reference/list-workflows)
+
+#### 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::Workflows.list
+```
+
+---
+
+### Workflows.get()
+
+Get a simplified workflow graph.
+
+[API Reference](https://loops.so/docs/api-reference/get-workflow)
+
+#### Parameters
+
+| Name | Type   | Required | Notes |
+| ---- | ------ | -------- | ----- |
+| `workflow_id` | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Workflows.get(workflow_id: "cls9t2u4v0210rx20jpuary23")
+```
+
+---
+
+### Workflows.get_node()
+
+Get detailed data for a single workflow node.
+
+[API Reference](https://loops.so/docs/api-reference/get-workflow-node)
+
+#### Parameters
+
+| Name         | Type   | Required | Notes |
+| ------------ | ------ | -------- | ----- |
+| `workflow_id`| string | Yes      |       |
+| `node_id`    | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Workflows.get_node(workflow_id: "cls9t2u4v0210rx20jpuary23", node_id: "clt0u3v5w0232sy31kqvbzs34")
+```
+
+---
+
+### TransactionalGroups.list()
+
+List transactional groups.
+
+[API Reference](https://loops.so/docs/api-reference/list-transactional-groups)
+
+#### 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::TransactionalGroups.list
+```
+
+---
+
+### TransactionalGroups.create()
+
+Create a transactional group.
+
+[API Reference](https://loops.so/docs/api-reference/create-transactional-group)
+
+#### Parameters
+
+| Name          | Type   | Required | Notes                                   |
+| ------------- | ------ | -------- | --------------------------------------- |
+| `name`        | string | Yes      | Cannot be the reserved name "Unsorted". |
+| `description` | string | No       | An optional description for the group.  |
+
+#### Example
+
+```ruby
+response = LoopsSdk::TransactionalGroups.create(name: "Account emails")
+```
+
+---
+
+### TransactionalGroups.get()
+
+Get a transactional group by ID.
+
+[API Reference](https://loops.so/docs/api-reference/get-transactional-group)
+
+#### Parameters
+
+| Name | Type   | Required | Notes |
+| ---- | ------ | -------- | ----- |
+| `transactional_group_id` | string | Yes      |       |
+
+#### Example
+
+```ruby
+response = LoopsSdk::TransactionalGroups.get(transactional_group_id: "clv2w3x4y0288xbb0kqrsuv67")
+```
+
+---
+
+### TransactionalGroups.update()
+
+Update a transactional group's name or description.
+
+[API Reference](https://loops.so/docs/api-reference/update-transactional-group)
+
+#### Parameters
+
+| Name          | Type   | Required | Notes                                   |
+| ------------- | ------ | -------- | --------------------------------------- |
+| `transactional_group_id`          | string | Yes      |                                         |
+| `name`        | string | No       | Cannot be the reserved name "Unsorted". |
+| `description` | string | No       |                                         |
+
+At least one field must be provided.
+
+#### Example
+
+```ruby
+response = LoopsSdk::TransactionalGroups.update(
+  transactional_group_id: "clv2w3x4y0288xbb0kqrsuv67",
+  name: "Updated name"
+)
+```
+
+---
+
+### Uploads.upload()
+
+Upload an image file for use in LMX email content.
+
+Supported image types: JPEG, PNG, GIF, and WebP (max 4 MB). MIME type is detected from file contents, or pass `content_type:` to override.
+
+[API Reference](https://loops.so/docs/api-reference/create-upload)
+
+#### Parameters
+
+| Name            | Type   | Required | Notes                                                                                        |
+| --------------- | ------ | -------- | -------------------------------------------------------------------------------------------- |
+| `path`          | string | Yes      | Path to the image file on disk.                                                              |
+| `content_type`  | string | No       | MIME type override. Supported: `image/jpeg`, `image/png`, `image/gif`, `image/webp`.         |
+
+#### Example
+
+```ruby
+response = LoopsSdk::Uploads.upload(path: "./header.png")
+
+# Use the returned URL in LMX
+lmx = %(<Image src="#{response['finalUrl']}" alt="Header" />)
 ```
 
 #### Response
 
 ```json
 {
-  "pagination": {
-    "totalResults": 23,
-    "returnedResults": 20,
-    "perPage": 20,
-    "totalPages": 2,
-    "nextCursor": "clyo0q4wo01p59fsecyxqsh38",
-    "nextPage": "https://app.loops.so/api/v1/transactional?cursor=clyo0q4wo01p59fsecyxqsh38&perPage=20"
-  },
-  "data": [
-    {
-      "id": "clfn0k1yg001imo0fdeqg30i8",
-      "lastUpdated": "2023-11-06T17:48:07.249Z",
-      "dataVariables": []
-    },
-    {
-      "id": "cll42l54f20i1la0lfooe3z12",
-      "lastUpdated": "2025-02-02T02:56:28.845Z",
-      "dataVariables": [
-        "confirmationUrl"
-      ]
-    },
-    {
-      "id": "clw6rbuwp01rmeiyndm80155l",
-      "lastUpdated": "2024-05-14T19:02:52.000Z",
-      "dataVariables": [
-        "firstName",
-        "lastName",
-        "inviteLink"
-      ]
-    },
-    ...
-  ]
+  "emailAssetId": "clu1v4w6x0254tz42lrcwat45",
+  "finalUrl": "https://cdn.loops.so/clu1v4w6x0254tz42lrcwat45.png"
 }
 ```
 
@@ -878,4 +1640,4 @@ Run tests with `bundle exec rspec`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome. Please read our [Contributing Guidelines](CONTRIBUTING.md).
+Bug reports and pull requests are welcome. Please read our [Contributing Guidelines](CONTRIBUTING.md).

data/lib/loops_sdk/audience_segments.rb

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

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class CampaignGroups < Base
+    class << self
+      def list(perPage: 20, cursor: nil)
+        make_request(method: :get, path: "v1/campaign-groups", params: { perPage: perPage, cursor: cursor })
+      end
+
+      def create(name:, description: nil)
+        body = { name: name, description: description }.compact
+        make_request(method: :post, path: "v1/campaign-groups", body: body)
+      end
+
+      def get(campaign_group_id:)
+        make_request(method: :get, path: "v1/campaign-groups/#{campaign_group_id}")
+      end
+
+      def update(campaign_group_id:, name: nil, description: nil)
+        body = { name: name, description: description }.compact
+        make_request(method: :post, path: "v1/campaign-groups/#{campaign_group_id}", body: body)
+      end
+    end
+  end
+end

data/lib/loops_sdk/campaigns.rb

@@ -0,0 +1,39 @@
+# 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:, campaign_group_id: nil, mailing_list_id: nil, audience_segment_id: nil, audience_filter: nil, scheduling: nil)
+        body = {
+          name: name,
+          campaignGroupId: campaign_group_id,
+          mailingListId: mailing_list_id,
+          audienceSegmentId: audience_segment_id,
+          audienceFilter: audience_filter,
+          scheduling: scheduling
+        }.compact
+        make_request(method: :post, path: "v1/campaigns", body: body)
+      end
+
+      def get(campaign_id:)
+        make_request(method: :get, path: "v1/campaigns/#{campaign_id}")
+      end
+
+      def update(campaign_id:, name: nil, campaign_group_id: nil, mailing_list_id: nil, audience_segment_id: nil, audience_filter: nil, scheduling: nil)
+        body = {
+          name: name,
+          campaignGroupId: campaign_group_id,
+          mailingListId: mailing_list_id,
+          audienceSegmentId: audience_segment_id,
+          audienceFilter: audience_filter,
+          scheduling: scheduling
+        }.compact
+        make_request(method: :post, path: "v1/campaigns/#{campaign_id}", body: body)
+      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/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,57 @@
+# 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,
+        cc_email: nil,
+        bcc_email: nil,
+        language_code: nil,
+        email_format: nil,
+        lmx: nil,
+        contact_properties_fallbacks: nil,
+        event_properties_fallbacks: nil,
+        data_variables_fallbacks: nil
+      )
+        body = {
+          expectedRevisionId: expected_revision_id,
+          subject: subject,
+          previewText: preview_text,
+          fromName: from_name,
+          fromEmail: from_email,
+          replyToEmail: reply_to_email,
+          ccEmail: cc_email,
+          bccEmail: bcc_email,
+          languageCode: language_code,
+          emailFormat: email_format,
+          lmx: lmx,
+          contactPropertiesFallbacks: contact_properties_fallbacks,
+          eventPropertiesFallbacks: event_properties_fallbacks,
+          dataVariablesFallbacks: data_variables_fallbacks
+        }.compact
+        make_request(method: :post, path: "v1/email-messages/#{email_message_id}", body: body)
+      end
+
+      def preview(email_message_id:, emails:, contact_properties: nil, event_properties: nil, data_variables: nil)
+        body = {
+          emails: emails,
+          contactProperties: contact_properties,
+          eventProperties: event_properties,
+          dataVariables: data_variables
+        }.compact
+        make_request(method: :post, path: "v1/email-messages/#{email_message_id}/preview", 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/transactional.rb

@@ -4,8 +4,31 @@ module LoopsSdk
   class Transactional < Base
     class << self
       def list(perPage: 20, cursor: nil)
-        make_request(method: :get, path: "v1/transactional", params: { perPage: perPage, cursor: cursor })
+        make_request(method: :get, path: "v1/transactional-emails", params: { perPage: perPage, cursor: cursor })
       end
+
+      def create(name:, transactional_group_id: nil)
+        body = { name: name, transactionalGroupId: transactional_group_id }.compact
+        make_request(method: :post, path: "v1/transactional-emails", body: body)
+      end
+
+      def get(transactional_id:)
+        make_request(method: :get, path: "v1/transactional-emails/#{transactional_id}")
+      end
+
+      def update(transactional_id:, name: nil, transactional_group_id: nil)
+        body = { name: name, transactionalGroupId: transactional_group_id }.compact
+        make_request(method: :post, path: "v1/transactional-emails/#{transactional_id}", body: body)
+      end
+
+      def ensure_draft(transactional_id:)
+        make_request(method: :post, path: "v1/transactional-emails/#{transactional_id}/draft")
+      end
+
+      def publish(transactional_id:)
+        make_request(method: :post, path: "v1/transactional-emails/#{transactional_id}/publish")
+      end
+
       def send(transactional_id:, email:, add_to_audience: false, data_variables: {}, attachments: [], headers: {})
         attachments = attachments.map do |attachment|
           attachment.transform_keys { |key| key == :content_type ? :contentType : key }

data/lib/loops_sdk/transactional_groups.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class TransactionalGroups < Base
+    class << self
+      def list(perPage: 20, cursor: nil)
+        make_request(method: :get, path: "v1/transactional-groups", params: { perPage: perPage, cursor: cursor })
+      end
+
+      def create(name:, description: nil)
+        body = { name: name, description: description }.compact
+        make_request(method: :post, path: "v1/transactional-groups", body: body)
+      end
+
+      def get(transactional_group_id:)
+        make_request(method: :get, path: "v1/transactional-groups/#{transactional_group_id}")
+      end
+
+      def update(transactional_group_id:, name: nil, description: nil)
+        body = { name: name, description: description }.compact
+        make_request(method: :post, path: "v1/transactional-groups/#{transactional_group_id}", body: body)
+      end
+    end
+  end
+end

data/lib/loops_sdk/uploads.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class Uploads < Base
+    SUPPORTED_CONTENT_TYPES = %w[image/jpeg image/png image/gif image/webp].freeze
+
+    class << self
+      def upload(path:, content_type: nil)
+        data = File.binread(path)
+        content_type ||= detect_content_type(data)
+        validate_content_type!(content_type)
+
+        create_response = make_request(
+          method: :post,
+          path: "v1/uploads",
+          body: { contentType: content_type, contentLength: data.bytesize }
+        )
+
+        put_to_presigned_url(create_response["presignedUrl"], data, content_type)
+
+        make_request(
+          method: :post,
+          path: "v1/uploads/#{create_response["emailAssetId"]}/complete"
+        )
+      end
+
+      private
+
+      def detect_content_type(data)
+        if data.start_with?("\xFF\xD8\xFF".b)
+          "image/jpeg"
+        elsif data.start_with?("\x89PNG\r\n\x1a\n".b)
+          "image/png"
+        elsif data.start_with?("GIF87a".b, "GIF89a".b)
+          "image/gif"
+        elsif data.bytesize >= 12 && data[0, 4] == "RIFF".b && data[8, 4] == "WEBP".b
+          "image/webp"
+        else
+          raise ArgumentError,
+                "Unable to detect image type. Pass content_type: explicitly. " \
+                "Supported types: #{SUPPORTED_CONTENT_TYPES.join(', ')}."
+        end
+      end
+
+      def validate_content_type!(content_type)
+        return if SUPPORTED_CONTENT_TYPES.include?(content_type)
+
+        raise ArgumentError,
+              "Unsupported content_type: #{content_type}. " \
+              "Supported types: #{SUPPORTED_CONTENT_TYPES.join(', ')}."
+      end
+
+      def put_to_presigned_url(url, data, content_type)
+        response = Faraday.put(url) do |req|
+          req.headers["Content-Type"] = content_type
+          req.headers["Content-Length"] = data.bytesize.to_s
+          req.body = data
+        end
+
+        return if response.success?
+
+        raise APIError.new(response.status, response.body)
+      end
+    end
+  end
+end

data/lib/loops_sdk/version.rb

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

data/lib/loops_sdk/workflows.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class Workflows < Base
+    class << self
+      def list(perPage: 20, cursor: nil)
+        make_request(method: :get, path: "v1/workflows", params: { perPage: perPage, cursor: cursor })
+      end
+
+      def get(workflow_id:)
+        make_request(method: :get, path: "v1/workflows/#{workflow_id}")
+      end
+
+      def get_node(workflow_id:, node_id:)
+        make_request(method: :get, path: "v1/workflows/#{workflow_id}/nodes/#{node_id}")
+      end
+    end
+  end
+end

data/lib/loops_sdk.rb

@@ -11,6 +11,16 @@ 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/campaign_groups"
+require_relative "loops_sdk/email_messages"
+require_relative "loops_sdk/uploads"
+require_relative "loops_sdk/audience_segments"
+require_relative "loops_sdk/workflows"
+require_relative "loops_sdk/transactional_groups"
 
 module LoopsSdk
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loops_sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Dan Rowden
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-08 00:00:00.000000000 Z
+date: 2026-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -35,14 +35,24 @@ files:
 - README.md
 - lib/loops_sdk.rb
 - lib/loops_sdk/api_key.rb
+- lib/loops_sdk/audience_segments.rb
 - lib/loops_sdk/base.rb
+- lib/loops_sdk/campaign_groups.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/transactional_groups.rb
+- lib/loops_sdk/uploads.rb
 - lib/loops_sdk/version.rb
+- lib/loops_sdk/workflows.rb
 homepage: https://loops.so/docs/api-reference
 licenses:
 - MIT