mailchimp-rest-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e12dd5f9138dd42df18a44d79b07a9d7d280a8c09694a64e5c9e7963dd6d992
-  data.tar.gz: 7fd21428cd4d12c5881e2eea7bc4c3a045742bfd9120b01cf1a62704e834b814
+  metadata.gz: cd8e4ac41f0ff072d449fab1c0466bed09d533def2a97db463a0dd76e47aaef2
+  data.tar.gz: 24fccb0d0eb4175d77055bdd5ce4e935789cbd5b6ed700d17f7d98ab86ada034
 SHA512:
-  metadata.gz: 4fdebf9fbf90a37a171ec67d64c3ff8c53361cf4bc0d90a22649ddb14f962e76f4f4742ef7ac16b6bdbcc8be49677557f3debe8a2f6dd229101d58641ec9a993
-  data.tar.gz: 948ee7442f8a69395c4d1743cb4b91140f32820f96d4bf4709e4c625699bc551092cc2648700540c5e26418f5f05a0523957b90baa8e5d1d45daeec138544906
+  metadata.gz: 8cc1fa18308afd486cb4418317f8809d9e2758df9a1ea4087aaea57ba66db3570ae91fc99faccd8472a4663f22800151519b5c4c350f750f275a484c147544fe
+  data.tar.gz: 0df6d93f8742d35b73372a5b7ce139723102261f046243e77bcb30f90937fa519a93e0c1fd4e267bc67bb5a38c9932907d5a2373a0f27ac49f81d763bd4465f5

data/README.md

@@ -60,6 +60,52 @@ MailchimpAPI.audience_members.create(audience_id, body: body)
 - `response.success?` - checks HTTP status code is 2xx
 - `response.failed?` - checks HTTP status code is not 2xx
 
+## Errors
+
+All error classes inherit from `MailchimpAPI::Error` and provide:
+
+- `error_type` - Error type returned by Mailchimp
+- `error_title` - Error title or response error class name
+- `error_status` - Error status or HTTP status
+- `error_detail` - Error description from Mailchimp
+- `error_fields` - Field-specific errors
+- `error_instance` - Error ID from Mailchimp
+- `response` - Response object
+- `request` - Request object
+
+MailchimpAPI provides specific error classes for different types of errors:
+
+### Network Errors
+
+- `MailchimpAPI::Errors::NetworkError` - Raised when a network error occurs
+  during request execution
+
+### HTTP Status Code Errors
+
+- `MailchimpAPI::Errors::BadRequest` (400) - Invalid request parameters
+- `MailchimpAPI::Errors::Unauthorized` (401) - Invalid API key
+- `MailchimpAPI::Errors::Forbidden` (403) - Insufficient permissions
+- `MailchimpAPI::Errors::NotFound` (404) - Resource not found
+- `MailchimpAPI::Errors::MethodNotAllowed` (405) - HTTP method not allowed
+- `MailchimpAPI::Errors::RequestURITooLong` (414) - Request URI too long
+- `MailchimpAPI::Errors::UnprocessableEntity` (422) - Request validation failed
+- `MailchimpAPI::Errors::UpgradeRequired` (426) - API version upgrade required
+- `MailchimpAPI::Errors::TooManyRequests` (429) - Rate limit exceeded
+- `MailchimpAPI::Errors::ServerError` (5xx) - Mailchimp server error
+
+Example:
+
+```ruby
+begin
+  MailchimpAPI.audience_members.create(audience_id, body: body)
+rescue MailchimpAPI::Errors::UnprocessableEntity => e
+  puts "Validation failed: #{e.error_detail}"
+  puts "Field errors: #{e.error_fields}"
+rescue MailchimpAPI::Errors::NetworkError => e
+  puts "Network error: #{e.error_detail}"
+end
+```
+
 ## Configuration options
 
 MailchimpAPI client accepts this additional options:
@@ -128,13 +174,46 @@ end
 
 ...
 
-## Errors
+## APIs
 
-...
+### Audience Members
 
-## APIs
+- List `MailchimpAPI.audience_members.get(audience_id)`
+- Create `MailchimpAPI.audience_members.create(audience_id, body: body)`
+- Show `MailchimpAPI.audience_members.show(audience_id, email)`
+- Update `MailchimpAPI.audience_members.update(audience_id, email, body: body)`
+- Add or Update `MailchimpAPI.audience_members.add_or_update(audience_id, email, body: body)`
+- Archive `MailchimpAPI.audience_members.delete(audience_id, email)`
+- Delete Permanently `MailchimpAPI.audience_members.delete(audience_id, email)`
 
-...
+### Audience Member Tags
+
+- List `MailchimpAPI.audience_member_tags.get(audience_id, email)`
+- Create `MailchimpAPI.audience_member_tags.create(audience_id, email, body: body)`
+
+### Audience Webhooks
+
+- List `MailchimpAPI.audience_webhooks.get(audience_id)`
+- Create `MailchimpAPI.audience_webhooks.create(audience_id, body: body)`
+- Show `MailchimpAPI.audience_webhooks.show(audience_id, webhook_id)`
+- Update `MailchimpAPI.audience_webhooks.update(audience_id, webhook_id, body: body)`
+- Delete `MailchimpAPI.audience_webhooks.delete(audience_id, webhook_id)`
+
+### Audience Interest Categories
+
+- List `MailchimpAPI.audience_interest_categories.get(audience_id)`
+- Create `MailchimpAPI.audience_interest_categories.create(audience_id, body: body)`
+- Show `MailchimpAPI.audience_interest_categories.show(audience_id, webhook_id)`
+- Update `MailchimpAPI.audience_interest_categories.update(audience_id, webhook_id, body: body)`
+- Delete `MailchimpAPI.audience_interest_categories.delete(audience_id, webhook_id)`
+
+### Audience Interests
+
+- List `MailchimpAPI.audience_interests.get(audience_id)`
+- Create `MailchimpAPI.audience_interests.create(audience_id, body: body)`
+- Show `MailchimpAPI.audience_interests.show(audience_id, webhook_id)`
+- Update `MailchimpAPI.audience_interests.update(audience_id, webhook_id, body: body)`
+- Delete `MailchimpAPI.audience_interests.delete(audience_id, webhook_id)`
 
 ## Development
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/mailchimp-api/client/api_methods.rb

@@ -6,13 +6,25 @@ module MailchimpAPI
     # Methods to access API resources
     #
     module APIMethods
-      def audience_members
-        Audience::Members.new(self)
+      def audience_interest_categories
+        Audience::InterestCategories.new(self)
+      end
+
+      def audience_interests
+        Audience::Interests.new(self)
       end
 
       def audience_member_tags
         Audience::MemberTags.new(self)
       end
+
+      def audience_members
+        Audience::Members.new(self)
+      end
+
+      def audience_webhooks
+        Audience::Webhooks.new(self)
+      end
     end
   end
 end

data/lib/mailchimp-api/resources/audience/interest_categories.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  module Audience
+    class InterestCategories < Resource
+      module APIs
+        def list(list_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/interest-categories"
+          client.get(path, query: query, body: body, headers: headers)
+        end
+
+        def create(list_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/interest-categories"
+          client.post(path, query: query, body: body, headers: headers)
+        end
+
+        def show(list_id, interest_category_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/interest-categories/#{interest_category_id}"
+          client.get(path, query: query, body: body, headers: headers)
+        end
+
+        def delete(list_id, interest_category_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/interest-categories/#{interest_category_id}"
+          client.delete(path, query: query, body: body, headers: headers)
+        end
+
+        def update(list_id, interest_category_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/interest-categories/#{interest_category_id}"
+          client.patch(path, query: query, body: body, headers: headers)
+        end
+      end
+
+      include APIs
+      extend APIs
+    end
+  end
+end

data/lib/mailchimp-api/resources/audience/interests.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  module Audience
+    class Interests < Resource
+      module APIs
+        def list(list_id, interest_category_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/interest-categories/#{interest_category_id}/interests"
+          client.get(path, query: query, body: body, headers: headers)
+        end
+
+        def create(list_id, interest_category_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/interest-categories/#{interest_category_id}/interests"
+          client.post(path, query: query, body: body, headers: headers)
+        end
+
+        def show(list_id, interest_category_id, interest_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/interest-categories/#{interest_category_id}/interests/#{interest_id}"
+          client.get(path, query: query, body: body, headers: headers)
+        end
+
+        def delete(list_id, interest_category_id, interest_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/interest-categories/#{interest_category_id}/interests/#{interest_id}"
+          client.delete(path, query: query, body: body, headers: headers)
+        end
+
+        def update(list_id, interest_category_id, interest_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/interest-categories/#{interest_category_id}/interests/#{interest_id}"
+          client.patch(path, query: query, body: body, headers: headers)
+        end
+      end
+
+      include APIs
+      extend APIs
+    end
+  end
+end

data/lib/mailchimp-api/resources/audience/member_tags.rb

@@ -4,13 +4,13 @@ module MailchimpAPI
   module Audience
     class MemberTags < Resource
       module APIs
-        def list(audience_id, email, query: nil, body: nil, headers: nil)
-          path = "/lists/#{audience_id}/members/#{subscriber_hash(email)}/tags"
+        def list(list_id, email, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/members/#{subscriber_hash(email)}/tags"
           client.get(path, query: query, body: body, headers: headers)
         end
 
-        def create(audience_id, email, query: nil, body: nil, headers: nil)
-          path = "/lists/#{audience_id}/members/#{subscriber_hash(email)}/tags"
+        def create(list_id, email, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/members/#{subscriber_hash(email)}/tags"
           client.post(path, query: query, body: body, headers: headers)
         end
       end

data/lib/mailchimp-api/resources/audience/members.rb

@@ -4,38 +4,38 @@ module MailchimpAPI
   module Audience
     class Members < Resource
       module APIs
-        def list(audience_id, query: nil, body: nil, headers: nil)
-          path = "/lists/#{audience_id}/members"
+        def list(list_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/members"
           client.get(path, query: query, body: body, headers: headers)
         end
 
-        def create(audience_id, query: nil, body: nil, headers: nil)
-          path = "/lists/#{audience_id}/members"
+        def create(list_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/members"
           client.post(path, query: query, body: body, headers: headers)
         end
 
-        def show(audience_id, email, query: nil, body: nil, headers: nil)
-          path = "/lists/#{audience_id}/members/#{subscriber_hash(email)}"
+        def show(list_id, email, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/members/#{subscriber_hash(email)}"
           client.get(path, query: query, body: body, headers: headers)
         end
 
-        def archive(audience_id, email, query: nil, body: nil, headers: nil)
-          path = "/lists/#{audience_id}/members/#{subscriber_hash(email)}"
+        def archive(list_id, email, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/members/#{subscriber_hash(email)}"
           client.delete(path, query: query, body: body, headers: headers)
         end
 
-        def update(audience_id, email, query: nil, body: nil, headers: nil)
-          path = "/lists/#{audience_id}/members/#{subscriber_hash(email)}"
+        def update(list_id, email, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/members/#{subscriber_hash(email)}"
           client.patch(path, query: query, body: body, headers: headers)
         end
 
-        def add_or_update(audience_id, email, query: nil, body: nil, headers: nil)
-          path = "/lists/#{audience_id}/members/#{subscriber_hash(email)}"
+        def add_or_update(list_id, email, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/members/#{subscriber_hash(email)}"
           client.put(path, query: query, body: body, headers: headers)
         end
 
-        def delete_permanent(audience_id, email, query: nil, body: nil, headers: nil)
-          path = "/lists/#{audience_id}/members/#{subscriber_hash(email)}/actions/delete-permanent"
+        def delete_permanent(list_id, email, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/members/#{subscriber_hash(email)}/actions/delete-permanent"
           client.post(path, query: query, body: body, headers: headers)
         end
       end

data/lib/mailchimp-api/resources/audience/webhooks.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  module Audience
+    class Webhooks < Resource
+      module APIs
+        def list(list_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/webhooks"
+          client.get(path, query: query, body: body, headers: headers)
+        end
+
+        def create(list_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/webhooks"
+          client.post(path, query: query, body: body, headers: headers)
+        end
+
+        def show(list_id, webhook_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/webhooks/#{webhook_id}"
+          client.get(path, query: query, body: body, headers: headers)
+        end
+
+        def delete(list_id, webhook_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/webhooks/#{webhook_id}"
+          client.delete(path, query: query, body: body, headers: headers)
+        end
+
+        def update(list_id, webhook_id, query: nil, body: nil, headers: nil)
+          path = "/lists/#{list_id}/webhooks/#{webhook_id}"
+          client.patch(path, query: query, body: body, headers: headers)
+        end
+      end
+
+      include APIs
+      extend APIs
+    end
+  end
+end

data/lib/mailchimp-api.rb

@@ -35,8 +35,11 @@ module MailchimpAPI
 
     # Resources
     def_delegators :@client,
+      :audience_interest_categories,
+      :audience_interests,
+      :audience_member_tags,
       :audience_members,
-      :audience_member_tags
+      :audience_webhooks
 
     def client
       raise "#{name}.client must be set" unless @client
@@ -48,8 +51,11 @@ end
 
 require_relative "mailchimp-api/resource"
 require_relative "mailchimp-api/resources/audience/utils/subscriber_hash"
+require_relative "mailchimp-api/resources/audience/interest_categories"
+require_relative "mailchimp-api/resources/audience/interests"
 require_relative "mailchimp-api/resources/audience/member_tags"
 require_relative "mailchimp-api/resources/audience/members"
+require_relative "mailchimp-api/resources/audience/webhooks"
 require_relative "mailchimp-api/batch_request"
 require_relative "mailchimp-api/client/api_methods"
 require_relative "mailchimp-api/client/batch_methods"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailchimp-rest-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrey Glushkov
@@ -31,9 +31,12 @@ files:
 - lib/mailchimp-api/request.rb
 - lib/mailchimp-api/request_executor.rb
 - lib/mailchimp-api/resource.rb
+- lib/mailchimp-api/resources/audience/interest_categories.rb
+- lib/mailchimp-api/resources/audience/interests.rb
 - lib/mailchimp-api/resources/audience/member_tags.rb
 - lib/mailchimp-api/resources/audience/members.rb
 - lib/mailchimp-api/resources/audience/utils/subscriber_hash.rb
+- lib/mailchimp-api/resources/audience/webhooks.rb
 - lib/mailchimp-api/response.rb
 - lib/mailchimp-api/uri_builder.rb
 - lib/mailchimp-api/version.rb