crisp-api 1.1.10 → 1.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1492b534936fe90a085a39786b53e1e27455716226b7f7c1cfd5d8aaca42834
-  data.tar.gz: 20acf32bb4c32030d7d27d74b38049cc11a2abe66102b3ed229287def0a6836f
+  metadata.gz: a2a58efb0f1724208bdaafc199d5d3a2e7a7e414d92f633a439a76fcb137c70c
+  data.tar.gz: d69db7101c6076cc3ca4a3ab36a805919bb13cc1dae8e5340678103e6780a765
 SHA512:
-  metadata.gz: 66a573d5ec60568e00b7ca0b4cab89a3fd060664c0e72945c7dc6ef603855b52cf9dc7eb6bb05cf2f33d15b5d085dfea7b28650ca5355eedc4843dcfe0604967
-  data.tar.gz: 676af19bfacedc35d607036aca95086c9a9f8fbac33600bce3ec88f4ddc75aef627dbacc54b2e1704379558163978e76bf9ad7e2ced93cda028ddcec172513f4
+  metadata.gz: 682305e208688c767aaf2732eb95fe9ccf20656e8c3cc6d832bb619d5fa6f73f6cf287abff3cd027234f1ae0c74102bc96190fc0322d12cad4b9491f42e69ae3
+  data.tar.gz: '029b2f184d2e21cf058d756dbb2124d6904db79aa0a0649c7b250f0e4f8a9f67d89afd362d513bb3950ce4ad63ba2cfbd0f7833e9d42f6793ad8d110ff14c756'

data/.github/workflows/build.yml

@@ -8,6 +8,11 @@ name: Build and Release
 jobs:
   release:
     runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["2.7", "3.0", "3.1", "3.2"]
+
     steps:
       - name: Checkout
         id: checkout
@@ -17,7 +22,7 @@ jobs:
         id: install_ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "2.7"
+          ruby-version: ${{ matrix.ruby-version }}
 
       - name: Install dependencies
         id: install_dependencies

data/EXAMPLES.md

@@ -65,6 +65,10 @@ https://docs.crisp.chat/references/rest-api/v1/#get-messages-in-conversation
 website_id = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc"
 session_id = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
 
+query = {
+  "timestamp_before" => "1687314763164"
+}
+
 client.website.get_messages_in_conversation(website_id, session_id, query);
 
 =========================
@@ -74,12 +78,12 @@ https://docs.crisp.chat/references/rest-api/v1/#send-a-message-in-conversation
 website_id = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc"
 session_id = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
 
-query = [
+query = {
   "type" => "text",
   "from" => "operator",
   "origin" => "chat",
   "content" => "Hey there! Need help?"
-]
+}
 
 client.website.send_message_in_conversation(website_id, session_id, query);
 
@@ -221,6 +225,16 @@ client.website.list_conversation_events(website_id, session_id, page_number);
 
 =========================
 
+https://docs.crisp.chat/references/rest-api/v1/#list-conversation-files
+
+website_id = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc"
+session_id = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
+page_number = 1
+
+client.website.list_conversation_files(website_id, session_id, page_number);
+
+=========================
+
 https://docs.crisp.chat/references/rest-api/v1/#get-conversation-state
 
 website_id = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc"
@@ -517,6 +531,7 @@ data = [
     "visitor_compose" => false,
     "file_transfer" => true,
     "helpdesk_link" => true,
+    "helpdesk_only" => false,
     "status_health_dead" => true,
     "check_domain" => false,
     "color_theme" => "blue",

data/README.md

@@ -6,7 +6,7 @@ The Crisp API Ruby wrapper. Authenticate, send messages, fetch conversations, ac
 
 Copyright 2023 Crisp IM SAS. See LICENSE for copying information.
 
-* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 12/31/2017
+* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 16/01/2023
 * **😘 Maintainer**: [@valeriansaliou](https://github.com/valeriansaliou), [@eliottvincent](https://github.com/eliottvincent)
 
 ## Usage
@@ -16,7 +16,7 @@ You may follow the [REST API Quickstart](https://docs.crisp.chat/guides/rest-api
 Add the library to your `Gemfile`:
 
 ```bash
-gem "crisp-api", "~> 1.1.10"
+gem "crisp-api", "~> 1.1.12"
 ```
 
 Then, import it:
@@ -200,12 +200,12 @@ client.website.send_message_in_conversation(
       website_id = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc"
       session_id = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
 
-      query = [
+      query = {
         "type" => "text",
         "from" => "operator",
         "origin" => "chat",
         "content" => "Hey there! Need help?"
-      ]
+      }
 
       client.website.send_message_in_conversation(website_id, session_id, query);
       ```
@@ -387,6 +387,20 @@ client.website.send_message_in_conversation(
       ```
       </details>
 
+  * **List Conversation Files** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversation-files)
+    * `client.website.list_conversation_files(website_id, session_id, page_number)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```ruby
+      website_id = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc"
+      session_id = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
+      page_number = 1
+
+      client.website.list_conversation_files(website_id, session_id, page_number);
+      ```
+      </details>
+
   * **Get Conversation State** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-state)
     * `client.website.get_conversation_state(website_id, session_id)`
     * <details>
@@ -820,6 +834,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
           "visitor_compose" => false,
           "file_transfer" => true,
           "helpdesk_link" => true,
+          "helpdesk_only" => false,
           "status_health_dead" => true,
           "check_domain" => false,
           "color_theme" => "blue",

data/crisp-api.gemspec

@@ -2,7 +2,7 @@ require File.expand_path("../lib/crisp-api", __FILE__)
 
 Gem::Specification.new do |s|
   s.name          = "crisp-api"
-  s.version       = "1.1.10"
+  s.version       = "1.1.12"
   s.date          = Date.today
   s.summary       = "Crisp API Ruby"
   s.description   = "Crisp API Ruby"

data/lib/crisp-api.rb

@@ -91,7 +91,7 @@ module Crisp
           :payload => (data ? data.to_json : nil),
 
           :headers => {
-            :user_agent => "ruby-crisp-api/1.1.10",
+            :user_agent => "ruby-crisp-api/1.1.12",
             :accept => :json,
             :content_type => :json,
             "X-Crisp-Tier" => @tier,

data/lib/resources/website.rb

@@ -22,11 +22,23 @@ module Crisp
       "filter_unassigned",
       "filter_date_start",
       "filter_date_end",
-      "filter_date_end",
       "order_date_created",
       "order_date_updated",
     ]
 
+    SEARCH_HELPDESK_ARTICLES_QUERY_PARAMETERS = [
+      "order_visits",
+      "search_title",
+      "filter_category_id",
+      "filter_section_id",
+      "filter_status_published",
+      "filter_status_draft",
+      "filter_visibility_visible",
+      "filter_visibility_hidden",
+      "filter_date_start",
+      "filter_date_end",
+    ]
+
     def initialize(parent)
       @parent = parent
     end
@@ -192,6 +204,10 @@ module Crisp
       return @parent.get(self._url_conversation(website_id, session_id, "/events/%d" % page_number))
     end
 
+    def list_conversation_files(website_id, session_id, page_number)
+      return @parent.get(self._url_conversation(website_id, session_id, "/files/%d" % page_number))
+    end
+
     def get_conversation_state(website_id, session_id)
       return @parent.get(self._url_conversation(website_id, session_id, "/state"))
     end
@@ -287,5 +303,30 @@ module Crisp
     def get_session_id_by_token(website_id, token)
       return @parent.get(self._url_website(website_id, "/visitors/token/#{token}"))
     end
+
+    def search_helpdesk_articles(website_id, locale, page_number = 1, order_visits = "", search_title = "", filter_category_id = "", filter_section_id = "", filter_status_published = "", filter_status_draft = "", filter_visibility_visible = "", filter_visibility_hidden = "", filter_date_start = "", filter_date_end="")
+      resource_url = ""
+      query_parameters = []
+
+      SEARCH_HELPDESK_ARTICLES_QUERY_PARAMETERS.each do |parameter|
+        parameter_value = binding.local_variable_get(parameter)
+
+        if parameter_value != ""
+          query_parameters.push("%s=%s" % [parameter, CGI.escape(parameter_value).gsub("+", "%20")])
+        end
+      end
+
+      if query_parameters != []
+        resource_url = self._url_website(website_id, "/helpdesk/locale/%s/articles/%d?%s" % [locale, page_number, query_parameters.join("&")])
+      else
+        resource_url = self._url_website(website_id, "/helpdesk/locale/%s/articles/%d" % [locale, page_number])
+      end
+
+      return @parent.get(resource_url)
+    end
+
+    def list_helpdesk_articles(website_id, locale, page_number = 1)
+      return self.search_helpdesk_articles(website_id, locale, page_number)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crisp-api
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.1.12
 platform: ruby
 authors:
 - Valerian Saliou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Crisp API Ruby