yonoma 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c456a17b6bc182674222649da8d078f1cbe9d2b3576272380ebdbcbe5fa016c4
-  data.tar.gz: fbe633b432234503323bd4160842db7c41519750d2fc1497df863b711c608b2e
+  metadata.gz: 8f782eff8ed3e2b785f3a4cc1d5a83baafdcf4e25436b51404bca5054dac149a
+  data.tar.gz: 0ceff5124f0cc0e5e8f3dea4b7219b57f0e98c3ac2e1b10553ac89e06174ceca
 SHA512:
-  metadata.gz: eb230d860b90c45d81d803ff66336746115d56ec39f02dd5044a63ca1ae1752d85670145c8f517ff9468f128da482cc655a8d9c3de7b8361b8d308cca8e02406
-  data.tar.gz: 269f0296fe4e848b8459b10c8107620e569143b567d9d39766a75c5a4a3f7ef8041537f0dadb6436530b26d463272fef2dfc07fd96a5d2b7576bc3e23ac49119
+  metadata.gz: d1cf346c4e354af8f110e4df7afd4e33e745b7154c13986ddc59389e4c9c24ed396d1645874ad1da3b27b541ff375261d4ab1aed44bb28962bdc0af88d3a7cf7
+  data.tar.gz: 0bd71cbfaa5d6fb10029a0f071360b3187c226b77c9034e71b542fb8ba9bd618f3f928cb2c6f3e7a2e2060691162a29b1528398c1adbe0b9130d07147b24b9ee

data/README.md

@@ -1,4 +1,4 @@
-# Yonoma Ruby SDK
+## [Yonoma](https://yonoma.io/) Ruby Email Marketing SDK
 
 Welcome to the Yonoma Ruby SDK! This gem provides a simple and efficient way to integrate with the Yonoma Email Marketing API.
 
@@ -29,51 +29,134 @@ To configure the SDK, initialize it with your API key:
 ```ruby
 require 'yonoma'
 
-Yonoma::Client.configure do |config|
-  config.api_key = 'your_api_key_here'
-end
+Yonoma.api_key = 'api_key'
 ```
 
-## Usage
-
+### Usage
+#### Send your email:
+```ruby
+response_email = Yonoma::Mail.send({
+    "from_email":"updates@yonoma.io",
+    "to_email":"email@yourdomain.com",
+    "subject":"Welcome to Yonoma - You're In!",
+    "mail_template": "We're excited to welcome you to Yonoma! Your successful signup marks the beginning of what we hope will be an exceptional journey."
+})
+puts response_email
+```
 ### Managing Contacts
 
+#### Create a Contact
 ```ruby
-client = Yonoma::Client.new
-contacts = client.contacts.all
-client.contacts.create(email: 'test@example.com', name: 'John Doe')
+response_contact = Yonoma::Contacts.create("List Id", {
+  "email" : "email@example.com",
+  "status": "Subscribed" | "Unsubscribed"
+  "data": {
+    "firstName": string,
+    "lastName": string,
+    "phone": string,
+    "gender": string,
+    "address": string,
+    "city": string,
+    "state": string,
+    "country": string,
+    "zipcode": string,
+  }
+})
+puts response_contact
 ```
 
-### Managing Lists
+#### Unsubscribe a Contact
+```ruby
+response_contact = Yonoma::Contacts.unsubscribe("List Id", "Contact Id", {
+  "status" : "Subscribed" | "Unsubscribed"
+})
+puts response_contact
+```
 
+#### Add a Tag to a Contact
 ```ruby
-lists = client.lists.all
-client.lists.create(name: 'Newsletter Subscribers')
+response_add_tag = Yonoma::Contacts.add_tag("Contact Id", {
+  "tag_id" : "Tag Id"
+})
+puts response_add_tag
+```
+
+#### Remove a Tag from a Contact
+```ruby
+response_remove_tag = Yonoma::Contacts.remove_tag("Contact Id", {
+  "tag_id" : "Tag Id"
+})
+puts response_remove_tag
 ```
 
 ### Managing Tags
 
+#### Create a Tag
+```ruby
+response_add_tag = Yonoma::Tags.create({
+  "tag_name" : "Tag Name"
+})
+puts response_add_tag
+```
+
+#### Update a Tag
+```ruby
+response_update_tag = Yonoma::Tags.update("Tag Id", {
+  "tag_name" : "Tag Name"
+})
+puts response_update_tag
+```
+
+#### Delete a Tag
 ```ruby
-tags = client.tags.all
-client.tags.create(name: 'VIP Customer')
+response_del_tag = Yonoma::Tags.delete("Tag Id")
+puts response_del_tag
 ```
 
-## Development
+#### Retrieve a Specific Tag
+```ruby
+response_tags_retrieve = Yonoma::Tags.retrieve("Tag Id")
+puts response_tags_retrieve
+```
 
-To contribute to the SDK:
+#### List All Tags
+```ruby
+response_tags = Yonoma::Tags.list()
+puts response_tags
+```
 
-1. Clone the repository
-   ```sh
-   git clone https://github.com/YonomaHQ/yonoma-email-marketing-ruby.git
-   ```
-2. Run `bin/setup` to install dependencies
-3. Run `rake test` to execute tests
-4. Submit a pull request with your changes
+### Managing Lists
 
-## GitHub Repository
-Find the project on GitHub: [Yonoma Ruby SDK](https://github.com/YonomaHQ/yonoma-email-marketing-ruby)
+#### Create a List
+```ruby
+response_add_list = Yonoma::Lists.create({
+  "list_name" : "List Name"
+})
+puts response_add_list
+```
 
-## License
+#### Update a List
+```ruby
+response_update_list = Yonoma::Lists.update("List Id", {
+  "list_name" : "List Name"
+})
+puts response_update_list
+```
 
-This project is licensed under the MIT License. See the `LICENSE` file for details.
+#### Delete a List
+```ruby
+response_del_list = Yonoma::Lists.delete("List Id")
+puts response_del_list
+```
 
+#### Retrieve a Specific List
+```ruby
+response_list_retrieve = Yonoma::Lists.retrieve("List Id")
+puts response_list_retrieve
+```
+
+#### List All Lists
+```ruby
+response_list = Yonoma::Lists.list()
+puts response_list
+```

data/lib/yonoma/mail.rb

@@ -0,0 +1,7 @@
+module Yonoma
+    class Mail
+      def self.send(params)
+        Client.request(:post, "/email/send", params)
+      end
+    end
+end

data/lib/yonoma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yonoma
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/yonoma.rb

@@ -5,6 +5,7 @@ require_relative "yonoma/client"
 require_relative "yonoma/contacts"
 require_relative "yonoma/lists"
 require_relative "yonoma/tags"
+require_relative "yonoma/mail"
 
 module Yonoma
   class Error < StandardError; end

data/yonoma.gemspec

@@ -8,16 +8,15 @@ Gem::Specification.new do |spec|
   spec.authors = ["YonomaHQ"]
   spec.email = ["tools@yonoma.io"]
 
-  spec.summary = "A Ruby gem for managing and sending marketing emails."
-  spec.description = "A Ruby gem for managing and sending marketing emails. This gem provides an easy-to-use interface to create email campaigns, handle mailing lists, and track metrics such as open rates and clicks. Ideal for small businesses and individuals who need a straightforward, code-driven solution for their email marketing needs."
+  spec.summary = "The official Ruby client library for the Yonoma Email Marketing API."
   spec.homepage = "https://yonoma.io/"
   spec.required_ruby_version = ">= 3.1.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/YonomaHQ/yonoma-email-marketing-ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/YonomaHQ/yonoma-email-marketing-ruby/releases"
+  spec.metadata["source_code_uri"] = "https://github.com/YonomaHQ/yonoma-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/YonomaHQ/yonoma-ruby/releases"
   spec.license = "MIT"
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: yonoma
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - YonomaHQ
 bindir: exe
 cert_chain: []
-date: 2025-03-05 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -37,10 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-description: A Ruby gem for managing and sending marketing emails. This gem provides
-  an easy-to-use interface to create email campaigns, handle mailing lists, and track
-  metrics such as open rates and clicks. Ideal for small businesses and individuals
-  who need a straightforward, code-driven solution for their email marketing needs.
 email:
 - tools@yonoma.io
 executables: []
@@ -53,6 +49,7 @@ files:
 - lib/yonoma/client.rb
 - lib/yonoma/contacts.rb
 - lib/yonoma/lists.rb
+- lib/yonoma/mail.rb
 - lib/yonoma/tags.rb
 - lib/yonoma/version.rb
 - yonoma.gemspec
@@ -62,8 +59,8 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://yonoma.io/
-  source_code_uri: https://github.com/YonomaHQ/yonoma-email-marketing-ruby
-  changelog_uri: https://github.com/YonomaHQ/yonoma-email-marketing-ruby/releases
+  source_code_uri: https://github.com/YonomaHQ/yonoma-ruby
+  changelog_uri: https://github.com/YonomaHQ/yonoma-ruby/releases
 rdoc_options: []
 require_paths:
 - lib
@@ -80,5 +77,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.5
 specification_version: 4
-summary: A Ruby gem for managing and sending marketing emails.
+summary: The official Ruby client library for the Yonoma Email Marketing API.
 test_files: []