seven_api 0.5.0 → 0.6.1

data/lib/seven_api/resources/analytics.rb

@@ -1,21 +1,54 @@
-# frozen_string_literal: true
-
-require 'seven_api/resource'
-
-# This module exposes the methods for communicating with the API endpoint /analytics.
-module SevenApi::Resources
-  class Analytics < SevenApi::Resource
-    @endpoint = SevenApi::Endpoint::ANALYTICS
-    @http_methods = {
-      :retrieve => :get,
-    }
-
-    # Retrieve analytics for associated API key
-    # read more: https://www.seven.io/en/docs/gateway/http-api/analytics/
-    # @param params [Hash]
-    # @return [Array]
-    def retrieve(params = {})
-      request(params)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /analytics.
+module SevenApi::Resources
+  class Analytics < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::ANALYTICS
+    PATHS = {
+      :by_country => "/country",
+      :by_date => "/date",
+      :by_label => "/label",
+      :by_subaccount => "/subaccount",
+    }
+    @http_methods = {
+      :by_country => :get,
+      :by_date => :get,
+      :by_label => :get,
+      :by_subaccount => :get,
+    }
+
+    # Retrieve analytics grouped by country
+    # read more: https://docs.seven.io/en/rest-api/endpoints/account#statistics
+    # @param params [Hash]
+    # @return [Array]
+    def by_country(params = {})
+      request(:get, {}, params, PATHS[:by_country])
+    end
+
+    # Retrieve analytics grouped by date
+    # read more: https://docs.seven.io/en/rest-api/endpoints/account#statistics
+    # @param params [Hash]
+    # @return [Array]
+    def by_date(params = {})
+      request(:get,{}, params, PATHS[:by_date])
+    end
+
+    # Retrieve analytics grouped by label
+    # read more: https://docs.seven.io/en/rest-api/endpoints/account#statistics
+    # @param params [Hash]
+    # @return [Array]
+    def by_label(params = {})
+      request(:get,{}, params, PATHS[:by_label])
+    end
+
+    # Retrieve analytics grouped by subaccount
+    # read more: https://docs.seven.io/en/rest-api/endpoints/account#statistics
+    # @param params [Hash]
+    # @return [Array]
+    def by_subaccount(params = {})
+      request(:get,{}, params, PATHS[:by_subaccount])
+    end
+  end
+end

data/lib/seven_api/resources/balance.rb

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-
-require 'seven_api/resource'
-
-# This module exposes the methods for communicating with the API endpoint /balance.
-module SevenApi::Resources
-  class Balance < SevenApi::Resource
-    @endpoint = SevenApi::Endpoint::BALANCE
-    @http_methods = {
-      :retrieve => :get,
-    }
-
-    # Retrieve account balance for associated API key
-    # read more: https://www.seven.io/en/docs/gateway/http-api/credit-balance/
-    # @return [Float]
-    def retrieve
-      request
-    end
-  end
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /balance.
+module SevenApi::Resources
+  class Balance < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::BALANCE
+    @http_methods = {
+      :retrieve => :get,
+    }
+
+    # Retrieve account balance for associated API key
+    # read more: https://docs.seven.io/en/rest-api/endpoints/account#balance
+    # @return [Hash]
+    def retrieve
+      request(:get)
+    end
+  end
 end

data/lib/seven_api/resources/contacts.rb

@@ -1,39 +1,57 @@
-# frozen_string_literal: true
-
-require 'seven_api/resource'
-
-# This module exposes the methods for communicating with the API endpoint /contacts.
-module SevenApi::Resources
-  class Contacts < SevenApi::Resource
-    @endpoint = SevenApi::Endpoint::CONTACTS
-    @http_methods = {
-      :delete => :post,
-      :read => :get,
-      :write => :post,
-    }
-
-    # Retrieve contacts associated with the API key
-    # read more: https://www.seven.io/en/docs/gateway/http-api/contacts/#read-contacts
-    # @param params [Hash]
-    # @return [String, Hash]
-    def read(params = {})
-      request(params.merge({ :action => SevenApi::Contacts::Action::READ }))
-    end
-
-    # Delete an account with given ID
-    # read more: https://www.seven.io/en/docs/gateway/http-api/contacts/#delete-contacts
-    # @param params [Hash]
-    # @return [String, Hash]
-    def delete(params)
-      request({}, params.merge({ :action => SevenApi::Contacts::Action::DEL }))
-    end
-
-    # Create or update a contact
-    # read more: https://www.seven.io/en/docs/gateway/http-api/contacts/#create-and-edit-contacts
-    # @param params [Hash]
-    # @return [String, Hash]
-    def write(params)
-      request({}, params.merge({ :action => SevenApi::Contacts::Action::WRITE }))
-    end
-  end
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /contacts.
+module SevenApi::Resources
+  class Contacts < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::CONTACTS
+    @http_methods = {
+      :all => :get,
+      :create => :post,
+      :delete => :delete,
+      :one => :get,
+      :update => :patch,
+    }
+
+    # Retrieve contacts associated with the API key
+    # read more: https://docs.seven.io/en/rest-api/endpoints/contacts#query-contact-list
+    # @param params [Hash]
+    # @return [Hash]
+    def all(params = {})
+      request(:get, params)
+    end
+
+    # Retrieve a contact associated with the API key
+    # read more: https://docs.seven.io/en/rest-api/endpoints/contacts#retrieve-contact
+    # @param id [Int]
+    # @return [Hash]
+    def one(id)
+      request(:get,{}, {}, "/#{id}")
+    end
+
+    # Delete a contact with given ID
+    # read more: https://docs.seven.io/en/rest-api/endpoints/contacts#delete-contact
+    # @param id [Integer]
+    # @return [Hash]
+    def delete(id)
+      request({}, {}, "/#{id}")
+    end
+
+    # Create a contact
+    # read more: https://docs.seven.io/en/rest-api/endpoints/contacts#create-contact
+    # @param params [Hash]
+    # @return [Hash]
+    def create(params)
+      request( :post, params)
+    end
+
+    # Update a contact
+    # read more: https://docs.seven.io/en/rest-api/endpoints/contacts#update-contact
+    # @param contact [Hash]
+    # @return [Hash]
+    def update(contact)
+      request(:patch, contact, {}, "/#{contact['id']}")
+    end
+  end
 end

data/lib/seven_api/resources/groups.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /groups.
+module SevenApi::Resources
+  class Groups < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::GROUPS
+    @http_methods = {
+      :all => :get,
+      :create => :post,
+      :delete => :delete,
+      :one => :get,
+      :update => :patch,
+    }
+
+    # Retrieve groups associated with the API key
+    # read more: https://docs.seven.io/en/rest-api/endpoints/groups#list-all-groups
+    # @param params [Hash]
+    # @return [Hash]
+    def all(params = {})
+      request(:get, params)
+    end
+
+    # Retrieve a group associated with the API key
+    # read more: https://docs.seven.io/en/rest-api/endpoints/groups#retrieve-a-group
+    # @param id [Int]
+    # @return [Hash]
+    def one(id)
+      request(:get,{}, {}, "/#{id}")
+    end
+
+    # Delete a group with given ID
+    # read more: https://docs.seven.io/en/rest-api/endpoints/groups#delete-group
+    # @param id [Integer]
+    # @return [Hash]
+    def delete(id)
+      request(:delete,{}, {}, "/#{id}")
+    end
+
+    # Create a group
+    # read more: https://docs.seven.io/en/rest-api/endpoints/groups#create-group
+    # @param params [Hash]
+    # @return [Hash]
+    def create(params)
+      request(:post, params)
+    end
+
+    # Update a group
+    # read more: https://docs.seven.io/en/rest-api/endpoints/groups#update-a-group
+    # @param contact [Hash]
+    # @return [Hash]
+    def update(contact)
+      request(:patch, contact, {}, "/#{contact['id']}")
+    end
+  end
+end

data/lib/seven_api/resources/hooks.rb

@@ -1,41 +1,41 @@
-# frozen_string_literal: true
-
-require 'seven_api/resource'
-
-# This module exposes the methods for communicating with the API endpoint /hooks.
-# read more: https://www.seven.io/en/docs/gateway/http-api/webhooks/
-module SevenApi::Resources
-  class Hooks < SevenApi::Resource
-    @endpoint = SevenApi::Endpoint::HOOKS
-    @http_methods = {
-      :read => :get,
-      :subscribe => :post,
-      :unsubscribe => :post,
-    }
-
-    # Retrieve all webhooks
-    # @param params [Hash]
-    # @return [Hash]
-    def read(params = {})
-      request(params.merge({ :action => SevenApi::Hooks::Action::READ }))
-    end
-
-    # Register a new webhook
-    # @param params [Hash]
-    # @return [Hash]
-    def subscribe(params)
-      SevenApi::Hooks::Validator::subscribe(params)
-
-      request(params.merge({ :action => SevenApi::Hooks::Action::SUBSCRIBE }))
-    end
-
-    # Delete a webhook
-    # @param params [Hash]
-    # @return [Hash]
-    def unsubscribe(params)
-      SevenApi::Hooks::Validator::unsubscribe(params)
-
-      request(params.merge({ :action => SevenApi::Hooks::Action::UNSUBSCRIBE }))
-    end
-  end
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /hooks.
+# read more: https://docs.seven.io/en/rest-api/endpoints/webhooks
+module SevenApi::Resources
+  class Hooks < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::HOOKS
+    @http_methods = {
+      :read => :get,
+      :subscribe => :post,
+      :unsubscribe => :post,
+    }
+
+    # Retrieve all webhooks
+    # @param params [Hash]
+    # @return [Hash]
+    def read(params = {})
+      request(:get, params.merge({ :action => SevenApi::Hooks::Action::READ }))
+    end
+
+    # Register a new webhook
+    # @param params [Hash]
+    # @return [Hash]
+    def subscribe(params)
+      SevenApi::Hooks::Validator::subscribe(params)
+
+      request(:post, params.merge({ :action => SevenApi::Hooks::Action::SUBSCRIBE }))
+    end
+
+    # Delete a webhook
+    # @param params [Hash]
+    # @return [Hash]
+    def unsubscribe(params)
+      SevenApi::Hooks::Validator::unsubscribe(params)
+
+      request(:post, params.merge({ :action => SevenApi::Hooks::Action::UNSUBSCRIBE }))
+    end
+  end
 end

data/lib/seven_api/resources/journal.rb

@@ -1,21 +1,21 @@
-# frozen_string_literal: true
-
-require 'seven_api/resource'
-
-# This module exposes the methods for communicating with the API endpoint /journal.
-module SevenApi::Resources
-  class Journal < SevenApi::Resource
-    @endpoint = SevenApi::Endpoint::JOURNAL
-    @http_methods = {
-      :retrieve => :get,
-    }
-
-    # Retrieve the journal for associated API key
-    # read more: https://www.seven.io/en/docs/gateway/http-api/journal/
-    # @param params [Hash]
-    # @return [Array]
-    def retrieve(params)
-      request(params)
-    end
-  end
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /journal.
+module SevenApi::Resources
+  class Journal < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::JOURNAL
+    @http_methods = {
+      :retrieve => :get,
+    }
+
+    # Retrieve the journal for associated API key
+    # read more: https://docs.seven.io/en/rest-api/endpoints/logbook
+    # @param params [Hash]
+    # @return [Array]
+    def retrieve(params)
+      request(:get, params)
+    end
+  end
 end

data/lib/seven_api/resources/lookup.rb

@@ -1,48 +1,64 @@
-# frozen_string_literal: true
-
-require 'seven_api/resource'
-
-# This module exposes the methods for communicating with the API endpoint /lookup.
-module SevenApi::Resources
-  class Lookup < SevenApi::Resource
-    @endpoint = SevenApi::Endpoint::LOOKUP
-    @http_methods = {
-      :cnam => :post,
-      :format => :post,
-      :hlr => :post,
-      :mnp => :post,
-    }
-
-    # Perform a caller name lookup
-    # read more: https://www.seven.io/en/docs/gateway/http-api/cnam-lookup/
-    # @param params [Hash]
-    # @return [Hash,Array]
-    def cnam(params)
-      request(params.merge({ :type => SevenApi::Lookup::Type::CNAM }))
-    end
-
-    # Retrieve phone number formats
-    # read more: https://www.seven.io/en/docs/gateway/http-api/nummernformat-lookup/
-    # @param params [Hash]
-    # @return [String,Hash]
-    def format(params)
-      request(params.merge({ :type => SevenApi::Lookup::Type::FORMAT }))
-    end
-
-    # Perform a home location register lookup
-    # read more: https://www.seven.io/en/docs/gateway/http-api/hlr-lookup/
-    # @param params [Hash]
-    # @return [Hash,Array]
-    def hlr(params)
-      request(params.merge({ :type => SevenApi::Lookup::Type::HLR }))
-    end
-
-    # Perform a mobile number portability lookup
-    # read more: https://www.seven.io/en/docs/gateway/http-api/mnp-lookup/
-    # @param params [Hash]
-    # @return [Hash,Array]
-    def mnp(params)
-      request(params.merge({ :type => SevenApi::Lookup::Type::MNP }))
-    end
-  end
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /lookup.
+module SevenApi::Resources
+  class Lookup < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::LOOKUP
+    @http_methods = {
+      :cnam => :get,
+      :format => :get,
+      :hlr => :get,
+      :mnp => :get,
+      :rcs_capabilities => :get
+    }
+    PATHS = {
+      :cnam => '/cnam',
+      :format => '/format',
+      :hlr => '/hlr',
+      :mnp => '/mnp',
+      :rcs_capabilities => '/rcs'
+    }
+
+    # Perform a caller name lookup
+    # read more: https://docs.seven.io/en/rest-api/endpoints/lookup#cnam
+    # @param number [String]
+    # @return [Hash,Array]
+    def cnam(number)
+      request(:get, {}, {number: number}, PATHS[:cnam])
+    end
+
+    # Retrieve phone number formats
+    # read more: https://docs.seven.io/en/rest-api/endpoints/lookup#format
+    # @param number [String]
+    # @return [String,Hash]
+    def format(number)
+      request(:get, {}, {number: number}, PATHS[:format])
+    end
+
+    # Perform a home location register lookup
+    # read more: https://docs.seven.io/en/rest-api/endpoints/lookup#hlr
+    # @param number [String]
+    # @return [Hash,Array]
+    def hlr(number)
+      request(:get, {}, {number: number}, PATHS[:hlr])
+    end
+
+    # Perform a mobile number portability lookup
+    # read more: https://docs.seven.io/en/rest-api/endpoints/lookup#mnp
+    # @param number [String]
+    # @return [Hash,Array]
+    def mnp(number)
+      request(:get, {}, {number: number}, PATHS[:mnp])
+    end
+
+    # Perform a RCS capabilities lookup
+    # read more: https://docs.seven.io/en/rest-api/endpoints/lookup#rcs-capabilities
+    # @param number [String]
+    # @return [Hash,Array]
+    def rcs_capabilities(number)
+      request(:get, {}, {number: number}, PATHS[:rcs])
+    end
+  end
 end

data/lib/seven_api/resources/numbers.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /numbers.
+module SevenApi::Resources
+  class Numbers < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::NUMBERS
+    @http_methods = {
+      :active => :get,
+      :available => :get,
+      :delete => :delete,
+      :order => :post,
+      :one => :get,
+      :update => :patch,
+    }
+
+    # Retrieve active phone numbers
+    # read more: https://docs.seven.io/en/rest-api/endpoints/numbers#active-numbers
+    # @return [Array]
+    def active
+      request(:get, {}, {}, '/active')
+    end
+
+
+    # Retrieve available phone numbers
+    # read more: https://docs.seven.io/en/rest-api/endpoints/numbers#available-numbers
+    # @return [Hash]
+    def available
+      request(:get, params, {}, '/available')
+    end
+
+    # Order a phone number
+    # read more: https://docs.seven.io/en/rest-api/endpoints/numbers#order-a-number
+    # @param number [String]
+    # @param payment_interval [String]
+    # @return [Hash]
+    def order(number, payment_interval = PaymentInterval.ASCENDING)
+      payload = {
+        number => number,
+        payment_interval => payment_interval,
+      }
+      request(:post, payload, {}, '/order')
+    end
+
+    # Delete a number
+    # read more: https://docs.seven.io/en/rest-api/endpoints/numbers#delete-number
+    # @param number [String]
+    # @return [Hash]
+    def delete(number, delete_immediately = false)
+      request(:delete, {}, {delete_immediately => delete_immediately}, "/active/#{number}")
+    end
+
+    # Retrieve a number
+    # read more: https://docs.seven.io/en/rest-api/endpoints/numbers#get-number
+    # @param number [String]
+    # @return [Hash]
+    def one(number)
+      request(:get, {}, {}, "/active/#{number}")
+    end
+
+    # Update a number
+    # read more: https://docs.seven.io/en/rest-api/endpoints/numbers#update-number
+    # @param number [String]
+    # @param params [Hash]
+    # @return [Hash]
+    def update(number, params)
+      request(:patch, params, {}, "/active/#{number}")
+    end
+  end
+end

data/lib/seven_api/resources/pricing.rb

@@ -1,21 +1,21 @@
-# frozen_string_literal: true
-
-require 'seven_api/resource'
-
-# This module exposes the methods for communicating with the API endpoint /pricing.
-module SevenApi::Resources
-  class Pricing < SevenApi::Resource
-    @endpoint = SevenApi::Endpoint::PRICING
-    @http_methods = {
-      :retrieve => :get,
-    }
-
-    # Retrieve pricing
-    # read more: https://www.seven.io/en/docs/gateway/http-api/pricing/
-    # @param params [Hash]
-    # @return [Hash,String]
-    def retrieve(params = {})
-      request(params)
-    end
-  end
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /pricing.
+module SevenApi::Resources
+  class Pricing < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::PRICING
+    @http_methods = {
+      :retrieve => :get,
+    }
+
+    # Retrieve pricing
+    # read more: https://docs.seven.io/en/rest-api/endpoints/account#prices
+    # @param params [Hash]
+    # @return [Hash,String]
+    def retrieve(params = {})
+      request(:get, params)
+    end
+  end
 end

data/lib/seven_api/resources/rcs.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /rcs.
+module SevenApi::Resources
+  class Rcs < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::RCS
+    @http_methods = {
+      :delete => :delete,
+      :dispatch => :post,
+      :event => :post
+    }
+
+    # Send RCS
+    # read more: https://docs.seven.io/en/rest-api/endpoints/rcs#send-rcs
+    # @param params [Hash]
+    # @return [Hash]
+    def dispatch(params)
+      request(:post, params, {}, '/messages')
+    end
+
+    # Delete scheduled RCS
+    # read more: https://docs.seven.io/en/rest-api/endpoints/rcs#delete-rcs
+    # @param params [Hash]
+    # @return [Hash]
+    def delete(params)
+      request(:delete, {}, {}, "/messages/#{params[:id]}")
+    end
+
+    # Send Event
+    # read more: https://docs.seven.io/en/rest-api/endpoints/rcs#events
+    # @param params [Hash]
+    # @return [Hash]
+    def event(params)
+      request(:post, params, {}, '/events')
+    end
+  end
+end