active_campaign_wrapper 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1590dc0b398aa32233b19bcf394874316aa2d5c1a0b38b569fdfe57d333ab97e
-  data.tar.gz: 2946ac23c953474593a0dbde6e5aafa27e2843acb60e660139044eb7a9b3d943
+  metadata.gz: a735bcf1cf52db420446e13c246621ba8eb009a5d776e1889c68355bd11e811f
+  data.tar.gz: b154ef14ee4a7e9ff35f68cd65bb198e335b3de3071cf331be79a200fa14035c
 SHA512:
-  metadata.gz: 920d304e2e617f68af61d8238e67b3f23b5d6e9a44f99a930e6316b5a9781ae5184f846985db7aec4e7677b466a26b71b3a7d0d0bc675afd9ea23373873c35ae
-  data.tar.gz: 72e5fa0c1a16b06de14dc775f975cdfbc331f019841bbd049b9d991cc82640ff222de2d1e2b8b5395c7a55110166ee51f19eea9032ad1175a3248cda8d2f067e
+  metadata.gz: 3eea2118267ad4e4be0a012f6e04f8a10c66aa7b82045bd828ac984a073afc5decc1c59252483239e517a6e86ac74a2264482434415ffb3d976536eecac0cc65
+  data.tar.gz: c61f5a8c3f8fd38d79dd556a8bf8bacd80ffcf773c5e3868eb5586472469c688eb4d2902603c7734e8ebcaa1a1b70eee57bcffa1559da4578c917d0cae384dae

data/README.md

@@ -4,6 +4,7 @@
 [![Test Coverage](https://codecov.io/gh/anmol-yousaf/active_campaign_wrapper/graph/badge.svg)](https://codecov.io/gh/anmol-yousaf/active_campaign_wrapper)
 
 This library is designed to help ruby/rails based applications communicate with the publicly available REST API for ActiveCampaign.
+It also supports a lot of functionality which is currently undocumented in the REST API.
 
 If you are unfamiliar with the ActiveCampaign REST API, you should first read the documentation located at https://developers.activecampaign.com/reference.
 
@@ -30,6 +31,7 @@ Or install it yourself as:
 * [Initialize](#initialize)
 * [Tags](#tags)
 * [Lists](#lists)
+* [List Groups](#list-groups)
 * [Contacts](#contacts)
 * [Contact Tags](#contact-tags)
 * [Contact Automations](#contact-automations)
@@ -38,7 +40,9 @@ Or install it yourself as:
 * [Custom Fields](#custom-fields)
 * [Custom Field Options](#custom-field-options)
 * [Custom Field Values](#custom-field-values)
-
+* [Users](#users)
+* [Groups](#groups)
+* [Templates](#templates)
 
 <a name="initialize"/>
 
@@ -168,9 +172,43 @@ client.lists.all
 **QUERY PARAMS** (Optional)
 - filters[name]  (string): Filter by the name of the list.
 
+<a name="list-groups"/>
+
+### List Groups - [Api Reference](https://developers.activecampaign.com/reference#create-a-list-group-permission)
+
+#### Create a list group permission
+
+```ruby
+client.list_groups.create({
+  listid: list_id,
+  groupid: group_id
+})
+```
+**BODY PARAMS**
+- listid* (integer): ID of the list
+- groupid* (integer): ID of the group that list should be associated with
+
+#### Retrieve a list group permission
+
+```ruby
+client.list_groups.find(list_group_id)
+```
+
+#### Delete a list group permission
+
+```ruby
+client.list_groups.delete(list_group_id)
+```
+
+#### Retrieve all list group permissions
+
+```ruby
+client.list_groups.all
+```
+
 <a name="contacts"/>
 
-#### Contacts - [Api Reference](https://developers.activecampaign.com/reference#contact)
+### Contacts - [Api Reference](https://developers.activecampaign.com/reference#contact)
 
 #### Create a contact
 
@@ -184,12 +222,6 @@ client.contacts.create({
 
 **BODY PARAMS**
 - email* (string): Email address of the new contact. Example: 'test@example.com'
-- status (integer) Status of your contact. Possible Values: -1..3
-  - -1 Any
-  - 0 Unconfirmed
-  - 1 Active
-  - 2 Unsubscribed
-  - 3 Bounced
 - first_name (string): First name of the new contact.
 - last_name (string): Last name of the new contact.
 - phone (integer): Phone number of the contact.
@@ -218,7 +250,14 @@ client.contacts.update_list_status({
 **BODY PARAMS**
 - list* (string/integer):ID of the list to subscribe the contact to
 - contact* (string/integer): ID of the contact to subscribe to the list
-- status* (string/integer): Set to "1" to subscribe the contact to the list. Set to "2" to unsubscribe the contact from the list. WARNING: If you change a status from unsubscribed to active, you can re-subscribe a contact to a list from which they had manually unsubscribed.
+- status* (string/integer): Possible Values: -1..3
+  - -1 Any
+  - 0 Unconfirmed
+  - 1 Active
+  - 2 Unsubscribed
+  - 3 Bounced
+  
+  Set to "1" to subscribe the contact to the list. Set to "2" to unsubscribe the contact from the list. WARNING: If you change a status from unsubscribed to active, you can re-subscribe a contact to a list from which they had manually unsubscribed.
 - sourceid (integer): Set to "4" when re-subscribing a contact to a list
 
 #### Retrieve a contact
@@ -259,7 +298,6 @@ client.contacts.all
 - search (string): Filter contacts that match the given value in the contact names, organization, phone or email
 - segmentid (integer): Return only contacts that match a list segment (this param initially returns segment information, when it is run a second time it will return contacts that match the segment)
 - seriesid (integer): Filter contacts associated with the given automation
-- status (integer): -1..3
 - tagid (integer): Filter contacts associated with the given tag
 - filters[created_before]  (date) Filter contacts that were created prior to this date
 - filters[created_after]  (date): Filter contacts that were created after this date
@@ -525,6 +563,192 @@ client.custom_field_values.delete(field_value_id)
 ```ruby
 client.custom_field_values.all
 ```
+<a name="users"/>
+
+### Users - [Api Reference](https://developers.activecampaign.com/reference#users)
+
+#### Create a user
+
+```ruby
+client.users.create({
+  first_name: 'Phoebe',
+  last_name: 'Buffay',
+  username: 'raginaphalange',
+  password: 'smellycat',
+  email: 'ragina.phalange@smellycat.com'
+})
+```
+**BODY PARAMS**
+- username* (string): Username
+- email (string): Email address
+- first_name (string): First name
+- last_name (string): Last name
+- group (string/integer): Group ID
+- password (string): Plain text password
+
+#### Retrieve a user
+
+```ruby
+client.users.find(user_id)
+```
+
+#### Retrieve logged in user
+
+```ruby
+client.users.logged_in
+```
+
+#### Retrieve a user by email
+
+```ruby
+client.users.find_by_email(email)
+```
+
+#### Retrieve a user by username
+
+```ruby
+client.users.find_by_username(username)
+```
+
+#### Update a user
+
+```ruby
+client.users.update(user_id, {
+  password: 'newsmellycat',
+  group: group_id
+})
+```
+*Note*: Group ID is mandatory in update.
+
+#### Delete a user
+
+```ruby
+client.users.delete(user_id)
+```
+
+#### List all users
+
+```ruby
+client.users.all
+```
+
+<a name="groups"/>
+
+### Groups - [Api Reference](https://developers.activecampaign.com/reference#groups)
+
+#### Create a group
+
+```ruby
+client.groups.create({
+  title: 'Admin',
+  descript: 'This is a group for admin users (people that can manage content)'
+})
+```
+**BODY PARAMS**
+- title* (string): Title of the group to be created
+- descript (string): Group description
+- pg_message_add (boolean): Permission for adding messages
+- unsubscribelink (boolean): Whether or not to force unsubscribe links
+- optinconfirm (boolean): Whether or not to force optin confirm for this group
+- pg_list_add (boolean): Permission for adding lists
+- pg_list_edit (boolean): Permission for editing lists
+- pg_list_delete (boolean): Permission for deleting lists
+- pg_list_headers (boolean): Permission for managing custom email headers
+- pg_list_emailaccount (boolean): Permission for managing Unsubscribe By Email
+- pg_list_bounce (boolean): Permission for accessing list bounce settings
+- pg_message_edit (boolean): Permission for editing messages
+- pg_message_delete (boolean): Permission for deleting messages
+- pg_message_send (boolean): Permission for sending messages
+- pg_contact_add (boolean): Permission for adding contacts
+- pg_contact_edit (boolean): Permission for editing contacts
+- pg_contact_delete (boolean): Permission for deleting contacts
+- pg_contact_merge (boolean): Permission for merging contacts
+- pg_contact_import (boolean): Permission for importing contacts
+- pg_contact_approve (boolean): Permission for approving contacts
+- pg_contact_export (boolean): Permission for exporting contacts
+- pg_contact_sync (boolean): Permission for syncing contacts
+- pg_contact_filters (boolean): Permission for managing contact list segments
+- pg_contact_actions (boolean): Permission for managing contact actions
+- pg_contact_fields (boolean): Permission for managing contact custom fields
+- pg_user_add (boolean): Permission for adding users
+- pg_user_edit (boolean): Permission for editing users
+- pg_user_delete (boolean): Permission for deleting users
+- pg_group_add (boolean): Permission for adding groups
+- pg_group_edit (boolean): Permission for editing groups
+- pg_group_delete (boolean): Permission for deleting groups
+- pg_template_add (boolean): Permission for adding templates
+- pg_template_edit (boolean): Permission for editing templates
+- pg_template_delete (boolean): Permission for deleting templates
+- pg_personalization_add (boolean): Permission for adding personalization tags
+- pg_personalization_edit (boolean): Permission for editing personalization tags
+- pg_personalization_delete (boolean): Permission for deleting personalization tags
+- pg_automation_manage (boolean): pgFormEdit (boolean): Permission for editing subscription forms
+- pg_reports_campaign (boolean): Permission for viewing campaign reports
+- pg_reports_list (boolean): Permission for viewing list reports
+- pg_reports_user (boolean): Permission for viewing user reports
+- pg_startup_reports (boolean): Campaign ID of last campaign report viewed to decide whether to show link on startup
+- pg_reports_trend (boolean): Permission for viewing trend reports
+- pg_startup_gettingstarted (boolean): Whether or not to show the "getting started" tutorial on overview page
+- pg_deal (boolean): Permission for viewing deals
+- pg_deal_delete (boolean): Permission for deleting deals
+- pg_deal_reassign (boolean): Permission for reassigning deals
+- pg_deal_group_add (boolean): Permission for adding deal groups
+- pg_deal_group_edit (boolean): Permission for editing deal groups
+- pg_deal_group_delete (boolean): Permission for deleting deals groups
+- pg_saved_responses_manage (boolean): Permission for managing saved responses
+- pg_tag_manage (boolean): Permission for managing tags
+- req_approval (boolean): Whether or not this group requires all campaigns to be approved
+- req_approval_1st (boolean): Whether or not this group requires first campaign to be approved
+- req_approval_notify_string (string): Who to notify for approval related issues (email)
+- socialdata (boolean): Whether or not to show social links in campaigns sent from this group
+
+#### Retrieve a group
+
+```ruby
+client.groups.find(group_id)
+```
+
+#### Update a group
+
+```ruby
+client.groups.update(group_id, {
+  title: 'Updated Group Title'
+})
+```
+
+#### Delete a group
+
+```ruby
+client.groups.delete(group_id)
+```
+
+#### List all groups
+
+```ruby
+client.groups.all
+```
+
+<a name="templates"/>
+
+### Templates - [Api Reference](https://developers.activecampaign.com/reference#templates)
+
+#### Retrieve a template
+
+```ruby
+client.templates.find(template_id)
+```
+
+#### Delete a template
+
+```ruby
+client.templates.delete(templates_id)
+```
+
+#### List all templates
+
+```ruby
+client.templates.all
+```
 
 ## Contributing
 

data/lib/active_campaign_wrapper/api/group/arguments.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveCampaignWrapper
+  module Api
+    module Group
+      module Arguments
+        SNAKE_CASED = {
+          create: %i[
+            pg_user_add
+            pg_user_edit
+            pg_user_delete
+          ]
+        }.freeze
+      end
+    end
+  end
+end

data/lib/active_campaign_wrapper/client.rb

@@ -12,10 +12,15 @@ require 'active_campaign_wrapper/core/custom_field_value_gateway'
 require 'active_campaign_wrapper/core/contact_tag_gateway'
 require 'active_campaign_wrapper/core/contact_automation_gateway'
 require 'active_campaign_wrapper/core/contact_score_value_gateway'
+require 'active_campaign_wrapper/core/group_gateway'
+require 'active_campaign_wrapper/core/list_group_gateway'
+require 'active_campaign_wrapper/core/user_gateway'
+require 'active_campaign_wrapper/core/template_gateway'
 
 require 'active_campaign_wrapper/api/contact/arguments'
 require 'active_campaign_wrapper/api/list/arguments'
 require 'active_campaign_wrapper/api/custom_field/arguments'
+require 'active_campaign_wrapper/api/group/arguments'
 
 module ActiveCampaignWrapper
   class Client
@@ -31,43 +36,59 @@ module ActiveCampaignWrapper
     end
 
     def tags
-      TagGateway.new(self)
+      @tags ||= TagGateway.new(self)
     end
 
     def contacts
-      ContactGateway.new(self)
+      @contacts ||= ContactGateway.new(self)
     end
 
     def email_activities
-      EmailActivityGateway.new(self)
+      @email_activities ||= EmailActivityGateway.new(self)
     end
 
     def contact_tags
-      ContactTagGateway.new(self)
+      @contact_tags ||= ContactTagGateway.new(self)
     end
 
     def contact_score_values
-      ContactScoreValueGateway.new(self)
+      @contact_score_values ||= ContactScoreValueGateway.new(self)
     end
 
     def contact_automations
-      ContactAutomationGateway.new(self)
+      @contact_automations ||= ContactAutomationGateway.new(self)
     end
 
     def custom_fields
-      CustomFieldGateway.new(self)
+      @custom_fields ||= CustomFieldGateway.new(self)
     end
 
     def custom_field_options
-      CustomFieldOptionGateway.new(self)
+      @custom_field_options ||= CustomFieldOptionGateway.new(self)
     end
 
     def custom_field_values
-      CustomFieldValueGateway.new(self)
+      @custom_field_values ||= CustomFieldValueGateway.new(self)
     end
 
     def lists
-      ListGateway.new(self)
+      @lists ||= ListGateway.new(self)
+    end
+
+    def groups
+      @groups ||= GroupGateway.new(self)
+    end
+
+    def list_groups
+      @list_groups ||= ListGroupGateway.new(self)
+    end
+
+    def users
+      @users ||= UserGateway.new(self)
+    end
+
+    def templates
+      @templates ||= TemplateGateway.new(self)
     end
   end
 end

data/lib/active_campaign_wrapper/core/group_gateway.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ActiveCampaignWrapper
+  module Core
+    class GroupGateway
+      def initialize(client)
+        @client = client
+        @config = client.config
+      end
+
+      def all(**params)
+        @config.get('/groups', query: params)
+      end
+
+      def create(params)
+        params = { group: params }
+        @config.post(
+          '/groups',
+          body: ActiveCampaignWrapper::Helpers.normalize_body(
+            params,
+            ActiveCampaignWrapper::Api::Group::Arguments::SNAKE_CASED[:create]
+          )
+        )
+      end
+
+      def delete(group_id)
+        @config.delete("/groups/#{group_id}")
+      end
+
+      def update(group_id, params)
+        params = { group: params }
+        @config.put(
+          "/groups/#{group_id}",
+          body: ActiveCampaignWrapper::Helpers.normalize_body(
+            params,
+            ActiveCampaignWrapper::Api::Group::Arguments::SNAKE_CASED[:create]
+          )
+        )
+      end
+
+      def find(group_id)
+        @config.get("/groups/#{group_id}")
+      end
+    end
+  end
+end

data/lib/active_campaign_wrapper/core/list_group_gateway.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ActiveCampaignWrapper
+  module Core
+    class ListGroupGateway
+      def initialize(client)
+        @client = client
+        @config = client.config
+      end
+
+      def all(**params)
+        @config.get('/listGroups', query: params)
+      end
+
+      def create(params)
+        params = { list_group: params }
+        @config.post(
+          '/listGroups',
+          body: ActiveCampaignWrapper::Helpers.normalize_body(params)
+        )
+      end
+
+      def delete(list_group_id)
+        @config.delete("/listGroups/#{list_group_id}")
+      end
+
+      def find(list_group_id)
+        @config.get("/listGroups/#{list_group_id}")
+      end
+    end
+  end
+end

data/lib/active_campaign_wrapper/core/template_gateway.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ActiveCampaignWrapper
+  module Core
+    class TemplateGateway
+      def initialize(client)
+        @client = client
+        @config = client.config
+      end
+
+      def all(**params)
+        @config.get('/templates', query: params)
+      end
+
+      def delete(template_id)
+        @config.delete("/templates/#{template_id}")
+      end
+
+      def find(template_id)
+        @config.get("/templates/#{template_id}")
+      end
+    end
+  end
+end

data/lib/active_campaign_wrapper/core/user_gateway.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ActiveCampaignWrapper
+  module Core
+    class UserGateway
+      def initialize(client)
+        @client = client
+        @config = client.config
+      end
+
+      def all(**params)
+        @config.get('/users', query: params)
+      end
+
+      def create(params)
+        params = { user: params }
+        @config.post(
+          '/users',
+          body: ActiveCampaignWrapper::Helpers.normalize_body(params)
+        )
+      end
+
+      def delete(user_id)
+        @config.delete("/users/#{user_id}")
+      end
+
+      def update(user_id, params)
+        params = { user: params }
+        @config.put(
+          "/users/#{user_id}", body:
+          ActiveCampaignWrapper::Helpers.normalize_body(params)
+        )
+      end
+
+      def find(user_id)
+        @config.get("/users/#{user_id}")
+      end
+
+      def find_by_email(email)
+        @config.get("/users/email/#{email}")
+      end
+
+      def find_by_username(username)
+        @config.get("/users/username/#{username}")
+      end
+
+      def logged_in
+        @config.get('/users/me')
+      end
+    end
+  end
+end

data/lib/active_campaign_wrapper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveCampaignWrapper
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_campaign_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Anmol Yousaf
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -255,6 +255,7 @@ files:
 - lib/active_campaign_wrapper.rb
 - lib/active_campaign_wrapper/api/contact/arguments.rb
 - lib/active_campaign_wrapper/api/custom_field/arguments.rb
+- lib/active_campaign_wrapper/api/group/arguments.rb
 - lib/active_campaign_wrapper/api/list/arguments.rb
 - lib/active_campaign_wrapper/client.rb
 - lib/active_campaign_wrapper/configuration.rb
@@ -266,8 +267,12 @@ files:
 - lib/active_campaign_wrapper/core/custom_field_option_gateway.rb
 - lib/active_campaign_wrapper/core/custom_field_value_gateway.rb
 - lib/active_campaign_wrapper/core/email_activity_gateway.rb
+- lib/active_campaign_wrapper/core/group_gateway.rb
 - lib/active_campaign_wrapper/core/list_gateway.rb
+- lib/active_campaign_wrapper/core/list_group_gateway.rb
 - lib/active_campaign_wrapper/core/tag_gateway.rb
+- lib/active_campaign_wrapper/core/template_gateway.rb
+- lib/active_campaign_wrapper/core/user_gateway.rb
 - lib/active_campaign_wrapper/helpers.rb
 - lib/active_campaign_wrapper/version.rb
 homepage: https://github.com/anmol-yousaf/active_campaign_wrapper