wixanswers 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab2efe60f7a4edaf0679e4af2e77136613dc5db51c778154971faf9e1fddb782
+  data.tar.gz: 79384045fa6f34ec14a8e6c3ac83f5460f061e4ff7d772fb64840b441c26cb82
+SHA512:
+  metadata.gz: b8033ceed55b50873ec0eb48c44e3d952fba71d24978009aa1893c5bdb118596e28b6daed89086423d7dd25981f19aef05e28ab763283991feb3daee31816652
+  data.tar.gz: 794022bc28a08b1630ff841af19b03ccbd21595b053d811ca16109f45c46bea6c2a93a7e35fd2f029952a16ead825389bbc7d01a26d38c37011e448c2d960ada

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+0.0.3
+------
+* fixed wrong method name
+
+0.0.1
+------
+
+* Created models for all Ticket and Reply objects
+* Created models for all User objects
+* Created models for Attachment, Label and UserInfo attributes
+* Created basic Enumerations for WixAnswers 
+* Validate object structure using SCHEMA and raise exceptions on non-implemented objects
+* load ticket and reply objects from a raw payload

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2020 Roee Sheelo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# wixanswers
+A Ruby Wrapper to the WIX Answers REST API
+
+# Introduction
+The WIX Answers REST API enables you to use code to interact 
+with the Wix Answers back-end. You can use the API to create 
+webhooks that interact with the Wix Answers front and back-ends, 
+or create a new front-end app that works with the Wix Answers 
+back-end. You can also use the API to get information about your 
+customers and their Wix Answers history 
+(Source: [Wix Answers Developers Overview](https://help.wixanswers.com/kb/en/article/wix-answers-api-overview)).
+
+This library serves as a Ruby wrapper for the API, in order to
+enable easy interfacing with WIX Answers REST API's raw payload.
+
+# Features
+* Schema-based Objects for Tickets, Users and other API objects
+* Schema validation
+* Enumerations and enumerations validation
+
+
+# Usage Examples
+
+**Instantiating a new Ticket directly** 
+```
+ticket = WixAnswers:Models::Ticket.new(<ticket_payload>)
+```
+
+**Instantiating a new Ticket via the `#from_payload` method** 
+```
+ticket = WixAnswers::Models::Ticket.from_payload(<ticket_payload>)
+```
+
+**Validating Enumeration**
+```
+WixAnswers::Enumerations::Channel.validate!(payload[:channel])
+```
+
+# Supported Ruby Versions
+
+* \>= 2.3
+
+
+# Installation
+
+```
+gem install wixanswers
+```
+
+Or via Gemfile:
+```
+gem 'wixanswers'
+```

data/lib/wixanswers.rb

@@ -0,0 +1,23 @@
+require 'wixanswers/rest/api'
+require 'wixanswers/rest/enumerations'
+require 'wixanswers/rest/exceptions'
+
+require 'wixanswers/models/base'
+
+require 'wixanswers/models/user/user'
+require 'wixanswers/models/user/agent'
+require 'wixanswers/models/user/company'
+require 'wixanswers/models/user/group'
+require 'wixanswers/models/user/location'
+require 'wixanswers/models/user/team'
+
+require 'wixanswers/models/ticket/ticket'
+require 'wixanswers/models/ticket/reply'
+require 'wixanswers/models/ticket/by_agent'
+require 'wixanswers/models/ticket/chat'
+require 'wixanswers/models/ticket/phone_callback'
+require 'wixanswers/models/ticket/widget'
+
+require 'wixanswers/models/attachment'
+require 'wixanswers/models/label'
+require 'wixanswers/models/user_info'

data/lib/wixanswers/models/attachment.rb

@@ -0,0 +1,20 @@
+require_relative './base'
+
+# https://help.wixanswers.com/kb/en/article/api-object-structures#attachment-object
+module WixAnswers
+  module Models
+    class Attachment < Base
+      SCHEMA ||= {
+          name: {type: "String", description: "The attachment name", required: true},
+          url: {type: "String", description: "URL of the attachment", required: true},
+          status: {type: "Integer", description: "The attachment status", required: true},
+          sizeBytes: {type: "Integer", description: "The size of the attachment, in bytes"},
+          contentType: {type: "String", description: "The content type of the attachment"}
+      }
+
+      def initialize(attrs={})
+        super(attrs)
+      end
+    end
+  end
+end

data/lib/wixanswers/models/base.rb

@@ -0,0 +1,39 @@
+
+module WixAnswers
+  module Models
+    class Base
+      attr_accessor :attrs
+
+      def initialize(attrs={})
+        self.attrs = attrs.deep_symbolize_keys!
+
+        self.validate!
+      end
+
+      def validate!
+        self.validate_schema!
+
+        return self
+      end
+
+      def validate_schema!
+        return unless defined?(self.class::SCHEMA)
+
+        # make sure all required params appear and that the supplied arguments match their types
+        self.class::SCHEMA.each_pair do |k,v|
+          attr = self.attrs[k]
+
+          raise WixAnswers::Exceptions::MissingAttribute.new(k) if v[:required] and attr.nil?
+
+          attr_type = v[:type] == "Boolean" ? ["FalseClass", "TrueClass"] : Array.wrap(v[:type])
+
+          raise WixAnswers::Exceptions::SchemaTypeError.new(v[:type], attr.class.name) if !attr.nil? and !attr_type.include?(attr.class.name)
+        end
+      end
+
+      def method_missing(k)
+        self.attrs[k.to_sym]
+      end
+    end
+  end
+end

data/lib/wixanswers/models/label.rb

@@ -0,0 +1,16 @@
+
+module WixAnswers
+  module Models
+    class Label < Base
+      SCHEMA ||= {
+          id: {type: "String", description: "Ticket ID", required: true},
+          name: {type: "String", required: true},
+          status: {type: "Integer", required: true}
+      }
+
+      def initialize(attrs={})
+        super(attrs)
+      end
+    end
+  end
+end

data/lib/wixanswers/models/ticket/by_agent.rb

@@ -0,0 +1,8 @@
+
+
+module WixAnswers
+  module Models
+    class ByAgent < Ticket
+    end
+  end
+end

data/lib/wixanswers/models/ticket/chat.rb

@@ -0,0 +1,8 @@
+
+
+module WixAnswers
+  module Models
+    class Chat < Ticket
+    end
+  end
+end

data/lib/wixanswers/models/ticket/phone_callback.rb

@@ -0,0 +1,7 @@
+
+module WixAnswers
+  module Models
+    class PhoneCallback < Ticket
+    end
+  end
+end

data/lib/wixanswers/models/ticket/reply.rb

@@ -0,0 +1,58 @@
+
+# https://help.wixanswers.com/kb/en/article/api-object-structures#reply-object
+module WixAnswers
+  module Models
+    class Reply < Base
+      SCHEMA ||= {
+          id: {type: "String", description: "Reply ID", required: true},
+          ticketId: {type: "String", description: "The ticket to which this reply is attached", required: true},
+          content: {type: "String", description: "Reply content HTML"},
+          type: {type: "Integer", description: "Reply Type", required: true},
+          attachments: {type: "Array", description: "List of reply attachments"},
+          ccRecipients: {type: "Array", description: "Current CC email addresses associated with the reply"},
+          slaState: {type: "Hash", description: "SLA policy associated with the reply"},
+          newTicketStatus: {type: "Integer", description: "New Ticket Status. Relevant when the ticket status is changed when the reply is attached."},
+          user: {type: "Hash", description: "The user or agent that wrote the reply", required: true},
+          userInfo: {type: "Hash", description: "Structure of user system information sent by the user's browser"},
+          channel: {type: "Integer", description: "How the reply was created", required: true},
+          webChannelData: {type: "Hash", description: "Additional data is channel is web"},
+          chatChannelData: {type: "Hash", description: "Additional data if channel is chat"},
+          widgetChannelData: {type: "Hash", description: "Additional data if channel is widget"},
+          emailChannelData: {type: "Hash", description: "Additional data if channel is email"},
+          facebookChannelData: {type: "Hash", description: "Additional data if channel is facebook"},
+          timelineItemType: {type: "Integer", description: "For a reply, this is always 9"},
+          deleted: {type: "Boolean", description: "Whether this reply was deleted"},
+          creationDate: {type: "Integer", description: "Time this record was created", required: true},
+          lastUpdateDate: {type: "Integer", description: "Last time this record was updated"},
+          importId: {type: "String", description: "Import batch process"},
+          parentTicket: {type: "Hash", required: true},
+      }
+
+      def initialize(attrs={})
+        super(attrs)
+      end
+
+      def validate!
+        Enumerations::ReplyType.validate!(self.attrs[:type])
+        super
+      end
+
+      def user
+        @_user ||= User.new(self.attrs[:user] || {})
+      end
+
+      def ticket
+        return @_ticket if defined?(@_ticket)
+
+        attrs = self.attrs[:parentTicket]
+        return if attrs.nil?
+
+        @_ticket = Ticket.from_payload(attrs)
+      end
+
+      def user_info
+        self.ticket.user_info unless self.ticket.nil?
+      end
+    end
+  end
+end

data/lib/wixanswers/models/ticket/ticket.rb

@@ -0,0 +1,117 @@
+
+# https://help.wixanswers.com/kb/en/article/api-object-structures#ticket-object
+
+module WixAnswers
+  module Models
+    class Ticket < Base
+      SCHEMA ||= {
+          id: {type: "String", description: "Ticket ID", required: true},
+          locale: {type: "String", description: "Ticket language"},
+          subject: {type: "String", description: "Ticket subject", required: true},
+          content: {type: "String", description: "Ticket content"},
+          user: {type: "Hash", description: "User that created the ticket, or on behalf of whom the ticket was created", required: true},
+          company: {type: "Hash", description: "Company associated with the ticket"},
+          userInfo: {type: "Hash", description: "Structure of user system information sent by the user's browser"},
+          status: {type: "Integer", description: "Ticket Status", required: true},
+          priority: {type: "Integer", description: "Ticket priority", required: true},
+          repliesCount: {type: "Integer", description: "Number of ticket replies (user and agent replies, not including internal notes)"},
+          lastReply: {type: "Hash", description: "Last reply (user or agent, not internal note)"},
+          channel: {type: "Integer", description: "The channel by which the ticket was created"},
+          channelData: {type: "Hash", description: "Other data related to the channel, depending on the channel"},
+          labels: {type: "Array", description: "List of labels attached to the ticket"},
+          relatedArticleIds: {type: "Array", description: "List of articles that are marked as related to the ticket"},
+          ticketNumber: {type: "Integer", description: "Ticket reference number", required: true},
+          creationDate: {type: "Integer", description: "Time this record was created", required: true},
+          lastUpdateDate: {type: "Integer", description: "Last time this record was updated"},
+          assignedBy: {type: "Hash", description: "Agent who assigned the ticket"},
+          createdByAgent: {type: "Hash", description: "Agent who created the ticket"},
+          assignedUser: {type: "Hash", description: "Agent assigned to the ticket"},
+          assignedGroup: {type: "Hash", description: "Agent group assigned to the ticket"},
+          lastAgentReplyDate: {type: "Integer", description: "The time of the last agent reply"},
+          lastSolvedDate: {type: "Integer", description: "The time the ticket was last solved."},
+          lastOpenedDate: {type: "Integer", description: "The last time the ticket was opened"},
+          lastStatusChangeDate: {type: "Integer", description: "The last time the ticket status changed"},
+          handledByUserIds: {type: "Array", description: "List of user/agent IDs that have previously handled the ticket"},
+          handlingUsers: {type: "Array", description: "List of user/agent IDs that are currently handling the ticket"},
+          repliedByUserIds: {type: "Array", description: "List of user/agent IDs that have replied to the ticket"},
+          positiveRatedUserIds: {type: "Array", description: "List of users that rated the ticket positively"},
+          negativeRatedUserIds: {type: "Array", description: "List of users that rated the ticket negatively"},
+          customFields: {type: "Array", description: "List of ticket custom field values"},
+          hasAgentReply: {type: "Boolean", description: "Whether the ticket has a reply from an agent"},
+          spam: {type: "Boolean", description: "Whether the ticket was marked as spam"},
+          unauthenticated: {type: "Boolean", description: "Whether the user is unauthenticated (not registered in Wix Answers)"},
+          createdOnBehalf: {type: "Boolean", description: "Whether an agent created the ticket on behalf of the user"},
+          initialUserEmail: {type: "String", description: "Email address of user who created the ticket"},
+          allCcUsers: {type: "Array", description: "All (current or previous) CC users associated with the ticket"},
+          allCcUserIds: {type: "Array", description: "All (current or previous) CC users associated with the ticket"},
+          ccUserIds: {type: "Array", description: "CC users associated with the most recent reply"},
+          SLA: {type: "Hash", description: "SLA policy associated with the ticket"},
+          previousLocales: {type: "String", description: "List of previous locales"},
+          importId: {type: "String", description: "Import batch process"},
+      }
+
+      def initialize(attrs={})
+        super(attrs)
+      end
+
+      def attachments
+        @_attachments ||= (self.attrs[:attachments] || []).map {|attrs| Attachment.new(attrs)}
+      end
+
+      def user_info
+        @_user_info ||= UserInfo.new(self.attrs[:userInfo] || {})
+      end
+
+      def user
+        @_user ||= User.new(self.attrs[:user] || {})
+      end
+
+      def labels
+        @_labels ||= (self.attrs[:labels] || []).map {|attrs| Label.new(attrs)}
+      end
+
+      def last_reply
+        @_last_reply ||= Reply.new(self.attrs[:lastReply] || {})
+      end
+
+      def assigned_by
+        @_assigned_by ||= User.new(self.attrs[:assignedBy] || {})
+      end
+
+      def created_by_agent
+        @_created_by_agent ||= User.new(self.attrs[:createdByAgent] || {})
+      end
+
+      def assigned_user
+        @_assigned_user ||= Agent.new(self.attrs[:assignedUser] || {})
+      end
+
+      def assigned_group
+        @_assigned_group ||= Group.new(self.attrs[:assignedGroup] || {})
+      end
+
+      def all_cc_users
+        @_all_cc_users ||= (self.attrs[:allCcUsers] || []).map {|attrs| User.new(attrs)}
+      end
+
+      def self.from_payload(payload)
+        Enumerations::Channel.validate!(payload[:channel])
+
+        case payload[:channel]
+          when Enumerations::Channel::WEB
+            Models::Ticket.new(payload)
+          when Enumerations::Channel::BY_AGENT
+            Models::ByAgent.new(payload)
+          when Enumerations::Channel::EMAIL
+            Models::Reply.new(payload)
+          when Enumerations::Channel::PHONE_CALLBACK
+            Models::PhoneCallback.new(payload)
+          when Enumerations::Channel::WIDGET
+            Models::Widget.new(payload)
+          else
+            raise Exceptions::NotImplementedError.new('Channel', payload[:channel])
+        end
+      end
+    end
+  end
+end

data/lib/wixanswers/models/ticket/widget.rb

@@ -0,0 +1,7 @@
+
+module WixAnswers
+  module Models
+    class Widget < Ticket
+    end
+  end
+end

data/lib/wixanswers/models/user/agent.rb

@@ -0,0 +1,35 @@
+
+# https://help.wixanswers.com/kb/en/article/api-object-structures#agent-object
+module WixAnswers
+  module Models
+    class Agent < User
+      SCHEMA ||= User::SCHEMA.merge({
+        roleId: {type: 'String', description: 'User role'},
+        statusStartDate: {type: 'Integer', description: 'Time status last changed'},
+        agentCreationDate: {type: 'Integer', description: 'Time this user was made an agent'},
+        agentLastUpdateDate: {type: 'Integer', description: 'Last time the record of this agent was updated'},
+        manager: {type: 'Hash', description: 'The agent\'s manager'},
+        isManager: {type: 'Boolean', description: 'Whether this agent is a manager of one or more other agents'},
+        locationId: {type: 'String', description: 'The agent\'s location'},
+        teamId: {type: 'String', description: 'The agent\'s team'},
+        jobTitle: {type: 'String', description: 'The agent\'s job title'},
+        locales: {type: 'Array', description: 'The languages with which the agent is familiar'},
+        active: {type: 'Boolean', description: 'Whether the agent is active or not'},
+        supportUtilizationRate: {type: 'Integer', description: 'The agent\'s availability percentage'},
+        groupIds: {type: 'Array', description: 'The groups of which this agent is a member'},
+        qualifiedChannels: {type: 'Array', description: 'List of Agent Channels methods that the agent uses to communicate with users'},
+        channel: {type: 'Integer', description: 'Agent Channel to which the agent is currently assigned'},
+        customStatusId: {type: 'String', description: 'A custom busy status'},
+        agentStatus: {type: 'Integer', description: 'Agent Status'},
+        lastChatAssignedDate: {type: 'Integer', description: 'Time agent last assigned to a chat'},
+        assignedQueues: {type: 'Array', description: 'List of queues to which the agent is assigned'},
+        statistics: {type: 'Hash'},
+        customFields: {type: 'Hash', description: 'List of agent custom field values'},
+      })
+
+      def manager
+        @_manager ||= Agent.new(self.attrs[:manager] || {})
+      end
+    end
+  end
+end

data/lib/wixanswers/models/user/company.rb

@@ -0,0 +1,11 @@
+
+# https://help.wixanswers.com/en/article/api-object-structures#company-object
+module WixAnswers
+  module Models
+    class Company < Base
+      SCHEMA ||= {
+          id: {type: "String", description: "Company ID", required: true},
+      }
+    end
+  end
+end

data/lib/wixanswers/models/user/group.rb

@@ -0,0 +1,21 @@
+
+# https://help.wixanswers.com/kb/en/article/api-object-structures#group-object
+module WixAnswers
+  module Models
+    class Group < Base
+      SCHEMA ||= {
+          id: {type: 'String', description: 'The group ID', required: true},
+          name: {type: 'String', description: 'The group name, between 1 and 100 characters'},
+          settings: {type: 'Hash'},
+          creationDate: {type: 'Integer', description: 'Time this record was created', required: true},
+          latUpdateDate: {type: 'Integer', description: 'Last time this record was updated'},
+          membersCount: {type: 'Integer', description: 'Number of agents in the group'},
+          members: {type: 'Array', description: 'List of agents in the group'},
+      }
+
+      def members
+        @members ||= (self.attrs[:members] || []).map {|member| Agent.new(member)}
+      end
+    end
+  end
+end

data/lib/wixanswers/models/user/location.rb

@@ -0,0 +1,14 @@
+
+# https://help.wixanswers.com/kb/en/article/api-object-structures#location-object
+module WixAnswers
+  module Models
+    class Location < Base
+      SCHEMA ||= {
+          id: {type: 'String', description: 'The location ID', required: true},
+          name: {type: 'String', description: 'The location name'},
+          creationDate: {type: 'Integer', description: 'Time this record was created', required: true},
+          latUpdateDate: {type: 'Integer', description: 'Last time this record was updated'},
+      }
+    end
+  end
+end

data/lib/wixanswers/models/user/team.rb

@@ -0,0 +1,14 @@
+
+# https://help.wixanswers.com/kb/en/article/api-object-structures#team-object
+module WixAnswers
+  module Models
+    class Team < Base
+      SCHEMA ||= {
+          id: {type: 'String', description: 'The team ID', required: true},
+          name: {type: 'String', description: 'The team name'},
+          creationDate: {type: 'Integer', description: 'Time this record was created', required: true},
+          latUpdateDate: {type: 'Integer', description: 'Last time this record was updated'},
+      }
+    end
+  end
+end

data/lib/wixanswers/models/user/user.rb

@@ -0,0 +1,34 @@
+
+# https://help.wixanswers.com/kb/en/article/api-object-structures#user-object
+module WixAnswers
+  module Models
+    class User < Base
+      SCHEMA ||= {
+          id: {type: "String", description: "User ID", required: true},
+          firstName: {type: "String", description: "User first name"},
+          lastName: {type: "String", description: "User last name"},
+          userType: {type: 'Integer', description: "User Type", required: true},
+          email: {type: "String", description: "User email address, up to 200 characters. Must be unique to this user object."},
+          emailStatus: {type: "String", description: "Email Status"},
+          lastUpdateDate: {type: "Integer", description: "Time this record was last updated"},
+          profileImage: {type: "String", description: "URL of user’s profile image"},
+          signature: {type: "String", description: "URL of signature"},
+          phoneNumbers: {type: "Array", description: "List of phone numbers"},
+          company: {type: "Hash", description: "Associated company"},
+          isPartner: {type: "Boolean", description: "Whether the user is a partner"},
+          companyIds: {type: "Array", description: "List of associated companies"},
+          externalId: {type: "String", description: "Relevant only for tenants supporting SSO - the external ID in the tenant’s SSO auth system"},
+          creationDate: {type: "Integer", description: "Time this record was created"},
+          customFields: {type: "Hash", description: "List of user custom field values"},
+          banned: {type: "Boolean", description: "Whether the user is banned"},
+          importId: {type: "Boolean", description: "Import batch process"},
+      }
+
+      def validate!
+        super
+
+        Enumerations::UserType.validate!(self.userType)
+      end
+    end
+  end
+end

data/lib/wixanswers/models/user_info.rb

@@ -0,0 +1,44 @@
+
+module WixAnswers
+  module Models
+    class UserInfo < Base
+      SCHEMA ||= {
+        ip: {type: "String"},
+        userAgent: {type: "String"},
+        operatingSystemFamily: {type: "String"},
+        operatingSystemName: {type: "String"},
+        operatingSystemVersion: {type: "String"},
+        browserFamily: {type: "String"},
+        browserName: {type: "String"},
+        browserVersion: {type: "String"},
+        netSpeed: {type: "String"},
+        domain: {type: "String"},
+        ispName: {type: "String"},
+        organization: {type: "String"},
+        city: {type: "String"},
+        regionName: {type: "String"},
+        postalCode: {type: "String"},
+        metroCode: {type: "String"},
+        areaCode: {type: "String"},
+        countryCode: {type: "String"},
+        countryName: {type: "String"},
+        continentCode: {type: "String"},
+        latitude: {type: "Integer"},
+        longitude: {type: "Integer"},
+        timezone: {type: "String"},
+        asNumber: {type: "String"},
+        ipUserType: {type: "String"},
+        processed: {type: "Boolean"},
+      }
+
+      def initialize(attrs={})
+        super(attrs)
+      end
+
+      def validate!
+        # does not require validation
+        self
+      end
+    end
+  end
+end

data/lib/wixanswers/rest/api.rb

@@ -0,0 +1,6 @@
+
+
+module WixAnswers
+  module Api
+  end
+end

data/lib/wixanswers/rest/enumerations.rb

@@ -0,0 +1,95 @@
+
+
+module WixAnswers
+  module Enumerations
+    class Enumeration
+      def self.values
+        Set.new(constants.map {|const| const_get(const) })
+      end
+
+      def self.valid?(value)
+        values.include?(value)
+      end
+
+      def self.validate!(value)
+        raise Exceptions::UnsupportedType.new(self.name, value) unless self.valid?(value)
+      end
+    end
+
+    class WebhookType < Enumeration
+      TICKET_CREATED ||= 2
+      TICKET_STATUS_CHANGED ||= 8
+    end
+
+    class AttachmentStatus < Enumeration
+      FAILED ||= 1
+      INVALID_EXTENSION ||= 2
+      MAX_FILE_SIZE_EXCEEDED ||= 3
+      OK ||= 200
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#user-type
+    class UserType < Enumeration
+      AUTHENTICATED ||= 1
+      UNAUTHENTICATED ||= 2
+      PENDING_AUTHENTICATION ||= 4
+      PENDING_DELETION ||= 5
+      DELETED ||= 99
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#call-type
+    class CallType < Enumeration
+      INBOUND ||= 10
+      OUTBOUND ||= 20
+      CALLBACK ||= 30
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#reply-type
+    class ReplyType < Enumeration
+      USER ||= 100
+      CC_USER ||= 101
+      AGENT ||= 110
+      INTERNAL ||= 120
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#article-type
+    class ArticleType < Enumeration
+      ARTICLE ||= 100
+      FEATURE_REQUEST ||= 110
+      KNOWN_ISSUE ||= 120
+      VIDEO ||= 130
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#ticket-priority
+    class TicketPriority < Enumeration
+      LOW ||= 10
+      NORMAL ||= 20
+      HIGH ||= 30
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#channel
+    class Channel < Enumeration
+      WEB ||= 100
+      EMAIL ||= 110
+      PHONE_CALLBACK ||= 120
+      PHONE_OUTBOUND ||= 121
+      PHONE_INBOUND ||= 122
+      BY_AGENT ||= 130
+      FACEBOOK ||= 140
+      WHATSAPP ||= 150
+      CHAT ||= 160
+      WIDGET ||= 170
+      API ||= 180
+      SMS ||= 190
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#satisfaction
+    class Satisfaction < Enumeration
+      NOT_AT_ALL ||= 10
+      NOT_VERY ||= 10
+      SOMEWHAT ||= 20
+      VERY ||= 30
+      EXTREMELY ||= 40
+    end
+  end
+end

data/lib/wixanswers/rest/exceptions.rb

@@ -0,0 +1,28 @@
+
+module WixAnswers
+  module Exceptions
+    class UnsupportedType < StandardError
+      def initialize(payload_type, value)
+        super("Unsupported Payload #{payload_type.split('::')[-1]}: #{value}")
+      end
+    end
+
+    class MissingAttribute < StandardError
+      def initialize(value)
+        super("Missing Attribute: #{value}")
+      end
+    end
+
+    class SchemaTypeError < TypeError
+      def initialize(expected, actual)
+        super("no implicit conversation of #{expected} to #{actual}")
+      end
+    end
+
+    class NotImplementedError < StandardError
+      def initialize(object_type, value)
+        super("Unimplemented #{object_type} Entity: #{value}")
+      end
+    end
+  end
+end

data/lib/wixanswers/version.rb

@@ -0,0 +1,38 @@
+module WixAnswers
+  module Version
+    module_function
+
+    def major
+      0
+    end
+
+    def minor
+      0
+    end
+
+    def patch
+      3
+    end
+
+    def pre
+      nil
+    end
+
+    def to_h
+      {
+          major: major,
+          minor: minor,
+          patch: patch,
+          pre: pre,
+      }
+    end
+
+    def to_a
+      [major, minor, patch, pre].compact
+    end
+
+    def to_s
+      to_a.join('.')
+    end
+  end
+end

data/wixanswers.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'wixanswers/version'
+
+Gem::Specification.new do |spec|
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.authors = ['Roee Sheelo']
+  spec.description = 'A Ruby interface to the WixAnswers API'
+  spec.email = %w[roee.sheelo@gmail.com]
+  spec.files = %w[CHANGELOG.md LICENSE.md README.md wixanswers.gemspec] + Dir['lib/**/*.rb']
+  spec.homepage = 'https://github.com/communit-team/wixanswers'
+  spec.licenses = %w[MIT]
+  spec.name = 'wixanswers'
+  spec.require_paths = %w[lib]
+  spec.required_ruby_version = '>= 2.3.1'
+  spec.summary = spec.description
+  spec.version = WixAnswers::Version
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: wixanswers
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Roee Sheelo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Ruby interface to the WixAnswers API
+email:
+- roee.sheelo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/wixanswers.rb
+- lib/wixanswers/models/attachment.rb
+- lib/wixanswers/models/base.rb
+- lib/wixanswers/models/label.rb
+- lib/wixanswers/models/ticket/by_agent.rb
+- lib/wixanswers/models/ticket/chat.rb
+- lib/wixanswers/models/ticket/phone_callback.rb
+- lib/wixanswers/models/ticket/reply.rb
+- lib/wixanswers/models/ticket/ticket.rb
+- lib/wixanswers/models/ticket/widget.rb
+- lib/wixanswers/models/user/agent.rb
+- lib/wixanswers/models/user/company.rb
+- lib/wixanswers/models/user/group.rb
+- lib/wixanswers/models/user/location.rb
+- lib/wixanswers/models/user/team.rb
+- lib/wixanswers/models/user/user.rb
+- lib/wixanswers/models/user_info.rb
+- lib/wixanswers/rest/api.rb
+- lib/wixanswers/rest/enumerations.rb
+- lib/wixanswers/rest/exceptions.rb
+- lib/wixanswers/version.rb
+- wixanswers.gemspec
+homepage: https://github.com/communit-team/wixanswers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to the WixAnswers API
+test_files: []