loops_sdk 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5cbc02e88853c1dfb986f2d18fc113badcc569865c83c21a58d42809651245c
-  data.tar.gz: d38a4ff09a27e949dcae803cbd9c4f143f32b8dfb7100e6e3cbdc9323d61ccb9
+  metadata.gz: 0a8b0b6350209acdbb57d8414d35d24c27dc3b53ddbb8dfebf30893221863483
+  data.tar.gz: 462b317da348740e35285efb05d67aa59f71adb54644094f2fe666b6968f8fad
 SHA512:
-  metadata.gz: e9298ac3c8a13c8e207a1c621bd74a5370881537e11a520a85dc2b9ac7a302ece4d2b13a3997c8726b825a474391624d8f5127610823f4dbb5bb75c3bde7b90f
-  data.tar.gz: c3b0de412fea85c5635880c5bdf962164fac8884cd25344b46ad975125dacd89809c541ce4cc921c0e2b304b6204b12fe15455b905479b0593d093126a70c175
+  metadata.gz: 2a4b0181a592ff98fda831db5235def393d934375957215cb223219148dce1cbe940271ff5a6881dddec2dc5a9b68bc307009d1ebce947a2522aa672f6f8d752
+  data.tar.gz: b6134652c05daf397d23c1a30bf86fb89f8ae681c60b88e645f6921941f2c327dc1acedc2e86c6db26addb819e7e2b09287373e58460942aaa66766471e1a2c9

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 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`.

data/README.md

@@ -38,9 +38,10 @@ LoopsSdk.configure do |config|
 end
 ```
 
+Then you can call methods in your code:
+
 ```ruby
 begin
-
   response = LoopsSdk::Transactional.send(
     transactional_id: "closfz8ui02yq......",
     email: "dan@loops.so",
@@ -48,11 +49,12 @@ begin
       loginUrl: "https://app.domain.com/login?code=1234567890"
     }
   )
-
   render json: response
 
 rescue LoopsSdk::APIError => e
-  # Do something if there is an error from the API
+  # JSON returned by the API is in error.json and the HTTP code is in error.statusCode
+  # Error messages explaining the issue can be found in error.json['message']
+  Rails.logger.error("Loops API Error: #{e.json['message']} (Status: #{e.statusCode})")
 end
 ```
 
@@ -98,15 +100,16 @@ You can use custom contact properties in API calls. Please make sure to [add cus
 
 ## Methods
 
-- [ApiKey.test()](#apikey-test)
-- [Contacts.create()](#contacts-create)
-- [Contacts.update()](#contacts-update)
-- [Contacts.find()](#contacts-find)
-- [Contacts.delete()](#contacts-delete)
-- [MailingLists.list()](#mailinglists-list)
-- [Events.send()](#events-send)
-- [Transactional.send()](#transactional-send)
-- [CustomFields.list()](#customfields-list)
+- [ApiKey.test()](#apikeytest)
+- [Contacts.create()](#contactscreate)
+- [Contacts.update()](#contactsupdate)
+- [Contacts.find()](#contactsfind)
+- [Contacts.delete()](#contactsdelete)
+- [ContactProperties.create()](#contactpropertiescreate)
+- [ContactProperties.list()](#contactpropertieslist)
+- [MailingLists.list()](#mailinglistslist)
+- [Events.send()](#eventssend)
+- [Transactional.send()](#transactionalsend)
 
 ---
 
@@ -145,7 +148,7 @@ This method will return a success or error message:
 
 ---
 
-## Contacts.create()
+### Contacts.create()
 
 Create a new contact.
 
@@ -199,7 +202,7 @@ This method will return a success or error message:
 
 ---
 
-## Contacts.update()
+### Contacts.update()
 
 Update a contact.
 
@@ -348,6 +351,133 @@ This method will return a success or error message:
 
 ---
 
+### ContactProperties.create()
+
+Create a new contact property.
+
+[API Reference](https://loops.so/docs/api-reference/create-contact-property)
+
+#### Parameters
+
+| Name   | Type   | Required | Notes                                                                                  |
+| ------ | ------ | -------- | -------------------------------------------------------------------------------------- |
+| `name` | string | Yes      | The name of the property. Should be in camelCase, like `planName` or `favouriteColor`. |
+| `type` | string | Yes      | The property's value type.<br />Can be one of `string`, `number`, `boolean` or `date`. |
+
+#### Examples
+
+```ruby
+response = LoopsSdk::ContactProperties.create(
+  name: "planName",
+  type: "string"
+)
+```
+
+#### Response
+
+This method will return a success or error message:
+
+```json
+{
+  "success": true
+}
+```
+
+```json
+{
+  "success": false,
+  "message": "An error message here."
+}
+```
+
+---
+
+### ContactProperties.list()
+
+Get a list of your account's contact properties.
+
+[API Reference](https://loops.so/docs/api-reference/list-contact-properties)
+
+#### Parameters
+
+| Name   | Type   | Required | Notes                                                           |
+| ------ | ------ | -------- | --------------------------------------------------------------- |
+| `list` | string | No       | Use "custom" to retrieve only your account's custom properties. |
+
+#### Example
+
+```ruby
+response = LoopsSdk::ContactProperties.list
+
+response = LoopsSdk::ContactProperties.list(list: "custom")
+```
+
+#### Response
+
+This method will return a list of contact property objects containing `key`, `label` and `type` attributes.
+
+```json
+[
+  {
+    "key": "firstName",
+    "label": "First Name",
+    "type": "string"
+  },
+  {
+    "key": "lastName",
+    "label": "Last Name",
+    "type": "string"
+  },
+  {
+    "key": "email",
+    "label": "Email",
+    "type": "string"
+  },
+  {
+    "key": "notes",
+    "label": "Notes",
+    "type": "string"
+  },
+  {
+    "key": "source",
+    "label": "Source",
+    "type": "string"
+  },
+  {
+    "key": "userGroup",
+    "label": "User Group",
+    "type": "string"
+  },
+  {
+    "key": "userId",
+    "label": "User Id",
+    "type": "string"
+  },
+  {
+    "key": "subscribed",
+    "label": "Subscribed",
+    "type": "boolean"
+  },
+  {
+    "key": "createdAt",
+    "label": "Created At",
+    "type": "date"
+  },
+  {
+    "key": "favoriteColor",
+    "label": "Favorite Color",
+    "type": "string"
+  },
+  {
+    "key": "plan",
+    "label": "Plan",
+    "type": "string"
+  }
+]
+```
+
+---
+
 ### MailingLists.list()
 
 Get a list of your account's mailing lists. [Read more about mailing lists](https://loops.so/docs/contacts/mailing-lists)
@@ -366,7 +496,7 @@ response = LoopsSdk::MailingLists.list
 
 #### Response
 
-This method will return a list of mailing list objects containing `id`, `name` and `isPublic` attributes.
+This method will return a list of mailing list objects containing `id`, `name`, `description` and `isPublic` attributes.
 
 If your account has no mailing lists, an empty list will be returned.
 
@@ -375,11 +505,13 @@ If your account has no mailing lists, an empty list will be returned.
   {
     "id": "cm06f5v0e45nf0ml5754o9cix",
     "name": "Main list",
+    "description": "All customers.",
     "isPublic": true
   },
   {
     "id": "cm16k73gq014h0mmj5b6jdi9r",
     "name": "Investors",
+    "description": null,
     "isPublic": false
   }
 ]
@@ -504,7 +636,7 @@ response = LoopsSdk::Transactional.send(
       data: "JVBERi0xLjMKJcTl8uXrp/Og0MTGCjQgMCBvYmoKPD...",
     },
   ],
-})
+)
 ```
 
 #### Response
@@ -540,45 +672,6 @@ If there is a problem with the request, a descriptive error message will be retu
 
 ---
 
-### CustomFields.list()
-
-Get a list of your account's custom fields. These are custom properties that can be added to contacts to store extra data. [Read more about contact properties](https://loops.so/docs/contacts/properties)
-
-[API Reference](https://loops.so/docs/api-reference/list-custom-fields)
-
-#### Parameters
-
-None
-
-#### Example
-
-```ruby
-response LoopsSdk::CustomFields.list
-```
-
-#### Response
-
-This method will return a list of custom field objects containing `key`, `label` and `type` attributes.
-
-If your account has no custom fields, an empty list will be returned.
-
-```json
-[
-  {
-    "key": "favoriteColor",
-    "label": "Favorite Color",
-    "type": "string"
-  },
-  {
-    "key": "plan",
-    "label": "Plan",
-    "type": "string"
-  }
-]
-```
-
----
-
 ## Contributing
 
 Bug reports and pull requests are welcome. Please read our [Contributing Guidelines](CONTRIBUTING.md).

data/lib/loops_sdk/base.rb

@@ -40,12 +40,18 @@ module LoopsSdk
   end
 
   class APIError < StandardError
-    attr_reader :status, :body
+    attr_reader :statusCode, :json
 
     def initialize(status, body)
-      @status = status
-      @body = body
-      super("API request failed with status #{status}: #{body}")
+      @statusCode = status
+      @json = body
+      message = begin
+                  parsed = JSON.parse(body)
+                  parsed["message"] ? ": #{parsed["message"]}" : ""
+                rescue JSON::ParserError
+                  ""
+                end
+      super("API request failed with status #{statusCode}#{message}")
     end
   end
 end

data/lib/loops_sdk/version.rb

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

data/lib/loops_sdk.rb

@@ -9,7 +9,7 @@ require_relative "loops_sdk/contacts"
 require_relative "loops_sdk/events"
 require_relative "loops_sdk/mailing_lists"
 require_relative "loops_sdk/transactional"
-require_relative "loops_sdk/custom_fields"
+require_relative "loops_sdk/contact_properties"
 require_relative "loops_sdk/api_key"
 
 module LoopsSdk

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loops_sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Dan Rowden
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-29 00:00:00.000000000 Z
+date: 2025-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday