smooch-api 1.12.0 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (79) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -25
  3. data/docs/AppUserApi.md +54 -83
  4. data/docs/ConversationApi.md +30 -15
  5. data/docs/MenuApi.md +26 -11
  6. data/lib/smooch-api.rb +1 -7
  7. data/lib/smooch-api/api/app_api.rb +1 -1
  8. data/lib/smooch-api/api/app_user_api.rb +91 -98
  9. data/lib/smooch-api/api/attachments_api.rb +1 -1
  10. data/lib/smooch-api/api/conversation_api.rb +51 -21
  11. data/lib/smooch-api/api/integration_api.rb +1 -1
  12. data/lib/smooch-api/api/menu_api.rb +31 -13
  13. data/lib/smooch-api/api/webhook_api.rb +1 -1
  14. data/lib/smooch-api/api_client.rb +1 -1
  15. data/lib/smooch-api/api_error.rb +1 -1
  16. data/lib/smooch-api/configuration.rb +1 -1
  17. data/lib/smooch-api/models/action.rb +1 -34
  18. data/lib/smooch-api/models/app.rb +1 -1
  19. data/lib/smooch-api/models/app_create.rb +1 -1
  20. data/lib/smooch-api/models/app_response.rb +1 -1
  21. data/lib/smooch-api/models/app_settings.rb +1 -1
  22. data/lib/smooch-api/models/app_update.rb +1 -1
  23. data/lib/smooch-api/models/app_user.rb +1 -1
  24. data/lib/smooch-api/models/app_user_link.rb +1 -34
  25. data/lib/smooch-api/models/app_user_pre_create.rb +1 -1
  26. data/lib/smooch-api/models/app_user_response.rb +1 -1
  27. data/lib/smooch-api/models/app_user_update.rb +1 -1
  28. data/lib/smooch-api/models/attachment_response.rb +1 -1
  29. data/lib/smooch-api/models/client.rb +1 -34
  30. data/lib/smooch-api/models/client_info.rb +1 -1
  31. data/lib/smooch-api/models/confirmation.rb +1 -1
  32. data/lib/smooch-api/models/conversation.rb +1 -1
  33. data/lib/smooch-api/models/destination.rb +1 -1
  34. data/lib/smooch-api/models/device_response.rb +1 -1
  35. data/lib/smooch-api/models/device_update.rb +1 -1
  36. data/lib/smooch-api/models/display_settings.rb +1 -1
  37. data/lib/smooch-api/models/get_messages_response.rb +1 -1
  38. data/lib/smooch-api/models/integration.rb +1 -1
  39. data/lib/smooch-api/models/integration_create.rb +1 -1
  40. data/lib/smooch-api/models/integration_response.rb +1 -1
  41. data/lib/smooch-api/models/jwt_response.rb +1 -1
  42. data/lib/smooch-api/models/list_apps_response.rb +1 -1
  43. data/lib/smooch-api/models/list_integrations_response.rb +1 -1
  44. data/lib/smooch-api/models/list_secret_keys_response.rb +1 -1
  45. data/lib/smooch-api/models/list_webhooks_response.rb +1 -1
  46. data/lib/smooch-api/models/menu.rb +1 -1
  47. data/lib/smooch-api/models/menu_item.rb +1 -1
  48. data/lib/smooch-api/models/menu_response.rb +1 -1
  49. data/lib/smooch-api/models/message.rb +1 -34
  50. data/lib/smooch-api/models/message_item.rb +1 -1
  51. data/lib/smooch-api/models/message_post.rb +1 -34
  52. data/lib/smooch-api/models/message_response.rb +1 -1
  53. data/lib/smooch-api/models/secret_key.rb +1 -1
  54. data/lib/smooch-api/models/secret_key_create.rb +1 -1
  55. data/lib/smooch-api/models/secret_key_response.rb +1 -1
  56. data/lib/smooch-api/models/source.rb +1 -1
  57. data/lib/smooch-api/models/typing_activity_trigger.rb +1 -1
  58. data/lib/smooch-api/models/webhook.rb +1 -22
  59. data/lib/smooch-api/models/webhook_create.rb +1 -22
  60. data/lib/smooch-api/models/webhook_response.rb +1 -1
  61. data/lib/smooch-api/models/webhook_update.rb +1 -22
  62. data/lib/smooch-api/version.rb +2 -2
  63. data/smooch-api.gemspec +1 -1
  64. data/spec/api_client_spec.rb +1 -1
  65. data/spec/configuration_spec.rb +1 -1
  66. data/spec/spec_helper.rb +1 -1
  67. metadata +3 -15
  68. data/docs/DeviceInit.md +0 -12
  69. data/docs/Event.md +0 -8
  70. data/docs/Init.md +0 -9
  71. data/docs/InitApi.md +0 -61
  72. data/docs/InitResponse.md +0 -9
  73. data/docs/TrackEventResponse.md +0 -8
  74. data/lib/smooch-api/api/init_api.rb +0 -78
  75. data/lib/smooch-api/models/device_init.rb +0 -271
  76. data/lib/smooch-api/models/event.rb +0 -194
  77. data/lib/smooch-api/models/init.rb +0 -203
  78. data/lib/smooch-api/models/init_response.rb +0 -209
  79. data/lib/smooch-api/models/track_event_response.rb +0 -189
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -54,27 +54,6 @@ module SmoochApi
54
54
  # Specifies which channel to deliver a message to. See [list integrations](https://docs.smooch.io/rest/#list-integrations) to get integration ID and type.
55
55
  attr_accessor :destination
56
56
 
57
- class EnumAttributeValidator
58
- attr_reader :datatype
59
- attr_reader :allowable_values
60
-
61
- def initialize(datatype, allowable_values)
62
- @allowable_values = allowable_values.map do |value|
63
- case datatype.to_s
64
- when /Integer/i
65
- value.to_i
66
- when /Float/i
67
- value.to_f
68
- else
69
- value
70
- end
71
- end
72
- end
73
-
74
- def valid?(value)
75
- !value || allowable_values.include?(value)
76
- end
77
- end
78
57
 
79
58
  # Attribute mapping from ruby-style variable name to JSON key.
80
59
  def self.attribute_map
@@ -200,21 +179,9 @@ module SmoochApi
200
179
  def valid?
201
180
  return false if @role.nil?
202
181
  return false if @type.nil?
203
- type_validator = EnumAttributeValidator.new('String', ["text", "image", "carousel", "list", "file"])
204
- return false unless type_validator.valid?(@type)
205
182
  return true
206
183
  end
207
184
 
208
- # Custom attribute writer method checking allowed values (enum).
209
- # @param [Object] type Object to be assigned
210
- def type=(type)
211
- validator = EnumAttributeValidator.new('String', ["text", "image", "carousel", "list", "file"])
212
- unless validator.valid?(type)
213
- fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
214
- end
215
- @type = type
216
- end
217
-
218
185
  # Checks equality by comparing each attribute.
219
186
  # @param [Object] Object to be compared
220
187
  def ==(o)
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -27,27 +27,6 @@ module SmoochApi
27
27
  # Secret which will be transmitted with each webhook invocation and can be used to verify the authenticity of the caller.
28
28
  attr_accessor :secret
29
29
 
30
- class EnumAttributeValidator
31
- attr_reader :datatype
32
- attr_reader :allowable_values
33
-
34
- def initialize(datatype, allowable_values)
35
- @allowable_values = allowable_values.map do |value|
36
- case datatype.to_s
37
- when /Integer/i
38
- value.to_i
39
- when /Float/i
40
- value.to_f
41
- else
42
- value
43
- end
44
- end
45
- end
46
-
47
- def valid?(value)
48
- !value || allowable_values.include?(value)
49
- end
50
- end
51
30
 
52
31
  # Attribute mapping from ruby-style variable name to JSON key.
53
32
  def self.attribute_map
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -21,27 +21,6 @@ module SmoochApi
21
21
  # An array of triggers you wish to have the webhook listen to. If unspecified the default trigger is *message*.
22
22
  attr_accessor :triggers
23
23
 
24
- class EnumAttributeValidator
25
- attr_reader :datatype
26
- attr_reader :allowable_values
27
-
28
- def initialize(datatype, allowable_values)
29
- @allowable_values = allowable_values.map do |value|
30
- case datatype.to_s
31
- when /Integer/i
32
- value.to_i
33
- when /Float/i
34
- value.to_f
35
- else
36
- value
37
- end
38
- end
39
- end
40
-
41
- def valid?(value)
42
- !value || allowable_values.include?(value)
43
- end
44
- end
45
24
 
46
25
  # Attribute mapping from ruby-style variable name to JSON key.
47
26
  def self.attribute_map
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -21,27 +21,6 @@ module SmoochApi
21
21
  # An array of triggers you wish to have the webhook listen to. If unspecified the default trigger is *message*.
22
22
  attr_accessor :triggers
23
23
 
24
- class EnumAttributeValidator
25
- attr_reader :datatype
26
- attr_reader :allowable_values
27
-
28
- def initialize(datatype, allowable_values)
29
- @allowable_values = allowable_values.map do |value|
30
- case datatype.to_s
31
- when /Integer/i
32
- value.to_i
33
- when /Float/i
34
- value.to_f
35
- else
36
- value
37
- end
38
- end
39
- end
40
-
41
- def valid?(value)
42
- !value || allowable_values.include?(value)
43
- end
44
- end
45
24
 
46
25
  # Attribute mapping from ruby-style variable name to JSON key.
47
26
  def self.attribute_map
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.2.3-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module SmoochApi
14
- VERSION = "1.12.0"
14
+ VERSION = "2.0.0"
15
15
  end
data/smooch-api.gemspec CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
7
7
 
8
- OpenAPI spec version: 1.12
8
+ OpenAPI spec version: 2
9
9
 
10
10
  Generated by: https://github.com/swagger-api/swagger-codegen.git
11
11
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
data/spec/spec_helper.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
5
5
 
6
- OpenAPI spec version: 1.12
6
+ OpenAPI spec version: 2
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: smooch-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.12.0
4
+ version: 2.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Smooch
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-07-13 00:00:00.000000000 Z
11
+ date: 2017-07-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -224,15 +224,10 @@ files:
224
224
  - docs/Conversation.md
225
225
  - docs/ConversationApi.md
226
226
  - docs/Destination.md
227
- - docs/DeviceInit.md
228
227
  - docs/DeviceResponse.md
229
228
  - docs/DeviceUpdate.md
230
229
  - docs/DisplaySettings.md
231
- - docs/Event.md
232
230
  - docs/GetMessagesResponse.md
233
- - docs/Init.md
234
- - docs/InitApi.md
235
- - docs/InitResponse.md
236
231
  - docs/Integration.md
237
232
  - docs/IntegrationApi.md
238
233
  - docs/IntegrationCreate.md
@@ -254,7 +249,6 @@ files:
254
249
  - docs/SecretKeyCreate.md
255
250
  - docs/SecretKeyResponse.md
256
251
  - docs/Source.md
257
- - docs/TrackEventResponse.md
258
252
  - docs/TypingActivityTrigger.md
259
253
  - docs/Webhook.md
260
254
  - docs/WebhookApi.md
@@ -267,7 +261,6 @@ files:
267
261
  - lib/smooch-api/api/app_user_api.rb
268
262
  - lib/smooch-api/api/attachments_api.rb
269
263
  - lib/smooch-api/api/conversation_api.rb
270
- - lib/smooch-api/api/init_api.rb
271
264
  - lib/smooch-api/api/integration_api.rb
272
265
  - lib/smooch-api/api/menu_api.rb
273
266
  - lib/smooch-api/api/webhook_api.rb
@@ -291,14 +284,10 @@ files:
291
284
  - lib/smooch-api/models/confirmation.rb
292
285
  - lib/smooch-api/models/conversation.rb
293
286
  - lib/smooch-api/models/destination.rb
294
- - lib/smooch-api/models/device_init.rb
295
287
  - lib/smooch-api/models/device_response.rb
296
288
  - lib/smooch-api/models/device_update.rb
297
289
  - lib/smooch-api/models/display_settings.rb
298
- - lib/smooch-api/models/event.rb
299
290
  - lib/smooch-api/models/get_messages_response.rb
300
- - lib/smooch-api/models/init.rb
301
- - lib/smooch-api/models/init_response.rb
302
291
  - lib/smooch-api/models/integration.rb
303
292
  - lib/smooch-api/models/integration_create.rb
304
293
  - lib/smooch-api/models/integration_response.rb
@@ -318,7 +307,6 @@ files:
318
307
  - lib/smooch-api/models/secret_key_create.rb
319
308
  - lib/smooch-api/models/secret_key_response.rb
320
309
  - lib/smooch-api/models/source.rb
321
- - lib/smooch-api/models/track_event_response.rb
322
310
  - lib/smooch-api/models/typing_activity_trigger.rb
323
311
  - lib/smooch-api/models/webhook.rb
324
312
  - lib/smooch-api/models/webhook_create.rb
@@ -349,7 +337,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
349
337
  version: '0'
350
338
  requirements: []
351
339
  rubyforge_project:
352
- rubygems_version: 2.6.11
340
+ rubygems_version: 2.6.12
353
341
  signing_key:
354
342
  specification_version: 4
355
343
  summary: Smooch Ruby Gem
data/docs/DeviceInit.md DELETED
@@ -1,12 +0,0 @@
1
- # SmoochApi::DeviceInit
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | An identifier for the client. Must be globally unique. |
7
- **platform** | **String** | The client's platform. |
8
- **push_notification_token** | **String** | The GCM or APN token to be used for sending push notifications to the device. Applies to only *android* and *ios* clients. | [optional]
9
- **app_version** | **String** | A reserved string field for reporting the app version running on the device. | [optional]
10
- **info** | [**ClientInfo**](ClientInfo.md) | | [optional]
11
-
12
-
data/docs/Event.md DELETED
@@ -1,8 +0,0 @@
1
- # SmoochApi::Event
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | The name of the event. |
7
-
8
-
data/docs/Init.md DELETED
@@ -1,9 +0,0 @@
1
- # SmoochApi::Init
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **device** | [**DeviceInit**](DeviceInit.md) | |
7
- **user_id** | **String** | The app user's userId. If specified, this ID can be used to invoke APIs. If left blank, an ID will automatically be generated. | [optional]
8
-
9
-
data/docs/InitApi.md DELETED
@@ -1,61 +0,0 @@
1
- # SmoochApi::InitApi
2
-
3
- All URIs are relative to *https://api.smooch.io/v1*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**init**](InitApi.md#init) | **POST** /init |
8
-
9
-
10
- # **init**
11
- > InitResponse init(init_body)
12
-
13
-
14
-
15
- This API is called by an iOS, Android, or browser client when the app is first loaded. It serves a number of purposes. 1. Initializes a new *appUser* and *client* if they don’t yet exist. 2. Updates an existing app user’s profile and client information. 3. Authenticates the *appUser* if *jwt* credentials are provided.
16
-
17
- ### Example
18
- ```ruby
19
- # load the gem
20
- require 'smooch-api'
21
- # setup authorization
22
- SmoochApi.configure do |config|
23
- # Configure API key authorization: jwt
24
- config.api_key['Authorization'] = 'YOUR JWT'
25
- config.api_key_prefix['Authorization'] = 'Bearer'
26
- end
27
-
28
- api_instance = SmoochApi::InitApi.new
29
-
30
- init_body = SmoochApi::Init.new # Init | Body for an init request.
31
-
32
-
33
- begin
34
- result = api_instance.init(init_body)
35
- p result
36
- rescue SmoochApi::ApiError => e
37
- puts "Exception when calling InitApi->init: #{e}"
38
- end
39
- ```
40
-
41
- ### Parameters
42
-
43
- Name | Type | Description | Notes
44
- ------------- | ------------- | ------------- | -------------
45
- **init_body** | [**Init**](Init.md)| Body for an init request. |
46
-
47
- ### Return type
48
-
49
- [**InitResponse**](InitResponse.md)
50
-
51
- ### Authorization
52
-
53
- [jwt](../README.md#jwt)
54
-
55
- ### HTTP request headers
56
-
57
- - **Content-Type**: application/json
58
- - **Accept**: application/json
59
-
60
-
61
-