loops_sdk 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a8b0b6350209acdbb57d8414d35d24c27dc3b53ddbb8dfebf30893221863483
-  data.tar.gz: 462b317da348740e35285efb05d67aa59f71adb54644094f2fe666b6968f8fad
+  metadata.gz: 359ea0bf26c0f71ba07ff6e8fe435ecf6ee72c33e994aeff4040661199768a9b
+  data.tar.gz: 62512a5d7c037aef79d56e4bc6bf13b71aaa0e11fd74ae9b5ac8b35f75779f04
 SHA512:
-  metadata.gz: 2a4b0181a592ff98fda831db5235def393d934375957215cb223219148dce1cbe940271ff5a6881dddec2dc5a9b68bc307009d1ebce947a2522aa672f6f8d752
-  data.tar.gz: b6134652c05daf397d23c1a30bf86fb89f8ae681c60b88e645f6921941f2c327dc1acedc2e86c6db26addb819e7e2b09287373e58460942aaa66766471e1a2c9
+  metadata.gz: e35da20e6e24efa3a37a7a8fdf09acedb6b7e333d515251c095ce8222c7635834dc6fa0acc42d2cab516253b7e101654665b76f252bcce7965cde97adbc98717
+  data.tar.gz: c20564327c894dad4b4b97ffc65b5b5eca60f7bf5eaad5d106b00ca1e3dd3b87910fc48c47f16b3688af314ef8effe34177a843f55d141df4e6ec0eb628b1e90

data/README.md

@@ -1,5 +1,7 @@
 # Loops Ruby SDK
 
+[![Gem Total Downloads](https://img.shields.io/gem/dt/loops_sdk?style=social)](https://rubygems.org/gems/loops_sdk)
+
 ## Introduction
 
 This is the official Ruby SDK for [Loops](https://loops.so), an email platform for modern software companies.
@@ -110,6 +112,7 @@ You can use custom contact properties in API calls. Please make sure to [add cus
 - [MailingLists.list()](#mailinglistslist)
 - [Events.send()](#eventssend)
 - [Transactional.send()](#transactionalsend)
+- [Transactional.list()](#transactionallist)
 
 ---
 
@@ -235,7 +238,8 @@ response = LoopsSdk::Contacts.update(
   email: "newemail@gmail.com",
   properties: {
     userId: "1234",
-  })
+  }
+)
 ```
 
 #### Response
@@ -555,7 +559,7 @@ response = LoopsSdk::Events.send(
     cm06f5v0e45nf0ml5754o9cix: true,
     cm16k73gq014h0mmj5b6jdi9r: false,
   },
-})
+)
 
 # In this case with both email and userId present, the system will look for a contact with either a
 #  matching `email` or `user_id` value.
@@ -570,7 +574,7 @@ response = LoopsSdk::Events.send(
     firstName: "Bob",
     plan: "pro",
   },
-})
+)
 ```
 
 #### Response
@@ -672,6 +676,74 @@ If there is a problem with the request, a descriptive error message will be retu
 
 ---
 
+### Transactional.list()
+
+Get a list of published transactional emails.
+
+[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)
+```
+
+#### 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"
+      ]
+    },
+    ...
+  ]
+}
+```
+
+---
+
+## Testing
+
+Run tests with `bundle exec rspec`.
+
+---
+
 ## Contributing
 
 Bug reports and pull requests are welcome. Please read our [Contributing Guidelines](CONTRIBUTING.md).

data/lib/loops_sdk/api_key.rb

@@ -4,7 +4,7 @@ module LoopsSdk
   class ApiKey < Base
     class << self
       def test
-        make_request(:get, "v1/api-key")
+        make_request(method: :get, path: "v1/api-key")
       end
     end
   end

data/lib/loops_sdk/base.rb

@@ -20,9 +20,19 @@ module LoopsSdk
         end
       end
 
-      def make_request(method, path, params = {}, body = nil)
-        response = LoopsSdk.configuration.connection.send(method, path, params) do |req|
+      def make_request(method:, path:, headers: {}, params: {}, body: nil)
+        # Merge default headers with request-specific headers
+        merged_headers = LoopsSdk.configuration.connection.headers.merge(headers)
+        
+        response = LoopsSdk.configuration.connection.send(
+          method: method,
+          path: path,
+          headers: merged_headers,
+          params: params,
+          body: body
+        ) do |req|
           req.body = body.to_json if body
+          req
         end
         handle_response(response)
       end

data/lib/loops_sdk/contact_properties.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LoopsSdk
+  class ContactProperties < Base
+    class << self
+      def create(name:, type:)
+        body = {
+          name: name,
+          type: type
+        }
+        make_request(method: :post, path: "v1/contacts/properties", body: body)
+      end
+      def list(list: nil)
+        raise ArgumentError, "List value must be nil, 'custom' or 'all'." unless [nil, "custom", "all"].include?(list)
+        make_request(method: :get, path: "v1/contacts/properties", params: { list: list || "all" })
+      end
+    end
+  end
+end

data/lib/loops_sdk/contacts.rb

@@ -8,7 +8,7 @@ module LoopsSdk
           email: email,
           mailingLists: mailing_lists
         }.merge(properties)
-        make_request(:post, "v1/contacts/create", {}, contact_data)
+        make_request(method: :post, path: "v1/contacts/create", body: contact_data)
       end
 
       def update(email:, properties: {}, mailing_lists: {})
@@ -16,7 +16,7 @@ module LoopsSdk
           email: email,
           mailingLists: mailing_lists
         }.merge(properties)
-        make_request(:put, "v1/contacts/update", {}, contact_data)
+        make_request(method: :put, path: "v1/contacts/update", body: contact_data)
       end
 
       def find(email: nil, user_id: nil)
@@ -24,7 +24,7 @@ module LoopsSdk
         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(:get, "v1/contacts/find", params)
+        make_request(method: :get, path: "v1/contacts/find", params: params)
       end
 
       def delete(email: nil, user_id: nil)
@@ -32,7 +32,7 @@ module LoopsSdk
         raise ArgumentError, "You must provide an email or user_id value." if email.nil? && user_id.nil?
 
         body = email ? { email: email } : { userId: user_id }
-        make_request(:post, "v1/contacts/delete", {}, body)
+        make_request(method: :post, path: "v1/contacts/delete", body: body)
       end
     end
   end

data/lib/loops_sdk/events.rb

@@ -3,7 +3,7 @@
 module LoopsSdk
   class Events < Base
     class << self
-      def send(event_name:, email: nil, user_id: nil, contact_properties: {}, event_properties: {}, mailing_lists: {})
+      def send(event_name:, email: nil, user_id: nil, contact_properties: {}, event_properties: {}, mailing_lists: {}, headers: {})
         raise ArgumentError, "You must provide an email or user_id value." if email.nil? && user_id.nil?
 
         event_data = {
@@ -13,7 +13,7 @@ module LoopsSdk
           eventProperties: event_properties.compact,
           mailingLists: mailing_lists.compact
         }.merge(contact_properties)
-        make_request(:post, "v1/events/send", {}, event_data)
+        make_request(method: :post, path: "v1/events/send", headers: headers, body: event_data)
       end
     end
   end

data/lib/loops_sdk/mailing_lists.rb

@@ -4,7 +4,7 @@ module LoopsSdk
   class MailingLists < Base
     class << self
       def list
-        make_request(:get, "v1/lists")
+        make_request(method: :get, path: "v1/lists")
       end
     end
   end

data/lib/loops_sdk/transactional.rb

@@ -3,7 +3,10 @@
 module LoopsSdk
   class Transactional < Base
     class << self
-      def send(transactional_id:, email:, add_to_audience: false, data_variables: {}, attachments: [])
+      def list(perPage: 20, cursor: nil)
+        make_request(method: :get, path: "v1/transactional", params: { perPage: perPage, cursor: cursor })
+      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 }
         end
@@ -14,7 +17,7 @@ module LoopsSdk
           dataVariables: data_variables,
           attachments: attachments
         }.compact
-        make_request(:post, "v1/transactional", {}, email_data)
+        make_request(method: :post, path: "v1/transactional", headers: headers, body: email_data)
       end
     end
   end

data/lib/loops_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loops_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Dan Rowden
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-26 00:00:00.000000000 Z
+date: 2025-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -31,24 +31,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/loops_sdk.rb
 - lib/loops_sdk/api_key.rb
 - lib/loops_sdk/base.rb
 - lib/loops_sdk/configuration.rb
+- lib/loops_sdk/contact_properties.rb
 - lib/loops_sdk/contacts.rb
-- lib/loops_sdk/custom_fields.rb
 - lib/loops_sdk/events.rb
 - lib/loops_sdk/mailing_lists.rb
 - lib/loops_sdk/transactional.rb
 - lib/loops_sdk/version.rb
-- sig/loops_sdk.rbs
 homepage: https://loops.so/docs/api-reference
 licenses:
 - MIT

data/.rubocop.yml

@@ -1,11 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.0
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-
-Metrics/ParameterLists:
-  Max: 6

data/CHANGELOG.md

@@ -1,21 +0,0 @@
-## v1.0.0 - Feb 26, 2025
-
-- JSON from API errors is now accessible from the `APIError` class.
-- Added support for two new contact property endpoints: `ContactProperties.create()` and `ContactProperties.list()`.
-- Deprecated and removed the `CustomFields.list()` method (you can now use `ContactProperties.list()` instead).
-
-## v0.2.0 - Oct 29, 2024
-
-Added rate limit handling with `RateLimitError`.
-
-## v0.1.2 - Aug 16, 2024
-
-Support for resetting contact properties with `nil`.
-
-## v0.1.1 - Aug 16, 2024
-
-Added `ApiKey.test` method for testing API keys.
-
-## v0.1.0 - Aug 16, 2024
-
-Initial release.

data/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-- Demonstrating empathy and kindness toward other people
-- Being respectful of differing opinions, viewpoints, and experiences
-- Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-- The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-- Trolling, insulting or derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official email address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

data/CONTRIBUTING.md

@@ -1,51 +0,0 @@
-# Contributing to Loops Ruby SDK
-
-Thank you for your interest in contributing to Loops Ruby SDK. We welcome contributions from the community and are excited to see what you'll bring to the project.
-
-## Getting Started
-
-1. Fork the repository on GitHub.
-2. Clone your fork locally: `git clone <https://github.com/Loops-so/loops-rb.git`>
-3. Create a new branch for your feature or bug fix: `git checkout -b your-branch-name`
-
-## Making Changes
-
-1. Make your changes in your branch.
-2. Follow the coding style and conventions used in the project.
-3. Write clear, concise commit messages.
-4. Test your changes thoroughly.
-
-## Submitting a Pull Request
-
-1. Push your changes to your fork on GitHub.
-2. From your fork, open a pull request in the correct branch of the main repository.
-3. Provide a clear title and description for your pull request using our PR template.
-4. Link any relevant issues in the pull request description.
-
-## Code of Conduct
-
-Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
-
-## Reporting Bugs
-
-If you find a bug, please open an issue on GitHub. Include as much detail as possible:
-
-- A clear and descriptive title
-- Steps to reproduce the issue
-- Expected behavior
-- Actual behavior
-- Any error messages or screenshots
-
-## Suggesting Enhancements
-
-We welcome suggestions for enhancements! Please open an issue on GitHub with:
-
-- A clear and descriptive title
-- A detailed description of the proposed enhancement
-- Any examples or mock-ups if applicable
-
-## Questions?
-
-If you have any questions, feel free to open an issue or contact the maintainers directly.
-
-Thank you for contributing!

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: :rubocop

data/lib/loops_sdk/custom_fields.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module LoopsSdk
-  class CustomFields < Base
-    class << self
-      def list
-        make_request(:get, "v1/contacts/customFields")
-      end
-    end
-  end
-end

data/sig/loops_sdk.rbs

@@ -1,4 +0,0 @@
-module LoopsSdk
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end