hubspot-api-client 3.1.0.pre.beta → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (241) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +28 -0
  3. data/lib/hubspot-api-client.rb +66 -1
  4. data/lib/hubspot/codegen/cms/audit-logs/api/default_api.rb +106 -0
  5. data/lib/hubspot/codegen/cms/audit-logs/api_client.rb +422 -0
  6. data/lib/hubspot/codegen/cms/audit-logs/api_error.rb +61 -0
  7. data/lib/hubspot/codegen/cms/audit-logs/configuration.rb +258 -0
  8. data/lib/hubspot/codegen/cms/audit-logs/models/collection_response_public_audit_log.rb +226 -0
  9. data/lib/hubspot/codegen/cms/audit-logs/models/error.rb +292 -0
  10. data/lib/hubspot/codegen/cms/audit-logs/models/error_detail.rb +258 -0
  11. data/lib/hubspot/codegen/cms/audit-logs/models/next_page.rb +224 -0
  12. data/lib/hubspot/codegen/cms/audit-logs/models/paging.rb +210 -0
  13. data/lib/hubspot/codegen/cms/audit-logs/models/public_audit_log.rb +352 -0
  14. data/lib/hubspot/codegen/cms/domains/api/domains_api.rb +183 -0
  15. data/lib/hubspot/codegen/cms/domains/api_client.rb +422 -0
  16. data/lib/hubspot/codegen/cms/domains/api_error.rb +61 -0
  17. data/lib/hubspot/codegen/cms/domains/configuration.rb +258 -0
  18. data/lib/hubspot/codegen/cms/domains/models/collection_response_with_total_domain.rb +240 -0
  19. data/lib/hubspot/codegen/cms/domains/models/domain.rb +1091 -0
  20. data/lib/hubspot/codegen/cms/domains/models/domain_cdn_config.rb +497 -0
  21. data/lib/hubspot/codegen/cms/domains/models/domain_setup_info.rb +231 -0
  22. data/lib/hubspot/codegen/cms/domains/models/error.rb +292 -0
  23. data/lib/hubspot/codegen/cms/domains/models/error_detail.rb +258 -0
  24. data/lib/hubspot/codegen/cms/domains/models/next_page.rb +224 -0
  25. data/lib/hubspot/codegen/cms/domains/models/paging.rb +210 -0
  26. data/lib/hubspot/codegen/cms/performance/api/default_api.rb +186 -0
  27. data/lib/hubspot/codegen/cms/performance/api_client.rb +422 -0
  28. data/lib/hubspot/codegen/cms/performance/api_error.rb +61 -0
  29. data/lib/hubspot/codegen/cms/performance/configuration.rb +258 -0
  30. data/lib/hubspot/codegen/cms/performance/models/error.rb +292 -0
  31. data/lib/hubspot/codegen/cms/performance/models/error_detail.rb +258 -0
  32. data/lib/hubspot/codegen/cms/performance/models/performance_view.rb +528 -0
  33. data/lib/hubspot/codegen/cms/performance/models/public_performance_response.rb +332 -0
  34. data/lib/hubspot/codegen/cms/site-search/api/default_api.rb +225 -0
  35. data/lib/hubspot/codegen/cms/site-search/api_client.rb +422 -0
  36. data/lib/hubspot/codegen/cms/site-search/api_error.rb +61 -0
  37. data/lib/hubspot/codegen/cms/site-search/configuration.rb +258 -0
  38. data/lib/hubspot/codegen/cms/site-search/models/content_search_result.rb +427 -0
  39. data/lib/hubspot/codegen/cms/site-search/models/error.rb +292 -0
  40. data/lib/hubspot/codegen/cms/site-search/models/error_detail.rb +258 -0
  41. data/lib/hubspot/codegen/cms/site-search/models/indexed_data.rb +279 -0
  42. data/lib/hubspot/codegen/cms/site-search/models/public_search_results.rb +282 -0
  43. data/lib/hubspot/codegen/cms/site-search/models/search_hit_field.rb +259 -0
  44. data/lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb +368 -0
  45. data/lib/hubspot/codegen/cms/url-redirects/api_client.rb +422 -0
  46. data/lib/hubspot/codegen/cms/url-redirects/api_error.rb +61 -0
  47. data/lib/hubspot/codegen/cms/url-redirects/configuration.rb +258 -0
  48. data/lib/hubspot/codegen/cms/url-redirects/models/collection_response_with_total_url_mapping.rb +242 -0
  49. data/lib/hubspot/codegen/cms/url-redirects/models/error.rb +292 -0
  50. data/lib/hubspot/codegen/cms/url-redirects/models/error_detail.rb +258 -0
  51. data/lib/hubspot/codegen/cms/url-redirects/models/next_page.rb +224 -0
  52. data/lib/hubspot/codegen/cms/url-redirects/models/paging.rb +210 -0
  53. data/lib/hubspot/codegen/cms/url-redirects/models/url_mapping.rb +596 -0
  54. data/lib/hubspot/codegen/cms/url-redirects/models/url_mapping_create_request_body.rb +306 -0
  55. data/lib/hubspot/codegen/crm/imports/api/core_api.rb +41 -41
  56. data/lib/hubspot/codegen/webhooks/api/subscriptions_api.rb +70 -0
  57. data/lib/hubspot/codegen/webhooks/models/batch_input_subscription_batch_update_request.rb +215 -0
  58. data/lib/hubspot/codegen/webhooks/models/batch_response_subscription_response.rb +331 -0
  59. data/lib/hubspot/codegen/webhooks/models/subscription_batch_update_request.rb +227 -0
  60. data/lib/hubspot/exceptions.rb +11 -0
  61. data/lib/hubspot/helpers/webhooks_helper.rb +31 -0
  62. data/lib/hubspot/version.rb +1 -1
  63. data/sample-apps/imports-contacts-app/.env.template +2 -0
  64. data/sample-apps/imports-contacts-app/.env.test.template +3 -0
  65. data/sample-apps/imports-contacts-app/.gitignore +37 -0
  66. data/sample-apps/imports-contacts-app/.rspec +1 -0
  67. data/sample-apps/imports-contacts-app/.ruby-version +1 -0
  68. data/sample-apps/imports-contacts-app/Dockerfile +22 -0
  69. data/sample-apps/imports-contacts-app/Gemfile +33 -0
  70. data/sample-apps/imports-contacts-app/Gemfile.lock +271 -0
  71. data/sample-apps/imports-contacts-app/README.md +27 -0
  72. data/sample-apps/imports-contacts-app/Rakefile +6 -0
  73. data/sample-apps/imports-contacts-app/app/assets/config/manifest.js +3 -0
  74. data/sample-apps/imports-contacts-app/app/assets/images/.keep +0 -0
  75. data/sample-apps/imports-contacts-app/app/assets/javascripts/application.js +15 -0
  76. data/sample-apps/imports-contacts-app/app/assets/javascripts/cable.js +13 -0
  77. data/sample-apps/imports-contacts-app/app/assets/javascripts/channels/.keep +0 -0
  78. data/sample-apps/imports-contacts-app/app/assets/stylesheets/application.css +87 -0
  79. data/sample-apps/imports-contacts-app/app/controllers/application_controller.rb +12 -0
  80. data/sample-apps/imports-contacts-app/app/controllers/concerns/.keep +0 -0
  81. data/sample-apps/imports-contacts-app/app/controllers/concerns/exception_handler.rb +12 -0
  82. data/sample-apps/imports-contacts-app/app/controllers/imports_controller.rb +24 -0
  83. data/sample-apps/imports-contacts-app/app/controllers/oauth/authorization_controller.rb +19 -0
  84. data/sample-apps/imports-contacts-app/app/helpers/application_helper.rb +2 -0
  85. data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/authorize_hubspot.rb +0 -0
  86. data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/get_authorization_uri.rb +1 -1
  87. data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/tokens/base.rb +0 -0
  88. data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/tokens/generate.rb +2 -2
  89. data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/tokens/refresh.rb +3 -4
  90. data/sample-apps/imports-contacts-app/app/lib/services/hubspot/imports/create.rb +52 -0
  91. data/sample-apps/imports-contacts-app/app/models/application_record.rb +3 -0
  92. data/sample-apps/imports-contacts-app/app/models/concerns/.keep +0 -0
  93. data/sample-apps/imports-contacts-app/app/views/imports/index.html.erb +70 -0
  94. data/sample-apps/imports-contacts-app/app/views/layouts/application.html.erb +23 -0
  95. data/sample-apps/imports-contacts-app/app/views/oauth/authorization/login.html.erb +15 -0
  96. data/sample-apps/imports-contacts-app/app/views/shared/_header.html.erb +15 -0
  97. data/sample-apps/imports-contacts-app/bin/bundle +3 -0
  98. data/sample-apps/imports-contacts-app/bin/rails +9 -0
  99. data/sample-apps/imports-contacts-app/bin/rake +9 -0
  100. data/sample-apps/imports-contacts-app/bin/setup +36 -0
  101. data/sample-apps/imports-contacts-app/bin/spring +17 -0
  102. data/sample-apps/imports-contacts-app/bin/update +31 -0
  103. data/sample-apps/imports-contacts-app/bin/yarn +11 -0
  104. data/sample-apps/imports-contacts-app/config.ru +5 -0
  105. data/sample-apps/imports-contacts-app/config/application.rb +19 -0
  106. data/sample-apps/imports-contacts-app/config/boot.rb +3 -0
  107. data/sample-apps/imports-contacts-app/config/cable.yml +10 -0
  108. data/sample-apps/imports-contacts-app/config/database.yml +25 -0
  109. data/sample-apps/imports-contacts-app/config/environment.rb +5 -0
  110. data/sample-apps/imports-contacts-app/config/environments/development.rb +61 -0
  111. data/sample-apps/imports-contacts-app/config/environments/production.rb +94 -0
  112. data/sample-apps/imports-contacts-app/config/environments/test.rb +46 -0
  113. data/sample-apps/imports-contacts-app/config/initializers/assets.rb +14 -0
  114. data/sample-apps/imports-contacts-app/config/initializers/filter_parameter_logging.rb +4 -0
  115. data/sample-apps/imports-contacts-app/config/initializers/hubspot-api-client.rb +3 -0
  116. data/sample-apps/imports-contacts-app/config/initializers/mime_types.rb +1 -0
  117. data/sample-apps/imports-contacts-app/config/initializers/wrap_parameters.rb +14 -0
  118. data/sample-apps/imports-contacts-app/config/locales/en.yml +33 -0
  119. data/sample-apps/imports-contacts-app/config/puma.rb +34 -0
  120. data/sample-apps/imports-contacts-app/config/routes.rb +11 -0
  121. data/sample-apps/imports-contacts-app/config/spring.rb +6 -0
  122. data/sample-apps/imports-contacts-app/db/seeds.rb +7 -0
  123. data/sample-apps/imports-contacts-app/docker-compose.yml +11 -0
  124. data/sample-apps/imports-contacts-app/docker-entrypoint.sh +8 -0
  125. data/sample-apps/imports-contacts-app/lib/assets/.keep +0 -0
  126. data/sample-apps/imports-contacts-app/lib/tasks/.keep +0 -0
  127. data/sample-apps/imports-contacts-app/log/.keep +0 -0
  128. data/sample-apps/imports-contacts-app/package.json +5 -0
  129. data/sample-apps/imports-contacts-app/public/404.html +67 -0
  130. data/sample-apps/imports-contacts-app/public/422.html +67 -0
  131. data/sample-apps/imports-contacts-app/public/500.html +66 -0
  132. data/sample-apps/imports-contacts-app/public/apple-touch-icon-precomposed.png +0 -0
  133. data/sample-apps/imports-contacts-app/public/apple-touch-icon.png +0 -0
  134. data/sample-apps/imports-contacts-app/public/examples/example.csv +2 -0
  135. data/sample-apps/imports-contacts-app/public/favicon.ico +0 -0
  136. data/sample-apps/imports-contacts-app/public/robots.txt +1 -0
  137. data/sample-apps/imports-contacts-app/tmp/.keep +0 -0
  138. data/sample-apps/search-result-paging-app/.env.template +4 -0
  139. data/sample-apps/search-result-paging-app/.gitignore +35 -0
  140. data/sample-apps/search-result-paging-app/.rspec +1 -0
  141. data/sample-apps/search-result-paging-app/.ruby-version +1 -0
  142. data/sample-apps/search-result-paging-app/Dockerfile +22 -0
  143. data/sample-apps/search-result-paging-app/Gemfile +35 -0
  144. data/sample-apps/search-result-paging-app/Gemfile.lock +279 -0
  145. data/sample-apps/search-result-paging-app/README.md +0 -0
  146. data/sample-apps/search-result-paging-app/Rakefile +6 -0
  147. data/sample-apps/search-result-paging-app/app/assets/config/manifest.js +3 -0
  148. data/sample-apps/search-result-paging-app/app/assets/images/.keep +0 -0
  149. data/sample-apps/search-result-paging-app/app/assets/javascripts/application.js +25 -0
  150. data/sample-apps/search-result-paging-app/app/assets/javascripts/cable.js +13 -0
  151. data/sample-apps/search-result-paging-app/app/assets/javascripts/channels/.keep +0 -0
  152. data/sample-apps/search-result-paging-app/app/assets/stylesheets/application.css +77 -0
  153. data/sample-apps/search-result-paging-app/app/controllers/application_controller.rb +12 -0
  154. data/sample-apps/search-result-paging-app/app/controllers/concerns/.keep +0 -0
  155. data/sample-apps/search-result-paging-app/app/controllers/concerns/exception_handler.rb +12 -0
  156. data/sample-apps/search-result-paging-app/app/controllers/home_controller.rb +14 -0
  157. data/sample-apps/search-result-paging-app/app/controllers/oauth/authorization_controller.rb +19 -0
  158. data/sample-apps/search-result-paging-app/app/helpers/application_helper.rb +2 -0
  159. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/authorization/authorize.rb +17 -0
  160. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/authorization/get_authorization_uri.rb +35 -0
  161. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/authorization/tokens/base.rb +21 -0
  162. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/authorization/tokens/generate.rb +28 -0
  163. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/authorization/tokens/refresh.rb +35 -0
  164. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/contacts/get_page.rb +26 -0
  165. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/contacts/search.rb +35 -0
  166. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/properties/create.rb +23 -0
  167. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/properties/destroy.rb +16 -0
  168. data/sample-apps/search-result-paging-app/app/models/application_record.rb +3 -0
  169. data/sample-apps/search-result-paging-app/app/models/concerns/.keep +0 -0
  170. data/sample-apps/search-result-paging-app/app/views/home/index.html.erb +13 -0
  171. data/sample-apps/search-result-paging-app/app/views/layouts/application.html.erb +23 -0
  172. data/sample-apps/search-result-paging-app/app/views/oauth/authorization/login.html.erb +15 -0
  173. data/sample-apps/search-result-paging-app/app/views/shared/_header.html.erb +18 -0
  174. data/sample-apps/search-result-paging-app/bin/bundle +3 -0
  175. data/sample-apps/search-result-paging-app/bin/rails +9 -0
  176. data/sample-apps/search-result-paging-app/bin/rake +9 -0
  177. data/sample-apps/search-result-paging-app/bin/setup +36 -0
  178. data/sample-apps/search-result-paging-app/bin/spring +17 -0
  179. data/sample-apps/search-result-paging-app/bin/update +31 -0
  180. data/sample-apps/search-result-paging-app/bin/yarn +11 -0
  181. data/sample-apps/search-result-paging-app/config.ru +5 -0
  182. data/sample-apps/search-result-paging-app/config/application.rb +19 -0
  183. data/sample-apps/search-result-paging-app/config/boot.rb +3 -0
  184. data/sample-apps/search-result-paging-app/config/cable.yml +10 -0
  185. data/sample-apps/search-result-paging-app/config/database.yml +25 -0
  186. data/sample-apps/search-result-paging-app/config/environment.rb +5 -0
  187. data/sample-apps/search-result-paging-app/config/environments/development.rb +61 -0
  188. data/sample-apps/search-result-paging-app/config/environments/production.rb +94 -0
  189. data/sample-apps/search-result-paging-app/config/environments/test.rb +46 -0
  190. data/sample-apps/search-result-paging-app/config/initializers/assets.rb +14 -0
  191. data/sample-apps/search-result-paging-app/config/initializers/filter_parameter_logging.rb +4 -0
  192. data/sample-apps/search-result-paging-app/config/initializers/hubspot-api-client.rb +3 -0
  193. data/sample-apps/search-result-paging-app/config/initializers/mime_types.rb +1 -0
  194. data/sample-apps/search-result-paging-app/config/initializers/wrap_parameters.rb +14 -0
  195. data/sample-apps/search-result-paging-app/config/locales/en.yml +33 -0
  196. data/sample-apps/search-result-paging-app/config/puma.rb +34 -0
  197. data/sample-apps/search-result-paging-app/config/routes.rb +7 -0
  198. data/sample-apps/search-result-paging-app/config/spring.rb +6 -0
  199. data/sample-apps/search-result-paging-app/db/seeds.rb +7 -0
  200. data/sample-apps/search-result-paging-app/docker-compose.yml +11 -0
  201. data/sample-apps/search-result-paging-app/docker-entrypoint.sh +8 -0
  202. data/sample-apps/search-result-paging-app/lib/assets/.keep +0 -0
  203. data/sample-apps/search-result-paging-app/lib/tasks/.keep +0 -0
  204. data/sample-apps/search-result-paging-app/lib/tasks/search_contacts.rake +36 -0
  205. data/sample-apps/search-result-paging-app/log/.keep +0 -0
  206. data/sample-apps/search-result-paging-app/package.json +5 -0
  207. data/sample-apps/search-result-paging-app/public/404.html +67 -0
  208. data/sample-apps/search-result-paging-app/public/422.html +67 -0
  209. data/sample-apps/search-result-paging-app/public/500.html +66 -0
  210. data/sample-apps/search-result-paging-app/public/apple-touch-icon-precomposed.png +0 -0
  211. data/sample-apps/search-result-paging-app/public/apple-touch-icon.png +0 -0
  212. data/sample-apps/search-result-paging-app/public/favicon.ico +0 -0
  213. data/sample-apps/search-result-paging-app/public/robots.txt +1 -0
  214. data/sample-apps/search-result-paging-app/tmp/.keep +0 -0
  215. data/sample-apps/webhooks-contacts-app/.env.template +3 -1
  216. data/sample-apps/webhooks-contacts-app/Gemfile.lock +1 -1
  217. data/sample-apps/webhooks-contacts-app/README.md +24 -21
  218. data/sample-apps/webhooks-contacts-app/app/assets/stylesheets/application.css +7 -55
  219. data/sample-apps/webhooks-contacts-app/app/controllers/events_controller.rb +8 -10
  220. data/sample-apps/webhooks-contacts-app/app/controllers/home_controller.rb +44 -0
  221. data/sample-apps/webhooks-contacts-app/app/controllers/oauth/authorization_controller.rb +6 -6
  222. data/sample-apps/webhooks-contacts-app/app/controllers/webhooks_controller.rb +1 -1
  223. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/authorize.rb +17 -0
  224. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/get_authorization_uri.rb +35 -0
  225. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/tokens/base.rb +21 -0
  226. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/tokens/generate.rb +28 -0
  227. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/tokens/refresh.rb +35 -0
  228. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/webhooks/configure_target_url.rb +25 -0
  229. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/webhooks/create_or_activate_subscription.rb +44 -0
  230. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/webhooks/handle.rb +13 -1
  231. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/webhooks/pause_active_subscriptions.rb +39 -0
  232. data/sample-apps/webhooks-contacts-app/app/models/event.rb +3 -0
  233. data/sample-apps/webhooks-contacts-app/app/views/events/index.html.erb +14 -16
  234. data/sample-apps/webhooks-contacts-app/app/views/home/index.html.erb +47 -0
  235. data/sample-apps/webhooks-contacts-app/app/views/oauth/authorization/login.html.erb +6 -6
  236. data/sample-apps/webhooks-contacts-app/app/views/shared/_header.html.erb +3 -0
  237. data/sample-apps/webhooks-contacts-app/config/database.yml +9 -9
  238. data/sample-apps/webhooks-contacts-app/config/routes.rb +2 -0
  239. data/sample-apps/webhooks-contacts-app/db/schema.rb +2 -5
  240. data/sample-apps/webhooks-contacts-app/docker-compose.yml +13 -10
  241. metadata +612 -10
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 80ecd54729d423ab033c403733ef61f6807d285aa9067e8c42d16c96d2de6a12
4
- data.tar.gz: 03afe846117c3ee664f900c22e336074c8239e80059b289e16d4114e5f44cce5
3
+ metadata.gz: 7e5dc633dd968b4e6566ae95b924412f2cd07eacf79c72bedefddbe4f7c6ea50
4
+ data.tar.gz: e5c23904d08071e7b9aef383eda44f89817d0118e5cf5d2dfbc7ce0e736b0b37
5
5
  SHA512:
6
- metadata.gz: d69d3fa819d02e99fd62158782dbb64c7e29d4b6071d74410f39fc60f9e8bc64df4b53966caf5c40677a26470d99658eef59300e187c3c2c376d6092fad2bef0
7
- data.tar.gz: 98ba703dde574775b0ca8dea7e53fd0e509d6a50a5980843ca9aa573998d352ac8ba8d7f62c071a3194e2b664b96fe94a9079918702e39d53c71bf0f6aed04ee
6
+ metadata.gz: acbe9accac2aa7967846f084767f48c34ec20822c50f54196e9b47b973a87f80074bbb51b9fd5260efadfb46ef5d8e9ff07ad2fabadf7e78ebbc3b7fc7fa90ff
7
+ data.tar.gz: 0c34dd74a0dc3304d1e51c7e56cae0e63aa4523688bdab02b4a3bb15bde9688da3dcecb03e793ad7a5d72fcb4db5f2f60393249528c0d62310398d783ba73452
@@ -5,6 +5,34 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [5.0.0] - 2020-06-23
9
+
10
+ - Fix methods of default_api (Site-search client)
11
+
12
+ ## [4.0.0] - 2020-06-09
13
+
14
+ - Add Add search sample app
15
+ - Add AuditLogs client
16
+ - Add Domains client
17
+ - Add Perfirmance client
18
+ - Add SiteSearch client
19
+ - Add UrlRedirects client
20
+
21
+ ## [3.3.0] - 2020-06-01
22
+
23
+ - Add webhooks contacts sample app
24
+ - Add imports contacts sample app
25
+ - Add webhook signature verification helper
26
+
27
+ ## [3.2.0] - 2020-05-06
28
+
29
+ - Rename imports#get_all to get_page method
30
+ - Update Webhooks client
31
+
32
+ ## [3.1.1] - 2020-05-04
33
+
34
+ - Add Imports api client to common configuration
35
+
8
36
  ## [3.1.0-beta] - 2020-04-23
9
37
 
10
38
  - Add new models to main client
@@ -19,6 +19,63 @@ require 'hubspot/oauth_helper'
19
19
  require 'hubspot/version'
20
20
 
21
21
  require 'hubspot/helpers/get_all_helper'
22
+ require 'hubspot/helpers/webhooks_helper'
23
+
24
+ require 'hubspot/codegen/cms/audit-logs/api_client'
25
+ require 'hubspot/codegen/cms/audit-logs/api_error'
26
+ require 'hubspot/codegen/cms/audit-logs/configuration'
27
+ require 'hubspot/codegen/cms/audit-logs/api/default_api'
28
+ require 'hubspot/codegen/cms/audit-logs/models/collection_response_public_audit_log'
29
+ require 'hubspot/codegen/cms/audit-logs/models/error'
30
+ require 'hubspot/codegen/cms/audit-logs/models/error_detail'
31
+ require 'hubspot/codegen/cms/audit-logs/models/next_page'
32
+ require 'hubspot/codegen/cms/audit-logs/models/paging'
33
+ require 'hubspot/codegen/cms/audit-logs/models/public_audit_log'
34
+
35
+ require 'hubspot/codegen/cms/domains/api_client'
36
+ require 'hubspot/codegen/cms/domains/api_error'
37
+ require 'hubspot/codegen/cms/domains/configuration'
38
+ require 'hubspot/codegen/cms/domains/api/domains_api'
39
+ require 'hubspot/codegen/cms/domains/models/collection_response_with_total_domain'
40
+ require 'hubspot/codegen/cms/domains/models/domain'
41
+ require 'hubspot/codegen/cms/domains/models/domain_cdn_config'
42
+ require 'hubspot/codegen/cms/domains/models/domain_setup_info'
43
+ require 'hubspot/codegen/cms/domains/models/error'
44
+ require 'hubspot/codegen/cms/domains/models/error_detail'
45
+ require 'hubspot/codegen/cms/domains/models/next_page'
46
+ require 'hubspot/codegen/cms/domains/models/paging'
47
+
48
+ require 'hubspot/codegen/cms/performance/api_client'
49
+ require 'hubspot/codegen/cms/performance/api_error'
50
+ require 'hubspot/codegen/cms/performance/configuration'
51
+ require 'hubspot/codegen/cms/performance/api/default_api'
52
+ require 'hubspot/codegen/cms/performance/models/error'
53
+ require 'hubspot/codegen/cms/performance/models/error_detail'
54
+ require 'hubspot/codegen/cms/performance/models/performance_view'
55
+ require 'hubspot/codegen/cms/performance/models/public_performance_response'
56
+
57
+ require 'hubspot/codegen/cms/site-search/api_client'
58
+ require 'hubspot/codegen/cms/site-search/api_error'
59
+ require 'hubspot/codegen/cms/site-search/configuration'
60
+ require 'hubspot/codegen/cms/site-search/api/default_api'
61
+ require 'hubspot/codegen/cms/site-search/models/content_search_result'
62
+ require 'hubspot/codegen/cms/site-search/models/error'
63
+ require 'hubspot/codegen/cms/site-search/models/error_detail'
64
+ require 'hubspot/codegen/cms/site-search/models/indexed_data'
65
+ require 'hubspot/codegen/cms/site-search/models/public_search_results'
66
+ require 'hubspot/codegen/cms/site-search/models/search_hit_field'
67
+
68
+ require 'hubspot/codegen/cms/url-redirects/api_client'
69
+ require 'hubspot/codegen/cms/url-redirects/api_error'
70
+ require 'hubspot/codegen/cms/url-redirects/configuration'
71
+ require 'hubspot/codegen/cms/url-redirects/api/redirects_api'
72
+ require 'hubspot/codegen/cms/url-redirects/models/collection_response_with_total_url_mapping'
73
+ require 'hubspot/codegen/cms/url-redirects/models/error'
74
+ require 'hubspot/codegen/cms/url-redirects/models/error_detail'
75
+ require 'hubspot/codegen/cms/url-redirects/models/next_page'
76
+ require 'hubspot/codegen/cms/url-redirects/models/paging'
77
+ require 'hubspot/codegen/cms/url-redirects/models/url_mapping'
78
+ require 'hubspot/codegen/cms/url-redirects/models/url_mapping_create_request_body'
22
79
 
23
80
  require 'hubspot/codegen/crm/associations/api_client'
24
81
  require 'hubspot/codegen/crm/associations/api_error'
@@ -372,10 +429,13 @@ require 'hubspot/codegen/webhooks/api_error'
372
429
  require 'hubspot/codegen/webhooks/configuration'
373
430
  require 'hubspot/codegen/webhooks/api/settings_api'
374
431
  require 'hubspot/codegen/webhooks/api/subscriptions_api'
432
+ require 'hubspot/codegen/webhooks/models/batch_input_subscription_batch_update_request'
433
+ require 'hubspot/codegen/webhooks/models/batch_response_subscription_response'
375
434
  require 'hubspot/codegen/webhooks/models/error'
376
435
  require 'hubspot/codegen/webhooks/models/error_detail'
377
436
  require 'hubspot/codegen/webhooks/models/settings_change_request'
378
437
  require 'hubspot/codegen/webhooks/models/settings_response'
438
+ require 'hubspot/codegen/webhooks/models/subscription_batch_update_request'
379
439
  require 'hubspot/codegen/webhooks/models/subscription_create_request'
380
440
  require 'hubspot/codegen/webhooks/models/subscription_list_response'
381
441
  require 'hubspot/codegen/webhooks/models/subscription_patch_request'
@@ -383,17 +443,22 @@ require 'hubspot/codegen/webhooks/models/subscription_response'
383
443
  require 'hubspot/codegen/webhooks/models/throttling_settings'
384
444
 
385
445
 
386
-
387
446
  module Hubspot
388
447
  class << self
389
448
  CLIENTS = [
390
449
  'OAuth',
391
450
  'Webhooks',
451
+ 'Cms::AuditLogs',
452
+ 'Cms::Domains',
453
+ 'Cms::Performance',
454
+ 'Cms::SiteSearch',
455
+ 'Cms::UrlRedirects',
392
456
  'Crm::Associations',
393
457
  'Crm::Companies',
394
458
  'Crm::Contacts',
395
459
  'Crm::Deals',
396
460
  'Crm::Extensions::Cards',
461
+ 'Crm::Imports',
397
462
  'Crm::LineItems',
398
463
  'Crm::Owners',
399
464
  'Crm::Pipelines',
@@ -0,0 +1,106 @@
1
+ =begin
2
+ #CMS Audit Logs
3
+
4
+ #Use this endpoint to query audit logs of CMS changes that occurred on your HubSpot account.
5
+
6
+ The version of the OpenAPI document: v3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.2.3
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Hubspot
16
+ module Cms
17
+ module AuditLogs
18
+ class DefaultApi
19
+ attr_accessor :api_client
20
+
21
+ def initialize(api_client = ApiClient.default)
22
+ @api_client = api_client
23
+ end
24
+ # Query audit logs
25
+ # Returns audit logs based on filters.
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [Array<String>] :object_id Comma separated list of object ids to filter by.
28
+ # @option opts [Array<String>] :user_id Comma separated list of user ids to filter by.
29
+ # @option opts [String] :after Timestamp after which audit logs will be returned
30
+ # @option opts [String] :before Timestamp before which audit logs will be returned
31
+ # @option opts [Array<String>] :sort The sort direction for the audit logs. (Can only sort by timestamp).
32
+ # @option opts [Array<String>] :event_type Comma separated list of event types to filter by (CREATED, UPDATED, PUBLISHED, DELETED, UNPUBLISHED).
33
+ # @option opts [Integer] :limit The number of logs to return.
34
+ # @option opts [Array<String>] :object_type Comma separated list of object types to filter by (BLOG, LANDING_PAGE, DOMAIN, HUBDB_TABLE etc.)
35
+ # @return [CollectionResponsePublicAuditLog]
36
+ def get_page(opts = {})
37
+ data, _status_code, _headers = get_page_with_http_info(opts)
38
+ data
39
+ end
40
+
41
+ # Query audit logs
42
+ # Returns audit logs based on filters.
43
+ # @param [Hash] opts the optional parameters
44
+ # @option opts [Array<String>] :object_id Comma separated list of object ids to filter by.
45
+ # @option opts [Array<String>] :user_id Comma separated list of user ids to filter by.
46
+ # @option opts [String] :after Timestamp after which audit logs will be returned
47
+ # @option opts [String] :before Timestamp before which audit logs will be returned
48
+ # @option opts [Array<String>] :sort The sort direction for the audit logs. (Can only sort by timestamp).
49
+ # @option opts [Array<String>] :event_type Comma separated list of event types to filter by (CREATED, UPDATED, PUBLISHED, DELETED, UNPUBLISHED).
50
+ # @option opts [Integer] :limit The number of logs to return.
51
+ # @option opts [Array<String>] :object_type Comma separated list of object types to filter by (BLOG, LANDING_PAGE, DOMAIN, HUBDB_TABLE etc.)
52
+ # @return [Array<(CollectionResponsePublicAuditLog, Integer, Hash)>] CollectionResponsePublicAuditLog data, response status code and response headers
53
+ def get_page_with_http_info(opts = {})
54
+ if @api_client.config.debugging
55
+ @api_client.config.logger.debug 'Calling API: DefaultApi.get_page ...'
56
+ end
57
+ # resource path
58
+ local_var_path = '/cms/v3/audit-logs/'
59
+
60
+ # query parameters
61
+ query_params = opts[:query_params] || {}
62
+ query_params[:'objectId'] = @api_client.build_collection_param(opts[:'object_id'], :multi) if !opts[:'object_id'].nil?
63
+ query_params[:'userId'] = @api_client.build_collection_param(opts[:'user_id'], :multi) if !opts[:'user_id'].nil?
64
+ query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
65
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
66
+ query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
67
+ query_params[:'eventType'] = @api_client.build_collection_param(opts[:'event_type'], :multi) if !opts[:'event_type'].nil?
68
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
69
+ query_params[:'objectType'] = @api_client.build_collection_param(opts[:'object_type'], :multi) if !opts[:'object_type'].nil?
70
+
71
+ # header parameters
72
+ header_params = opts[:header_params] || {}
73
+ # HTTP header 'Accept' (if needed)
74
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
75
+
76
+ # form parameters
77
+ form_params = opts[:form_params] || {}
78
+
79
+ # http body (model)
80
+ post_body = opts[:body]
81
+
82
+ # return_type
83
+ return_type = opts[:return_type] || 'CollectionResponsePublicAuditLog'
84
+
85
+ # auth_names
86
+ auth_names = opts[:auth_names] || ['hapikey']
87
+
88
+ new_options = opts.merge(
89
+ :header_params => header_params,
90
+ :query_params => query_params,
91
+ :form_params => form_params,
92
+ :body => post_body,
93
+ :auth_names => auth_names,
94
+ :return_type => return_type
95
+ )
96
+
97
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
98
+ if @api_client.config.debugging
99
+ @api_client.config.logger.debug "API called: DefaultApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
100
+ end
101
+ return data, status_code, headers
102
+ end
103
+ end
104
+ end
105
+ end
106
+ end
@@ -0,0 +1,422 @@
1
+ =begin
2
+ #CMS Audit Logs
3
+
4
+ #Use this endpoint to query audit logs of CMS changes that occurred on your HubSpot account.
5
+
6
+ The version of the OpenAPI document: v3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.2.3
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'json'
15
+ require 'logger'
16
+ require 'tempfile'
17
+ require 'faraday'
18
+
19
+ module Hubspot
20
+ module Cms
21
+ module AuditLogs
22
+ class ApiClient
23
+ # The Configuration object holding settings to be used in the API client.
24
+ attr_accessor :config
25
+
26
+ # Defines the headers to be used in HTTP requests of all API calls by default.
27
+ #
28
+ # @return [Hash]
29
+ attr_accessor :default_headers
30
+
31
+ # Initializes the ApiClient
32
+ # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
33
+ def initialize(config = Configuration.default)
34
+ @config = config
35
+ @user_agent = "hubspot-api-client-ruby; #{VERSION}"
36
+ @default_headers = {
37
+ 'Content-Type' => 'application/json',
38
+ 'User-Agent' => @user_agent
39
+ }
40
+ end
41
+
42
+ def self.default
43
+ @@default ||= ApiClient.new
44
+ end
45
+
46
+ # Call an API with given options.
47
+ #
48
+ # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
49
+ # the data deserialized from response body (could be nil), response status code and response headers.
50
+ def call_api(http_method, path, opts = {})
51
+ ssl_options = {
52
+ :ca_file => @config.ssl_ca_file,
53
+ :verify => @config.ssl_verify,
54
+ :verify_mode => @config.ssl_verify_mode,
55
+ :client_cert => @config.ssl_client_cert,
56
+ :client_key => @config.ssl_client_key
57
+ }
58
+
59
+ connection = Faraday.new(:url => config.base_url, :ssl => ssl_options) do |conn|
60
+ conn.basic_auth(config.username, config.password)
61
+ if opts[:header_params]["Content-Type"] == "multipart/form-data"
62
+ conn.request :multipart
63
+ conn.request :url_encoded
64
+ end
65
+ conn.adapter(Faraday.default_adapter)
66
+ conn.options[:params_encoder] = Faraday::FlatParamsEncoder
67
+
68
+ # Errors handler settings
69
+ if !config.error_handler.empty?
70
+ config.error_handler.each do |statuses, opts|
71
+ statuses = statuses.is_a?(Integer) ? [statuses] : statuses
72
+ retry_options = {
73
+ max: opts[:max_retries],
74
+ interval: opts[:seconds_delay],
75
+ retry_statuses: statuses,
76
+ methods: %i[post delete get head options put],
77
+ retry_block: -> (env, options, retries, exc) { opts[:retry_block].call }
78
+ }
79
+ conn.request :retry, retry_options
80
+ end
81
+ end
82
+ end
83
+
84
+ begin
85
+ response = connection.public_send(http_method.to_sym.downcase) do |req|
86
+ build_request(http_method, path, req, opts)
87
+ end
88
+
89
+ if @config.debugging
90
+ @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
91
+ end
92
+
93
+ unless response.success?
94
+ if response.status == 0
95
+ # Errors from libcurl will be made visible here
96
+ fail ApiError.new(:code => 0,
97
+ :message => response.return_message)
98
+ else
99
+ fail ApiError.new(:code => response.status,
100
+ :response_headers => response.headers,
101
+ :response_body => response.body),
102
+ response.reason_phrase
103
+ end
104
+ end
105
+ rescue Faraday::TimeoutError
106
+ fail ApiError.new('Connection timed out')
107
+ end
108
+
109
+ if opts[:return_type]
110
+ data = deserialize(response, opts[:return_type])
111
+ else
112
+ data = nil
113
+ end
114
+ return data, response.status, response.headers
115
+ end
116
+
117
+ # Builds the HTTP request
118
+ #
119
+ # @param [String] http_method HTTP method/verb (e.g. POST)
120
+ # @param [String] path URL path (e.g. /account/new)
121
+ # @option opts [Hash] :header_params Header parameters
122
+ # @option opts [Hash] :query_params Query parameters
123
+ # @option opts [Hash] :form_params Query parameters
124
+ # @option opts [Object] :body HTTP body (JSON/XML)
125
+ # @return [Typhoeus::Request] A Typhoeus Request
126
+ def build_request(http_method, path, request, opts = {})
127
+ url = build_request_url(path)
128
+ http_method = http_method.to_sym.downcase
129
+
130
+ header_params = @default_headers.merge(opts[:header_params] || {})
131
+ query_params = opts[:query_params] || {}
132
+ form_params = opts[:form_params] || {}
133
+
134
+ update_params_for_auth! header_params, query_params, opts[:auth_names]
135
+
136
+ req_opts = {
137
+ :method => http_method,
138
+ :headers => header_params,
139
+ :params => query_params,
140
+ :params_encoding => @config.params_encoding,
141
+ :timeout => @config.timeout,
142
+ :verbose => @config.debugging
143
+ }
144
+
145
+ if [:post, :patch, :put, :delete].include?(http_method)
146
+ req_body = build_request_body(header_params, form_params, opts[:body])
147
+ req_opts.update :body => req_body
148
+ if @config.debugging
149
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
150
+ end
151
+ end
152
+ request.headers = header_params
153
+ request.body = req_body
154
+ request.url url
155
+ request.params = query_params
156
+ download_file(request) if opts[:return_type] == 'File'
157
+ request
158
+ end
159
+
160
+ # Builds the HTTP request body
161
+ #
162
+ # @param [Hash] header_params Header parameters
163
+ # @param [Hash] form_params Query parameters
164
+ # @param [Object] body HTTP body (JSON/XML)
165
+ # @return [String] HTTP body data in the form of string
166
+ def build_request_body(header_params, form_params, body)
167
+ # http form
168
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded'
169
+ data = URI.encode_www_form(form_params)
170
+ elsif header_params['Content-Type'] == 'multipart/form-data'
171
+ data = {}
172
+ form_params.each do |key, value|
173
+ case value
174
+ when ::File, ::Tempfile
175
+ # TODO hardcode to application/octet-stream, need better way to detect content type
176
+ data[key] = Faraday::UploadIO.new(value.path, 'application/octet-stream', value.path)
177
+ when ::Array, nil
178
+ # let Faraday handle Array and nil parameters
179
+ data[key] = value
180
+ else
181
+ data[key] = value.to_s
182
+ end
183
+ end
184
+ elsif body
185
+ data = body.is_a?(String) ? body : body.to_json
186
+ else
187
+ data = nil
188
+ end
189
+ data
190
+ end
191
+
192
+ # Check if the given MIME is a JSON MIME.
193
+ # JSON MIME examples:
194
+ # application/json
195
+ # application/json; charset=UTF8
196
+ # APPLICATION/JSON
197
+ # */*
198
+ # @param [String] mime MIME
199
+ # @return [Boolean] True if the MIME is application/json
200
+ def json_mime?(mime)
201
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
202
+ end
203
+
204
+ # Deserialize the response to the given return type.
205
+ #
206
+ # @param [Response] response HTTP response
207
+ # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
208
+ def deserialize(response, return_type)
209
+ body = response.body
210
+
211
+ # handle file downloading - return the File instance processed in request callbacks
212
+ # note that response body is empty when the file is written in chunks in request on_body callback
213
+ return @tempfile if return_type == 'File'
214
+
215
+ return nil if body.nil? || body.empty?
216
+
217
+ # return response body directly for String return type
218
+ return body if return_type == 'String'
219
+
220
+ # ensuring a default content type
221
+ content_type = response.headers['Content-Type'] || 'application/json'
222
+
223
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
224
+
225
+ begin
226
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
227
+ rescue JSON::ParserError => e
228
+ if %w(String Date DateTime).include?(return_type)
229
+ data = body
230
+ else
231
+ raise e
232
+ end
233
+ end
234
+
235
+ convert_to_type data, return_type
236
+ end
237
+
238
+ # Convert data to the given return type.
239
+ # @param [Object] data Data to be converted
240
+ # @param [String] return_type Return type
241
+ # @return [Mixed] Data in a particular type
242
+ def convert_to_type(data, return_type)
243
+ return nil if data.nil?
244
+ case return_type
245
+ when 'String'
246
+ data.to_s
247
+ when 'Integer'
248
+ data.to_i
249
+ when 'Float'
250
+ data.to_f
251
+ when 'Boolean'
252
+ data == true
253
+ when 'DateTime'
254
+ # parse date time (expecting ISO 8601 format)
255
+ DateTime.parse data
256
+ when 'Date'
257
+ # parse date time (expecting ISO 8601 format)
258
+ Date.parse data
259
+ when 'Object'
260
+ # generic object (usually a Hash), return directly
261
+ data
262
+ when /\AArray<(.+)>\z/
263
+ # e.g. Array<Pet>
264
+ sub_type = $1
265
+ data.map { |item| convert_to_type(item, sub_type) }
266
+ when /\AHash\<String, (.+)\>\z/
267
+ # e.g. Hash<String, Integer>
268
+ sub_type = $1
269
+ {}.tap do |hash|
270
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
271
+ end
272
+ else
273
+ # models, e.g. Pet
274
+ Hubspot::Cms::AuditLogs.const_get(return_type).build_from_hash(data)
275
+ end
276
+ end
277
+
278
+ # Save response body into a file in (the defined) temporary folder, using the filename
279
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
280
+ # The response body is written to the file in chunks in order to handle files which
281
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
282
+ # process can use.
283
+ #
284
+ # @see Configuration#temp_folder_path
285
+ def download_file(request)
286
+ tempfile = nil
287
+ encoding = nil
288
+ request.on_headers do |response|
289
+ content_disposition = response.headers['Content-Disposition']
290
+ if content_disposition && content_disposition =~ /filename=/i
291
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
292
+ prefix = sanitize_filename(filename)
293
+ else
294
+ prefix = 'download-'
295
+ end
296
+ prefix = prefix + '-' unless prefix.end_with?('-')
297
+ encoding = response.body.encoding
298
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
299
+ @tempfile = tempfile
300
+ end
301
+ request.on_body do |chunk|
302
+ chunk.force_encoding(encoding)
303
+ tempfile.write(chunk)
304
+ end
305
+ request.on_complete do |response|
306
+ tempfile.close if tempfile
307
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
308
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
309
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
310
+ "explicitly with `tempfile.delete`"
311
+ end
312
+ end
313
+
314
+ # Sanitize filename by removing path.
315
+ # e.g. ../../sun.gif becomes sun.gif
316
+ #
317
+ # @param [String] filename the filename to be sanitized
318
+ # @return [String] the sanitized filename
319
+ def sanitize_filename(filename)
320
+ filename.gsub(/.*[\/\\]/, '')
321
+ end
322
+
323
+ def build_request_url(path)
324
+ # Add leading and trailing slashes to path
325
+ path = "/#{path}".gsub(/\/+/, '/')
326
+ @config.base_url + path
327
+ end
328
+
329
+ # Update hearder and query params based on authentication settings.
330
+ #
331
+ # @param [Hash] header_params Header parameters
332
+ # @param [Hash] query_params Query parameters
333
+ # @param [String] auth_names Authentication scheme name
334
+ def update_params_for_auth!(header_params, query_params, auth_names)
335
+ Array(auth_names).each do |auth_name|
336
+ auth_setting = @config.auth_settings[auth_name]
337
+ next unless auth_setting
338
+ case auth_setting[:in]
339
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
340
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
341
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
342
+ end
343
+ end
344
+ end
345
+
346
+ # Sets user agent in HTTP header
347
+ #
348
+ # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
349
+ def user_agent=(user_agent)
350
+ @user_agent = user_agent
351
+ @default_headers['User-Agent'] = @user_agent
352
+ end
353
+
354
+ # Return Accept header based on an array of accepts provided.
355
+ # @param [Array] accepts array for Accept
356
+ # @return [String] the Accept header (e.g. application/json)
357
+ def select_header_accept(accepts)
358
+ return nil if accepts.nil? || accepts.empty?
359
+ # use JSON when present, otherwise use all of the provided
360
+ json_accept = accepts.find { |s| json_mime?(s) }
361
+ json_accept || accepts.join(',')
362
+ end
363
+
364
+ # Return Content-Type header based on an array of content types provided.
365
+ # @param [Array] content_types array for Content-Type
366
+ # @return [String] the Content-Type header (e.g. application/json)
367
+ def select_header_content_type(content_types)
368
+ # use application/json by default
369
+ return 'application/json' if content_types.nil? || content_types.empty?
370
+ # use JSON when present, otherwise use the first one
371
+ json_content_type = content_types.find { |s| json_mime?(s) }
372
+ json_content_type || content_types.first
373
+ end
374
+
375
+ # Convert object (array, hash, object, etc) to JSON string.
376
+ # @param [Object] model object to be converted into JSON string
377
+ # @return [String] JSON string representation of the object
378
+ def object_to_http_body(model)
379
+ return model if model.nil? || model.is_a?(String)
380
+ local_body = nil
381
+ if model.is_a?(Array)
382
+ local_body = model.map { |m| object_to_hash(m) }
383
+ else
384
+ local_body = object_to_hash(model)
385
+ end
386
+ local_body.to_json
387
+ end
388
+
389
+ # Convert object(non-array) to hash.
390
+ # @param [Object] obj object to be converted into JSON string
391
+ # @return [String] JSON string representation of the object
392
+ def object_to_hash(obj)
393
+ if obj.respond_to?(:to_hash)
394
+ obj.to_hash
395
+ else
396
+ obj
397
+ end
398
+ end
399
+
400
+ # Build parameter value according to the given collection format.
401
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
402
+ def build_collection_param(param, collection_format)
403
+ case collection_format
404
+ when :csv
405
+ param.join(',')
406
+ when :ssv
407
+ param.join(' ')
408
+ when :tsv
409
+ param.join("\t")
410
+ when :pipes
411
+ param.join('|')
412
+ when :multi
413
+ # return the array directly as typhoeus will handle it as expected
414
+ param
415
+ else
416
+ fail "unknown collection format: #{collection_format.inspect}"
417
+ end
418
+ end
419
+ end
420
+ end
421
+ end
422
+ end