hipcall 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 072b7a0cc008aca2610f483131fb18c9d884d0cb1dc9a3001393986f6b5c7348
-  data.tar.gz: f31f1a70e20bb86cc2fea7c3450278ea18c9dbc1ab5721f30215467bc8aa348e
+  metadata.gz: 86fa5797a95b72bd2b60b4c8d147c478ed1fa59bba67a465ae5572fe6a044a8c
+  data.tar.gz: 82d9521bd9aa970ef05a203f056891cfcf0e445b5021a25bf580465e5fb60b2a
 SHA512:
-  metadata.gz: 1ea9402937bef7e0cdadc121cb23013b027f76c72653cf2e2c4886f5ee542826a0943bdf99e6aaf77d11e1c38ba80888e1b661253d8c48e1fb8d0ae2802a0884
-  data.tar.gz: 7d76e148e92da353a8affa155bc5816eb17c1f4f79999feec23edab633e9273dc2da847356cc81e2144b7c62cd52066b2b55015db2f1b1acb2d8fc9d44ac56fc
+  metadata.gz: 047a6f008aee5f9328f02b93cb1c14e980d3820257f0914267740386d25cbfa7b5b81d86b60f5a3cba9d7930f776140bcfcc21b2befed94759069978625b494e
+  data.tar.gz: af39ed341c79bcef2b7361af744fdb7da616a7c65adb46a1a7d0e6c84db7c4ed9b5ebdac19479b027788ce0b80a80ad5538bc2748daa03cced47972103b27fd6

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.8

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## v3.0.0
+
+- Start support new Hipcall API.
+- Change `Cdr` resource name to `Call`
+
+## v2.3.0
+
+- Add tags to Contact 
+- Remove tags from Contact.
+- Add tags to Company 
+- Remove tags from Company.
+
 ## v2.2.0
 
 ### Features

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hipcall (2.0.0)
+    hipcall (3.0.0)
       faraday (~> 1.10)
       faraday_middleware (~> 1.2)
 
@@ -35,7 +35,7 @@ GEM
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
     minitest (5.16.2)
-    multipart-post (2.3.0)
+    multipart-post (2.4.0)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
@@ -66,11 +66,11 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  ruby
   x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
-  faraday (~> 1.10, >= 1.10.3)
   hipcall!
   minitest (>= 5.0.5)
   rake (~> 13.0)

data/README.md

@@ -1,6 +1,9 @@
 # Hipcall
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hipcall`. To experiment with that code, run `bin/console` for an interactive prompt.
+Welcome to your new gem! In this directory, you'll find the files 
+you need to be able to package up your Ruby library into a gem. 
+Put your Ruby code in the file `lib/hipcall`. To experiment with 
+that code, run `bin/console` for an interactive prompt.
 
 ## Installation
 
@@ -23,45 +26,88 @@ Or install it yourself as:
 ```ruby
 require "hipcall_sdk"
 
-hipcall = HipcallSdk::Client.new(api_key: "YOUR_TOKEN_IS_HERE", version: "v20211124", base_url: "https://app.hipcall.com/api/")
+hipcall = HipcallSdk::Client.new(
+    api_key: "YOUR TOKEN IS HERE", 
+    version: "v3", 
+    base_url: "https://use.hipcall.com/api/"
+)
 ```
 
-### Cdr resource
+### Call resource
 
 ```ruby
 # List
-cdrs = hipcall.cdrs.list
+calls = hipcall.calls.list(limit: 10, offset: 0, sort: "started_at.asc,user_id.desc_nulls_last")
 
 # Retrieve
 year = 2022
 mounth = 07
 day = 07
-cdr_uuid = "caedfd1b-25ec-447e-ad87-3b7eb3d358ea"
-cdr = hipcall.cdrs.retrieve(year: year, mounth: mounth, day: day, cdr_uuid: cdr_uuid)
+call_uuid = "caedfd1b-25ec-447e-ad87-3b7eb3d358ea"
+call = hipcall.calls.retrieve(year: year, mounth: mounth, day: day, call_uuid: call_uuid)
 ```
 
-### Comment resource
+### Company resource
+
+#### Add tags to company
 
 ```ruby
-# Create
-new_comment = hipcall.comments.create(commentable_type: 'company', commentable_id: 8777, content: 'Comment body, note, etc')
+# Add tags to company
+tags = hipcall.companies.create_tags(company_id: 1, tags: ["tag1", "tag2"]);
+```
+
+#### Remove a tag from company
+
+```ruby
+# Remove a tag from company
+hipcall.companies.delete_tags(company_id: 1, tag_id: 1);
+```
+
+#### Add comment to company
+
+```ruby
+# Add tags to company
+comment = hipcall.companies.create_tags(company_id: 4, content: "Hello world!");
+```
+
+### Contact resource
+
+#### Add tags to contact
+
+```ruby
+# Add tags to contact
+tags = hipcall.contacts.create_tags(contact_id: 1, tags: ["tag1", "tag2"]);
+```
+
+#### Remove a tag from contact
+
+```ruby
+# Remove a tag from contact
+hipcall.contacts.delete_tags(contact_id: 1, tag_id: 1);
+```
+
+#### Add comment to contact
+
+```ruby
+# Add tags to contact
+comment = hipcall.contacts.create_tags(contact_id: 4, content: "Hello world!");
 ```
 
 ### Extension resource
 
 ```ruby
 # List
-extensions = hipcall.extensions.list
+extensions = hipcall.extensions.list(limit: 10, offset: 0, sort: "id.asc")
 
 # Retrieve
-extension = hipcall.extensions.retrieve(extension_id: 1)
+extension = hipcall.extensions.retrieve(extension_id: 1234)
 ```
 
 ### Greetings resource
 
 ```ruby
 # List
-greetings = hipcall.greetings.list
+greetings = hipcall.greetings.list(limit: 10, offset: 0, sort: "id.asc")
 
 # Retrieve
 greeting = hipcall.greetings.retrieve(greeting_id: 1)
@@ -71,17 +117,17 @@ greeting = hipcall.greetings.retrieve(greeting_id: 1)
 
 ```ruby
 # List
-numbers = hipcall.numbers.list
+numbers = hipcall.numbers.list(limit: 10, offset: 0, sort: "id.asc")
 
 # Retrieve
-number = hipcall.numbers.retrieve(number_id: 1)
+number = hipcall.numbers.retrieve(number_id: 2)
 ```
 
 ### Task resource
 
 ```ruby
 # List
-tasks = hipcall.tasks.list
+tasks = hipcall.tasks.list(limit: 10, offset: 0, sort: "id.asc")
 
 # Retrieve
 task = hipcall.tasks.retrieve(task_id: 1)
@@ -94,7 +140,7 @@ new_task = hipcall.tasks.create(name: 'Lets email the contact')
 
 ```ruby
 # List
-teams = hipcall.teams.list
+teams = hipcall.teams.list(limit: 10, offset: 0, sort: "id.asc")
 
 # Retrieve
 team = hipcall.teams.retrieve(team_id: 1)
@@ -104,14 +150,12 @@ team = hipcall.teams.retrieve(team_id: 1)
 
 ```ruby
 # List
-users = hipcall.users.list
+users = hipcall.users.list(limit: 10, offset: 0, sort: "id.asc")
 
 # Retrieve
 user = hipcall.users.retrieve(user_id: 1)
 ```
 
-
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/hipcall/ruby-sdk .
@@ -122,4 +166,17 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/hipcal
 rake test
 rake build
 sudo gem install --local pkg/hipcall-X.X.X.gem
+gem push pkg/hipcall-x.x.x.gem
+```
+
+For local development
+
+```ruby
+require "hipcall_sdk"
+
+hipcall = HipcallSdk::Client.new(
+    api_key: "g2gDbQAAACQwMDZiYzA4Ni00OGI4LTRjMGItYjQxNy01MzAzNWFjZDVjOGFuBgBfEMd9jQFiAeNPSA.v4O0DvJ9IbzH_GOk6Uo4XpXPNpuM9GF4WvxqKmHB7Is", 
+    version: "v3", 
+    base_url: "http://localhost:4000/api/"
+)
 ```

data/lib/hipcall/client.rb

@@ -5,7 +5,7 @@ module HipcallSdk
 	class Client
 		attr_reader :api_key, :version, :base_url, :adapter
 
-		def initialize(api_key:, version: "v20211124", base_url: "https://app.hipcall.com/api/", adapter: Faraday.default_adapter, stubs: nil)
+		def initialize(api_key:, version: "v3", base_url: "https://use.hipcall.com/api/", adapter: Faraday.default_adapter, stubs: nil)
 			@api_key = api_key
 			@version = version
 			@base_url = base_url
@@ -22,12 +22,16 @@ module HipcallSdk
 			end
 		end
 
-		def cdrs
-			CdrResource.new(self)
+		def calls
+			CallResource.new(self)
 		end
 
-		def comments
-			CommentResource.new(self)
+		def companies
+			CompanyResource.new(self)
+		end
+
+		def contacts
+			ContactResource.new(self)
 		end
 
 		def extensions

data/lib/hipcall/collection.rb

@@ -1,19 +1,17 @@
 module HipcallSdk
 	class Collection
-		attr_reader :data, :links, :meta
+		attr_reader :data, :meta
 
 		def self.from_response(response, key:, type:)
 			body = response.body
 			new(
 				data: body[key].map { |attrs| type.new(attrs) },
-				links: body["links"],
 				meta: body["meta"],
 			)
 		end
 
-		def initialize(data:, links:, meta:)
+		def initialize(data:, meta:)
 			@data = data
-			@links = links
 			@meta = meta
 		end
 	end

data/lib/hipcall/objects/call.rb

@@ -0,0 +1,4 @@
+module HipcallSdk
+	class Call < Object
+	end
+end

data/lib/hipcall/objects/company.rb

@@ -0,0 +1,4 @@
+module HipcallSdk
+	class Company < Object
+	end
+end

data/lib/hipcall/objects/contact.rb

@@ -0,0 +1,4 @@
+module HipcallSdk
+	class Contact < Object
+	end
+end

data/lib/hipcall/objects/{cdr.rb → tag.rb}

@@ -1,4 +1,4 @@
 module HipcallSdk
-	class Cdr < Object
+	class Tag < Object
 	end
 end

data/lib/hipcall/resource.rb

@@ -41,6 +41,8 @@ module HipcallSdk
 				raise Error, message
 			when 419 
 				raise Error, message
+			when 422
+				raise Error, message
 			when 429
 				raise Error, message
 			when 500

data/lib/hipcall/resources/calls.rb

@@ -0,0 +1,12 @@
+module HipcallSdk
+	class CallResource < Resource
+		def list(**params)
+			response = get_request("calls", params: params)
+			Collection.from_response(response, key: "data", type: Call)
+		end
+
+		def retrieve(year:, mounth:, day:, call_uuid:)
+			Call.new get_request("calls/#{year}/#{mounth}/#{day}/#{call_uuid}").body.dig("data")
+		end
+	end
+end

data/lib/hipcall/resources/companies.rb

@@ -0,0 +1,17 @@
+module HipcallSdk
+	class CompanyResource < Resource
+    def create_tags(company_id:, **attributes)
+      response = post_request("companies/#{company_id}/tags", body: attributes)
+			Collection.from_response(response, key: "data", type: Tag)
+    end
+    
+    def delete_tags(company_id:, tag_id:)
+      delete_request("companies/#{company_id}/tags/#{tag_id}")
+    end
+
+    def create_comment(company_id:, **attributes)
+      response = post_request("companies/#{company_id}/comments", body: attributes)
+      Comment.new response.body.dig("data")
+    end
+	end
+end

data/lib/hipcall/resources/contacts.rb

@@ -0,0 +1,17 @@
+module HipcallSdk
+	class ContactResource < Resource
+    def create_tags(contact_id:, **attributes)
+      response = post_request("contacts/#{contact_id}/tags", body: attributes)
+			Collection.from_response(response, key: "data", type: Tag)
+    end
+    
+    def delete_tags(contact_id:, tag_id:)
+      delete_request("contacts/#{contact_id}/tags/#{tag_id}")
+    end
+
+    def create_comment(contact_id:, **attributes)
+      response = post_request("contacts/#{company_id}/comments", body: attributes)
+      Comment.new response.body.dig("data")
+    end
+	end
+end

data/lib/hipcall/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HipcallSdk
-  VERSION = "2.2.0"
+  VERSION = "3.0.0"
 end

data/lib/hipcall_sdk.rb

@@ -9,16 +9,21 @@ module HipcallSdk
   autoload :Object, "hipcall/object"
   autoload :Resource, "hipcall/resource"
 
-  autoload :Cdr, "hipcall/objects/cdr"
+  autoload :Call, "hipcall/objects/call"
+  autoload :Contact, "hipcall/objects/contact"
+  autoload :Company, "hipcall/objects/company"
   autoload :Comment, "hipcall/objects/comment"
   autoload :Extension, "hipcall/objects/extension"
   autoload :Greeting, "hipcall/objects/greeting"
   autoload :Number, "hipcall/objects/number"
+  autoload :Tag, "hipcall/objects/tag"
   autoload :Task, "hipcall/objects/task"
   autoload :Team, "hipcall/objects/team"
   autoload :User, "hipcall/objects/user"
 
-  autoload :CdrResource, "hipcall/resources/cdrs"
+  autoload :CallResource, "hipcall/resources/calls"
+  autoload :ContactResource, "hipcall/resources/contacts"
+  autoload :CompanyResource, "hipcall/resources/companies"
   autoload :CommentResource, "hipcall/resources/comments"
   autoload :ExtensionResource, "hipcall/resources/extensions"
   autoload :GreetingResource, "hipcall/resources/greetings"

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: hipcall
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Hipcall Development Team
 - Onur Ozgur OZKAN
 - Kendal BOZKURT
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-18 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -40,13 +40,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description:
+description: 
 email:
 - hello@hipcall.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".tool-versions"
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
@@ -60,17 +61,21 @@ files:
 - lib/hipcall/collection.rb
 - lib/hipcall/error.rb
 - lib/hipcall/object.rb
-- lib/hipcall/objects/cdr.rb
+- lib/hipcall/objects/call.rb
 - lib/hipcall/objects/comment.rb
+- lib/hipcall/objects/company.rb
+- lib/hipcall/objects/contact.rb
 - lib/hipcall/objects/extension.rb
 - lib/hipcall/objects/greeting.rb
 - lib/hipcall/objects/number.rb
+- lib/hipcall/objects/tag.rb
 - lib/hipcall/objects/task.rb
 - lib/hipcall/objects/team.rb
 - lib/hipcall/objects/user.rb
 - lib/hipcall/resource.rb
-- lib/hipcall/resources/cdrs.rb
-- lib/hipcall/resources/comments.rb
+- lib/hipcall/resources/calls.rb
+- lib/hipcall/resources/companies.rb
+- lib/hipcall/resources/contacts.rb
 - lib/hipcall/resources/extensions.rb
 - lib/hipcall/resources/greetings.rb
 - lib/hipcall/resources/numbers.rb
@@ -87,7 +92,7 @@ metadata:
   homepage_uri: https://www.hipcall.com
   source_code_uri: https://github.com/hipcall/ruby-sdk
   changelog_uri: https://github.com/hipcall/ruby-sdk/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -102,8 +107,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Hipcall's Ruby SDK
 test_files: []

data/lib/hipcall/resources/cdrs.rb

@@ -1,12 +0,0 @@
-module HipcallSdk
-	class CdrResource < Resource
-		def list(**params)
-			response = get_request("cdrs", params: params)
-			Collection.from_response(response, key: "data", type: Cdr)
-		end
-
-		def retrieve(year:, mounth:, day:, cdr_uuid:)
-			Cdr.new get_request("cdrs/#{year}/#{mounth}/#{day}/#{cdr_uuid}").body.dig("data")
-		end
-	end
-end

data/lib/hipcall/resources/comments.rb

@@ -1,7 +0,0 @@
-module HipcallSdk
-	class CommentResource < Resource
-		def create(**attributes)
-			Comment.new post_request("comments", body: attributes).body.dig("data")
-		end
-	end
-end