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
@@ -0,0 +1,258 @@
1
+ =begin
2
+ #CMS Site Search
3
+
4
+ #Use these endpoints for searching content on your HubSpot hosted CMS website(s).
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
+ module Hubspot
14
+ module Cms
15
+ module SiteSearch
16
+ class Configuration
17
+ # Defines url scheme
18
+ attr_accessor :scheme
19
+
20
+ # Defines url host
21
+ attr_accessor :host
22
+
23
+ # Defines url base path
24
+ attr_accessor :base_path
25
+
26
+ # Defines API keys used with API Key authentications.
27
+ #
28
+ # @return [Hash] key: parameter name, value: parameter value (API key)
29
+ #
30
+ # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
31
+ # config.api_key['api_key'] = 'xxx'
32
+ attr_accessor :api_key
33
+
34
+ # Defines API key prefixes used with API Key authentications.
35
+ #
36
+ # @return [Hash] key: parameter name, value: API key prefix
37
+ #
38
+ # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
39
+ # config.api_key_prefix['api_key'] = 'Token'
40
+ attr_accessor :api_key_prefix
41
+
42
+ # Defines the username used with HTTP basic authentication.
43
+ #
44
+ # @return [String]
45
+ attr_accessor :username
46
+
47
+ # Defines the password used with HTTP basic authentication.
48
+ #
49
+ # @return [String]
50
+ attr_accessor :password
51
+
52
+ # Defines the access token (Bearer) used with OAuth2.
53
+ attr_accessor :access_token
54
+
55
+ # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
56
+ # details will be logged with `logger.debug` (see the `logger` attribute).
57
+ # Default to false.
58
+ #
59
+ # @return [true, false]
60
+ attr_accessor :debugging
61
+
62
+ # Defines the logger used for debugging.
63
+ # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
64
+ #
65
+ # @return [#debug]
66
+ attr_accessor :logger
67
+
68
+ # Defines the temporary folder to store downloaded files
69
+ # (for API endpoints that have file response).
70
+ # Default to use `Tempfile`.
71
+ #
72
+ # @return [String]
73
+ attr_accessor :temp_folder_path
74
+
75
+ # The time limit for HTTP request in seconds.
76
+ # Default to 0 (never times out).
77
+ attr_accessor :timeout
78
+
79
+ # Set this to false to skip client side validation in the operation.
80
+ # Default to true.
81
+ # @return [true, false]
82
+ attr_accessor :client_side_validation
83
+
84
+ ### TLS/SSL setting
85
+ # Set this to false to skip verifying SSL certificate when calling API from https server.
86
+ # Default to true.
87
+ #
88
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
89
+ #
90
+ # @return [true, false]
91
+ attr_accessor :ssl_verify
92
+
93
+ ### TLS/SSL setting
94
+ # Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
95
+ #
96
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
97
+ #
98
+ attr_accessor :ssl_verify_mode
99
+
100
+ ### TLS/SSL setting
101
+ # Set this to customize the certificate file to verify the peer.
102
+ #
103
+ # @return [String] the path to the certificate file
104
+ attr_accessor :ssl_ca_file
105
+
106
+ ### TLS/SSL setting
107
+ # Client certificate file (for client certificate)
108
+ attr_accessor :ssl_client_cert
109
+
110
+ ### TLS/SSL setting
111
+ # Client private key file (for client certificate)
112
+ attr_accessor :ssl_client_key
113
+
114
+ # Set this to customize parameters encoding of array parameter with multi collectionFormat.
115
+ # Default to nil.
116
+ #
117
+ # @see The params_encoding option of Ethon. Related source code:
118
+ # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
119
+ attr_accessor :params_encoding
120
+
121
+ attr_accessor :inject_format
122
+
123
+ attr_accessor :force_ending_format
124
+
125
+ attr_accessor :error_handler
126
+
127
+ def initialize
128
+ @scheme = 'https'
129
+ @host = 'api.hubapi.com'
130
+ @base_path = ''
131
+ @api_key = {}
132
+ @api_key_prefix = {}
133
+ @timeout = 0
134
+ @client_side_validation = true
135
+ @ssl_verify = true
136
+ @ssl_verify_mode = nil
137
+ @ssl_ca_file = nil
138
+ @ssl_client_cert = nil
139
+ @ssl_client_key = nil
140
+ @debugging = false
141
+ @inject_format = false
142
+ @force_ending_format = false
143
+ @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
144
+ # error_handler params: { 'status_code': { max_retries: ..., seconds_delay: ... }, ... }
145
+ @error_handler = {}
146
+
147
+ yield(self) if block_given?
148
+ end
149
+
150
+ # The default Configuration object.
151
+ def self.default
152
+ @@default ||= Configuration.new
153
+ end
154
+
155
+ def configure
156
+ yield(self) if block_given?
157
+ end
158
+
159
+ def scheme=(scheme)
160
+ # remove :// from scheme
161
+ @scheme = scheme.sub(/:\/\//, '')
162
+ end
163
+
164
+ def host=(host)
165
+ # remove http(s):// and anything after a slash
166
+ @host = host.sub(/https?:\/\//, '').split('/').first
167
+ end
168
+
169
+ def base_path=(base_path)
170
+ # Add leading and trailing slashes to base_path
171
+ @base_path = "/#{base_path}".gsub(/\/+/, '/')
172
+ @base_path = '' if @base_path == '/'
173
+ end
174
+
175
+ def base_url
176
+ "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
177
+ end
178
+
179
+ # Gets API key (with prefix if set).
180
+ # @param [String] param_name the parameter name of API key auth
181
+ def api_key_with_prefix(param_name)
182
+ if @api_key_prefix[param_name]
183
+ "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
184
+ else
185
+ @api_key[param_name]
186
+ end
187
+ end
188
+
189
+ # Gets Basic Auth token string
190
+ def basic_auth_token
191
+ 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
192
+ end
193
+
194
+ # Returns Auth Settings hash for api client.
195
+ def auth_settings
196
+ {
197
+ 'hapikey' =>
198
+ {
199
+ type: 'api_key',
200
+ in: 'query',
201
+ key: 'hapikey',
202
+ value: api_key_with_prefix('hapikey')
203
+ },
204
+ 'oauth2' =>
205
+ {
206
+ type: 'oauth2',
207
+ in: 'header',
208
+ key: 'Authorization',
209
+ value: "Bearer #{access_token}"
210
+ },
211
+ }
212
+ end
213
+
214
+ # Returns an array of Server setting
215
+ def server_settings
216
+ [
217
+ {
218
+ url: "https://api.hubapi.com/",
219
+ description: "No description provided",
220
+ }
221
+ ]
222
+ end
223
+
224
+ # Returns URL based on server settings
225
+ #
226
+ # @param index array index of the server settings
227
+ # @param variables hash of variable and the corresponding value
228
+ def server_url(index, variables = {})
229
+ servers = server_settings
230
+
231
+ # check array index out of bound
232
+ if (index < 0 || index >= servers.size)
233
+ fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
234
+ end
235
+
236
+ server = servers[index]
237
+ url = server[:url]
238
+
239
+ # go through variable and assign a value
240
+ server[:variables].each do |name, variable|
241
+ if variables.key?(name)
242
+ if (server[:variables][name][:enum_values].include? variables[name])
243
+ url.gsub! "{" + name.to_s + "}", variables[name]
244
+ else
245
+ fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
246
+ end
247
+ else
248
+ # use default value
249
+ url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
250
+ end
251
+ end
252
+
253
+ url
254
+ end
255
+ end
256
+ end
257
+ end
258
+ end
@@ -0,0 +1,427 @@
1
+ =begin
2
+ #CMS Site Search
3
+
4
+ #Use these endpoints for searching content on your HubSpot hosted CMS website(s).
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
+
15
+ module Hubspot
16
+ module Cms
17
+ module SiteSearch
18
+ class ContentSearchResult
19
+ attr_accessor :id
20
+
21
+ attr_accessor :score
22
+
23
+ attr_accessor :type
24
+
25
+ attr_accessor :domain
26
+
27
+ attr_accessor :url
28
+
29
+ attr_accessor :featured_image_url
30
+
31
+ attr_accessor :language
32
+
33
+ attr_accessor :title
34
+
35
+ attr_accessor :description
36
+
37
+ attr_accessor :category
38
+
39
+ attr_accessor :subcategory
40
+
41
+ attr_accessor :author_full_name
42
+
43
+ attr_accessor :tags
44
+
45
+ attr_accessor :table_id
46
+
47
+ attr_accessor :row_id
48
+
49
+ attr_accessor :published_date
50
+
51
+ attr_accessor :combined_id
52
+
53
+ class EnumAttributeValidator
54
+ attr_reader :datatype
55
+ attr_reader :allowable_values
56
+
57
+ def initialize(datatype, allowable_values)
58
+ @allowable_values = allowable_values.map do |value|
59
+ case datatype.to_s
60
+ when /Integer/i
61
+ value.to_i
62
+ when /Float/i
63
+ value.to_f
64
+ else
65
+ value
66
+ end
67
+ end
68
+ end
69
+
70
+ def valid?(value)
71
+ !value || allowable_values.include?(value)
72
+ end
73
+ end
74
+
75
+ # Attribute mapping from ruby-style variable name to JSON key.
76
+ def self.attribute_map
77
+ {
78
+ :'id' => :'id',
79
+ :'score' => :'score',
80
+ :'type' => :'type',
81
+ :'domain' => :'domain',
82
+ :'url' => :'url',
83
+ :'featured_image_url' => :'featuredImageUrl',
84
+ :'language' => :'language',
85
+ :'title' => :'title',
86
+ :'description' => :'description',
87
+ :'category' => :'category',
88
+ :'subcategory' => :'subcategory',
89
+ :'author_full_name' => :'authorFullName',
90
+ :'tags' => :'tags',
91
+ :'table_id' => :'tableId',
92
+ :'row_id' => :'rowId',
93
+ :'published_date' => :'publishedDate',
94
+ :'combined_id' => :'combinedId'
95
+ }
96
+ end
97
+
98
+ # Attribute type mapping.
99
+ def self.openapi_types
100
+ {
101
+ :'id' => :'Integer',
102
+ :'score' => :'Float',
103
+ :'type' => :'String',
104
+ :'domain' => :'String',
105
+ :'url' => :'String',
106
+ :'featured_image_url' => :'String',
107
+ :'language' => :'String',
108
+ :'title' => :'String',
109
+ :'description' => :'String',
110
+ :'category' => :'String',
111
+ :'subcategory' => :'String',
112
+ :'author_full_name' => :'String',
113
+ :'tags' => :'Array<String>',
114
+ :'table_id' => :'Integer',
115
+ :'row_id' => :'Integer',
116
+ :'published_date' => :'Integer',
117
+ :'combined_id' => :'String'
118
+ }
119
+ end
120
+
121
+ # List of attributes with nullable: true
122
+ def self.openapi_nullable
123
+ Set.new([
124
+ ])
125
+ end
126
+
127
+ # Initializes the object
128
+ # @param [Hash] attributes Model attributes in the form of hash
129
+ def initialize(attributes = {})
130
+ if (!attributes.is_a?(Hash))
131
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Cms::SiteSearch::ContentSearchResult` initialize method"
132
+ end
133
+
134
+ # check to see if the attribute exists and convert string to symbol for hash key
135
+ attributes = attributes.each_with_object({}) { |(k, v), h|
136
+ if (!self.class.attribute_map.key?(k.to_sym))
137
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Cms::SiteSearch::ContentSearchResult`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
138
+ end
139
+ h[k.to_sym] = v
140
+ }
141
+
142
+ if attributes.key?(:'id')
143
+ self.id = attributes[:'id']
144
+ end
145
+
146
+ if attributes.key?(:'score')
147
+ self.score = attributes[:'score']
148
+ end
149
+
150
+ if attributes.key?(:'type')
151
+ self.type = attributes[:'type']
152
+ end
153
+
154
+ if attributes.key?(:'domain')
155
+ self.domain = attributes[:'domain']
156
+ end
157
+
158
+ if attributes.key?(:'url')
159
+ self.url = attributes[:'url']
160
+ end
161
+
162
+ if attributes.key?(:'featured_image_url')
163
+ self.featured_image_url = attributes[:'featured_image_url']
164
+ end
165
+
166
+ if attributes.key?(:'language')
167
+ self.language = attributes[:'language']
168
+ end
169
+
170
+ if attributes.key?(:'title')
171
+ self.title = attributes[:'title']
172
+ end
173
+
174
+ if attributes.key?(:'description')
175
+ self.description = attributes[:'description']
176
+ end
177
+
178
+ if attributes.key?(:'category')
179
+ self.category = attributes[:'category']
180
+ end
181
+
182
+ if attributes.key?(:'subcategory')
183
+ self.subcategory = attributes[:'subcategory']
184
+ end
185
+
186
+ if attributes.key?(:'author_full_name')
187
+ self.author_full_name = attributes[:'author_full_name']
188
+ end
189
+
190
+ if attributes.key?(:'tags')
191
+ if (value = attributes[:'tags']).is_a?(Array)
192
+ self.tags = value
193
+ end
194
+ end
195
+
196
+ if attributes.key?(:'table_id')
197
+ self.table_id = attributes[:'table_id']
198
+ end
199
+
200
+ if attributes.key?(:'row_id')
201
+ self.row_id = attributes[:'row_id']
202
+ end
203
+
204
+ if attributes.key?(:'published_date')
205
+ self.published_date = attributes[:'published_date']
206
+ end
207
+
208
+ if attributes.key?(:'combined_id')
209
+ self.combined_id = attributes[:'combined_id']
210
+ end
211
+ end
212
+
213
+ # Show invalid properties with the reasons. Usually used together with valid?
214
+ # @return Array for valid properties with the reasons
215
+ def list_invalid_properties
216
+ invalid_properties = Array.new
217
+ if @id.nil?
218
+ invalid_properties.push('invalid value for "id", id cannot be nil.')
219
+ end
220
+
221
+ if @score.nil?
222
+ invalid_properties.push('invalid value for "score", score cannot be nil.')
223
+ end
224
+
225
+ if @type.nil?
226
+ invalid_properties.push('invalid value for "type", type cannot be nil.')
227
+ end
228
+
229
+ if @domain.nil?
230
+ invalid_properties.push('invalid value for "domain", domain cannot be nil.')
231
+ end
232
+
233
+ if @url.nil?
234
+ invalid_properties.push('invalid value for "url", url cannot be nil.')
235
+ end
236
+
237
+ invalid_properties
238
+ end
239
+
240
+ # Check to see if the all the properties in the model are valid
241
+ # @return true if the model is valid
242
+ def valid?
243
+ return false if @id.nil?
244
+ return false if @score.nil?
245
+ return false if @type.nil?
246
+ type_validator = EnumAttributeValidator.new('String', ["LANDING_PAGE", "BLOG_POST", "SITE_PAGE", "DOCUMENT", "KNOWLEDGE_ARTICLE", "LISTING_PAGE"])
247
+ return false unless type_validator.valid?(@type)
248
+ return false if @domain.nil?
249
+ return false if @url.nil?
250
+ language_validator = EnumAttributeValidator.new('String', ["af", "af-na", "af-za", "agq", "agq-cm", "ak", "ak-gh", "am", "am-et", "ar", "ar-001", "ar-ae", "ar-bh", "ar-dj", "ar-dz", "ar-eg", "ar-eh", "ar-er", "ar-il", "ar-iq", "ar-jo", "ar-km", "ar-kw", "ar-lb", "ar-ly", "ar-ma", "ar-mr", "ar-om", "ar-ps", "ar-qa", "ar-sa", "ar-sd", "ar-so", "ar-ss", "ar-sy", "ar-td", "ar-tn", "ar-ye", "as", "as-in", "asa", "asa-tz", "ast", "ast-es", "az", "az-az", "bas", "bas-cm", "be", "be-by", "bem", "bem-zm", "bez", "bez-tz", "bg", "bg-bg", "bm", "bm-ml", "bn", "bn-bd", "bn-in", "bo", "bo-cn", "bo-in", "br", "br-fr", "brx", "brx-in", "bs", "bs-ba", "ca", "ca-ad", "ca-es", "ca-fr", "ca-it", "ccp", "ccp-bd", "ccp-in", "ce", "ce-ru", "cgg", "cgg-ug", "chr", "chr-us", "ckb", "ckb-iq", "ckb-ir", "cs", "cs-cz", "cu", "cu-ru", "cy", "cy-gb", "da", "da-dk", "da-gl", "dav", "dav-ke", "de", "de-at", "de-be", "de-ch", "de-de", "de-gr", "de-it", "de-li", "de-lu", "dje", "dje-ne", "dsb", "dsb-de", "dua", "dua-cm", "dyo", "dyo-sn", "dz", "dz-bt", "ebu", "ebu-ke", "ee", "ee-gh", "ee-tg", "el", "el-cy", "el-gr", "en", "en-001", "en-150", "en-ag", "en-ai", "en-as", "en-at", "en-au", "en-bb", "en-be", "en-bi", "en-bm", "en-bs", "en-bw", "en-bz", "en-ca", "en-cc", "en-ch", "en-ck", "en-cm", "en-cx", "en-cy", "en-de", "en-dg", "en-dk", "en-dm", "en-er", "en-fi", "en-fj", "en-fk", "en-fm", "en-gb", "en-gd", "en-gg", "en-gh", "en-gi", "en-gm", "en-gu", "en-gy", "en-hk", "en-ie", "en-il", "en-im", "en-in", "en-io", "en-je", "en-jm", "en-ke", "en-ki", "en-kn", "en-ky", "en-lc", "en-lr", "en-ls", "en-mg", "en-mh", "en-mo", "en-mp", "en-ms", "en-mt", "en-mu", "en-mw", "en-my", "en-na", "en-nf", "en-ng", "en-nl", "en-nr", "en-nu", "en-nz", "en-pg", "en-ph", "en-pk", "en-pn", "en-pr", "en-pw", "en-rw", "en-sb", "en-sc", "en-sd", "en-se", "en-sg", "en-sh", "en-si", "en-sl", "en-ss", "en-sx", "en-sz", "en-tc", "en-tk", "en-to", "en-tt", "en-tv", "en-tz", "en-ug", "en-um", "en-us", "en-vc", "en-vg", "en-vi", "en-vu", "en-ws", "en-za", "en-zm", "en-zw", "eo", "eo-001", "es", "es-419", "es-ar", "es-bo", "es-br", "es-bz", "es-cl", "es-co", "es-cr", "es-cu", "es-do", "es-ea", "es-ec", "es-es", "es-gq", "es-gt", "es-hn", "es-ic", "es-mx", "es-ni", "es-pa", "es-pe", "es-ph", "es-pr", "es-py", "es-sv", "es-us", "es-uy", "es-ve", "et", "et-ee", "eu", "eu-es", "ewo", "ewo-cm", "fa", "fa-af", "fa-ir", "ff", "ff-cm", "ff-gn", "ff-mr", "ff-sn", "fi", "fi-fi", "fil", "fil-ph", "fo", "fo-dk", "fo-fo", "fr", "fr-be", "fr-bf", "fr-bi", "fr-bj", "fr-bl", "fr-ca", "fr-cd", "fr-cf", "fr-cg", "fr-ch", "fr-ci", "fr-cm", "fr-dj", "fr-dz", "fr-fr", "fr-ga", "fr-gf", "fr-gn", "fr-gp", "fr-gq", "fr-ht", "fr-km", "fr-lu", "fr-ma", "fr-mc", "fr-mf", "fr-mg", "fr-ml", "fr-mq", "fr-mr", "fr-mu", "fr-nc", "fr-ne", "fr-pf", "fr-pm", "fr-re", "fr-rw", "fr-sc", "fr-sn", "fr-sy", "fr-td", "fr-tg", "fr-tn", "fr-vu", "fr-wf", "fr-yt", "fur", "fur-it", "fy", "fy-nl", "ga", "ga-ie", "gd", "gd-gb", "gl", "gl-es", "gsw", "gsw-ch", "gsw-fr", "gsw-li", "gu", "gu-in", "guz", "guz-ke", "gv", "gv-im", "ha", "ha-gh", "ha-ne", "ha-ng", "haw", "haw-us", "he", "hi", "hi-in", "hr", "hr-ba", "hr-hr", "hsb", "hsb-de", "hu", "hu-hu", "hy", "hy-am", "id", "ig", "ig-ng", "ii", "ii-cn", "id-id", "is", "is-is", "it", "it-ch", "it-it", "it-sm", "it-va", "he-il", "ja", "ja-jp", "jgo", "jgo-cm", "yi", "yi-001", "jmc", "jmc-tz", "ka", "ka-ge", "kab", "kab-dz", "kam", "kam-ke", "kde", "kde-tz", "kea", "kea-cv", "khq", "khq-ml", "ki", "ki-ke", "kk", "kk-kz", "kkj", "kkj-cm", "kl", "kl-gl", "kln", "kln-ke", "km", "km-kh", "kn", "kn-in", "ko", "ko-kp", "ko-kr", "kok", "kok-in", "ks", "ks-in", "ksb", "ksb-tz", "ksf", "ksf-cm", "ksh", "ksh-de", "kw", "kw-gb", "ky", "ky-kg", "lag", "lag-tz", "lb", "lb-lu", "lg", "lg-ug", "lkt", "lkt-us", "ln", "ln-ao", "ln-cd", "ln-cf", "ln-cg", "lo", "lo-la", "lrc", "lrc-iq", "lrc-ir", "lt", "lt-lt", "lu", "lu-cd", "luo", "luo-ke", "luy", "luy-ke", "lv", "lv-lv", "mas", "mas-ke", "mas-tz", "mer", "mer-ke", "mfe", "mfe-mu", "mg", "mg-mg", "mgh", "mgh-mz", "mgo", "mgo-cm", "mk", "mk-mk", "ml", "ml-in", "mn", "mn-mn", "mr", "mr-in", "ms", "ms-bn", "ms-my", "ms-sg", "mt", "mt-mt", "mua", "mua-cm", "my", "my-mm", "mzn", "mzn-ir", "naq", "naq-na", "nb", "nb-no", "nb-sj", "nd", "nd-zw", "nds", "nds-de", "nds-nl", "ne", "ne-in", "ne-np", "nl", "nl-aw", "nl-be", "nl-bq", "nl-cw", "nl-nl", "nl-sr", "nl-sx", "nmg", "nmg-cm", "nn", "nn-no", "nnh", "nnh-cm", "no", "no-no", "nus", "nus-ss", "nyn", "nyn-ug", "om", "om-et", "om-ke", "or", "or-in", "os", "os-ge", "os-ru", "pa", "pa-in", "pa-pk", "pl", "pl-pl", "prg", "prg-001", "ps", "ps-af", "pt", "pt-ao", "pt-br", "pt-ch", "pt-cv", "pt-gq", "pt-gw", "pt-lu", "pt-mo", "pt-mz", "pt-pt", "pt-st", "pt-tl", "qu", "qu-bo", "qu-ec", "qu-pe", "rm", "rm-ch", "rn", "rn-bi", "ro", "ro-md", "ro-ro", "rof", "rof-tz", "ru", "ru-by", "ru-kg", "ru-kz", "ru-md", "ru-ru", "ru-ua", "rw", "rw-rw", "rwk", "rwk-tz", "sa", "sah", "sah-ru", "saq", "saq-ke", "sbp", "sbp-tz", "sd", "sd-pk", "se", "se-fi", "se-no", "se-se", "seh", "seh-mz", "ses", "ses-ml", "sg", "sg-cf", "shi", "shi-ma", "si", "si-lk", "sk", "sk-sk", "sl", "sl-si", "smn", "smn-fi", "sn", "sn-zw", "so", "so-dj", "so-et", "so-ke", "so-so", "sq", "sq-al", "sq-mk", "sq-xk", "sr", "sr-ba", "sr-cs", "sr-me", "sr-rs", "sr-xk", "sv", "sv-ax", "sv-fi", "sv-se", "sw", "sw-cd", "sw-ke", "sw-tz", "sw-ug", "sy", "ta", "ta-in", "ta-lk", "ta-my", "ta-sg", "te", "te-in", "teo", "teo-ke", "teo-ug", "tg", "tg-tj", "th", "th-th", "ti", "ti-er", "ti-et", "tk", "tk-tm", "to", "to-to", "tr", "tr-cy", "tr-tr", "tt", "tt-ru", "twq", "twq-ne", "tzm", "tzm-ma", "ug", "ug-cn", "uk", "uk-ua", "ur", "ur-in", "ur-pk", "uz", "uz-af", "uz-uz", "vai", "vai-lr", "vi", "vi-vn", "vo", "vo-001", "vun", "vun-tz", "wae", "wae-ch", "wo", "wo-sn", "xog", "xog-ug", "yav", "yav-cm", "yo", "yo-bj", "yo-ng", "yue", "yue-cn", "yue-hk", "zgh", "zgh-ma", "zh", "zh-cn", "zh-hk", "zh-mo", "zh-sg", "zh-tw", "zh-hans", "zh-hant", "zu", "zu-za"])
251
+ return false unless language_validator.valid?(@language)
252
+ true
253
+ end
254
+
255
+ # Custom attribute writer method checking allowed values (enum).
256
+ # @param [Object] type Object to be assigned
257
+ def type=(type)
258
+ validator = EnumAttributeValidator.new('String', ["LANDING_PAGE", "BLOG_POST", "SITE_PAGE", "DOCUMENT", "KNOWLEDGE_ARTICLE", "LISTING_PAGE"])
259
+ unless validator.valid?(type)
260
+ fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
261
+ end
262
+ @type = type
263
+ end
264
+
265
+ # Custom attribute writer method checking allowed values (enum).
266
+ # @param [Object] language Object to be assigned
267
+ def language=(language)
268
+ validator = EnumAttributeValidator.new('String', ["af", "af-na", "af-za", "agq", "agq-cm", "ak", "ak-gh", "am", "am-et", "ar", "ar-001", "ar-ae", "ar-bh", "ar-dj", "ar-dz", "ar-eg", "ar-eh", "ar-er", "ar-il", "ar-iq", "ar-jo", "ar-km", "ar-kw", "ar-lb", "ar-ly", "ar-ma", "ar-mr", "ar-om", "ar-ps", "ar-qa", "ar-sa", "ar-sd", "ar-so", "ar-ss", "ar-sy", "ar-td", "ar-tn", "ar-ye", "as", "as-in", "asa", "asa-tz", "ast", "ast-es", "az", "az-az", "bas", "bas-cm", "be", "be-by", "bem", "bem-zm", "bez", "bez-tz", "bg", "bg-bg", "bm", "bm-ml", "bn", "bn-bd", "bn-in", "bo", "bo-cn", "bo-in", "br", "br-fr", "brx", "brx-in", "bs", "bs-ba", "ca", "ca-ad", "ca-es", "ca-fr", "ca-it", "ccp", "ccp-bd", "ccp-in", "ce", "ce-ru", "cgg", "cgg-ug", "chr", "chr-us", "ckb", "ckb-iq", "ckb-ir", "cs", "cs-cz", "cu", "cu-ru", "cy", "cy-gb", "da", "da-dk", "da-gl", "dav", "dav-ke", "de", "de-at", "de-be", "de-ch", "de-de", "de-gr", "de-it", "de-li", "de-lu", "dje", "dje-ne", "dsb", "dsb-de", "dua", "dua-cm", "dyo", "dyo-sn", "dz", "dz-bt", "ebu", "ebu-ke", "ee", "ee-gh", "ee-tg", "el", "el-cy", "el-gr", "en", "en-001", "en-150", "en-ag", "en-ai", "en-as", "en-at", "en-au", "en-bb", "en-be", "en-bi", "en-bm", "en-bs", "en-bw", "en-bz", "en-ca", "en-cc", "en-ch", "en-ck", "en-cm", "en-cx", "en-cy", "en-de", "en-dg", "en-dk", "en-dm", "en-er", "en-fi", "en-fj", "en-fk", "en-fm", "en-gb", "en-gd", "en-gg", "en-gh", "en-gi", "en-gm", "en-gu", "en-gy", "en-hk", "en-ie", "en-il", "en-im", "en-in", "en-io", "en-je", "en-jm", "en-ke", "en-ki", "en-kn", "en-ky", "en-lc", "en-lr", "en-ls", "en-mg", "en-mh", "en-mo", "en-mp", "en-ms", "en-mt", "en-mu", "en-mw", "en-my", "en-na", "en-nf", "en-ng", "en-nl", "en-nr", "en-nu", "en-nz", "en-pg", "en-ph", "en-pk", "en-pn", "en-pr", "en-pw", "en-rw", "en-sb", "en-sc", "en-sd", "en-se", "en-sg", "en-sh", "en-si", "en-sl", "en-ss", "en-sx", "en-sz", "en-tc", "en-tk", "en-to", "en-tt", "en-tv", "en-tz", "en-ug", "en-um", "en-us", "en-vc", "en-vg", "en-vi", "en-vu", "en-ws", "en-za", "en-zm", "en-zw", "eo", "eo-001", "es", "es-419", "es-ar", "es-bo", "es-br", "es-bz", "es-cl", "es-co", "es-cr", "es-cu", "es-do", "es-ea", "es-ec", "es-es", "es-gq", "es-gt", "es-hn", "es-ic", "es-mx", "es-ni", "es-pa", "es-pe", "es-ph", "es-pr", "es-py", "es-sv", "es-us", "es-uy", "es-ve", "et", "et-ee", "eu", "eu-es", "ewo", "ewo-cm", "fa", "fa-af", "fa-ir", "ff", "ff-cm", "ff-gn", "ff-mr", "ff-sn", "fi", "fi-fi", "fil", "fil-ph", "fo", "fo-dk", "fo-fo", "fr", "fr-be", "fr-bf", "fr-bi", "fr-bj", "fr-bl", "fr-ca", "fr-cd", "fr-cf", "fr-cg", "fr-ch", "fr-ci", "fr-cm", "fr-dj", "fr-dz", "fr-fr", "fr-ga", "fr-gf", "fr-gn", "fr-gp", "fr-gq", "fr-ht", "fr-km", "fr-lu", "fr-ma", "fr-mc", "fr-mf", "fr-mg", "fr-ml", "fr-mq", "fr-mr", "fr-mu", "fr-nc", "fr-ne", "fr-pf", "fr-pm", "fr-re", "fr-rw", "fr-sc", "fr-sn", "fr-sy", "fr-td", "fr-tg", "fr-tn", "fr-vu", "fr-wf", "fr-yt", "fur", "fur-it", "fy", "fy-nl", "ga", "ga-ie", "gd", "gd-gb", "gl", "gl-es", "gsw", "gsw-ch", "gsw-fr", "gsw-li", "gu", "gu-in", "guz", "guz-ke", "gv", "gv-im", "ha", "ha-gh", "ha-ne", "ha-ng", "haw", "haw-us", "he", "hi", "hi-in", "hr", "hr-ba", "hr-hr", "hsb", "hsb-de", "hu", "hu-hu", "hy", "hy-am", "id", "ig", "ig-ng", "ii", "ii-cn", "id-id", "is", "is-is", "it", "it-ch", "it-it", "it-sm", "it-va", "he-il", "ja", "ja-jp", "jgo", "jgo-cm", "yi", "yi-001", "jmc", "jmc-tz", "ka", "ka-ge", "kab", "kab-dz", "kam", "kam-ke", "kde", "kde-tz", "kea", "kea-cv", "khq", "khq-ml", "ki", "ki-ke", "kk", "kk-kz", "kkj", "kkj-cm", "kl", "kl-gl", "kln", "kln-ke", "km", "km-kh", "kn", "kn-in", "ko", "ko-kp", "ko-kr", "kok", "kok-in", "ks", "ks-in", "ksb", "ksb-tz", "ksf", "ksf-cm", "ksh", "ksh-de", "kw", "kw-gb", "ky", "ky-kg", "lag", "lag-tz", "lb", "lb-lu", "lg", "lg-ug", "lkt", "lkt-us", "ln", "ln-ao", "ln-cd", "ln-cf", "ln-cg", "lo", "lo-la", "lrc", "lrc-iq", "lrc-ir", "lt", "lt-lt", "lu", "lu-cd", "luo", "luo-ke", "luy", "luy-ke", "lv", "lv-lv", "mas", "mas-ke", "mas-tz", "mer", "mer-ke", "mfe", "mfe-mu", "mg", "mg-mg", "mgh", "mgh-mz", "mgo", "mgo-cm", "mk", "mk-mk", "ml", "ml-in", "mn", "mn-mn", "mr", "mr-in", "ms", "ms-bn", "ms-my", "ms-sg", "mt", "mt-mt", "mua", "mua-cm", "my", "my-mm", "mzn", "mzn-ir", "naq", "naq-na", "nb", "nb-no", "nb-sj", "nd", "nd-zw", "nds", "nds-de", "nds-nl", "ne", "ne-in", "ne-np", "nl", "nl-aw", "nl-be", "nl-bq", "nl-cw", "nl-nl", "nl-sr", "nl-sx", "nmg", "nmg-cm", "nn", "nn-no", "nnh", "nnh-cm", "no", "no-no", "nus", "nus-ss", "nyn", "nyn-ug", "om", "om-et", "om-ke", "or", "or-in", "os", "os-ge", "os-ru", "pa", "pa-in", "pa-pk", "pl", "pl-pl", "prg", "prg-001", "ps", "ps-af", "pt", "pt-ao", "pt-br", "pt-ch", "pt-cv", "pt-gq", "pt-gw", "pt-lu", "pt-mo", "pt-mz", "pt-pt", "pt-st", "pt-tl", "qu", "qu-bo", "qu-ec", "qu-pe", "rm", "rm-ch", "rn", "rn-bi", "ro", "ro-md", "ro-ro", "rof", "rof-tz", "ru", "ru-by", "ru-kg", "ru-kz", "ru-md", "ru-ru", "ru-ua", "rw", "rw-rw", "rwk", "rwk-tz", "sa", "sah", "sah-ru", "saq", "saq-ke", "sbp", "sbp-tz", "sd", "sd-pk", "se", "se-fi", "se-no", "se-se", "seh", "seh-mz", "ses", "ses-ml", "sg", "sg-cf", "shi", "shi-ma", "si", "si-lk", "sk", "sk-sk", "sl", "sl-si", "smn", "smn-fi", "sn", "sn-zw", "so", "so-dj", "so-et", "so-ke", "so-so", "sq", "sq-al", "sq-mk", "sq-xk", "sr", "sr-ba", "sr-cs", "sr-me", "sr-rs", "sr-xk", "sv", "sv-ax", "sv-fi", "sv-se", "sw", "sw-cd", "sw-ke", "sw-tz", "sw-ug", "sy", "ta", "ta-in", "ta-lk", "ta-my", "ta-sg", "te", "te-in", "teo", "teo-ke", "teo-ug", "tg", "tg-tj", "th", "th-th", "ti", "ti-er", "ti-et", "tk", "tk-tm", "to", "to-to", "tr", "tr-cy", "tr-tr", "tt", "tt-ru", "twq", "twq-ne", "tzm", "tzm-ma", "ug", "ug-cn", "uk", "uk-ua", "ur", "ur-in", "ur-pk", "uz", "uz-af", "uz-uz", "vai", "vai-lr", "vi", "vi-vn", "vo", "vo-001", "vun", "vun-tz", "wae", "wae-ch", "wo", "wo-sn", "xog", "xog-ug", "yav", "yav-cm", "yo", "yo-bj", "yo-ng", "yue", "yue-cn", "yue-hk", "zgh", "zgh-ma", "zh", "zh-cn", "zh-hk", "zh-mo", "zh-sg", "zh-tw", "zh-hans", "zh-hant", "zu", "zu-za"])
269
+ unless validator.valid?(language)
270
+ fail ArgumentError, "invalid value for \"language\", must be one of #{validator.allowable_values}."
271
+ end
272
+ @language = language
273
+ end
274
+
275
+ # Checks equality by comparing each attribute.
276
+ # @param [Object] Object to be compared
277
+ def ==(o)
278
+ return true if self.equal?(o)
279
+ self.class == o.class &&
280
+ id == o.id &&
281
+ score == o.score &&
282
+ type == o.type &&
283
+ domain == o.domain &&
284
+ url == o.url &&
285
+ featured_image_url == o.featured_image_url &&
286
+ language == o.language &&
287
+ title == o.title &&
288
+ description == o.description &&
289
+ category == o.category &&
290
+ subcategory == o.subcategory &&
291
+ author_full_name == o.author_full_name &&
292
+ tags == o.tags &&
293
+ table_id == o.table_id &&
294
+ row_id == o.row_id &&
295
+ published_date == o.published_date &&
296
+ combined_id == o.combined_id
297
+ end
298
+
299
+ # @see the `==` method
300
+ # @param [Object] Object to be compared
301
+ def eql?(o)
302
+ self == o
303
+ end
304
+
305
+ # Calculates hash code according to all attributes.
306
+ # @return [Integer] Hash code
307
+ def hash
308
+ [id, score, type, domain, url, featured_image_url, language, title, description, category, subcategory, author_full_name, tags, table_id, row_id, published_date, combined_id].hash
309
+ end
310
+
311
+ # Builds the object from hash
312
+ # @param [Hash] attributes Model attributes in the form of hash
313
+ # @return [Object] Returns the model itself
314
+ def self.build_from_hash(attributes)
315
+ new.build_from_hash(attributes)
316
+ end
317
+
318
+ # Builds the object from hash
319
+ # @param [Hash] attributes Model attributes in the form of hash
320
+ # @return [Object] Returns the model itself
321
+ def build_from_hash(attributes)
322
+ return nil unless attributes.is_a?(Hash)
323
+ self.class.openapi_types.each_pair do |key, type|
324
+ if type =~ /\AArray<(.*)>/i
325
+ # check to ensure the input is an array given that the attribute
326
+ # is documented as an array but the input is not
327
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
328
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
329
+ end
330
+ elsif !attributes[self.class.attribute_map[key]].nil?
331
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
332
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
333
+ end
334
+
335
+ self
336
+ end
337
+
338
+ # Deserializes the data based on type
339
+ # @param string type Data type
340
+ # @param string value Value to be deserialized
341
+ # @return [Object] Deserialized data
342
+ def _deserialize(type, value)
343
+ case type.to_sym
344
+ when :DateTime
345
+ DateTime.parse(value)
346
+ when :Date
347
+ Date.parse(value)
348
+ when :String
349
+ value.to_s
350
+ when :Integer
351
+ value.to_i
352
+ when :Float
353
+ value.to_f
354
+ when :Boolean
355
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
356
+ true
357
+ else
358
+ false
359
+ end
360
+ when :Object
361
+ # generic object (usually a Hash), return directly
362
+ value
363
+ when /\AArray<(?<inner_type>.+)>\z/
364
+ inner_type = Regexp.last_match[:inner_type]
365
+ value.map { |v| _deserialize(inner_type, v) }
366
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
367
+ k_type = Regexp.last_match[:k_type]
368
+ v_type = Regexp.last_match[:v_type]
369
+ {}.tap do |hash|
370
+ value.each do |k, v|
371
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
372
+ end
373
+ end
374
+ else # model
375
+ Hubspot::Cms::SiteSearch.const_get(type).build_from_hash(value)
376
+ end
377
+ end
378
+
379
+ # Returns the string representation of the object
380
+ # @return [String] String presentation of the object
381
+ def to_s
382
+ to_hash.to_s
383
+ end
384
+
385
+ # to_body is an alias to to_hash (backward compatibility)
386
+ # @return [Hash] Returns the object in the form of hash
387
+ def to_body
388
+ to_hash
389
+ end
390
+
391
+ # Returns the object in the form of hash
392
+ # @return [Hash] Returns the object in the form of hash
393
+ def to_hash
394
+ hash = {}
395
+ self.class.attribute_map.each_pair do |attr, param|
396
+ value = self.send(attr)
397
+ if value.nil?
398
+ is_nullable = self.class.openapi_nullable.include?(attr)
399
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
400
+ end
401
+
402
+ hash[param] = _to_hash(value)
403
+ end
404
+ hash
405
+ end
406
+
407
+ # Outputs non-array value in the form of hash
408
+ # For object, use to_hash. Otherwise, just return the value
409
+ # @param [Object] value Any valid value
410
+ # @return [Hash] Returns the value in the form of hash
411
+ def _to_hash(value)
412
+ if value.is_a?(Array)
413
+ value.compact.map { |v| _to_hash(v) }
414
+ elsif value.is_a?(Hash)
415
+ {}.tap do |hash|
416
+ value.each { |k, v| hash[k] = _to_hash(v) }
417
+ end
418
+ elsif value.respond_to? :to_hash
419
+ value.to_hash
420
+ else
421
+ value
422
+ end
423
+ end
424
+ end
425
+ end
426
+ end
427
+ end