sunshine-conversations-client 9.4.6 → 9.5.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +4 -4
- data/docs/AppSettings.md +2 -2
- data/docs/Content.md +1 -1
- data/docs/Field.md +4 -4
- data/docs/FormMessage.md +1 -1
- data/lib/sunshine-conversations-client/models/app_settings.rb +2 -2
- data/lib/sunshine-conversations-client/models/content.rb +1 -1
- data/lib/sunshine-conversations-client/models/field.rb +4 -4
- data/lib/sunshine-conversations-client/models/form_message.rb +2 -2
- data/lib/sunshine-conversations-client/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: db3f689e0e9a3ce03f9ef958611da1c75223dd8a
|
4
|
+
data.tar.gz: 52307dd2f59823a345705089abeef30afaa11cd6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6f3f8fe84ec5ed93367a74bbde72ce437ec0ffa3e84042fbcae9023449ff1df885ebcb5abd56fd2c0a84feefa6381e75d8806aba27d471ba717678fe4af9cebd
|
7
|
+
data.tar.gz: 184b4e16575591dd69fa9e8dc662095e9b1f40ca12e5506d569dd68904845ccac5114ae1dac73ad3173230ed3d136051201556e58c5aa8e5d9261ff47bde8d94
|
data/README.md
CHANGED
@@ -5,7 +5,7 @@ SunshineConversationsClient - the Ruby gem for the Sunshine Conversations API
|
|
5
5
|
This SDK is automatically generated by the [OpenAPI Generator Codegen](https://github.com/OpenAPITools/openapi-generator) project using the [Sunshine Conversations API spec](https://github.com/zendesk/sunshine-conversations-api-spec).
|
6
6
|
|
7
7
|
- API version: 9.4.5
|
8
|
-
- Package version: 9.
|
8
|
+
- Package version: 9.5.6
|
9
9
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
10
10
|
|
11
11
|
## Sunshine Conversations API Version
|
@@ -32,16 +32,16 @@ gem build sunshine-conversations-client.gemspec
|
|
32
32
|
Then either install the gem locally:
|
33
33
|
|
34
34
|
```shell
|
35
|
-
gem install ./sunshine-conversations-client-9.
|
35
|
+
gem install ./sunshine-conversations-client-9.5.6.gem
|
36
36
|
```
|
37
37
|
|
38
|
-
(for development, run `gem install --dev ./sunshine-conversations-client-9.
|
38
|
+
(for development, run `gem install --dev ./sunshine-conversations-client-9.5.6.gem` to install the development dependencies)
|
39
39
|
|
40
40
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
41
41
|
|
42
42
|
Finally add this to the Gemfile:
|
43
43
|
|
44
|
-
gem 'sunshine-conversations-client', '~> 9.
|
44
|
+
gem 'sunshine-conversations-client', '~> 9.5.6'
|
45
45
|
|
46
46
|
### Install from Git
|
47
47
|
|
data/docs/AppSettings.md
CHANGED
@@ -4,10 +4,10 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**conversation_retention_seconds** | **Integer** | Number of seconds of inactivity before a conversation’s messages will be automatically deleted. See [Conversation Retention Seconds](https://docs.smooch.io/
|
7
|
+
**conversation_retention_seconds** | **Integer** | Number of seconds of inactivity before a conversation’s messages will be automatically deleted. See [Conversation Retention Seconds](https://docs.smooch.io/guide/creating-and-managing-apps/#conversation-retention-seconds) for more information. | [optional]
|
8
8
|
**mask_credit_card_numbers** | **Boolean** | A boolean specifying whether credit card numbers should be masked when sent through Sunshine Conversations. | [optional]
|
9
9
|
**use_animal_names** | **Boolean** | A boolean specifying whether animal names should be used for unnamed users. See the [user naming guide](https://docs.smooch.io/guide/receiving-messages/#message-author-name) for details. | [optional]
|
10
|
-
**echo_postback** | **Boolean** | A boolean specifying whether a message should be added to the conversation history when a postback button is clicked. See [Echo Postbacks](https://docs.smooch.io/
|
10
|
+
**echo_postback** | **Boolean** | A boolean specifying whether a message should be added to the conversation history when a postback button is clicked. See [Echo Postbacks](https://docs.smooch.io/guide/creating-and-managing-apps/#echo-postbacks) for more information. | [optional]
|
11
11
|
**ignore_auto_conversation_start** | **Boolean** | A boolean specifying whether a non message event coming from a channel will trigger a [start conversation](https://docs.smooch.io/rest/#section/Webhook-Triggers) event and count as a monthly active user (MAU). <aside class=\"notice\">Calling <code>startConversation()</code> (or equivalent) from the Android, iOS or Web SDK will count as a MAU, regardless of the value of this setting.</aside> | [optional]
|
12
12
|
**multi_convo_enabled** | **Boolean** | A boolean specifying whether users are allowed to be part of several conversations. Enabling `multiConvo` is **irreversible**. | [optional]
|
13
13
|
**attachments_access** | **String** | A string specifying whether attachments should be stored in a publicly or privately accessible cloud storage. attachmentsAccess is set to public by default but can be modified to private. See <a href=\"https://docs.smooch.io/guide/private-attachments/\">Private Attachments</a> for more information. | [optional]
|
data/docs/Content.md
CHANGED
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
**media_size** | **Float** | The size of the media. | [optional] [readonly]
|
14
14
|
**media_type** | **String** | The media type of the file. | [optional] [readonly]
|
15
15
|
**alt_text** | **String** | An optional description of the image for accessibility purposes. The field will be saved by default with the file name as the value. | [optional]
|
16
|
-
**block_chat_input** | **Boolean** | true if the message should block the chat input on Web Messenger.
|
16
|
+
**block_chat_input** | **Boolean** | true if the message should block the chat input on Web Messenger. | [optional]
|
17
17
|
**fields** | [**Array<Field>**](Field.md) | Array of field objects that contain the submitted fields. |
|
18
18
|
**text_fallback** | **String** | A string containing the `label: value` of all fields, each separated by a newline character. | [optional] [readonly]
|
19
19
|
**coordinates** | [**LocationMessageCoordinates**](LocationMessageCoordinates.md) | |
|
data/docs/Field.md
CHANGED
@@ -7,12 +7,12 @@ Name | Type | Description | Notes
|
|
7
7
|
**type** | **String** | The field type. |
|
8
8
|
**name** | **String** | The name of the field. Must be unique per form or formResponse. |
|
9
9
|
**label** | **String** | The label of the field. What the field is displayed as on Web Messenger. |
|
10
|
-
**placeholder** | **String** | Placeholder text for the field.
|
11
|
-
**min_size** | **Integer** | The minimum allowed length for the response for a field of type text.
|
12
|
-
**max_size** | **Integer** | The maximum allowed length for the response for a field of type text.
|
10
|
+
**placeholder** | **String** | Placeholder text for the field. Form message only. | [optional]
|
11
|
+
**min_size** | **Integer** | The minimum allowed length for the response for a field of type text. Form message only. | [optional] [default to 1]
|
12
|
+
**max_size** | **Integer** | The maximum allowed length for the response for a field of type text. Form message only. | [optional] [default to 128]
|
13
13
|
**text** | **String** | Specifies the response for a text field. | [optional]
|
14
14
|
**email** | **String** | Specifies the response for a email field. | [optional]
|
15
|
-
**select** | **Array<Object>** | Array of objects representing the response for a field of type select.
|
15
|
+
**select** | **Array<Object>** | Array of objects representing the response for a field of type select. Form and formResponse messages only. | [optional]
|
16
16
|
**options** | **Array<Object>** | Array of objects representing options for a field of type select. | [optional]
|
17
17
|
|
18
18
|
## Code Sample
|
data/docs/FormMessage.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**type** | **String** | The type of message. | [default to 'form']
|
8
|
-
**block_chat_input** | **Boolean** | true if the message should block the chat input on Web Messenger.
|
8
|
+
**block_chat_input** | **Boolean** | true if the message should block the chat input on Web Messenger. | [optional]
|
9
9
|
**fields** | [**Array<Field>**](Field.md) | An array of objects representing fields associated with the message. Only present in form and formResponse messages. |
|
10
10
|
|
11
11
|
## Code Sample
|
@@ -12,7 +12,7 @@ require 'date'
|
|
12
12
|
module SunshineConversationsClient
|
13
13
|
# Customizable app settings.
|
14
14
|
class AppSettings
|
15
|
-
# Number of seconds of inactivity before a conversation’s messages will be automatically deleted. See [Conversation Retention Seconds](https://docs.smooch.io/
|
15
|
+
# Number of seconds of inactivity before a conversation’s messages will be automatically deleted. See [Conversation Retention Seconds](https://docs.smooch.io/guide/creating-and-managing-apps/#conversation-retention-seconds) for more information.
|
16
16
|
attr_accessor :conversation_retention_seconds
|
17
17
|
|
18
18
|
# A boolean specifying whether credit card numbers should be masked when sent through Sunshine Conversations.
|
@@ -21,7 +21,7 @@ module SunshineConversationsClient
|
|
21
21
|
# A boolean specifying whether animal names should be used for unnamed users. See the [user naming guide](https://docs.smooch.io/guide/receiving-messages/#message-author-name) for details.
|
22
22
|
attr_accessor :use_animal_names
|
23
23
|
|
24
|
-
# A boolean specifying whether a message should be added to the conversation history when a postback button is clicked. See [Echo Postbacks](https://docs.smooch.io/
|
24
|
+
# A boolean specifying whether a message should be added to the conversation history when a postback button is clicked. See [Echo Postbacks](https://docs.smooch.io/guide/creating-and-managing-apps/#echo-postbacks) for more information.
|
25
25
|
attr_accessor :echo_postback
|
26
26
|
|
27
27
|
# A boolean specifying whether a non message event coming from a channel will trigger a [start conversation](https://docs.smooch.io/rest/#section/Webhook-Triggers) event and count as a monthly active user (MAU). <aside class=\"notice\">Calling <code>startConversation()</code> (or equivalent) from the Android, iOS or Web SDK will count as a MAU, regardless of the value of this setting.</aside>
|
@@ -37,7 +37,7 @@ module SunshineConversationsClient
|
|
37
37
|
# An optional description of the image for accessibility purposes. The field will be saved by default with the file name as the value.
|
38
38
|
attr_accessor :alt_text
|
39
39
|
|
40
|
-
# true if the message should block the chat input on Web Messenger.
|
40
|
+
# true if the message should block the chat input on Web Messenger.
|
41
41
|
attr_accessor :block_chat_input
|
42
42
|
|
43
43
|
# Array of field objects that contain the submitted fields.
|
@@ -21,13 +21,13 @@ module SunshineConversationsClient
|
|
21
21
|
# The label of the field. What the field is displayed as on Web Messenger.
|
22
22
|
attr_accessor :label
|
23
23
|
|
24
|
-
# Placeholder text for the field.
|
24
|
+
# Placeholder text for the field. Form message only.
|
25
25
|
attr_accessor :placeholder
|
26
26
|
|
27
|
-
# The minimum allowed length for the response for a field of type text.
|
27
|
+
# The minimum allowed length for the response for a field of type text. Form message only.
|
28
28
|
attr_accessor :min_size
|
29
29
|
|
30
|
-
# The maximum allowed length for the response for a field of type text.
|
30
|
+
# The maximum allowed length for the response for a field of type text. Form message only.
|
31
31
|
attr_accessor :max_size
|
32
32
|
|
33
33
|
# Specifies the response for a text field.
|
@@ -36,7 +36,7 @@ module SunshineConversationsClient
|
|
36
36
|
# Specifies the response for a email field.
|
37
37
|
attr_accessor :email
|
38
38
|
|
39
|
-
# Array of objects representing the response for a field of type select.
|
39
|
+
# Array of objects representing the response for a field of type select. Form and formResponse messages only.
|
40
40
|
attr_accessor :select
|
41
41
|
|
42
42
|
# Array of objects representing options for a field of type select.
|
@@ -10,12 +10,12 @@ OpenAPI Generator version: 4.3.1
|
|
10
10
|
require 'date'
|
11
11
|
|
12
12
|
module SunshineConversationsClient
|
13
|
-
# A form type message without text or actions.
|
13
|
+
# A form type message without text or actions. Only supported in the Web SDK.
|
14
14
|
class FormMessage
|
15
15
|
# The type of message.
|
16
16
|
attr_accessor :type
|
17
17
|
|
18
|
-
# true if the message should block the chat input on Web Messenger.
|
18
|
+
# true if the message should block the chat input on Web Messenger.
|
19
19
|
attr_accessor :block_chat_input
|
20
20
|
|
21
21
|
# An array of objects representing fields associated with the message. Only present in form and formResponse messages.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: sunshine-conversations-client
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 9.
|
4
|
+
version: 9.5.6
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Sunshine Conversations
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-11-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|