yonoma 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c456a17b6bc182674222649da8d078f1cbe9d2b3576272380ebdbcbe5fa016c4
-  data.tar.gz: fbe633b432234503323bd4160842db7c41519750d2fc1497df863b711c608b2e
+  metadata.gz: 3aa4cde2f26f8817db1751a17d893eb4c7c61f3a8b847a7da5304dd97c376e23
+  data.tar.gz: 59a941a57b02aa14e22ae54c049879e1a8cacc517b0cc46653a1dfef481eef10
 SHA512:
-  metadata.gz: eb230d860b90c45d81d803ff66336746115d56ec39f02dd5044a63ca1ae1752d85670145c8f517ff9468f128da482cc655a8d9c3de7b8361b8d308cca8e02406
-  data.tar.gz: 269f0296fe4e848b8459b10c8107620e569143b567d9d39766a75c5a4a3f7ef8041537f0dadb6436530b26d463272fef2dfc07fd96a5d2b7576bc3e23ac49119
+  metadata.gz: 55a393f3a80d2f4fe3960d721c863cfce2d9b520f6bc940f25abb17c696c340b9c6cd2b9fc59bb2e8a196b9be77ead68390b97618e58c3d9954aa34fec819f31
+  data.tar.gz: '0644490625d841d8d57c59f3287db2349014ec3e659fd9d1f15aa903612b125f2b7d6bd529598f4cf69e0ce64c1c8607061f4d8cbf57f03ce7aef9babbb996ef'

data/README.md

@@ -30,7 +30,7 @@ To configure the SDK, initialize it with your API key:
 require 'yonoma'
 
 Yonoma::Client.configure do |config|
-  config.api_key = 'your_api_key_here'
+  config.api_key = api_key
 end
 ```
 
@@ -38,24 +38,120 @@ end
 
 ### 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
+response_del_tag = Yonoma::Tags.delete("Tag Id")
+puts response_del_tag
+```
+
+#### Retrieve a Specific Tag
+```ruby
+response_tags_retrieve = Yonoma::Tags.retrieve("Tag Id")
+puts response_tags_retrieve
+```
+
+#### List All Tags
+```ruby
+response_tags = Yonoma::Tags.list()
+puts response_tags
+```
+
+### Managing Lists
+
+#### Create a List
+```ruby
+response_add_list = Yonoma::Lists.create({
+  "list_name" : "List Name"
+})
+puts response_add_list
+```
+
+#### Update a List
+```ruby
+response_update_list = Yonoma::Lists.update("List Id", {
+  "list_name" : "List Name"
+})
+puts response_update_list
+```
+
+#### 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
-tags = client.tags.all
-client.tags.create(name: 'VIP Customer')
+response_list = Yonoma::Lists.list()
+puts response_list
 ```
 
 ## Development
@@ -64,14 +160,14 @@ To contribute to the SDK:
 
 1. Clone the repository
    ```sh
-   git clone https://github.com/YonomaHQ/yonoma-email-marketing-ruby.git
+   git clone https://github.com/YonoamaHQ/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
 
 ## GitHub Repository
-Find the project on GitHub: [Yonoma Ruby SDK](https://github.com/YonomaHQ/yonoma-email-marketing-ruby)
+Find the project on GitHub: [Yonoma Ruby SDK](https://github.com/YonoamaHQ/yonoma-email-marketing-ruby)
 
 ## License
 

data/lib/yonoma/version.rb

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

data/yonoma.gemspec

@@ -8,8 +8,7 @@ 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"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yonoma
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - YonomaHQ
@@ -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: []
@@ -80,5 +76,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: []