messente_api 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a3e94c8188f57b4554dbf1a855cf1754104f131472ddb22f0801c4afe71fec3
-  data.tar.gz: f105f2f18aedd0488d7c62ad7a2226a783a93028d7ef312229ba3b56c72c48f1
+  metadata.gz: 8d6627669fd5f0a81c7f8a6880505326e603be8f70f8e4a0c568c1d4d2074405
+  data.tar.gz: 3f51f1ac79d02eeb1590dc681ddf9660ba56b51b85d9c8483727ece954feef43
 SHA512:
-  metadata.gz: fe37dbd334cb8b0c32b76fe3aa0e0a68975a04d55a6d66dd6f702298804362dbed7d815cb2fd9834956535f454d6128f3623e9e8ce79b4f40e1db91932e60e39
-  data.tar.gz: 983823e1373e348f9aa338c1470a9214563078ed5bd0bb692c2f81fd23ed66840ddb7471f58bbf57e64babc4c44fcbb1dfa73fe17d304c021f6e03576bb0b10b
+  metadata.gz: 347a904c0b8973e7dbd6c74e1dcb8e31d7458ac569d986cb954dae5ad869c1356f145f16fed89a3de78352ad07ae4f2314e889fbe15bf891ce3966a536887286
+  data.tar.gz: 07c26b43df889c47d0af38d3e7541e9cc81ed682208943685690c88295a15f428777aba19868d24f29b3a2cc36c24bfd6a6fba9d43c559f3904c8b09a2a09f79

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    messente_api (2.4.1)
+    messente_api (2.5.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -10,15 +10,15 @@ GEM
     ast (2.4.3)
     byebug (12.0.0)
     coderay (1.1.3)
-    date (3.4.1)
+    date (3.5.1)
     diff-lcs (1.6.2)
-    ethon (0.16.0)
+    ethon (0.15.0)
       ffi (>= 1.15.0)
-    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.3-x86_64-linux-gnu)
     jaro_winkler (1.5.6)
     method_source (1.1.0)
     parallel (1.27.0)
-    parser (3.3.9.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
     pry (0.15.2)
@@ -27,25 +27,25 @@ GEM
     pry-byebug (3.11.0)
       byebug (~> 12.0)
       pry (>= 0.13, < 0.16)
-    psych (5.2.6)
+    psych (5.3.1)
       date
       stringio
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rspec (3.13.1)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.5)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.5)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.4)
+    rspec-support (3.13.6)
     rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -55,9 +55,9 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.13.0)
-    stringio (3.1.7)
-    typhoeus (1.4.1)
-      ethon (>= 0.9.0)
+    stringio (3.2.0)
+    typhoeus (1.5.0)
+      ethon (>= 0.9.0, < 0.16.0)
     unicode-display_width (1.5.0)
 
 PLATFORMS

data/README.md

@@ -1,7 +1,7 @@
 # Messente API Library
 
 - Messente API version: 2.0.0
-- Ruby gem version: 2.4.1
+- Ruby gem version: 2.5.0
 
 [Messente](https://messente.com) is a global provider of messaging and user verification services.  * Send and receive SMS, Viber and WhatsApp messages. * Manage contacts and groups. * Fetch detailed info about phone numbers. * Blacklist phone numbers to make sure you're not sending any unwanted messages.  Messente builds [tools](https://messente.com/documentation) to help organizations connect their services to people anywhere in the world.
 

data/docs/BulkMessagingApi.md

@@ -26,7 +26,7 @@ MessenteApi.configure do |config|
 end
 
 api_instance = MessenteApi::BulkMessagingApi.new
-bulk_omnimessage = MessenteApi::BulkOmnimessage.new({messages: [MessenteApi::Omnimessage.new({to: 'to_example', messages: [MessenteApi::SMS.new({text: 'Hello world!'})]})]}) # BulkOmnimessage | Bulk Omnimessage to be sent
+bulk_omnimessage = MessenteApi::BulkOmnimessage.new({messages: [MessenteApi::Omnimessage.new({to: 'to_example', messages: [MessenteApi::OmnimessageMessagesInner.new({sender: 'sender_example', text: 'text_example'})]})]}) # BulkOmnimessage | Bulk Omnimessage to be sent
 
 begin
   # Sends a bulk Omnimessage

data/docs/OmnimessageApi.md

@@ -95,7 +95,7 @@ MessenteApi.configure do |config|
 end
 
 api_instance = MessenteApi::OmnimessageApi.new
-omnimessage = MessenteApi::Omnimessage.new({to: 'to_example', messages: [MessenteApi::SMS.new({text: 'Hello world!'})]}) # Omnimessage | Omnimessage to be sent
+omnimessage = MessenteApi::Omnimessage.new({to: 'to_example', messages: [MessenteApi::OmnimessageMessagesInner.new({sender: 'sender_example', text: 'text_example'})]}) # Omnimessage | Omnimessage to be sent
 
 begin
   # Sends an Omnimessage

data/docs/OmnimessageMessagesInner.md

@@ -1,53 +1,54 @@
 # MessenteApi::OmnimessageMessagesInner
 
-## Class instance methods
-
-### `openapi_one_of`
-
-Returns the list of classes defined in oneOf.
-
-#### Example
-
-```ruby
-require 'messente_api'
-
-MessenteApi::OmnimessageMessagesInner.openapi_one_of
-# =>
-# [
-#   :'SMS',
-#   :'Telegram',
-#   :'Viber',
-#   :'WhatsApp'
-# ]
-```
-
-### build
-
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-
-#### Example
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sender** | **String** | Phone number or alphanumeric sender name |  |
+| **validity** | **Integer** | After how many minutes this channel is considered as failed and the next channel is attempted.Only one of \"ttl\" and \"validity\" can be used. | [optional] |
+| **ttl** | **Integer** | After how many seconds this channel is considered as failed and the next channel is attempted. Only one of \"ttl\" and \"validity\" can be used. | [optional] |
+| **text** | **String** | Text content of the RCS message |  |
+| **image_url** | **String** | URL for the embedded image    Valid combinations:    1) image_url,    2) text, image_url, button_url, button_text | [optional] |
+| **button_url** | **String** | URL of the button, must be specified along with ''text'', ''button_text'' and ''image_url'' (optional) | [optional] |
+| **button_text** | **String** | Must be specified along with ''text'', ''button_url'', ''button_text'', ''image_url'' (optional) | [optional] |
+| **channel** | **String** | The channel used to deliver the message | [optional][default to 'rcs'] |
+| **video** | [**WhatsAppVideo**](WhatsAppVideo.md) |  | [optional] |
+| **autoconvert** | **String** | Defines how non-GSM characters will be treated:    - \"on\" Use replacement settings from the account's [API Auto Replace settings page](https://dashboard.messente.com/api-settings/auto-replace) (default)   - \"full\" All non GSM 03.38 characters will be replaced with suitable alternatives   - \"off\" Message content is not modified in any way | [optional] |
+| **udh** | **String** | hex-encoded string containing SMS UDH | [optional] |
+| **template** | [**WhatsAppTemplate**](WhatsAppTemplate.md) |  | [optional] |
+| **image** | [**WhatsAppImage**](WhatsAppImage.md) |  | [optional] |
+| **audio** | [**WhatsAppAudio**](WhatsAppAudio.md) |  | [optional] |
+| **document** | [**WhatsAppDocument**](WhatsAppDocument.md) |  | [optional] |
+| **sticker** | [**WhatsAppSticker**](WhatsAppSticker.md) |  | [optional] |
+| **suggestions** | [**Array<RcsSuggestion>**](RcsSuggestion.md) | List of suggestions to include with the message | [optional] |
+| **rich_card** | [**RcsRichCard**](RcsRichCard.md) |  | [optional] |
+| **content_info** | [**RcsContentInfo**](RcsContentInfo.md) |  | [optional] |
+
+## Example
 
 ```ruby
 require 'messente_api'
 
-MessenteApi::OmnimessageMessagesInner.build(data)
-# => #<SMS:0x00007fdd4aab02a0>
-
-MessenteApi::OmnimessageMessagesInner.build(data_that_doesnt_match)
-# => nil
+instance = MessenteApi::OmnimessageMessagesInner.new(
+  sender: null,
+  validity: 360,
+  ttl: 21600,
+  text: null,
+  image_url: null,
+  button_url: null,
+  button_text: null,
+  channel: null,
+  video: null,
+  autoconvert: null,
+  udh: null,
+  template: null,
+  image: null,
+  audio: null,
+  document: null,
+  sticker: null,
+  suggestions: null,
+  rich_card: null,
+  content_info: null
+)
 ```
 
-#### Parameters
-
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| **data** | **Mixed** | data to be matched against the list of oneOf items |
-
-#### Return type
-
-- `SMS`
-- `Telegram`
-- `Viber`
-- `WhatsApp`
-- `nil` (if no type matches)
-

data/docs/Rcs.md

@@ -0,0 +1,32 @@
+# MessenteApi::Rcs
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel** | **String** | The channel used to deliver the message | [optional][default to 'rcs'] |
+| **sender** | **String** | Phone number or alphanumeric sender name |  |
+| **validity** | **Integer** | After how many minutes this channel is considered as failed and the next channel is attempted.Only one of \"ttl\" and \"validity\" can be used. | [optional] |
+| **ttl** | **Integer** | After how many seconds this channel is considered as failed and the next channel is attempted. Only one of \"ttl\" and \"validity\" can be used. | [optional] |
+| **text** | **String** | Text content of the RCS message | [optional] |
+| **suggestions** | [**Array<RcsSuggestion>**](RcsSuggestion.md) | List of suggestions to include with the message | [optional] |
+| **rich_card** | [**RcsRichCard**](RcsRichCard.md) |  | [optional] |
+| **content_info** | [**RcsContentInfo**](RcsContentInfo.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::Rcs.new(
+  channel: null,
+  sender: null,
+  validity: 360,
+  ttl: 21600,
+  text: null,
+  suggestions: null,
+  rich_card: null,
+  content_info: null
+)
+```
+

data/docs/RcsCardContent.md

@@ -0,0 +1,24 @@
+# MessenteApi::RcsCardContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | Title of the card content | [optional] |
+| **description** | **String** | Description of the card content | [optional] |
+| **media** | [**RcsMedia**](RcsMedia.md) |  | [optional] |
+| **suggestions** | [**Array<RcsSuggestion>**](RcsSuggestion.md) | List of suggestions that the recipient can use to respond. | [optional] |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsCardContent.new(
+  title: null,
+  description: null,
+  media: null,
+  suggestions: null
+)
+```
+

data/docs/RcsCardOrientation.md

@@ -0,0 +1,15 @@
+# MessenteApi::RcsCardOrientation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsCardOrientation.new()
+```
+

data/docs/RcsCardWidth.md

@@ -0,0 +1,15 @@
+# MessenteApi::RcsCardWidth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsCardWidth.new()
+```
+

data/docs/RcsCarouselCard.md

@@ -0,0 +1,20 @@
+# MessenteApi::RcsCarouselCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_width** | [**RcsCardWidth**](RcsCardWidth.md) |  |  |
+| **card_contents** | [**Array<RcsCardContent>**](RcsCardContent.md) | The contents of the carousel card. |  |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsCarouselCard.new(
+  card_width: null,
+  card_contents: null
+)
+```
+

data/docs/RcsContentInfo.md

@@ -0,0 +1,22 @@
+# MessenteApi::RcsContentInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_url** | **String** | Required file URL |  |
+| **thumbnail_url** | **String** | Optional thumbnail URL | [optional] |
+| **force_refresh** | **Boolean** | Force refresh the content |  |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsContentInfo.new(
+  file_url: null,
+  thumbnail_url: null,
+  force_refresh: null
+)
+```
+

data/docs/RcsCreateCalendarEventAction.md

@@ -0,0 +1,24 @@
+# MessenteApi::RcsCreateCalendarEventAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_time** | **String** | The start time of the event. |  |
+| **end_time** | **String** | The end time of the event. |  |
+| **title** | **String** | The title of the event. |  |
+| **description** | **String** | The description of the event. |  |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsCreateCalendarEventAction.new(
+  start_time: null,
+  end_time: null,
+  title: null,
+  description: null
+)
+```
+

data/docs/RcsDialAction.md

@@ -0,0 +1,18 @@
+# MessenteApi::RcsDialAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | The phone number to dial in E.164 format. |  |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsDialAction.new(
+  phone_number: +442071838750
+)
+```
+

data/docs/RcsImageAlignment.md

@@ -0,0 +1,15 @@
+# MessenteApi::RcsImageAlignment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsImageAlignment.new()
+```
+

data/docs/RcsLatLng.md

@@ -0,0 +1,20 @@
+# MessenteApi::RcsLatLng
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **latitude** | **Float** | The latitude coordinate. |  |
+| **longitude** | **Float** | The longitude coordinate. |  |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsLatLng.new(
+  latitude: null,
+  longitude: null
+)
+```
+

data/docs/RcsMedia.md

@@ -0,0 +1,20 @@
+# MessenteApi::RcsMedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **height** | [**RcsMediaHeight**](RcsMediaHeight.md) |  |  |
+| **content_info** | [**RcsContentInfo**](RcsContentInfo.md) |  |  |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsMedia.new(
+  height: null,
+  content_info: null
+)
+```
+

data/docs/RcsMediaHeight.md

@@ -0,0 +1,15 @@
+# MessenteApi::RcsMediaHeight
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsMediaHeight.new()
+```
+

data/docs/RcsOpenUrlAction.md

@@ -0,0 +1,24 @@
+# MessenteApi::RcsOpenUrlAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The URL to open. |  |
+| **description** | **String** | A description of the URL being opened. | [optional] |
+| **application** | [**RcsOpenUrlApplication**](RcsOpenUrlApplication.md) |  |  |
+| **webview_view_mode** | [**RcsWebviewViewMode**](RcsWebviewViewMode.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsOpenUrlAction.new(
+  url: null,
+  description: null,
+  application: null,
+  webview_view_mode: null
+)
+```
+

data/docs/RcsOpenUrlApplication.md

@@ -0,0 +1,15 @@
+# MessenteApi::RcsOpenUrlApplication
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsOpenUrlApplication.new()
+```
+

data/docs/RcsRichCard.md

@@ -0,0 +1,20 @@
+# MessenteApi::RcsRichCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **standalone_card** | [**RcsStandaloneCard**](RcsStandaloneCard.md) |  | [optional] |
+| **carousel_card** | [**RcsCarouselCard**](RcsCarouselCard.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsRichCard.new(
+  standalone_card: null,
+  carousel_card: null
+)
+```
+

data/docs/RcsStandaloneCard.md

@@ -0,0 +1,22 @@
+# MessenteApi::RcsStandaloneCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_orientation** | [**RcsCardOrientation**](RcsCardOrientation.md) |  |  |
+| **thumbnail_image_alignment** | [**RcsImageAlignment**](RcsImageAlignment.md) |  |  |
+| **card_content** | [**RcsCardContent**](RcsCardContent.md) |  |  |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsStandaloneCard.new(
+  card_orientation: null,
+  thumbnail_image_alignment: null,
+  card_content: null
+)
+```
+

data/docs/RcsSuggestedAction.md

@@ -0,0 +1,32 @@
+# MessenteApi::RcsSuggestedAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The text of the suggested action. Exactly one of the action fields (types) must be provided. |  |
+| **postback_data** | **String** | The postback data associated with the suggested action. This is sent back to the sender when the user selects the suggested action. |  |
+| **fallback_url** | **String** | The fallback URL to open if the suggested action is not supported. | [optional] |
+| **dial_action** | [**RcsDialAction**](RcsDialAction.md) |  | [optional] |
+| **view_location_action** | [**RcsViewLocationAction**](RcsViewLocationAction.md) |  | [optional] |
+| **create_calendar_event_action** | [**RcsCreateCalendarEventAction**](RcsCreateCalendarEventAction.md) |  | [optional] |
+| **open_url_action** | [**RcsOpenUrlAction**](RcsOpenUrlAction.md) |  | [optional] |
+| **share_location_action** | **Object** | This action does not have any properties. It simply triggers the share location action. | [optional] |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsSuggestedAction.new(
+  text: null,
+  postback_data: null,
+  fallback_url: null,
+  dial_action: null,
+  view_location_action: null,
+  create_calendar_event_action: null,
+  open_url_action: null,
+  share_location_action: null
+)
+```
+

data/docs/RcsSuggestedReply.md

@@ -0,0 +1,20 @@
+# MessenteApi::RcsSuggestedReply
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The text of the suggested reply. |  |
+| **postback_data** | **String** | The postback data associated with the suggested reply. This is sent back to the sender when the user selects the suggested reply. |  |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsSuggestedReply.new(
+  text: null,
+  postback_data: null
+)
+```
+

data/docs/RcsSuggestion.md

@@ -0,0 +1,20 @@
+# MessenteApi::RcsSuggestion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reply** | [**RcsSuggestedReply**](RcsSuggestedReply.md) |  | [optional] |
+| **action** | [**RcsSuggestedAction**](RcsSuggestedAction.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsSuggestion.new(
+  reply: null,
+  action: null
+)
+```
+

data/docs/RcsViewLocationAction.md

@@ -0,0 +1,22 @@
+# MessenteApi::RcsViewLocationAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lat_long** | [**RcsLatLng**](RcsLatLng.md) |  | [optional] |
+| **label** | **String** | The label of the pin dropped at latLong. | [optional] |
+| **query** | **String** | (Optional, only supported on Android Messages clients) Instead of specifying a latLong (and optionally, a label), the agent can specify a query string. For default map apps that support search functionality (including Google Maps), tapping this suggested action results in a location search centered around the user's current location.              For instance, setting the query string to \"Growing Tree Bank\" will show all Growing Tree Bank locations in the user's vicinity. Setting the query string to \"1600 Amphitheater Parkway, Mountain View, CA 94043\" will select that specific address, regardless of the user's location.        | [optional] |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::RcsViewLocationAction.new(
+  lat_long: null,
+  label: null,
+  query: null
+)
+```
+