rainbow-submarine-test-3356 1.2.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (113) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +150 -0
  4. data/Rakefile +8 -0
  5. data/docs/AppUser.md +14 -0
  6. data/docs/AppUserApi.md +616 -0
  7. data/docs/AppUserLink.md +9 -0
  8. data/docs/AppUserPreCreate.md +14 -0
  9. data/docs/AppUserResponse.md +8 -0
  10. data/docs/AppUserUpdate.md +12 -0
  11. data/docs/Client.md +12 -0
  12. data/docs/ClientInfo.md +15 -0
  13. data/docs/ClientResponse.md +8 -0
  14. data/docs/Conversation.md +9 -0
  15. data/docs/ConversationApi.md +192 -0
  16. data/docs/DeviceUpdate.md +10 -0
  17. data/docs/Event.md +8 -0
  18. data/docs/GetMessagesResponse.md +10 -0
  19. data/docs/Menu.md +9 -0
  20. data/docs/MenuApi.md +163 -0
  21. data/docs/MenuItem.md +13 -0
  22. data/docs/MenuResponse.md +8 -0
  23. data/docs/Message.md +17 -0
  24. data/docs/MessageResponse.md +9 -0
  25. data/docs/Postback.md +11 -0
  26. data/docs/TrackEventResponse.md +8 -0
  27. data/docs/TypingActivityTrigger.md +11 -0
  28. data/git_push.sh +55 -0
  29. data/lib/rainbow-submarine-test-3356.rb +61 -0
  30. data/lib/rainbow-submarine-test-3356/api/app_user_api.rb +585 -0
  31. data/lib/rainbow-submarine-test-3356/api/conversation_api.rb +189 -0
  32. data/lib/rainbow-submarine-test-3356/api/menu_api.rb +173 -0
  33. data/lib/rainbow-submarine-test-3356/api_client.rb +376 -0
  34. data/lib/rainbow-submarine-test-3356/api_error.rb +37 -0
  35. data/lib/rainbow-submarine-test-3356/configuration.rb +209 -0
  36. data/lib/rainbow-submarine-test-3356/models/app_user.rb +258 -0
  37. data/lib/rainbow-submarine-test-3356/models/app_user_link.rb +201 -0
  38. data/lib/rainbow-submarine-test-3356/models/app_user_pre_create.rb +246 -0
  39. data/lib/rainbow-submarine-test-3356/models/app_user_response.rb +192 -0
  40. data/lib/rainbow-submarine-test-3356/models/app_user_update.rb +223 -0
  41. data/lib/rainbow-submarine-test-3356/models/client.rb +248 -0
  42. data/lib/rainbow-submarine-test-3356/models/client_info.rb +250 -0
  43. data/lib/rainbow-submarine-test-3356/models/client_response.rb +187 -0
  44. data/lib/rainbow-submarine-test-3356/models/conversation.rb +206 -0
  45. data/lib/rainbow-submarine-test-3356/models/device_update.rb +205 -0
  46. data/lib/rainbow-submarine-test-3356/models/event.rb +192 -0
  47. data/lib/rainbow-submarine-test-3356/models/get_messages_response.rb +207 -0
  48. data/lib/rainbow-submarine-test-3356/models/menu.rb +203 -0
  49. data/lib/rainbow-submarine-test-3356/models/menu_item.rb +242 -0
  50. data/lib/rainbow-submarine-test-3356/models/menu_response.rb +192 -0
  51. data/lib/rainbow-submarine-test-3356/models/message.rb +303 -0
  52. data/lib/rainbow-submarine-test-3356/models/message_response.rb +206 -0
  53. data/lib/rainbow-submarine-test-3356/models/postback.rb +229 -0
  54. data/lib/rainbow-submarine-test-3356/models/track_event_response.rb +187 -0
  55. data/lib/rainbow-submarine-test-3356/models/typing_activity_trigger.rb +224 -0
  56. data/lib/rainbow-submarine-test-3356/version.rb +14 -0
  57. data/lib/swagger_client.rb +61 -0
  58. data/lib/swagger_client/api/app_user_api.rb +585 -0
  59. data/lib/swagger_client/api/conversation_api.rb +189 -0
  60. data/lib/swagger_client/api/menu_api.rb +173 -0
  61. data/lib/swagger_client/api_client.rb +376 -0
  62. data/lib/swagger_client/api_error.rb +37 -0
  63. data/lib/swagger_client/configuration.rb +209 -0
  64. data/lib/swagger_client/models/app_user.rb +258 -0
  65. data/lib/swagger_client/models/app_user_link.rb +201 -0
  66. data/lib/swagger_client/models/app_user_pre_create.rb +246 -0
  67. data/lib/swagger_client/models/app_user_response.rb +192 -0
  68. data/lib/swagger_client/models/app_user_update.rb +223 -0
  69. data/lib/swagger_client/models/client.rb +248 -0
  70. data/lib/swagger_client/models/client_info.rb +250 -0
  71. data/lib/swagger_client/models/client_response.rb +187 -0
  72. data/lib/swagger_client/models/conversation.rb +206 -0
  73. data/lib/swagger_client/models/device_update.rb +205 -0
  74. data/lib/swagger_client/models/event.rb +192 -0
  75. data/lib/swagger_client/models/get_messages_response.rb +207 -0
  76. data/lib/swagger_client/models/menu.rb +203 -0
  77. data/lib/swagger_client/models/menu_item.rb +242 -0
  78. data/lib/swagger_client/models/menu_response.rb +192 -0
  79. data/lib/swagger_client/models/message.rb +303 -0
  80. data/lib/swagger_client/models/message_response.rb +206 -0
  81. data/lib/swagger_client/models/postback.rb +229 -0
  82. data/lib/swagger_client/models/track_event_response.rb +187 -0
  83. data/lib/swagger_client/models/typing_activity_trigger.rb +224 -0
  84. data/lib/swagger_client/version.rb +14 -0
  85. data/rainbow-submarine-test-3356.gemspec +44 -0
  86. data/spec/api/app_user_api_spec.rb +162 -0
  87. data/spec/api/conversation_api_spec.rb +73 -0
  88. data/spec/api/menu_api_spec.rb +68 -0
  89. data/spec/api_client_spec.rb +225 -0
  90. data/spec/configuration_spec.rb +41 -0
  91. data/spec/models/app_user_link_spec.rb +47 -0
  92. data/spec/models/app_user_pre_create_spec.rb +77 -0
  93. data/spec/models/app_user_response_spec.rb +41 -0
  94. data/spec/models/app_user_spec.rb +77 -0
  95. data/spec/models/app_user_update_spec.rb +65 -0
  96. data/spec/models/client_info_spec.rb +83 -0
  97. data/spec/models/client_response_spec.rb +41 -0
  98. data/spec/models/client_spec.rb +65 -0
  99. data/spec/models/conversation_spec.rb +47 -0
  100. data/spec/models/device_update_spec.rb +53 -0
  101. data/spec/models/event_spec.rb +41 -0
  102. data/spec/models/get_messages_response_spec.rb +53 -0
  103. data/spec/models/menu_item_spec.rb +71 -0
  104. data/spec/models/menu_response_spec.rb +41 -0
  105. data/spec/models/menu_spec.rb +47 -0
  106. data/spec/models/message_response_spec.rb +47 -0
  107. data/spec/models/message_spec.rb +95 -0
  108. data/spec/models/postback_spec.rb +59 -0
  109. data/spec/models/track_event_response_spec.rb +41 -0
  110. data/spec/models/typing_activity_trigger_spec.rb +59 -0
  111. data/spec/spec_helper.rb +110 -0
  112. data/swagger_client.gemspec +45 -0
  113. metadata +361 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 94c850570432cfb30601d12c28611e2e91a26a7d
4
+ data.tar.gz: 273fe4d10f4d5bbb94a20bdf07a6f1d99d95163e
5
+ SHA512:
6
+ metadata.gz: 8629380d7f87aa98b7e276d25643e236b489391a9c088becf68483a62a16773924f9c7b151a0bdadddc61189cb6749ccaf25830e0501dbe66f2a816590e16e3f
7
+ data.tar.gz: 2bcd4ac44b87106c572e06e44a0029d916b7a1384d4ff65fd029a4e9f05c5bf3f297c9dce76ba4ff2e2aa91be46c284b8856a84914de95297933b71b80577154
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ end
@@ -0,0 +1,150 @@
1
+ # rainbow-submarine-test-3356
2
+
3
+ RainbowSubmarineTest3356 - the Ruby gem for the Smooch
4
+
5
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
6
+
7
+ This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
+
9
+ - API version: 1.0.0
10
+ - Package version: 1.2.2
11
+ - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
+
13
+ ## Installation
14
+
15
+ ### Build a gem
16
+
17
+ To build the Ruby code into a gem:
18
+
19
+ ```shell
20
+ gem build rainbow-submarine-test-3356.gemspec
21
+ ```
22
+
23
+ Then either install the gem locally:
24
+
25
+ ```shell
26
+ gem install ./rainbow-submarine-test-3356-1.2.2.gem
27
+ ```
28
+ (for development, run `gem install --dev ./rainbow-submarine-test-3356-1.2.2.gem` to install the development dependencies)
29
+
30
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
+
32
+ Finally add this to the Gemfile:
33
+
34
+ gem 'rainbow-submarine-test-3356', '~> 1.2.2'
35
+
36
+ ### Install from Git
37
+
38
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
39
+
40
+ gem 'rainbow-submarine-test-3356', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
41
+
42
+ ### Include the Ruby code directly
43
+
44
+ Include the Ruby code directly using `-I` as follows:
45
+
46
+ ```shell
47
+ ruby -Ilib script.rb
48
+ ```
49
+
50
+ ## Getting Started
51
+
52
+ Please follow the [installation](#installation) procedure and then run the following code:
53
+ ```ruby
54
+ # Load the gem
55
+ require 'rainbow-submarine-test-3356'
56
+
57
+ # Setup authorization
58
+ RainbowSubmarineTest3356.configure do |config|
59
+ # Configure API key authorization: appToken
60
+ config.api_key['app-token'] = 'YOUR API KEY'
61
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
62
+ #config.api_key_prefix['app-token'] = 'Bearer'
63
+
64
+ # Configure API key authorization: jwt
65
+ config.api_key['Authorization'] = 'YOUR API KEY'
66
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
67
+ #config.api_key_prefix['Authorization'] = 'Bearer'
68
+ end
69
+
70
+ api_instance = RainbowSubmarineTest3356::AppUserApi.new
71
+
72
+ user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
73
+
74
+ device_id = "device_id_example" # String | Id of the device.
75
+
76
+ app_user_device_update = RainbowSubmarineTest3356::DeviceUpdate.new # DeviceUpdate | Supported properties for an updateAppUserDevice request.
77
+
78
+
79
+ begin
80
+ result = api_instance.app_user_device_update(user_id, device_id, app_user_device_update)
81
+ p result
82
+ rescue RainbowSubmarineTest3356::ApiError => e
83
+ puts "Exception when calling AppUserApi->app_user_device_update: #{e}"
84
+ end
85
+
86
+ ```
87
+
88
+ ## Documentation for API Endpoints
89
+
90
+ All URIs are relative to *https://api.smooch.io/v1*
91
+
92
+ Class | Method | HTTP request | Description
93
+ ------------ | ------------- | ------------- | -------------
94
+ *RainbowSubmarineTest3356::AppUserApi* | [**app_user_device_update**](docs/AppUserApi.md#app_user_device_update) | **PUT** /appusers/{userId}/devices/{deviceId} |
95
+ *RainbowSubmarineTest3356::AppUserApi* | [**delete_app_user_profile**](docs/AppUserApi.md#delete_app_user_profile) | **DELETE** /appusers/{userId}/profile |
96
+ *RainbowSubmarineTest3356::AppUserApi* | [**get_app_user**](docs/AppUserApi.md#get_app_user) | **GET** /appusers/{userId} |
97
+ *RainbowSubmarineTest3356::AppUserApi* | [**get_app_user_entity_ids**](docs/AppUserApi.md#get_app_user_entity_ids) | **GET** /appusers/{userId}/channels |
98
+ *RainbowSubmarineTest3356::AppUserApi* | [**link_app_user**](docs/AppUserApi.md#link_app_user) | **POST** /appusers/{userId}/channels |
99
+ *RainbowSubmarineTest3356::AppUserApi* | [**post_image_message**](docs/AppUserApi.md#post_image_message) | **POST** /appusers/{userId}/images |
100
+ *RainbowSubmarineTest3356::AppUserApi* | [**pre_create_app_user**](docs/AppUserApi.md#pre_create_app_user) | **POST** /appusers |
101
+ *RainbowSubmarineTest3356::AppUserApi* | [**track_event**](docs/AppUserApi.md#track_event) | **POST** /appusers/{userId}/events |
102
+ *RainbowSubmarineTest3356::AppUserApi* | [**unlink_app_user**](docs/AppUserApi.md#unlink_app_user) | **DELETE** /appusers/{userId}/channels/{channel} |
103
+ *RainbowSubmarineTest3356::AppUserApi* | [**update_app_user**](docs/AppUserApi.md#update_app_user) | **PUT** /appusers/{userId} |
104
+ *RainbowSubmarineTest3356::ConversationApi* | [**get_messages**](docs/ConversationApi.md#get_messages) | **GET** /appusers/{userId}/messages |
105
+ *RainbowSubmarineTest3356::ConversationApi* | [**reset_unread_count**](docs/ConversationApi.md#reset_unread_count) | **POST** /appusers/{userId}/conversation/read |
106
+ *RainbowSubmarineTest3356::ConversationApi* | [**trigger_typing_activity**](docs/ConversationApi.md#trigger_typing_activity) | **POST** /appusers/{userId}/conversation/activity |
107
+ *RainbowSubmarineTest3356::MenuApi* | [**delete_menu**](docs/MenuApi.md#delete_menu) | **DELETE** /menu |
108
+ *RainbowSubmarineTest3356::MenuApi* | [**get_menu**](docs/MenuApi.md#get_menu) | **GET** /menu |
109
+ *RainbowSubmarineTest3356::MenuApi* | [**update_menu**](docs/MenuApi.md#update_menu) | **PUT** /menu |
110
+
111
+
112
+ ## Documentation for Models
113
+
114
+ - [RainbowSubmarineTest3356::AppUser](docs/AppUser.md)
115
+ - [RainbowSubmarineTest3356::AppUserLink](docs/AppUserLink.md)
116
+ - [RainbowSubmarineTest3356::AppUserPreCreate](docs/AppUserPreCreate.md)
117
+ - [RainbowSubmarineTest3356::AppUserResponse](docs/AppUserResponse.md)
118
+ - [RainbowSubmarineTest3356::AppUserUpdate](docs/AppUserUpdate.md)
119
+ - [RainbowSubmarineTest3356::Client](docs/Client.md)
120
+ - [RainbowSubmarineTest3356::ClientInfo](docs/ClientInfo.md)
121
+ - [RainbowSubmarineTest3356::ClientResponse](docs/ClientResponse.md)
122
+ - [RainbowSubmarineTest3356::Conversation](docs/Conversation.md)
123
+ - [RainbowSubmarineTest3356::DeviceUpdate](docs/DeviceUpdate.md)
124
+ - [RainbowSubmarineTest3356::Event](docs/Event.md)
125
+ - [RainbowSubmarineTest3356::GetMessagesResponse](docs/GetMessagesResponse.md)
126
+ - [RainbowSubmarineTest3356::Menu](docs/Menu.md)
127
+ - [RainbowSubmarineTest3356::MenuItem](docs/MenuItem.md)
128
+ - [RainbowSubmarineTest3356::MenuResponse](docs/MenuResponse.md)
129
+ - [RainbowSubmarineTest3356::Message](docs/Message.md)
130
+ - [RainbowSubmarineTest3356::MessageResponse](docs/MessageResponse.md)
131
+ - [RainbowSubmarineTest3356::Postback](docs/Postback.md)
132
+ - [RainbowSubmarineTest3356::TrackEventResponse](docs/TrackEventResponse.md)
133
+ - [RainbowSubmarineTest3356::TypingActivityTrigger](docs/TypingActivityTrigger.md)
134
+
135
+
136
+ ## Documentation for Authorization
137
+
138
+
139
+ ### appToken
140
+
141
+ - **Type**: API key
142
+ - **API key parameter name**: app-token
143
+ - **Location**: HTTP header
144
+
145
+ ### jwt
146
+
147
+ - **Type**: API key
148
+ - **API key parameter name**: Authorization
149
+ - **Location**: HTTP header
150
+
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
@@ -0,0 +1,14 @@
1
+ # RainbowSubmarineTest3356::AppUser
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **_id** | **String** | |
7
+ **user_id** | **String** | | [optional]
8
+ **given_name** | **String** | | [optional]
9
+ **surname** | **String** | | [optional]
10
+ **properties** | **Object** | |
11
+ **conversation_started** | **BOOLEAN** | |
12
+ **clients** | [**Array<Client>**](Client.md) | | [optional]
13
+
14
+
@@ -0,0 +1,616 @@
1
+ # RainbowSubmarineTest3356::AppUserApi
2
+
3
+ All URIs are relative to *https://api.smooch.io/v1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**app_user_device_update**](AppUserApi.md#app_user_device_update) | **PUT** /appusers/{userId}/devices/{deviceId} |
8
+ [**delete_app_user_profile**](AppUserApi.md#delete_app_user_profile) | **DELETE** /appusers/{userId}/profile |
9
+ [**get_app_user**](AppUserApi.md#get_app_user) | **GET** /appusers/{userId} |
10
+ [**get_app_user_entity_ids**](AppUserApi.md#get_app_user_entity_ids) | **GET** /appusers/{userId}/channels |
11
+ [**link_app_user**](AppUserApi.md#link_app_user) | **POST** /appusers/{userId}/channels |
12
+ [**post_image_message**](AppUserApi.md#post_image_message) | **POST** /appusers/{userId}/images |
13
+ [**pre_create_app_user**](AppUserApi.md#pre_create_app_user) | **POST** /appusers |
14
+ [**track_event**](AppUserApi.md#track_event) | **POST** /appusers/{userId}/events |
15
+ [**unlink_app_user**](AppUserApi.md#unlink_app_user) | **DELETE** /appusers/{userId}/channels/{channel} |
16
+ [**update_app_user**](AppUserApi.md#update_app_user) | **PUT** /appusers/{userId} |
17
+
18
+
19
+ # **app_user_device_update**
20
+ > ClientResponse app_user_device_update(user_id, device_id, app_user_device_update)
21
+
22
+
23
+
24
+ Update specified device information.
25
+
26
+ ### Example
27
+ ```ruby
28
+ # load the gem
29
+ require 'rainbow-submarine-test-3356'
30
+ # setup authorization
31
+ RainbowSubmarineTest3356.configure do |config|
32
+ # Configure API key authorization: appToken
33
+ config.api_key['app-token'] = 'YOUR API KEY'
34
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
35
+ #config.api_key_prefix['app-token'] = 'Bearer'
36
+
37
+ # Configure API key authorization: jwt
38
+ config.api_key['Authorization'] = 'YOUR API KEY'
39
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
40
+ #config.api_key_prefix['Authorization'] = 'Bearer'
41
+ end
42
+
43
+ api_instance = RainbowSubmarineTest3356::AppUserApi.new
44
+
45
+ user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
46
+
47
+ device_id = "device_id_example" # String | Id of the device.
48
+
49
+ app_user_device_update = RainbowSubmarineTest3356::DeviceUpdate.new # DeviceUpdate | Supported properties for an updateAppUserDevice request.
50
+
51
+
52
+ begin
53
+ result = api_instance.app_user_device_update(user_id, device_id, app_user_device_update)
54
+ p result
55
+ rescue RainbowSubmarineTest3356::ApiError => e
56
+ puts "Exception when calling AppUserApi->app_user_device_update: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ Name | Type | Description | Notes
63
+ ------------- | ------------- | ------------- | -------------
64
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
65
+ **device_id** | **String**| Id of the device. |
66
+ **app_user_device_update** | [**DeviceUpdate**](DeviceUpdate.md)| Supported properties for an updateAppUserDevice request. |
67
+
68
+ ### Return type
69
+
70
+ [**ClientResponse**](ClientResponse.md)
71
+
72
+ ### Authorization
73
+
74
+ [appToken](../README.md#appToken), [jwt](../README.md#jwt)
75
+
76
+ ### HTTP request headers
77
+
78
+ - **Content-Type**: application/json
79
+ - **Accept**: application/json
80
+
81
+
82
+
83
+ # **delete_app_user_profile**
84
+ > AppUserResponse delete_app_user_profile(user_id, )
85
+
86
+
87
+
88
+ Delete specified app users profile.
89
+
90
+ ### Example
91
+ ```ruby
92
+ # load the gem
93
+ require 'rainbow-submarine-test-3356'
94
+ # setup authorization
95
+ RainbowSubmarineTest3356.configure do |config|
96
+ # Configure API key authorization: appToken
97
+ config.api_key['app-token'] = 'YOUR API KEY'
98
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
99
+ #config.api_key_prefix['app-token'] = 'Bearer'
100
+
101
+ # Configure API key authorization: jwt
102
+ config.api_key['Authorization'] = 'YOUR API KEY'
103
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
104
+ #config.api_key_prefix['Authorization'] = 'Bearer'
105
+ end
106
+
107
+ api_instance = RainbowSubmarineTest3356::AppUserApi.new
108
+
109
+ user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
110
+
111
+
112
+ begin
113
+ result = api_instance.delete_app_user_profile(user_id, )
114
+ p result
115
+ rescue RainbowSubmarineTest3356::ApiError => e
116
+ puts "Exception when calling AppUserApi->delete_app_user_profile: #{e}"
117
+ end
118
+ ```
119
+
120
+ ### Parameters
121
+
122
+ Name | Type | Description | Notes
123
+ ------------- | ------------- | ------------- | -------------
124
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
125
+
126
+ ### Return type
127
+
128
+ [**AppUserResponse**](AppUserResponse.md)
129
+
130
+ ### Authorization
131
+
132
+ [appToken](../README.md#appToken), [jwt](../README.md#jwt)
133
+
134
+ ### HTTP request headers
135
+
136
+ - **Content-Type**: application/json
137
+ - **Accept**: application/json
138
+
139
+
140
+
141
+ # **get_app_user**
142
+ > AppUserResponse get_app_user(user_id, )
143
+
144
+
145
+
146
+ Get the specified app user.
147
+
148
+ ### Example
149
+ ```ruby
150
+ # load the gem
151
+ require 'rainbow-submarine-test-3356'
152
+ # setup authorization
153
+ RainbowSubmarineTest3356.configure do |config|
154
+ # Configure API key authorization: appToken
155
+ config.api_key['app-token'] = 'YOUR API KEY'
156
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
157
+ #config.api_key_prefix['app-token'] = 'Bearer'
158
+
159
+ # Configure API key authorization: jwt
160
+ config.api_key['Authorization'] = 'YOUR API KEY'
161
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
162
+ #config.api_key_prefix['Authorization'] = 'Bearer'
163
+ end
164
+
165
+ api_instance = RainbowSubmarineTest3356::AppUserApi.new
166
+
167
+ user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
168
+
169
+
170
+ begin
171
+ result = api_instance.get_app_user(user_id, )
172
+ p result
173
+ rescue RainbowSubmarineTest3356::ApiError => e
174
+ puts "Exception when calling AppUserApi->get_app_user: #{e}"
175
+ end
176
+ ```
177
+
178
+ ### Parameters
179
+
180
+ Name | Type | Description | Notes
181
+ ------------- | ------------- | ------------- | -------------
182
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
183
+
184
+ ### Return type
185
+
186
+ [**AppUserResponse**](AppUserResponse.md)
187
+
188
+ ### Authorization
189
+
190
+ [appToken](../README.md#appToken), [jwt](../README.md#jwt)
191
+
192
+ ### HTTP request headers
193
+
194
+ - **Content-Type**: application/json
195
+ - **Accept**: application/json
196
+
197
+
198
+
199
+ # **get_app_user_entity_ids**
200
+ > AppUserResponse get_app_user_entity_ids(user_id, )
201
+
202
+
203
+
204
+ Get specified app users channel entity IDs.
205
+
206
+ ### Example
207
+ ```ruby
208
+ # load the gem
209
+ require 'rainbow-submarine-test-3356'
210
+ # setup authorization
211
+ RainbowSubmarineTest3356.configure do |config|
212
+ # Configure API key authorization: appToken
213
+ config.api_key['app-token'] = 'YOUR API KEY'
214
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
215
+ #config.api_key_prefix['app-token'] = 'Bearer'
216
+
217
+ # Configure API key authorization: jwt
218
+ config.api_key['Authorization'] = 'YOUR API KEY'
219
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
220
+ #config.api_key_prefix['Authorization'] = 'Bearer'
221
+ end
222
+
223
+ api_instance = RainbowSubmarineTest3356::AppUserApi.new
224
+
225
+ user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
226
+
227
+
228
+ begin
229
+ result = api_instance.get_app_user_entity_ids(user_id, )
230
+ p result
231
+ rescue RainbowSubmarineTest3356::ApiError => e
232
+ puts "Exception when calling AppUserApi->get_app_user_entity_ids: #{e}"
233
+ end
234
+ ```
235
+
236
+ ### Parameters
237
+
238
+ Name | Type | Description | Notes
239
+ ------------- | ------------- | ------------- | -------------
240
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
241
+
242
+ ### Return type
243
+
244
+ [**AppUserResponse**](AppUserResponse.md)
245
+
246
+ ### Authorization
247
+
248
+ [appToken](../README.md#appToken), [jwt](../README.md#jwt)
249
+
250
+ ### HTTP request headers
251
+
252
+ - **Content-Type**: application/json
253
+ - **Accept**: application/json
254
+
255
+
256
+
257
+ # **link_app_user**
258
+ > AppUserResponse link_app_user(user_id, app_user_link)
259
+
260
+
261
+
262
+ Link specified app user to given channel.
263
+
264
+ ### Example
265
+ ```ruby
266
+ # load the gem
267
+ require 'rainbow-submarine-test-3356'
268
+ # setup authorization
269
+ RainbowSubmarineTest3356.configure do |config|
270
+ # Configure API key authorization: appToken
271
+ config.api_key['app-token'] = 'YOUR API KEY'
272
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
273
+ #config.api_key_prefix['app-token'] = 'Bearer'
274
+
275
+ # Configure API key authorization: jwt
276
+ config.api_key['Authorization'] = 'YOUR API KEY'
277
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
278
+ #config.api_key_prefix['Authorization'] = 'Bearer'
279
+ end
280
+
281
+ api_instance = RainbowSubmarineTest3356::AppUserApi.new
282
+
283
+ user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
284
+
285
+ app_user_link = RainbowSubmarineTest3356::AppUserLink.new # AppUserLink | Supported properties for a linkAppUser request.
286
+
287
+
288
+ begin
289
+ result = api_instance.link_app_user(user_id, app_user_link)
290
+ p result
291
+ rescue RainbowSubmarineTest3356::ApiError => e
292
+ puts "Exception when calling AppUserApi->link_app_user: #{e}"
293
+ end
294
+ ```
295
+
296
+ ### Parameters
297
+
298
+ Name | Type | Description | Notes
299
+ ------------- | ------------- | ------------- | -------------
300
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
301
+ **app_user_link** | [**AppUserLink**](AppUserLink.md)| Supported properties for a linkAppUser request. |
302
+
303
+ ### Return type
304
+
305
+ [**AppUserResponse**](AppUserResponse.md)
306
+
307
+ ### Authorization
308
+
309
+ [appToken](../README.md#appToken), [jwt](../README.md#jwt)
310
+
311
+ ### HTTP request headers
312
+
313
+ - **Content-Type**: application/json
314
+ - **Accept**: application/json
315
+
316
+
317
+
318
+ # **post_image_message**
319
+ > MessageResponse post_image_message(user_id, source, role)
320
+
321
+
322
+
323
+ Send an image message to the conversation
324
+
325
+ ### Example
326
+ ```ruby
327
+ # load the gem
328
+ require 'rainbow-submarine-test-3356'
329
+ # setup authorization
330
+ RainbowSubmarineTest3356.configure do |config|
331
+ # Configure API key authorization: appToken
332
+ config.api_key['app-token'] = 'YOUR API KEY'
333
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
334
+ #config.api_key_prefix['app-token'] = 'Bearer'
335
+
336
+ # Configure API key authorization: jwt
337
+ config.api_key['Authorization'] = 'YOUR API KEY'
338
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
339
+ #config.api_key_prefix['Authorization'] = 'Bearer'
340
+ end
341
+
342
+ api_instance = RainbowSubmarineTest3356::AppUserApi.new
343
+
344
+ user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
345
+
346
+ source = File.new("/path/to/file.txt") # File | Image to be uploaded
347
+
348
+ role = "role_example" # String | Role of the sender
349
+
350
+
351
+ begin
352
+ result = api_instance.post_image_message(user_id, source, role)
353
+ p result
354
+ rescue RainbowSubmarineTest3356::ApiError => e
355
+ puts "Exception when calling AppUserApi->post_image_message: #{e}"
356
+ end
357
+ ```
358
+
359
+ ### Parameters
360
+
361
+ Name | Type | Description | Notes
362
+ ------------- | ------------- | ------------- | -------------
363
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
364
+ **source** | **File**| Image to be uploaded |
365
+ **role** | **String**| Role of the sender |
366
+
367
+ ### Return type
368
+
369
+ [**MessageResponse**](MessageResponse.md)
370
+
371
+ ### Authorization
372
+
373
+ [appToken](../README.md#appToken), [jwt](../README.md#jwt)
374
+
375
+ ### HTTP request headers
376
+
377
+ - **Content-Type**: multipart/form-data
378
+ - **Accept**: application/json
379
+
380
+
381
+
382
+ # **pre_create_app_user**
383
+ > AppUserResponse pre_create_app_user(app_user_pre_create)
384
+
385
+
386
+
387
+ Pre-create an app user.
388
+
389
+ ### Example
390
+ ```ruby
391
+ # load the gem
392
+ require 'rainbow-submarine-test-3356'
393
+ # setup authorization
394
+ RainbowSubmarineTest3356.configure do |config|
395
+ # Configure API key authorization: jwt
396
+ config.api_key['Authorization'] = 'YOUR API KEY'
397
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
398
+ #config.api_key_prefix['Authorization'] = 'Bearer'
399
+ end
400
+
401
+ api_instance = RainbowSubmarineTest3356::AppUserApi.new
402
+
403
+ app_user_pre_create = RainbowSubmarineTest3356::AppUserPreCreate.new # AppUserPreCreate | Supported properties for a preCreateAppUser request.
404
+
405
+
406
+ begin
407
+ result = api_instance.pre_create_app_user(app_user_pre_create)
408
+ p result
409
+ rescue RainbowSubmarineTest3356::ApiError => e
410
+ puts "Exception when calling AppUserApi->pre_create_app_user: #{e}"
411
+ end
412
+ ```
413
+
414
+ ### Parameters
415
+
416
+ Name | Type | Description | Notes
417
+ ------------- | ------------- | ------------- | -------------
418
+ **app_user_pre_create** | [**AppUserPreCreate**](AppUserPreCreate.md)| Supported properties for a preCreateAppUser request. |
419
+
420
+ ### Return type
421
+
422
+ [**AppUserResponse**](AppUserResponse.md)
423
+
424
+ ### Authorization
425
+
426
+ [jwt](../README.md#jwt)
427
+
428
+ ### HTTP request headers
429
+
430
+ - **Content-Type**: application/json
431
+ - **Accept**: application/json
432
+
433
+
434
+
435
+ # **track_event**
436
+ > TrackEventResponse track_event(user_id, event)
437
+
438
+
439
+
440
+ Track an event for the given app user.
441
+
442
+ ### Example
443
+ ```ruby
444
+ # load the gem
445
+ require 'rainbow-submarine-test-3356'
446
+ # setup authorization
447
+ RainbowSubmarineTest3356.configure do |config|
448
+ # Configure API key authorization: appToken
449
+ config.api_key['app-token'] = 'YOUR API KEY'
450
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
451
+ #config.api_key_prefix['app-token'] = 'Bearer'
452
+
453
+ # Configure API key authorization: jwt
454
+ config.api_key['Authorization'] = 'YOUR API KEY'
455
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
456
+ #config.api_key_prefix['Authorization'] = 'Bearer'
457
+ end
458
+
459
+ api_instance = RainbowSubmarineTest3356::AppUserApi.new
460
+
461
+ user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
462
+
463
+ event = RainbowSubmarineTest3356::Event.new # Event | Supported properties for a trackEvent request.
464
+
465
+
466
+ begin
467
+ result = api_instance.track_event(user_id, event)
468
+ p result
469
+ rescue RainbowSubmarineTest3356::ApiError => e
470
+ puts "Exception when calling AppUserApi->track_event: #{e}"
471
+ end
472
+ ```
473
+
474
+ ### Parameters
475
+
476
+ Name | Type | Description | Notes
477
+ ------------- | ------------- | ------------- | -------------
478
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
479
+ **event** | [**Event**](Event.md)| Supported properties for a trackEvent request. |
480
+
481
+ ### Return type
482
+
483
+ [**TrackEventResponse**](TrackEventResponse.md)
484
+
485
+ ### Authorization
486
+
487
+ [appToken](../README.md#appToken), [jwt](../README.md#jwt)
488
+
489
+ ### HTTP request headers
490
+
491
+ - **Content-Type**: application/json
492
+ - **Accept**: application/json
493
+
494
+
495
+
496
+ # **unlink_app_user**
497
+ > unlink_app_user(user_id, channel)
498
+
499
+
500
+
501
+ Unlink specified app user from given channel.
502
+
503
+ ### Example
504
+ ```ruby
505
+ # load the gem
506
+ require 'rainbow-submarine-test-3356'
507
+ # setup authorization
508
+ RainbowSubmarineTest3356.configure do |config|
509
+ # Configure API key authorization: appToken
510
+ config.api_key['app-token'] = 'YOUR API KEY'
511
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
512
+ #config.api_key_prefix['app-token'] = 'Bearer'
513
+
514
+ # Configure API key authorization: jwt
515
+ config.api_key['Authorization'] = 'YOUR API KEY'
516
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
517
+ #config.api_key_prefix['Authorization'] = 'Bearer'
518
+ end
519
+
520
+ api_instance = RainbowSubmarineTest3356::AppUserApi.new
521
+
522
+ user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
523
+
524
+ channel = "channel_example" # String | Name of the channel.
525
+
526
+
527
+ begin
528
+ api_instance.unlink_app_user(user_id, channel)
529
+ rescue RainbowSubmarineTest3356::ApiError => e
530
+ puts "Exception when calling AppUserApi->unlink_app_user: #{e}"
531
+ end
532
+ ```
533
+
534
+ ### Parameters
535
+
536
+ Name | Type | Description | Notes
537
+ ------------- | ------------- | ------------- | -------------
538
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
539
+ **channel** | **String**| Name of the channel. |
540
+
541
+ ### Return type
542
+
543
+ nil (empty response body)
544
+
545
+ ### Authorization
546
+
547
+ [appToken](../README.md#appToken), [jwt](../README.md#jwt)
548
+
549
+ ### HTTP request headers
550
+
551
+ - **Content-Type**: application/json
552
+ - **Accept**: application/json
553
+
554
+
555
+
556
+ # **update_app_user**
557
+ > AppUserResponse update_app_user(user_id, app_user_update)
558
+
559
+
560
+
561
+ Update the specified app user.
562
+
563
+ ### Example
564
+ ```ruby
565
+ # load the gem
566
+ require 'rainbow-submarine-test-3356'
567
+ # setup authorization
568
+ RainbowSubmarineTest3356.configure do |config|
569
+ # Configure API key authorization: appToken
570
+ config.api_key['app-token'] = 'YOUR API KEY'
571
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
572
+ #config.api_key_prefix['app-token'] = 'Bearer'
573
+
574
+ # Configure API key authorization: jwt
575
+ config.api_key['Authorization'] = 'YOUR API KEY'
576
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
577
+ #config.api_key_prefix['Authorization'] = 'Bearer'
578
+ end
579
+
580
+ api_instance = RainbowSubmarineTest3356::AppUserApi.new
581
+
582
+ user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
583
+
584
+ app_user_update = RainbowSubmarineTest3356::AppUserUpdate.new # AppUserUpdate | Supported properties for an updateAppUser request.
585
+
586
+
587
+ begin
588
+ result = api_instance.update_app_user(user_id, app_user_update)
589
+ p result
590
+ rescue RainbowSubmarineTest3356::ApiError => e
591
+ puts "Exception when calling AppUserApi->update_app_user: #{e}"
592
+ end
593
+ ```
594
+
595
+ ### Parameters
596
+
597
+ Name | Type | Description | Notes
598
+ ------------- | ------------- | ------------- | -------------
599
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
600
+ **app_user_update** | [**AppUserUpdate**](AppUserUpdate.md)| Supported properties for an updateAppUser request. |
601
+
602
+ ### Return type
603
+
604
+ [**AppUserResponse**](AppUserResponse.md)
605
+
606
+ ### Authorization
607
+
608
+ [appToken](../README.md#appToken), [jwt](../README.md#jwt)
609
+
610
+ ### HTTP request headers
611
+
612
+ - **Content-Type**: application/json
613
+ - **Accept**: application/json
614
+
615
+
616
+