crisp-api 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 704987e5c967c926caf8629b2dcc11a6137e80d6
-  data.tar.gz: 60555599bd6529c0c7a619a88214784855148e4f
+  metadata.gz: f535e101dd3d19d6b95b77280611b6da76e67e17
+  data.tar.gz: 53ba9775a4ed69fd9df548d6f2f13c18691e9e53
 SHA512:
-  metadata.gz: 428fb0189315af090ffed1a0505ffcda531ef78dfc74aed8eb41f988c0323710739c32385d8711a55c915f92887c7c30921d93ad7aafe063b6c69b854806b630
-  data.tar.gz: 3d97221cd573e943ca21a89ddb9f08986c117b72d52dae26f3d9c7293e59436621639dff2937ab0a3baa32e36db61e74d0350511d6d51f0b720c83e32f2fffb8
+  metadata.gz: 784aea903c5ac6b07ca6ba41c25dacc329e3e3f7b5d1be4a4f7130919152355fc80bf3da99aefbf18eceefe2c208567a815acec809fd23b94faed13d0dc61ebb
+  data.tar.gz: ef0ada6743000946846b9a27e6b1ea1595bf18b6c0b97e192783f12497fdb047ee21e15dc26d5e0c3f6dd36d335b8888c73da9a6c0a893c36b1e94b91f419992

data/README.md

@@ -63,75 +63,26 @@ Thus, it is straightforward to look for them in the library while reading the [A
 
 In the following method prototypes, `crisp` is to be replaced with your Crisp API instance. For example, instanciate `client = Crisp()` and then call eg: `client.user.check_session_validity()`.
 
-When calling a method that writes data to the API (eg: `client.user.create_user_account()`), you need to build an account instance and submit it this way:
+When calling a method that writes data to the API (eg. send a message with: `client.website.send_message_in_conversation()`), you need to submit it this way:
 
 ```ruby
-client.user.create_user_account({
-  "email" => "john@acme-inc.com",
-  "password" => "SecurePassword",
-  "first_name" => "John",
-  "last_name" => "Doe"
-})
+website_id = "6497e4a4-b17c-41e0-bfea-eea97ba8115a"
+session_id = "session_f32bc993-f7ce-41af-bcd1-110fc147a392"
+
+client.website.send_message_in_conversation(
+  website_id, session_id,
+
+  {
+    "type" => "text",
+    "content" => "This message was sent from python-crisp-api! :)",
+    "from" => "operator",
+    "origin" => "chat"
+  }
+)
 ```
 
-### Bucket
-
-* **Bucket URL**
-  * **Generate Bucket URL**: `client.bucket.generate_bucket_url`
-
-### User
-
-* **User Availability**
-  * **Get User Availability**: `client.user.get_user_availability`
-  * **Update User Availability**: `client.user.update_user_availability`
-  * **Get User Availability Status**: `client.user.get_user_availability_status`
-
-* **User Account Base**
-  * **Get User Account**: `client.user.get_user_account`
-  * **Create User Account**: `client.user.create_user_account`
-
-* **User Account Websites**
-  * **List Websites**: `client.user.list_websites`
-
-* **User Account Profile**
-  * **Get Profile**: `client.user.get_profile`
-  * **Update Profile**: `client.user.update_profile`
-
-* **User Session**
-  * **Check Session Validity**: `client.user.check_session_validity`
-  * **Create A New Session**: `client.user.create_new_session`
-  * **Destroy A Session**: `client.user.destroy_session`
-
-* **User Statistics**
-  * **Count Total Unread Messages**: `client.user.count_total_unread_messages`
-
 ### Website
 
-* **Website Base**
-  * **Create Website**: `client.website.create_website`
-  * **Get A Website**: `client.website.get_website`
-  * **Delete A Website**: `client.website.delete_website`
-
-* **Website Batch**
-  * **Batch Resolve Items**: `client.website.batch_resolve_items`
-  * **Batch Read Items**: `client.website.batch_read_items`
-  * **Batch Remove Items**: `client.website.batch_remove_items`
-
-* **Website Availability**
-  * **Get Website Availability Status**: `client.website.get_website_availability_status`
-
-* **Website Operator**
-  * **List Website Operators**: `client.website.list_website_operators`
-  * **List Last Active Website Operators**: `client.website.list_last_active_website_operators`
-
-* **Website Settings**
-  * **Get Website Settings**: `client.website.get_website_settings`
-  * **Update Website Settings**: `client.website.update_website_settings`
-
-* **Website Visitors**
-  * **Count Visitors**: `client.website.count_visitors`
-  * **List Visitors**: `client.website.list_visitors`
-
 * **Website Conversations**
   * **List Conversations**: `client.website.list_conversations`
 
@@ -176,3 +127,59 @@ client.user.create_user_account({
   + **Save People Data**: `client.website.save_people_data`
   + **Get People Subscription Status**: `client.website.get_people_subscription_status`
   + **Update People Subscription Status**: `client.website.update_people_subscription_status`
+
+* **Website Base**
+  * **Create Website**: `client.website.create_website`
+  * **Get A Website**: `client.website.get_website`
+  * **Delete A Website**: `client.website.delete_website`
+
+* **Website Batch**
+  * **Batch Resolve Items**: `client.website.batch_resolve_items`
+  * **Batch Read Items**: `client.website.batch_read_items`
+  * **Batch Remove Items**: `client.website.batch_remove_items`
+
+* **Website Availability**
+  * **Get Website Availability Status**: `client.website.get_website_availability_status`
+
+* **Website Operator**
+  * **List Website Operators**: `client.website.list_website_operators`
+  * **List Last Active Website Operators**: `client.website.list_last_active_website_operators`
+
+* **Website Settings**
+  * **Get Website Settings**: `client.website.get_website_settings`
+  * **Update Website Settings**: `client.website.update_website_settings`
+
+* **Website Visitors**
+  * **Count Visitors**: `client.website.count_visitors`
+  * **List Visitors**: `client.website.list_visitors`
+
+### Bucket
+
+* **Bucket URL**
+  * **Generate Bucket URL**: `client.bucket.generate_bucket_url`
+
+### User
+
+* **User Availability**
+  * **Get User Availability**: `client.user.get_user_availability`
+  * **Update User Availability**: `client.user.update_user_availability`
+  * **Get User Availability Status**: `client.user.get_user_availability_status`
+
+* **User Account Base**
+  * **Get User Account**: `client.user.get_user_account`
+  * **Create User Account**: `client.user.create_user_account`
+
+* **User Account Websites**
+  * **List Websites**: `client.user.list_websites`
+
+* **User Account Profile**
+  * **Get Profile**: `client.user.get_profile`
+  * **Update Profile**: `client.user.update_profile`
+
+* **User Session**
+  * **Check Session Validity**: `client.user.check_session_validity`
+  * **Create A New Session**: `client.user.create_new_session`
+  * **Destroy A Session**: `client.user.destroy_session`
+
+* **User Statistics**
+  * **Count Total Unread Messages**: `client.user.count_total_unread_messages`

data/crisp-api.gemspec

@@ -1,6 +1,8 @@
+require File.expand_path("../lib/crisp-api", __FILE__)
+
 Gem::Specification.new do |s|
   s.name          = 'crisp-api'
-  s.version       = '1.0.1'
+  s.version       = '1.0.2'
   s.date          = Date.today
   s.summary       = "Crisp API Ruby"
   s.description   = "Crisp API Ruby"

data/lib/{crisp.rb → crisp-api.rb}

@@ -89,7 +89,7 @@ module Crisp
           :payload => (data ? data.to_json : nil),
 
           :headers => {
-            :user_agent => "ruby-crisp-api/1.0.1",
+            :user_agent => "ruby-crisp-api/1.0.2",
             :accept => :json,
             :content_type => :json,
             :params => query

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crisp-api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Valerian Saliou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -37,7 +37,7 @@ files:
 - crisp-api.gemspec
 - examples/user_get_profile.rb
 - examples/website_send_message_in_conversation.rb
-- lib/crisp.rb
+- lib/crisp-api.rb
 - lib/errors/route.rb
 - lib/resources/bucket.rb
 - lib/resources/user.rb