smooch-api 5.25.1 → 5.29.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (128) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +176 -0
  3. data/README.md +20 -1
  4. data/docs/AppApi.md +60 -0
  5. data/docs/AppUserLink.md +1 -0
  6. data/docs/Author.md +11 -0
  7. data/docs/GetSdkIdsResponse.md +10 -0
  8. data/docs/Integration.md +4 -0
  9. data/docs/IntegrationCreate.md +7 -0
  10. data/docs/NotificationApi.md +71 -0
  11. data/docs/NotificationPost.md +11 -0
  12. data/docs/NotificationPostDestination.md +9 -0
  13. data/docs/NotificationResponse.md +8 -0
  14. data/docs/NotificationResponseNotification.md +8 -0
  15. data/lib/smooch-api.rb +8 -1
  16. data/lib/smooch-api/api/app_api.rb +56 -1
  17. data/lib/smooch-api/api/app_user_api.rb +1 -1
  18. data/lib/smooch-api/api/attachments_api.rb +1 -1
  19. data/lib/smooch-api/api/conversation_api.rb +1 -1
  20. data/lib/smooch-api/api/deployment_api.rb +1 -1
  21. data/lib/smooch-api/api/integration_api.rb +1 -1
  22. data/lib/smooch-api/api/menu_api.rb +1 -1
  23. data/lib/smooch-api/api/notification_api.rb +84 -0
  24. data/lib/smooch-api/api/service_account_api.rb +1 -1
  25. data/lib/smooch-api/api/template_api.rb +1 -1
  26. data/lib/smooch-api/api/webhook_api.rb +1 -1
  27. data/lib/smooch-api/api_client.rb +1 -1
  28. data/lib/smooch-api/api_error.rb +1 -1
  29. data/lib/smooch-api/configuration.rb +1 -1
  30. data/lib/smooch-api/models/action.rb +1 -1
  31. data/lib/smooch-api/models/activity_response.rb +1 -1
  32. data/lib/smooch-api/models/app.rb +1 -1
  33. data/lib/smooch-api/models/app_create.rb +1 -1
  34. data/lib/smooch-api/models/app_response.rb +1 -1
  35. data/lib/smooch-api/models/app_settings.rb +1 -1
  36. data/lib/smooch-api/models/app_update.rb +1 -1
  37. data/lib/smooch-api/models/app_user.rb +1 -1
  38. data/lib/smooch-api/models/app_user_business_systems_response.rb +1 -1
  39. data/lib/smooch-api/models/app_user_channels_response.rb +1 -1
  40. data/lib/smooch-api/models/app_user_link.rb +12 -2
  41. data/lib/smooch-api/models/app_user_merge.rb +1 -1
  42. data/lib/smooch-api/models/app_user_pre_create.rb +1 -1
  43. data/lib/smooch-api/models/app_user_response.rb +1 -1
  44. data/lib/smooch-api/models/app_user_update.rb +1 -1
  45. data/lib/smooch-api/models/attachment_remove.rb +1 -1
  46. data/lib/smooch-api/models/attachment_response.rb +1 -1
  47. data/lib/smooch-api/models/auth_code_response.rb +1 -1
  48. data/lib/smooch-api/models/author.rb +224 -0
  49. data/lib/smooch-api/models/business_system_item.rb +1 -1
  50. data/lib/smooch-api/models/channel_entity_item.rb +1 -1
  51. data/lib/smooch-api/models/client.rb +1 -1
  52. data/lib/smooch-api/models/client_info.rb +1 -1
  53. data/lib/smooch-api/models/confirmation.rb +1 -1
  54. data/lib/smooch-api/models/conversation.rb +1 -1
  55. data/lib/smooch-api/models/conversation_activity.rb +1 -1
  56. data/lib/smooch-api/models/coordinates.rb +1 -1
  57. data/lib/smooch-api/models/deployment.rb +1 -1
  58. data/lib/smooch-api/models/deployment_activate_phone_number.rb +1 -1
  59. data/lib/smooch-api/models/deployment_confirm_code.rb +1 -1
  60. data/lib/smooch-api/models/deployment_create.rb +1 -1
  61. data/lib/smooch-api/models/deployment_response.rb +1 -1
  62. data/lib/smooch-api/models/destination.rb +1 -1
  63. data/lib/smooch-api/models/display_settings.rb +1 -1
  64. data/lib/smooch-api/models/enums.rb +3 -3
  65. data/lib/smooch-api/models/field.rb +1 -1
  66. data/lib/smooch-api/models/field_post.rb +1 -1
  67. data/lib/smooch-api/models/get_integration_profile_response.rb +1 -1
  68. data/lib/smooch-api/models/get_messages_response.rb +1 -1
  69. data/lib/smooch-api/models/get_sdk_ids_response.rb +224 -0
  70. data/lib/smooch-api/models/integration.rb +45 -5
  71. data/lib/smooch-api/models/integration_create.rb +75 -5
  72. data/lib/smooch-api/models/integration_profile_update.rb +1 -1
  73. data/lib/smooch-api/models/integration_response.rb +1 -1
  74. data/lib/smooch-api/models/integration_update.rb +1 -1
  75. data/lib/smooch-api/models/jwt_response.rb +1 -1
  76. data/lib/smooch-api/models/link_request_response.rb +1 -1
  77. data/lib/smooch-api/models/link_request_response_link_requests.rb +1 -1
  78. data/lib/smooch-api/models/list_apps_response.rb +1 -1
  79. data/lib/smooch-api/models/list_deployments_response.rb +1 -1
  80. data/lib/smooch-api/models/list_integrations_response.rb +1 -1
  81. data/lib/smooch-api/models/list_secret_keys_response.rb +1 -1
  82. data/lib/smooch-api/models/list_service_accounts_response.rb +1 -1
  83. data/lib/smooch-api/models/list_templates_response.rb +1 -1
  84. data/lib/smooch-api/models/list_webhooks_response.rb +1 -1
  85. data/lib/smooch-api/models/location.rb +1 -1
  86. data/lib/smooch-api/models/menu.rb +1 -1
  87. data/lib/smooch-api/models/menu_item.rb +1 -1
  88. data/lib/smooch-api/models/menu_response.rb +1 -1
  89. data/lib/smooch-api/models/merged_user.rb +1 -1
  90. data/lib/smooch-api/models/message.rb +1 -1
  91. data/lib/smooch-api/models/message_item.rb +1 -1
  92. data/lib/smooch-api/models/message_override.rb +1 -1
  93. data/lib/smooch-api/models/message_override_line.rb +1 -1
  94. data/lib/smooch-api/models/message_override_messenger.rb +1 -1
  95. data/lib/smooch-api/models/message_override_whatsapp.rb +1 -1
  96. data/lib/smooch-api/models/message_post.rb +1 -1
  97. data/lib/smooch-api/models/message_response.rb +1 -1
  98. data/lib/smooch-api/models/notification_post.rb +234 -0
  99. data/lib/smooch-api/models/notification_post_destination.rb +209 -0
  100. data/lib/smooch-api/models/notification_response.rb +188 -0
  101. data/lib/smooch-api/models/notification_response_notification.rb +194 -0
  102. data/lib/smooch-api/models/option.rb +1 -1
  103. data/lib/smooch-api/models/quoted_message.rb +1 -1
  104. data/lib/smooch-api/models/secret_key.rb +1 -1
  105. data/lib/smooch-api/models/secret_key_create.rb +1 -1
  106. data/lib/smooch-api/models/secret_key_response.rb +1 -1
  107. data/lib/smooch-api/models/select.rb +1 -1
  108. data/lib/smooch-api/models/service_account.rb +1 -1
  109. data/lib/smooch-api/models/service_account_create.rb +1 -1
  110. data/lib/smooch-api/models/service_account_response.rb +1 -1
  111. data/lib/smooch-api/models/service_account_update.rb +1 -1
  112. data/lib/smooch-api/models/source.rb +1 -1
  113. data/lib/smooch-api/models/sub_menu_item.rb +1 -1
  114. data/lib/smooch-api/models/template.rb +1 -1
  115. data/lib/smooch-api/models/template_create.rb +1 -1
  116. data/lib/smooch-api/models/template_response.rb +1 -1
  117. data/lib/smooch-api/models/template_update.rb +1 -1
  118. data/lib/smooch-api/models/upload_integration_profile_photo_response.rb +1 -1
  119. data/lib/smooch-api/models/webhook.rb +1 -1
  120. data/lib/smooch-api/models/webhook_create.rb +1 -1
  121. data/lib/smooch-api/models/webhook_response.rb +1 -1
  122. data/lib/smooch-api/models/webhook_update.rb +1 -1
  123. data/lib/smooch-api/version.rb +2 -2
  124. data/smooch-api.gemspec +4 -4
  125. data/spec/api_client_spec.rb +1 -1
  126. data/spec/configuration_spec.rb +1 -1
  127. data/spec/spec_helper.rb +1 -1
  128. metadata +23 -8
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 6953361cda33e901ed5ad46d57bc4ec2f43bbff4
4
- data.tar.gz: 170cd69494f5fd36f1b3195b01a39a2e8d436f68
3
+ metadata.gz: 4b248d59fcf907c9d9610faa94d4f86b35edd0f1
4
+ data.tar.gz: 02bf5b8b8336dd08d4c77a3b1591cc048054beb8
5
5
  SHA512:
6
- metadata.gz: 8fa92ec43a8e0524d3b84fe0d9ec5aaa86d4c6424d656792e245443332f3afbfb77dbcb39bb4fcbec2f432f11a7d8be6e7a67110d0b32145f26a0ed2c05ee26b
7
- data.tar.gz: 5e04fb67c58ea79f96853455c1406642458eeb329a93c958fb248e887f0e68a099247e50bfaee468cb5b3cc0c5b05c9d779ab5c3fac7a7971bd4e5a8e9cdbe15
6
+ metadata.gz: 9709e9be080d015d96b2b79b084bf80575f3dfc725d24e5121c85b7c4f83236135b968eabf0fc8e5bc35b612fffce55030393e2d08126b387516bd38875b4aea
7
+ data.tar.gz: 92759b645fc965fafb474e4d6d0ada872cd6711d410bd938aae44e18032a945880071a4806d777da9e3c716544fd2707fe64813e6c6073c6b084c288a2d0f777
data/LICENSE ADDED
@@ -0,0 +1,176 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
data/README.md CHANGED
@@ -25,7 +25,7 @@ gem install smooch-api
25
25
 
26
26
  Add this to the Gemfile:
27
27
 
28
- gem 'smooch-api', '~> 5.25.1'
28
+ gem 'smooch-api', '~> 5.29.1'
29
29
 
30
30
  ## Getting Started
31
31
 
@@ -110,6 +110,7 @@ Class | Method | HTTP request | Description
110
110
  *SmoochApi::AppApi* | [**delete_secret_key**](docs/AppApi.md#delete_secret_key) | **DELETE** /v1.1/apps/{appId}/keys/{keyId} |
111
111
  *SmoochApi::AppApi* | [**get_app**](docs/AppApi.md#get_app) | **GET** /v1.1/apps/{appId} |
112
112
  *SmoochApi::AppApi* | [**get_app_jwt**](docs/AppApi.md#get_app_jwt) | **GET** /v1.1/apps/{appId}/keys/{keyId}/jwt |
113
+ *SmoochApi::AppApi* | [**get_sdk_ids**](docs/AppApi.md#get_sdk_ids) | **GET** /v1.1/apps/{appId}/sdks |
113
114
  *SmoochApi::AppApi* | [**get_secret_key**](docs/AppApi.md#get_secret_key) | **GET** /v1.1/apps/{appId}/keys/{keyId} |
114
115
  *SmoochApi::AppApi* | [**list_apps**](docs/AppApi.md#list_apps) | **GET** /v1.1/apps |
115
116
  *SmoochApi::AppApi* | [**list_secret_keys**](docs/AppApi.md#list_secret_keys) | **GET** /v1.1/apps/{appId}/keys |
@@ -156,6 +157,7 @@ Class | Method | HTTP request | Description
156
157
  *SmoochApi::MenuApi* | [**delete_menu**](docs/MenuApi.md#delete_menu) | **DELETE** /v1.1/apps/{appId}/menu |
157
158
  *SmoochApi::MenuApi* | [**get_menu**](docs/MenuApi.md#get_menu) | **GET** /v1.1/apps/{appId}/menu |
158
159
  *SmoochApi::MenuApi* | [**update_menu**](docs/MenuApi.md#update_menu) | **PUT** /v1.1/apps/{appId}/menu |
160
+ *SmoochApi::NotificationApi* | [**post_notification**](docs/NotificationApi.md#post_notification) | **POST** /v1/apps/{appId}/notifications |
159
161
  *SmoochApi::ServiceAccountApi* | [**create_secret_key**](docs/ServiceAccountApi.md#create_secret_key) | **POST** /v1.1/serviceaccounts/{serviceAccountId}/keys |
160
162
  *SmoochApi::ServiceAccountApi* | [**create_service_account**](docs/ServiceAccountApi.md#create_service_account) | **POST** /v1.1/serviceaccounts |
161
163
  *SmoochApi::ServiceAccountApi* | [**delete_secret_key**](docs/ServiceAccountApi.md#delete_secret_key) | **DELETE** /v1.1/serviceaccounts/{serviceAccountId}/keys/{keyId} |
@@ -198,6 +200,7 @@ Class | Method | HTTP request | Description
198
200
  - [SmoochApi::AttachmentRemove](docs/AttachmentRemove.md)
199
201
  - [SmoochApi::AttachmentResponse](docs/AttachmentResponse.md)
200
202
  - [SmoochApi::AuthCodeResponse](docs/AuthCodeResponse.md)
203
+ - [SmoochApi::Author](docs/Author.md)
201
204
  - [SmoochApi::BusinessSystemItem](docs/BusinessSystemItem.md)
202
205
  - [SmoochApi::ChannelEntityItem](docs/ChannelEntityItem.md)
203
206
  - [SmoochApi::Client](docs/Client.md)
@@ -218,6 +221,7 @@ Class | Method | HTTP request | Description
218
221
  - [SmoochApi::FieldPost](docs/FieldPost.md)
219
222
  - [SmoochApi::GetIntegrationProfileResponse](docs/GetIntegrationProfileResponse.md)
220
223
  - [SmoochApi::GetMessagesResponse](docs/GetMessagesResponse.md)
224
+ - [SmoochApi::GetSdkIdsResponse](docs/GetSdkIdsResponse.md)
221
225
  - [SmoochApi::Integration](docs/Integration.md)
222
226
  - [SmoochApi::IntegrationCreate](docs/IntegrationCreate.md)
223
227
  - [SmoochApi::IntegrationProfileUpdate](docs/IntegrationProfileUpdate.md)
@@ -246,6 +250,10 @@ Class | Method | HTTP request | Description
246
250
  - [SmoochApi::MessageOverrideWhatsapp](docs/MessageOverrideWhatsapp.md)
247
251
  - [SmoochApi::MessagePost](docs/MessagePost.md)
248
252
  - [SmoochApi::MessageResponse](docs/MessageResponse.md)
253
+ - [SmoochApi::NotificationPost](docs/NotificationPost.md)
254
+ - [SmoochApi::NotificationPostDestination](docs/NotificationPostDestination.md)
255
+ - [SmoochApi::NotificationResponse](docs/NotificationResponse.md)
256
+ - [SmoochApi::NotificationResponseNotification](docs/NotificationResponseNotification.md)
249
257
  - [SmoochApi::Option](docs/Option.md)
250
258
  - [SmoochApi::QuotedMessage](docs/QuotedMessage.md)
251
259
  - [SmoochApi::SecretKey](docs/SecretKey.md)
@@ -282,3 +290,14 @@ Class | Method | HTTP request | Description
282
290
  - **API key parameter name**: Authorization
283
291
  - **Location**: HTTP header
284
292
 
293
+
294
+ ## Copyright and license
295
+
296
+ Copyright 2018 Zendesk, Inc.
297
+
298
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
299
+ You may obtain a copy of the License at
300
+
301
+ http://www.apache.org/licenses/LICENSE-2.0
302
+
303
+ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
@@ -10,6 +10,7 @@ Method | HTTP request | Description
10
10
  [**delete_secret_key**](AppApi.md#delete_secret_key) | **DELETE** /v1.1/apps/{appId}/keys/{keyId} |
11
11
  [**get_app**](AppApi.md#get_app) | **GET** /v1.1/apps/{appId} |
12
12
  [**get_app_jwt**](AppApi.md#get_app_jwt) | **GET** /v1.1/apps/{appId}/keys/{keyId}/jwt |
13
+ [**get_sdk_ids**](AppApi.md#get_sdk_ids) | **GET** /v1.1/apps/{appId}/sdks |
13
14
  [**get_secret_key**](AppApi.md#get_secret_key) | **GET** /v1.1/apps/{appId}/keys/{keyId} |
14
15
  [**list_apps**](AppApi.md#list_apps) | **GET** /v1.1/apps |
15
16
  [**list_secret_keys**](AppApi.md#list_secret_keys) | **GET** /v1.1/apps/{appId}/keys |
@@ -377,6 +378,65 @@ Name | Type | Description | Notes
377
378
 
378
379
 
379
380
 
381
+ # **get_sdk_ids**
382
+ > GetSdkIdsResponse get_sdk_ids(appId)
383
+
384
+
385
+
386
+ Retrieve the IDs of the three SDK integrations (`android`, `ios`, and `web`) for the specified app, to be used when initializing the SDKs.
387
+
388
+ ### Example
389
+ ```ruby
390
+ # load the gem
391
+ require 'smooch-api'
392
+ # setup authorization
393
+ SmoochApi.configure do |config|
394
+ # Configure HTTP basic authorization (recommended): basicAuth
395
+ config.username = 'API_KEY_ID'
396
+ config.password = 'API_KEY_SECRET'
397
+
398
+
399
+ # OR
400
+
401
+ # Configure API key authorization (alternative): jwt
402
+ config.api_key['Authorization'] = 'YOUR JWT'
403
+ config.api_key_prefix['Authorization'] = 'Bearer'
404
+ end
405
+
406
+ api_instance = SmoochApi::AppApi.new
407
+
408
+ appId = "appId_example" # String | Identifies the app.
409
+
410
+
411
+ begin
412
+ result = api_instance.get_sdk_ids(appId)
413
+ p result
414
+ rescue SmoochApi::ApiError => e
415
+ puts "Exception when calling AppApi->get_sdk_ids: #{e}"
416
+ end
417
+ ```
418
+
419
+ ### Parameters
420
+
421
+ Name | Type | Description | Notes
422
+ ------------- | ------------- | ------------- | -------------
423
+ **appId** | **String**| Identifies the app. |
424
+
425
+ ### Return type
426
+
427
+ [**GetSdkIdsResponse**](GetSdkIdsResponse.md)
428
+
429
+ ### Authorization
430
+
431
+ [basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
432
+
433
+ ### HTTP request headers
434
+
435
+ - **Content-Type**: application/json
436
+ - **Accept**: application/json
437
+
438
+
439
+
380
440
  # **get_secret_key**
381
441
  > SecretKeyResponse get_secret_key(appId, keyId)
382
442
 
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **type** | **String** | The type of the channel to link. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. |
7
+ **integrationId** | **String** | The id of the integration to link, it must match the provided type. | [optional]
7
8
  **phoneNumber** | **String** | A String of the appUser’s phone number. It must contain the + prefix and the country code. Required for *messenger*, *twilio*, *messagebird* and *whatsapp* linking. | [optional]
8
9
  **address** | **String** | A String of the appUser’s email address. Required for *mailgun* linking. | [optional]
9
10
  **givenName** | **String** | A String of the appUser’s given name. Used as additional criteria to increase the likelihood of a match. (Optional) Used for *messenger* linking. | [optional]
@@ -0,0 +1,11 @@
1
+ # SmoochApi::Author
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **role** | **String** | The role of the individual posting the message. The only accepted value is \"appMaker\". |
7
+ **name** | **String** | The display name of the message author. | [optional]
8
+ **email** | **String** | The email address of the message author. | [optional]
9
+ **avatarUrl** | **String** | The URL of the desired message avatar image. | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # SmoochApi::GetSdkIdsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **androidIntegrationId** | **String** | The ID of the `android` integration, used when initializing the Android SDK. |
7
+ **iosIntegrationId** | **String** | The ID of the `ios` integration, used when initializing the iOS SDK. |
8
+ **webIntegrationId** | **String** | The ID of the `web` integration, used when initializing the Web Messenger SDK. |
9
+
10
+
@@ -51,6 +51,7 @@ Name | Type | Description | Notes
51
51
  **incomingAddress** | **String** | Smooch will receive all emails sent to this address. Required for *mailgun* integrations. | [optional]
52
52
  **accessKey** | **String** | The public API key of your MessageBird account. Required for *messagebird* integrations. | [optional]
53
53
  **originator** | **String** | Smooch will receive all messages sent to this phone number. Required for *messagebird* integrations. | [optional]
54
+ **signingKey** | **String** | The signing key of your MessageBird account. Used to validate the webhooks' origin. (Optional) Used for *messagebird* integrations. | [optional]
54
55
  **brandColor** | **String** | This color will be used in the messenger header and the button or tab in idle state. (Optional) Used for *Web Messenger* integrations. | [optional]
55
56
  **fixedIntroPane** | **BOOLEAN** | When `true`, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. The default value is `false`. (Optional) Used for *Web Messenger* integrations. | [optional]
56
57
  **conversationColor** | **String** | This color will be used for customer messages, quick replies and actions in the footer. (Optional) Used for *Web Messenger* integrations. | [optional]
@@ -67,5 +68,8 @@ Name | Type | Description | Notes
67
68
  **hideUnsubscribeLink** | **BOOLEAN** | When `true`, unsubscribe links will not be included in outbound emails. If this setting is enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. (Optional) Used for *mailgun* integrations. | [optional]
68
69
  **status** | **String** | The integration status. See [**IntegrationStatusEnum**](Enums.md#IntegrationStatusEnum) for available values. [More info](https://docs.smooch.io/#integration-status). | [optional]
69
70
  **error** | **String** | The error causing the integration to fail. Will be present when `status` is 'error'. | [optional]
71
+ **apiSecret** | **String** | A key tied to Apple Business Chat Messaging Service Provider | [optional]
72
+ **businessId** | **String** | A unique ID tied to the brand using Apple Business Chat | [optional]
73
+ **mspId** | **String** | A unique identifier for an Apple Business Chat partner registered as a Messaging Service Provider through Apple Business Register | [optional]
70
74
 
71
75
 
@@ -53,5 +53,12 @@ Name | Type | Description | Notes
53
53
  **originWhitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454 `scheme \"://\" host [ \":\" port ]`, where scheme is `http` or `https`. (Optional) Used for *Web Messenger* integrations. | [optional]
54
54
  **qrCodeUrl** | **String** | URL provided by LINE in the [Developer Console](https://developers.line.biz/console/). | [optional]
55
55
  **hideUnsubscribeLink** | **BOOLEAN** | When `true`, unsubscribe links will not be included in outbound emails. If this setting is enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. (Optional) Used for *mailgun* integrations. | [optional]
56
+ **signingKey** | **String** | The signing key of your MessageBird account. Used to validate the webhooks' origin. (Optional) Used for *messagebird* integrations. | [optional]
57
+ **apiKey** | **String** | The public API key of your Mailgun account. Required for *mailgun* integrations. | [optional]
58
+ **domain** | **String** | The domain used to relay email. Required for *mailgun* integrations. | [optional]
59
+ **incomingAddress** | **String** | Smooch will receive all emails sent to this address. Required for *mailgun* integrations. | [optional]
60
+ **apiSecret** | **String** | A key tied to Apple Business Chat Messaging Service Provider | [optional]
61
+ **businessId** | **String** | A unique ID tied to the brand using Apple Business Chat | [optional]
62
+ **mspId** | **String** | A unique identifier for an Apple Business Chat partner registered as a Messaging Service Provider through Apple Business Register | [optional]
56
63
 
57
64
 
@@ -0,0 +1,71 @@
1
+ # SmoochApi::NotificationApi
2
+
3
+ All URIs are relative to *https://api.smooch.io*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**post_notification**](NotificationApi.md#post_notification) | **POST** /v1/apps/{appId}/notifications |
8
+
9
+
10
+ # **post_notification**
11
+ > NotificationResponse post_notification(appId, notificationPostBody)
12
+
13
+
14
+
15
+ Post a notification to an externalId.
16
+
17
+ ### Example
18
+ ```ruby
19
+ # load the gem
20
+ require 'smooch-api'
21
+ # setup authorization
22
+ SmoochApi.configure do |config|
23
+ # Configure HTTP basic authorization (recommended): basicAuth
24
+ config.username = 'API_KEY_ID'
25
+ config.password = 'API_KEY_SECRET'
26
+
27
+
28
+ # OR
29
+
30
+ # Configure API key authorization (alternative): jwt
31
+ config.api_key['Authorization'] = 'YOUR JWT'
32
+ config.api_key_prefix['Authorization'] = 'Bearer'
33
+ end
34
+
35
+ api_instance = SmoochApi::NotificationApi.new
36
+
37
+ appId = "appId_example" # String | Identifies the app.
38
+
39
+ notificationPostBody = SmoochApi::NotificationPost.new # NotificationPost | Body for a postNotification request.
40
+
41
+
42
+ begin
43
+ result = api_instance.post_notification(appId, notificationPostBody)
44
+ p result
45
+ rescue SmoochApi::ApiError => e
46
+ puts "Exception when calling NotificationApi->post_notification: #{e}"
47
+ end
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+ Name | Type | Description | Notes
53
+ ------------- | ------------- | ------------- | -------------
54
+ **appId** | **String**| Identifies the app. |
55
+ **notificationPostBody** | [**NotificationPost**](NotificationPost.md)| Body for a postNotification request. |
56
+
57
+ ### Return type
58
+
59
+ [**NotificationResponse**](NotificationResponse.md)
60
+
61
+ ### Authorization
62
+
63
+ [basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
64
+
65
+ ### HTTP request headers
66
+
67
+ - **Content-Type**: application/json
68
+ - **Accept**: application/json
69
+
70
+
71
+