wixanswers 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ea3ae208b3949e16ea98b5a5b92a5b55f0b3238efd2a7166307d35bfcbfefc3
-  data.tar.gz: e6b530888e60633decb0a3216a1786053f0a742fdb22ea7fb19603d93e2a9b3e
+  metadata.gz: 21d43335f8bcfa2fb50d395f15d2f91ebcc8dabd8232bd9c16e6aa6d1cd7d1b0
+  data.tar.gz: f007d21c8e72e016b8ab1fe1d05a94b6ea0f3773eee0fd75f805f45b4538808e
 SHA512:
-  metadata.gz: 6fbf6a0659f0494a60620852000497cd74c902a20b276cf8088836cb353cf1e49f403041667d716abfef6226258ec5cb5cab01fc5ae4f899682219175e0a049b
-  data.tar.gz: 2ee1de36a98bda372ffc06d7e274da99ba4cd1631977ed1e60c5a85072205c9a35495466ecbc9a0542727c6637c2f0772bfe80ae56c36aeaeca8c0326f0a7c1a
+  metadata.gz: 79a990f97a8b3af128ac72a3d2fa372813a3eddeba6341857a6912134621877303939cd3159aac2419df1a49dcac5ec1f479e7f63621fd2aa39b95a5153aae5e
+  data.tar.gz: 447cbf3731bd905b5132054f5632cf6f311c2c5ca7598ae21985d0e5931c8b5c55167a34b050ec0a2bcb8f7e9a47badfb547f88efe85bc43084ebf08ee3fa5f0

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+0.0.6 (In Progress)
+------
+* added PhoneNumber object
+* added API and Request modules, 
+* added Client class
+* added support for ticket 'Add', 'Get'
+
+0.0.5 (Stable)
+------
+* added all Enumeration objects
+* added Enumeration#title method
+
 0.0.3
 ------
 * support email-based tickets

data/lib/wixanswers.rb

@@ -1,6 +1,7 @@
 require 'wixanswers/rest/api'
-require 'wixanswers/rest/enumerations'
-require 'wixanswers/rest/exceptions'
+
+require 'wixanswers/enumerations'
+require 'wixanswers/exceptions'
 
 require 'wixanswers/models/base'
 

data/lib/wixanswers/enumerations.rb

@@ -0,0 +1,427 @@
+
+
+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
+
+      def self.by_values
+        constants.map {|const| [const_get(const), const] }.to_h
+      end
+
+      def self.title(value)
+        const_name = self.by_values[value]
+        return '' if const_name.nil?
+
+        const_name.to_s.capitalize.gsub(/\_/, ' ')
+      end
+    end
+
+    class WebhookType < Enumeration
+      TICKET_CREATED ||= 2
+      TICKET_STATUS_CHANGED ||= 8
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#agent-channel-1
+    class AgentChannel < Enumeration
+      NONE ||= 0
+      TICKET ||= 10
+      CALL_CENTER ||= 20
+      CHAT ||= 30
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#agent-status
+    class AgentStatus < Enumeration
+      ONLINE ||= 10
+      IN_WORK ||= 40
+      BUSY ||= 60
+      OFFLINE ||= 100
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#article-resolution
+    class ArticleResolution < Enumeration
+      COLLECTING_VOTES ||= 110
+      IN_DEVELOPMENT ||= 112
+      COMING_SOON ||= 114
+      RELEASED ||= 116
+      INVESTIGATING ||= 120
+      WORKING_ON_IT ||= 122
+      RESOLVED ||= 124
+      THIRD_PARTY_BUG ||= 126
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#article-status
+    class ArticleStatus < Enumeration
+      DRAFT ||= 0
+      PUBLISHED ||= 10
+      DELETED ||= 30
+    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#article-version-publication-status
+    class ArticleVersionPublicationStatus < Enumeration
+      DRAFT ||= 0
+      PUBLISHED ||= 1
+    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#call-participant-status
+    class CallParticipantStatus < Enumeration
+      CONNECTING ||= 10
+      TALKING ||= 20
+      ON_HOLD ||= 30
+      MUTED ||= 40
+      LEFT ||= 50
+      DECLINED ||= 60
+      NO_ANSWER ||= 70
+      CANCELLED ||= 80
+      INVITED ||= 90
+      FAILED ||= 100
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#call-priority
+    class CallPriority < Enumeration
+      NORMAL ||= 0
+      HIGH ||= 1
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#call-status
+    class CallStatus < Enumeration
+      IN_IVR ||= 10
+      IN_QUEUE ||= 20
+      RESERVED ||= 30
+      INITIATED ||= 40
+      RINGING ||= 50
+      IN_PROGRESS ||= 60
+      COMPLETED ||= 70
+      COMPLETED_IN_IVR ||= 71
+      FORWARDED ||= 72
+      TRANSFERRED_TO_NUMBER ||= 73
+      COMPLETED_VOICEMAIL ||= 74
+      PENDING_VOICEMAIL ||= 75
+      BUSY ||= 80
+      FAILED ||= 90
+      NO_ANSWER ||= 100
+      CANCELLED ||= 110
+      EXPIRED ||= 120
+      TRANSFERRED_TO_QUEUE ||= 130
+      ABANDONED ||= 140
+      HUNG_UP_IN_QUEUE ||= 150
+      HUNG_UP_IN_IVR ||= 160
+      TRANSFERRED_TO_IVR ||= 170
+    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#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#chat-message-status
+    class ChatMessageStatus < Enumeration
+      QUEUED ||= 10
+      FAILED ||= 20
+      SENT ||= 30
+      DELIVERED ||= 40
+      FAILED ||= 50
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#chat-message-type
+    class ChatMessageType < Enumeration
+      USER ||= 100
+      AGENT ||= 110
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#chat-participant-status
+    class ChatParticipantStatus < Enumeration
+      TALKING ||= 10
+      LEFT ||= 20
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#chat-status
+    class ChatStatus < Enumeration
+      WAITING ||= 0
+      ACTIVE ||= 1
+      COMPLETED ||= 2
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#content-task-priority
+    class ContentTaskPriority < Enumeration
+      LOW ||= 10
+      NORMAL ||= 20
+      HIGH ||= 30
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#content-task-status
+    class ContentTaskStatus < Enumeration
+      OPEN ||= 10
+      COMPLETED ||= 20
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#content-task-type
+    class ContentTaskType < Enumeration
+      WRITE ||= 10
+      UPDATE ||= 20
+      REVIEW ||= 30
+      TRANSLATE ||= 40
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#counter-type
+    class CounterType < Enumeration
+      FOLLOWER ||= 10
+      VIEW ||= 20
+      VOTE ||= 30
+
+      UNHELPFUL ||= 300
+      RATING_1 ||= 300
+
+      HELPFUL ||= 304
+      RATING_5 ||= 304
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#custom-field-type
+    class ContentTaskType < Enumeration
+      TEXT ||= 1
+      MULTI_LINE_TEXT ||= 2
+      SINGLE_SELECT ||= 3
+      MULTI_SELECT ||= 4
+      NUMBER ||= 5
+      CHECKBOX ||= 6
+      DATE_PICKER ||= 7
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#email-status
+    class EmailStatus < Enumeration
+      NOT_VERIFIED ||= 0
+      VERIFIED ||= 1
+      INVALIDATED ||= 99
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#event-type
+    class EventType < Enumeration
+      ARTICLE_ADDED ||= 650
+      ARTICLE_UPDATED ||= 651
+      ARTICLE_CONTENT_UPDATED ||= 652
+      ARTICLE_DELETED ||= 653
+      ARTICLE_RESTORED ||= 654
+      ARTICLE_MERGED ||= 655
+      ARTICLE_UNPUBLISHED ||= 656
+      ARTICLE_PUBLISHED ||= 663
+      ARTICLE_LABELS_UPDATED ||= 665
+      ARTICLE_PHRASES_UPDATED ||= 666
+      ARTICLE_VISIBILITY_CHANGED ||= 667
+      TICKET_UPDATED ||= 700
+      TICKET_CONTENT_UPDATED ||= 701
+      TICKET_DELETED ||= 702
+      TICKET_STATUS_CHANGED ||= 703
+      REPLY_DELETED ||= 705
+      OUTBOUND_TICKET_ADDED ||= 707
+      REPLY_CONTENT_UPDATED ||= 709
+      REPLY_MOVED ||= 710
+      TICKET_CREATED_FROM_REPLLY ||= 711
+      TICKET_LABELS_UPDATED ||= 712
+      SCHEDULED_CALL_CANCELLED ||= 713
+      REPLY_MADE_INTO_TICKET ||= 714
+      TICKET_LOCALE_CHANGED ||= 715
+      TICKET_SET_PRIVATE ||= 716
+      TICKET_ARTICLE_RELATIONS_CHANGED ||= 717
+      TICKET_PRIORITY_CHANGED ||= 718
+      TICKET_ASSIGNED ||= 722
+      TICKET_UNASSIGNED ||= 723
+      TICKET_MARKED_AS_SPAM ||= 724
+      REPLY_MOVED_TO_TICKET ||= 725
+      REPLY_MOVED_FROM_TICKET ||= 726
+      INTERNAL_NOTE_DELETED ||= 727
+      TICKET_CUSTOM_FIELDS_UPDATED ||= 728
+      AGENT_REPLY_ADDED ||= 729
+      TICKET_ATTACHMENTS_REMOVED ||= 730
+      REPLY_ATTACHMENTS_REMOVED ||= 731
+      RULE_FAILED ||= 732
+      TICKET_TRANSFERRED ||= 733
+      EMAIL_SENT||= 734
+      REPLY_UPDATED_ON_TICKET_TRANSFERRED ||= 735
+      TICKET_AUTHENTICATED ||= 736
+      SLA_POLICY_ADDED_TO_TICKET ||= 737
+      MACRO_APPLIED_ON_TICKET ||= 738
+      AGENT_INERNAL_REPLY_ADDED ||= 739
+      TICKET_AUTOMATICALLY_ASSIGNED_TO_ACCOUNT_MANAGER ||= 740
+      ADD_CUSTOM_TICKET_TIMELINE_API ||= 742
+      CATEGORY_ADDED ||= 800
+      CATEGORY_REMOVED ||= 801
+      CATEGORY_LANGUAGE_VALUES_CHANGED ||= 802
+      CATEGORY_UPDATED ||= 803
+      CATEGORY_MOVED ||= 804
+      CHAT_TICKET_USER_UPDATED ||= 1500
+      AGENT_JOINED_CHAT ||= 1501
+      AGENT_LEFT_CHAT ||= 1502
+      AGENT_ENDED_CHAT ||= 1503
+      TICKET_HANDLING_STARTED ||= 2500
+      TICKET_HANDLING_ENDED ||= 2501
+      ALL_TICKET_HANDLING_ENDED ||= 2502
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#item-type874
+    class ItemType < Enumeration
+      CATEGORY ||= 2
+      SEO_CONTENT ||= 6
+      TENANT ||= 7
+      TICKET ||= 8
+      REPLY ||= 9
+      ARTICLE ||= 10
+      EMAIL_TEMPLATE ||= 14
+      CONTENT_TASK ||= 40
+      MAILBOX ||= 50
+      USER ||= 60
+      SAVED_REPLY ||= 70
+      LABEL ||= 90
+      URL_MAPPING ||= 110
+      MULTILINGUAL_TEXT ||= 120
+      SAVED_FILTER ||= 130
+      PHONE_CALL ||= 150
+      NOTE ||= 160
+      CHAT_MESSAGE ||= 170
+      CHAT ||= 175
+      INTEGRATION ||= 180
+      SLA_POLICY ||= 190
+      GROUP ||= 200
+      WIDGET ||= 210
+      LINE ||= 220
+      WIDGET_MULTILINGUAL_TEXTS ||= 221
+      COMPANY ||= 230
+      QUEUE ||= 260
+      USER_ROLE ||= 280
+      AGENT ||= 300
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#rating
+    class Rating < Enumeration
+      POSITIVE ||= 10
+      NEUTRAL ||= 20
+      NEGATIVE ||= 30
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#reply-status
+    class ReplyStatus < Enumeration
+      DRAFT ||= 0
+      PUBLISHED ||= 1
+      DELETED ||= 2
+    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#satisfaction
+    class Satisfaction < Enumeration
+      NOT_AT_ALL ||= 10
+      NOT_VERY ||= 10
+      SOMEWHAT ||= 20
+      VERY ||= 30
+      EXTREMELY ||= 40
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#saved-filter-context
+    class SavedFilterContext < Enumeration
+      TICKET ||= 0
+      CHAT ||= 10
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#saved-filter-type
+    class SavedFilterType < Enumeration
+      SYSTEM ||= 0
+      PRIVATE ||= 10
+      PUBLIC ||= 20
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#saved-reply-status
+    class SavedReplyStatus < Enumeration
+      DRAFT ||= 0
+      PUBLISHED ||= 1
+      DELETE ||= 2
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#search-type
+    class SearchType < Enumeration
+      EXACT ||= 1
+      CONTAINS ||= 2
+      NOT_CONTAINS ||= 3
+    end
+
+    # https://help.wixanswers.com/kb/en/article/api-enumerations#sla-policy-status
+    class SLAPolicyStatus < Enumeration
+      PAUSED ||= 0
+      ACTIVE ||= 1
+      COMPLETED_SUCCESSFULLY ||= 2
+      COMPLETED_UNSUCCESSFULLY ||= 3
+    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#ticket-status
+    class TicketStatus < Enumeration
+      OPEN ||= 100
+      PENDING ||= 110
+      CLOSED ||= 120
+      SOLVED = 140
+      INVESTIGATING = 150
+    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
+  end
+end

data/lib/wixanswers/models/line/phone_number.rb

@@ -0,0 +1,12 @@
+
+# https://help.wixanswers.com/kb/en/article/api-object-structures#phone-number-object
+module WixAnswers
+  module Models
+    class PhoneNumber < Base
+      SCHEMA ||= {
+          countryCode: {type: 'String', description: 'The country code', required: true},
+          number: {type: 'String', description: 'The number', required: true},
+      }
+    end
+  end
+end

data/lib/wixanswers/rest/api.rb

@@ -1,6 +1,9 @@
-
+require 'wixanswers/rest/ticket'
 
 module WixAnswers
-  module Api
+  module REST
+    module API
+      include WixAnswers::REST::Ticket
+    end
   end
 end

data/lib/wixanswers/rest/client.rb

@@ -0,0 +1,26 @@
+
+require 'wixanswers/rest/api'
+require 'wixanswers/rest/request'
+
+module WixAnswers
+  module REST
+    class Client
+      include WixAnswers::REST::API
+      attr_accessor :bearer_token
+
+      def perform_request(path, request_method=:get, options = {})
+        WixAnswers::REST::Request.new(self, path, request_method, options).perform
+      end
+
+      # @return [Boolean]
+      def bearer_token?
+        !!bearer_token
+      end
+
+      # @return [Boolean]
+      def credentials?
+        super || bearer_token?
+      end
+    end
+  end
+end

data/lib/wixanswers/rest/request.rb

@@ -0,0 +1,47 @@
+
+
+module WixAnswers
+  module REST
+    class Request
+      def initialize(client, request_method, path, options: {}, headers: {})
+        @client = client
+
+        @request_method = request_method.to_sym
+
+        @uri = Addressable::URI.parse("#{client.base_url}/#{client.version}/#{path}")
+        @path = @uri.path
+
+        @options = options
+        @headers = default_headers.merge(headers)
+      end
+
+      def perform
+        response = self.send(@request_method, @uri.to_s, headers: @headers)
+
+        response.body
+      end
+
+      def default_headers
+        {'Content-Type' => 'application/json; charset=utf-8', 'Accept' => 'application/json'}
+      end
+
+      private
+
+      def get(uri, params: {}, headers: {})
+        HTTParty.get("#{uri}/#{params.to_param}", headers: headers)
+      end
+
+      def post(uri, body, headers)
+        HTTParty.post(uri, body: body, headers: headers)
+      end
+
+      def put(uri, body, headers)
+        HTTParty.put(uri, body: body, headers: headers)
+      end
+
+      def delete(uri, body, headers)
+        HTTParty.delete(uri, body: body, headers: headers)
+      end
+    end
+  end
+end

data/lib/wixanswers/rest/ticket.rb

@@ -0,0 +1,162 @@
+
+
+module WixAnswers
+  module REST
+    module Ticket
+      # Create a ticket for the authenticated user associated with the JWT token
+      #
+      # @see https://help.wixanswers.com/kb/en/article/ticket-apis#add-a-ticket-as-an-authenticated-user
+      # @authorization Requires user authorization token for specific user
+      # @raise [WixAnswers::Exceptions::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return <WixAnswers::Models::Ticket>
+      # @param options [Hash] A customizable set of options
+      # @option subject [String] A short description of the problem or question
+      # @option content [String] A complete description of the problem or question
+      # @option locale [String] The locale for the ticket
+      def add(options = {})
+        WixAnswers::Models::Ticket.new(perform_request("/tickets", :post, options))
+      end
+
+      # Create a ticket on behalf of an authenticated or unauthenticated user.
+      # Use this in response to a user request where the agent creates the ticket
+      # based on that request on behalf of the user.
+      #
+      # @see https://help.wixanswers.com/kb/en/article/ticket-apis#add-a-ticket-as-an-agent-on-behalf-of-a-user
+      # @authorization Requires agent authorization token and permission CREATE_TICKETS
+      # @raise [WixAnswers::Exceptions::Unauthorized] Error raised when supplied agent credentials are not valid.
+      # @return <WixAnswers::Models::Ticket>
+      # @param options [Hash] A customizable set of options
+      # @option recipientEmail [String] Email of the user this ticket is created for.
+      #                                 Either this parameter or recipientId is required.
+      # @option recipientId [String] ID of the user this ticket is created for
+      # @option subject [String] A short description of the problem or question
+      # @option content [String] A complete description of the problem or question
+      # @option locale [String] The locale for the ticket
+      def add_on_behalf(options = {})
+        WixAnswers::Models::Ticket.new(perform_request("/tickets/onBehalf", :post, options))
+      end
+
+      # Create a new ticket for an unauthenticated user who has provided an email address.
+      # Use this API only when a user GUID is not available, for example when an unregistered
+      # user creates a ticket on your site or widget.
+      #
+      # @see https://help.wixanswers.com/kb/en/article/ticket-apis#add-a-guest-unauthenticated-user-ticket
+      # @authorization Requires agent authorization token and permission CREATE_TICKETS
+      # @raise [WixAnswers::Exceptions::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return <WixAnswers::Models::Ticket>
+      # @param options [Hash] A customizable set of options
+      # @option userEmail [String] Email of the user this ticket is associated with
+      # @option subject [String] A short description of the problem or question
+      # @option content [String] A complete description of the problem or question
+      # @option locale [String] The locale for the ticket
+      def add_as_guest(options = {})
+        WixAnswers::Models::Ticket.new(perform_request("/tickets/guest", :post, options))
+      end
+
+      # Create a new ticket from an existing user reply. The new ticket takes many of its details
+      # (user, priority, status, and so forth) from the existing ticket, and the new contents from the reply.
+      # After creating the ticket, Wix Answer invokes the Ticket Created webhook.
+      #
+      # @see https://help.wixanswers.com/kb/en/article/ticket-apis#convert-a-user-reply-into-a-new-ticket
+      # @authorization Requires agent authorization token and permission CREATE_TICKETS
+      # @raise [WixAnswers::Exceptions::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return <WixAnswers::Models::Ticket>
+      # @param ticket_id [String] ticket GUID
+      # @param reply_id [String] reply GUID
+      # @param options [Hash] A customizable set of options
+      # @option subject [String] A short description of the problem or question
+      def add_as_agent(ticket_id, reply_id, options = {})
+        WixAnswers::Models::Ticket.new(perform_request("/tickets/#{ticket_id}/replies/#{reply_id}/createTicket", :post, options))
+      end
+
+      # Create a new callback request ticket to the passed phone number, for the user associated with the JWT token.
+      # Requires a line that supports outbound calls.
+      #
+      # @see https://help.wixanswers.com/kb/en/article/ticket-apis#add-a-phone-callback-request-ticket
+      # @authorization Requires user authorization token for specific user
+      # @raise [WixAnswers::Exceptions::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return <WixAnswers::Models::Ticket>
+      # @param options [Hash] A customizable set of options
+      # @option phoneNumber [Hash, WixAnswers::Models::PhoneNumber] Phone number to call back
+      # @option lineId [Integer] The account's phone line ID from which the callback will take place.
+      #                          See Call Center Lines APIs.
+      def add_callback_request(options = {})
+        options[:phoneNumber] = options[:phoneNumber].is_a?(WixAnswers::Models::PhoneNumber) ? options[:phoneNumber].attrs : options[:phoneNumber]
+        WixAnswers::Models::Ticket.new(perform_request("/tickets/callbackRequests", :post, options))
+      end
+
+      # Get a ticket by its ID. This requires agent privileges; to get one of your own tickets
+      # (with user privileges), see Get One of Your Tickets by ID.
+      #
+      # @see https://help.wixanswers.com/kb/en/article/ticket-apis#get-a-ticket-by-id
+      # @authorization Requires agent authorization token and permission FETCH_TICKETS
+      # @raise [WixAnswers::Exceptions::Unauthorized] Error raised when supplied agent credentials are not valid.
+      # @return <WixAnswers::Models::Ticket>
+      # @param ticket_id [String] Ticket GUID
+      def ticket(ticket_id)
+        WixAnswers::Models::Ticket.new(perform_request("/tickets/#{ticket_id}/admin"))
+      end
+      alias find_by_id ticket
+
+      # Get a ticket by its ticket reference number (issue ID). This requires agent privileges;
+      # to get one of your own tickets (with user privileges), see Get One of Your Tickets by ID.
+      #
+      # @see https://help.wixanswers.com/kb/en/article/ticket-apis#get-a-ticket-by-ticket-reference-number
+      # @authorization Requires agent authorization token and permission FETCH_TICKETS
+      # @raise [WixAnswers::Exceptions::Unauthorized] Error raised when supplied agent credentials are not valid.
+      # @return <WixAnswers::Models::Ticket>
+      # @param ticket_number [Integer] Ticket Number
+      def find_by_number(ticket_number)
+        WixAnswers::Models::Ticket.new(perform_request("/tickets/byNumber/#{ticket_number}/admin"))
+      end
+
+      # Get one of your tickets by its ID. The main use-case for this API is from the Help Center.
+      # If you have agent privileges, you can get any ticket by its reference number or id;
+      # see Get a Ticket by Ticket Reference Number.
+      #
+      # @see https://help.wixanswers.com/kb/en/article/ticket-apis#get-a-ticket-by-ticket-reference-number
+      # @authorization Requires agent authorization token and permission FETCH_TICKETS
+      # @raise [WixAnswers::Exceptions::Unauthorized] Error raised when supplied agent credentials are not valid.
+      # @return <WixAnswers::Models::Ticket>
+      # @param ticket_id [String] Ticket GUID
+      def my_ticket(ticket_id)
+        WixAnswers::Models::Ticket.new(perform_request("/tickets/byNumber/#{ticket_id}/my"))
+      end
+
+      # Get list of tickets that match the search/filtering criteria.
+      #
+      # @see https://help.wixanswers.com/kb/en/article/ticket-apis#search-tickets-agent
+      # @authorization Requires agent authorization token and permission FETCH_TICKETS
+      # @raise [WixAnswers::Exceptions::Unauthorized] Error raised when supplied agent credentials are not valid.
+      # @return [Array<WixAnswers::Models::Ticket>]
+      # @param options [Hash] A customizable set of options
+      def search(options = {})
+        perform_request("/tickets/search/admin", :post, options).map {|ticket| WixAnswers::Models::Ticket.new(ticket) }
+      end
+
+      # Get list of your tickets that match the search/filtering criteria.
+      # The main use-case for this API is from the Help Center.
+      #
+      # @see https://help.wixanswers.com/kb/en/article/ticket-apis#search-your-tickets1097
+      # @authorization Requires user authorization token for specific user
+      # @raise [WixAnswers::Exceptions::Unauthorized] Error raised when supplied agent credentials are not valid.
+      # @return [Array<WixAnswers::Models::Ticket>]
+      # @param options [Hash] A customizable set of options
+      def search_mine(options = {})
+        perform_request("/tickets/my", :post, options).map {|ticket| WixAnswers::Models::Ticket.new(ticket) }
+      end
+
+      # Get the number of tickets matching one or more saved filters.
+      #
+      # @see https://help.wixanswers.com/kb/en/article/ticket-apis#get-the-number-of-tickets-matching-one-or-more-saved-filters
+      # @authorization Requires agent authorization token and permission FETCH_TICKET_VIEWS
+      # @raise [WixAnswers::Exceptions::Unauthorized] Error raised when supplied agent credentials are not valid.
+      # @return [Hash]
+      # @param options [Hash] A customizable set of options
+      # @option locale [String] Get the number of tickets matching one or more saved filters.
+      def count(options = {})
+        perform_request("/tickets/filtersCounts", :post, options)
+      end
+    end
+  end
+end

data/lib/wixanswers/version.rb

@@ -11,7 +11,7 @@ module WixAnswers
     end
 
     def patch
-      4
+      5
     end
 
     def pre

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wixanswers
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Roee Sheelo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-17 00:00:00.000000000 Z
+date: 2020-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -35,9 +35,12 @@ files:
 - LICENSE.md
 - README.md
 - lib/wixanswers.rb
+- lib/wixanswers/enumerations.rb
+- lib/wixanswers/exceptions.rb
 - lib/wixanswers/models/attachment.rb
 - lib/wixanswers/models/base.rb
 - lib/wixanswers/models/label.rb
+- lib/wixanswers/models/line/phone_number.rb
 - lib/wixanswers/models/ticket/by_agent.rb
 - lib/wixanswers/models/ticket/chat.rb
 - lib/wixanswers/models/ticket/phone_callback.rb
@@ -52,8 +55,9 @@ files:
 - 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/rest/client.rb
+- lib/wixanswers/rest/request.rb
+- lib/wixanswers/rest/ticket.rb
 - lib/wixanswers/version.rb
 - wixanswers.gemspec
 homepage: https://github.com/communit-team/wixanswers

data/lib/wixanswers/rest/enumerations.rb

@@ -1,95 +0,0 @@
-
-
-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