gorgias-ruby 0.1.0

data/lib/gorgias/resources/tags.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Gorgias
+  module Resources
+    class Tags < Base
+      # Create a new tag.
+      #
+      # @param params [Hash] Tag attributes (name, etc.)
+      # @return [Gorgias::Object]
+      def create(**params)
+        post("/api/tags", params)
+      end
+
+      # List tags.
+      #
+      # @param params [Hash] Filter/pagination options
+      # @return [Array<Gorgias::Object>]
+      def list(**params)
+        get("/api/tags", params)
+      end
+
+      # Retrieve a single tag by ID.
+      #
+      # @param id [Integer, String]
+      # @return [Gorgias::Object]
+      def retrieve(id)
+        get("/api/tags/#{id}/")
+      end
+
+      # Update a tag.
+      #
+      # @param id [Integer, String]
+      # @param params [Hash] Attributes to update
+      # @return [Gorgias::Object]
+      def update(id, **params)
+        put("/api/tags/#{id}/", params)
+      end
+
+      # Delete a tag.
+      #
+      # @param id [Integer, String]
+      # @return [true]
+      def delete(id)
+        super("/api/tags/#{id}/")
+      end
+
+      # Merge one tag into another.
+      #
+      # @param id [Integer, String] Source tag ID
+      # @param params [Hash] Merge attributes (target_id, etc.)
+      # @return [Gorgias::Object]
+      def merge(id, **params)
+        put("/api/tags/#{id}/merge", params)
+      end
+    end
+  end
+end

data/lib/gorgias/resources/ticket_messages.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Gorgias
+  module Resources
+    class TicketMessages < Base
+      # Create a message on a ticket.
+      #
+      # @param ticket_id [Integer, String] Parent ticket ID
+      # @param params [Hash] Message attributes:
+      #   - :body_text [String] Plain-text body
+      #   - :body_html [String] HTML body
+      #   - :from_agent [Boolean]
+      #   - :channel [String]
+      #   - :attachments [Array<Hash>]
+      # @return [Gorgias::Object]
+      def create(ticket_id, **params)
+        post("/api/tickets/#{ticket_id}/messages", params)
+      end
+
+      # List messages for a ticket.
+      #
+      # @param ticket_id [Integer, String]
+      # @param params [Hash] Filter/pagination options
+      # @return [Array<Gorgias::Object>]
+      def list(ticket_id, **params)
+        get("/api/tickets/#{ticket_id}/messages", params)
+      end
+
+      # Retrieve a single message by ID.
+      #
+      # @param ticket_id [Integer, String]
+      # @param id [Integer, String] Message ID
+      # @return [Gorgias::Object]
+      def retrieve(ticket_id, id)
+        get("/api/tickets/#{ticket_id}/messages/#{id}/")
+      end
+
+      # Update a ticket message.
+      #
+      # @param ticket_id [Integer, String]
+      # @param id [Integer, String] Message ID
+      # @param params [Hash] Attributes to update
+      # @return [Gorgias::Object]
+      def update(ticket_id, id, **params)
+        put("/api/tickets/#{ticket_id}/messages/#{id}/", params)
+      end
+
+      # Delete a ticket message.
+      #
+      # @param ticket_id [Integer, String]
+      # @param id [Integer, String] Message ID
+      # @return [true]
+      def delete(ticket_id, id)
+        super("/api/tickets/#{ticket_id}/messages/#{id}/")
+      end
+    end
+  end
+end

data/lib/gorgias/resources/tickets.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Gorgias
+  module Resources
+    class Tickets < Base
+      # Create a new ticket.
+      #
+      # @param params [Hash] Ticket attributes:
+      #   - :subject [String]
+      #   - :channel [String] e.g. "email", "chat"
+      #   - :status [String] e.g. "open", "closed"
+      #   - :customer [Hash] { id: } or { email: }
+      #   - :tags [Array<Hash>]
+      #   - :assignee_user [Hash]
+      #   - :assignee_team [Hash]
+      #   - :messages [Array<Hash>] Initial messages
+      # @return [Gorgias::Object]
+      def create(**params)
+        post("/api/tickets", params)
+      end
+
+      # List tickets (paginated).
+      #
+      # @param params [Hash] Filter/pagination options:
+      #   - :status [String]
+      #   - :customer_id [Integer]
+      #   - :assignee_user_id [Integer]
+      #   - :channel [String]
+      #   - :cursor [String]
+      #   - :limit [Integer]
+      # @return [Array<Gorgias::Object>]
+      def list(**params)
+        get("/api/tickets", params)
+      end
+
+      # Retrieve a single ticket by ID.
+      #
+      # @param id [Integer, String]
+      # @return [Gorgias::Object]
+      def retrieve(id)
+        get("/api/tickets/#{id}/")
+      end
+
+      # Update a ticket.
+      #
+      # @param id [Integer, String]
+      # @param params [Hash] Attributes to update
+      # @return [Gorgias::Object]
+      def update(id, **params)
+        put("/api/tickets/#{id}/", params)
+      end
+
+      # Close a ticket.
+      #
+      # @param id [Integer, String]
+      # @return [Gorgias::Object]
+      def close(id)
+        put("/api/tickets/#{id}/close")
+      end
+
+      # Mark a ticket as spam.
+      #
+      # @param id [Integer, String]
+      # @return [Gorgias::Object]
+      def mark_as_spam(id)
+        put("/api/tickets/#{id}/spam")
+      end
+
+      # Delete a ticket.
+      #
+      # @param id [Integer, String]
+      # @return [true]
+      def delete(id)
+        super("/api/tickets/#{id}/")
+      end
+    end
+  end
+end

data/lib/gorgias/resources/users.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Gorgias
+  module Resources
+    class Users < Base
+      # Create a new agent/user.
+      #
+      # @param params [Hash] User attributes (name, email, role, etc.)
+      # @return [Gorgias::Object]
+      def create(**params)
+        post("/api/users", params)
+      end
+
+      # List users (agents).
+      #
+      # @param params [Hash] Filter/pagination options
+      # @return [Array<Gorgias::Object>]
+      def list(**params)
+        get("/api/users", params)
+      end
+
+      # Retrieve a single user by ID.
+      #
+      # @param id [Integer, String]
+      # @return [Gorgias::Object]
+      def retrieve(id)
+        get("/api/users/#{id}/")
+      end
+
+      # Update a user.
+      #
+      # @param id [Integer, String]
+      # @param params [Hash] Attributes to update
+      # @return [Gorgias::Object]
+      def update(id, **params)
+        put("/api/users/#{id}/", params)
+      end
+
+      # Delete a user.
+      #
+      # @param id [Integer, String]
+      # @return [true]
+      def delete(id)
+        super("/api/users/#{id}/")
+      end
+    end
+  end
+end

data/lib/gorgias/resources/views.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Gorgias
+  module Resources
+    class Views < Base
+      # Create a new view.
+      #
+      # @param params [Hash] View attributes (name, filters, etc.)
+      # @return [Gorgias::Object]
+      def create(**params)
+        post("/api/views", params)
+      end
+
+      # List views.
+      #
+      # @param params [Hash] Filter/pagination options
+      # @return [Array<Gorgias::Object>]
+      def list(**params)
+        get("/api/views", params)
+      end
+
+      # Retrieve a single view by ID.
+      #
+      # @param id [Integer, String]
+      # @return [Gorgias::Object]
+      def retrieve(id)
+        get("/api/views/#{id}/")
+      end
+
+      # Update a view.
+      #
+      # @param id [Integer, String]
+      # @param params [Hash] Attributes to update
+      # @return [Gorgias::Object]
+      def update(id, **params)
+        put("/api/views/#{id}/", params)
+      end
+
+      # Delete a view.
+      #
+      # @param id [Integer, String]
+      # @return [true]
+      def delete(id)
+        super("/api/views/#{id}/")
+      end
+
+      # Export the tickets in a view.
+      #
+      # @param id [Integer, String]
+      # @param params [Hash] Export options
+      # @return [Gorgias::Object]
+      def export(id, **params)
+        get("/api/views/#{id}/export", params)
+      end
+    end
+  end
+end

data/lib/gorgias/resources/widgets.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Gorgias
+  module Resources
+    class Widgets < Base
+      # Create a new widget.
+      #
+      # @param params [Hash] Widget attributes
+      # @return [Gorgias::Object]
+      def create(**params)
+        post("/api/widgets", params)
+      end
+
+      # List widgets.
+      #
+      # @param params [Hash] Filter/pagination options
+      # @return [Array<Gorgias::Object>]
+      def list(**params)
+        get("/api/widgets", params)
+      end
+
+      # Retrieve a single widget by ID.
+      #
+      # @param id [Integer, String]
+      # @return [Gorgias::Object]
+      def retrieve(id)
+        get("/api/widgets/#{id}/")
+      end
+
+      # Update a widget.
+      #
+      # @param id [Integer, String]
+      # @param params [Hash] Attributes to update
+      # @return [Gorgias::Object]
+      def update(id, **params)
+        put("/api/widgets/#{id}/", params)
+      end
+
+      # Delete a widget.
+      #
+      # @param id [Integer, String]
+      # @return [true]
+      def delete(id)
+        super("/api/widgets/#{id}/")
+      end
+    end
+  end
+end

data/lib/gorgias/ruby/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gorgias
+  module Ruby
+    VERSION = "0.1.0"
+  end
+end

data/lib/gorgias/ruby.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Backward-compatibility shim — load the real gem entry point.
+require_relative "../gorgias"
+

data/lib/gorgias/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gorgias
+  VERSION = "0.1.0"
+end

data/lib/gorgias.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "gorgias/version"
+require_relative "gorgias/error"
+require_relative "gorgias/configuration"
+require_relative "gorgias/object"
+
+require_relative "gorgias/resources/base"
+require_relative "gorgias/resources/account"
+require_relative "gorgias/resources/customers"
+require_relative "gorgias/resources/events"
+require_relative "gorgias/resources/files"
+require_relative "gorgias/resources/integrations"
+require_relative "gorgias/resources/jobs"
+require_relative "gorgias/resources/macros"
+require_relative "gorgias/resources/rules"
+require_relative "gorgias/resources/satisfaction_surveys"
+require_relative "gorgias/resources/search"
+require_relative "gorgias/resources/statistics"
+require_relative "gorgias/resources/tags"
+require_relative "gorgias/resources/tickets"
+require_relative "gorgias/resources/ticket_messages"
+require_relative "gorgias/resources/users"
+require_relative "gorgias/resources/views"
+require_relative "gorgias/resources/widgets"
+
+require_relative "gorgias/client"
+
+# Gorgias REST API Ruby client.
+#
+# @example Global configuration
+#   Gorgias.configure do |c|
+#     c.domain   = "mycompany"
+#     c.username = "me@example.com"
+#     c.api_key  = "abc123"
+#   end
+#   client = Gorgias.new
+#
+# @example Per-client configuration
+#   client = Gorgias::Client.new(
+#     domain:   "mycompany",
+#     username: "me@example.com",
+#     api_key:  "abc123"
+#   )
+#
+module Gorgias
+  class << self
+    # Yields the global {Configuration} for mutation.
+    #
+    # @yieldparam config [Gorgias::Configuration]
+    def configure
+      yield(configuration)
+    end
+
+    # Returns the global {Configuration} instance (created lazily).
+    #
+    # @return [Gorgias::Configuration]
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Resets the global configuration back to defaults.
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    # Convenience constructor — equivalent to {Client.new}.
+    #
+    # @param options [Hash] See {Client#initialize}
+    # @return [Client]
+    def new(**options)
+      Client.new(**options)
+    end
+  end
+end

data/sig/gorgias/ruby.rbs

@@ -0,0 +1,6 @@
+module Gorgias
+  module Ruby
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: gorgias-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chayut Orapinpatipat
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A professional-grade Ruby gem that wraps the Gorgias Public API, providing
+  resource-oriented access to tickets, customers, users, integrations, and more.
+email:
+- chayut_o@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/gorgias.rb
+- lib/gorgias/client.rb
+- lib/gorgias/configuration.rb
+- lib/gorgias/error.rb
+- lib/gorgias/object.rb
+- lib/gorgias/resources/account.rb
+- lib/gorgias/resources/base.rb
+- lib/gorgias/resources/customers.rb
+- lib/gorgias/resources/events.rb
+- lib/gorgias/resources/files.rb
+- lib/gorgias/resources/integrations.rb
+- lib/gorgias/resources/jobs.rb
+- lib/gorgias/resources/macros.rb
+- lib/gorgias/resources/rules.rb
+- lib/gorgias/resources/satisfaction_surveys.rb
+- lib/gorgias/resources/search.rb
+- lib/gorgias/resources/statistics.rb
+- lib/gorgias/resources/tags.rb
+- lib/gorgias/resources/ticket_messages.rb
+- lib/gorgias/resources/tickets.rb
+- lib/gorgias/resources/users.rb
+- lib/gorgias/resources/views.rb
+- lib/gorgias/resources/widgets.rb
+- lib/gorgias/ruby.rb
+- lib/gorgias/ruby/version.rb
+- lib/gorgias/version.rb
+- sig/gorgias/ruby.rbs
+homepage: https://github.com/Sentia/gorgias-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Sentia/gorgias-ruby
+  changelog_uri: https://github.com/Sentia/gorgias-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/Sentia/gorgias-ruby/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby client for the Gorgias REST API
+test_files: []