hubspot-api-client 3.1.1 → 6.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 (330) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +28 -0
  3. data/lib/hubspot-api-client.rb +73 -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 +265 -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 +265 -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 +265 -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 +265 -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 +265 -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/associations/configuration.rb +7 -0
  56. data/lib/hubspot/codegen/crm/companies/api/associations_api.rb +2 -2
  57. data/lib/hubspot/codegen/crm/companies/api/basic_api.rb +20 -12
  58. data/lib/hubspot/codegen/crm/companies/api/batch_api.rb +40 -24
  59. data/lib/hubspot/codegen/crm/companies/api/search_api.rb +10 -6
  60. data/lib/hubspot/codegen/crm/companies/configuration.rb +7 -0
  61. data/lib/hubspot/codegen/crm/companies/models/batch_read_input_simple_public_object_id.rb +20 -20
  62. data/lib/hubspot/codegen/crm/companies/models/batch_response_simple_public_object.rb +29 -38
  63. data/lib/hubspot/codegen/crm/companies/models/batch_response_simple_public_object_with_errors.rb +333 -0
  64. data/lib/hubspot/codegen/crm/companies/models/filter.rb +15 -15
  65. data/lib/hubspot/codegen/crm/companies/models/simple_public_object_batch_input.rb +18 -18
  66. data/lib/hubspot/codegen/crm/contacts/api/associations_api.rb +2 -2
  67. data/lib/hubspot/codegen/crm/contacts/api/basic_api.rb +20 -12
  68. data/lib/hubspot/codegen/crm/contacts/api/batch_api.rb +40 -24
  69. data/lib/hubspot/codegen/crm/contacts/api/search_api.rb +10 -6
  70. data/lib/hubspot/codegen/crm/contacts/configuration.rb +7 -0
  71. data/lib/hubspot/codegen/crm/contacts/models/batch_read_input_simple_public_object_id.rb +20 -20
  72. data/lib/hubspot/codegen/crm/contacts/models/batch_response_simple_public_object.rb +29 -38
  73. data/lib/hubspot/codegen/crm/contacts/models/batch_response_simple_public_object_with_errors.rb +333 -0
  74. data/lib/hubspot/codegen/crm/contacts/models/filter.rb +15 -15
  75. data/lib/hubspot/codegen/crm/contacts/models/simple_public_object_batch_input.rb +18 -18
  76. data/lib/hubspot/codegen/crm/deals/api/associations_api.rb +2 -2
  77. data/lib/hubspot/codegen/crm/deals/api/basic_api.rb +20 -12
  78. data/lib/hubspot/codegen/crm/deals/api/batch_api.rb +40 -24
  79. data/lib/hubspot/codegen/crm/deals/api/search_api.rb +10 -6
  80. data/lib/hubspot/codegen/crm/deals/configuration.rb +7 -0
  81. data/lib/hubspot/codegen/crm/deals/models/batch_read_input_simple_public_object_id.rb +20 -20
  82. data/lib/hubspot/codegen/crm/deals/models/batch_response_simple_public_object.rb +29 -38
  83. data/lib/hubspot/codegen/crm/deals/models/batch_response_simple_public_object_with_errors.rb +333 -0
  84. data/lib/hubspot/codegen/crm/deals/models/filter.rb +15 -15
  85. data/lib/hubspot/codegen/crm/deals/models/simple_public_object_batch_input.rb +18 -18
  86. data/lib/hubspot/codegen/crm/extensions/cards/configuration.rb +7 -0
  87. data/lib/hubspot/codegen/crm/imports/api/core_api.rb +41 -41
  88. data/lib/hubspot/codegen/crm/imports/configuration.rb +7 -0
  89. data/lib/hubspot/codegen/crm/line_items/api/associations_api.rb +2 -2
  90. data/lib/hubspot/codegen/crm/line_items/api/basic_api.rb +20 -12
  91. data/lib/hubspot/codegen/crm/line_items/api/batch_api.rb +40 -24
  92. data/lib/hubspot/codegen/crm/line_items/api/search_api.rb +10 -6
  93. data/lib/hubspot/codegen/crm/line_items/configuration.rb +7 -0
  94. data/lib/hubspot/codegen/crm/line_items/models/batch_read_input_simple_public_object_id.rb +20 -20
  95. data/lib/hubspot/codegen/crm/line_items/models/batch_response_simple_public_object.rb +29 -38
  96. data/lib/hubspot/codegen/crm/line_items/models/batch_response_simple_public_object_with_errors.rb +333 -0
  97. data/lib/hubspot/codegen/crm/line_items/models/filter.rb +15 -15
  98. data/lib/hubspot/codegen/crm/line_items/models/simple_public_object_batch_input.rb +18 -18
  99. data/lib/hubspot/codegen/crm/owners/api/default_api.rb +0 -2
  100. data/lib/hubspot/codegen/crm/owners/configuration.rb +7 -0
  101. data/lib/hubspot/codegen/crm/pipelines/configuration.rb +7 -0
  102. data/lib/hubspot/codegen/crm/products/api/associations_api.rb +2 -2
  103. data/lib/hubspot/codegen/crm/products/api/basic_api.rb +20 -12
  104. data/lib/hubspot/codegen/crm/products/api/batch_api.rb +40 -24
  105. data/lib/hubspot/codegen/crm/products/api/search_api.rb +10 -6
  106. data/lib/hubspot/codegen/crm/products/configuration.rb +7 -0
  107. data/lib/hubspot/codegen/crm/products/models/batch_read_input_simple_public_object_id.rb +20 -20
  108. data/lib/hubspot/codegen/crm/products/models/batch_response_simple_public_object.rb +29 -38
  109. data/lib/hubspot/codegen/crm/products/models/batch_response_simple_public_object_with_errors.rb +333 -0
  110. data/lib/hubspot/codegen/crm/products/models/filter.rb +15 -15
  111. data/lib/hubspot/codegen/crm/products/models/simple_public_object_batch_input.rb +18 -18
  112. data/lib/hubspot/codegen/crm/properties/api/batch_api.rb +30 -18
  113. data/lib/hubspot/codegen/crm/properties/api/core_api.rb +20 -12
  114. data/lib/hubspot/codegen/crm/properties/api/groups_api.rb +20 -12
  115. data/lib/hubspot/codegen/crm/properties/configuration.rb +7 -0
  116. data/lib/hubspot/codegen/crm/properties/models/batch_read_input_property_name.rb +18 -18
  117. data/lib/hubspot/codegen/crm/properties/models/batch_response_property.rb +29 -23
  118. data/lib/hubspot/codegen/crm/properties/models/property_create.rb +14 -4
  119. data/lib/hubspot/codegen/crm/properties/models/property_update.rb +14 -4
  120. data/lib/hubspot/codegen/crm/quotes/api/associations_api.rb +1 -157
  121. data/lib/hubspot/codegen/crm/quotes/api/basic_api.rb +2 -190
  122. data/lib/hubspot/codegen/crm/quotes/api/batch_api.rb +11 -187
  123. data/lib/hubspot/codegen/crm/quotes/api/default_api.rb +426 -0
  124. data/lib/hubspot/codegen/crm/quotes/api/search_api.rb +11 -7
  125. data/lib/hubspot/codegen/crm/quotes/configuration.rb +7 -0
  126. data/lib/hubspot/codegen/crm/quotes/models/batch_read_input_simple_public_object_id.rb +20 -20
  127. data/lib/hubspot/codegen/crm/quotes/models/batch_response_simple_public_object.rb +29 -38
  128. data/lib/hubspot/codegen/crm/quotes/models/batch_response_simple_public_object_with_errors.rb +333 -0
  129. data/lib/hubspot/codegen/crm/quotes/models/filter.rb +15 -15
  130. data/lib/hubspot/codegen/crm/quotes/models/simple_public_object_batch_input.rb +18 -18
  131. data/lib/hubspot/codegen/crm/tickets/api/associations_api.rb +2 -2
  132. data/lib/hubspot/codegen/crm/tickets/api/basic_api.rb +20 -12
  133. data/lib/hubspot/codegen/crm/tickets/api/batch_api.rb +40 -24
  134. data/lib/hubspot/codegen/crm/tickets/api/search_api.rb +10 -6
  135. data/lib/hubspot/codegen/crm/tickets/configuration.rb +7 -0
  136. data/lib/hubspot/codegen/crm/tickets/models/batch_read_input_simple_public_object_id.rb +20 -20
  137. data/lib/hubspot/codegen/crm/tickets/models/batch_response_simple_public_object.rb +29 -38
  138. data/lib/hubspot/codegen/crm/tickets/models/batch_response_simple_public_object_with_errors.rb +333 -0
  139. data/lib/hubspot/codegen/crm/tickets/models/filter.rb +15 -15
  140. data/lib/hubspot/codegen/crm/tickets/models/simple_public_object_batch_input.rb +18 -18
  141. data/lib/hubspot/codegen/crm/timeline/configuration.rb +7 -0
  142. data/lib/hubspot/codegen/oauth/configuration.rb +7 -0
  143. data/lib/hubspot/codegen/webhooks/api/subscriptions_api.rb +70 -0
  144. data/lib/hubspot/codegen/webhooks/configuration.rb +7 -0
  145. data/lib/hubspot/codegen/webhooks/models/batch_input_subscription_batch_update_request.rb +215 -0
  146. data/lib/hubspot/codegen/webhooks/models/batch_response_subscription_response.rb +331 -0
  147. data/lib/hubspot/codegen/webhooks/models/subscription_batch_update_request.rb +227 -0
  148. data/lib/hubspot/exceptions.rb +11 -0
  149. data/lib/hubspot/helpers/webhooks_helper.rb +31 -0
  150. data/lib/hubspot/version.rb +1 -1
  151. data/sample-apps/imports-contacts-app/.env.template +2 -0
  152. data/sample-apps/imports-contacts-app/.env.test.template +3 -0
  153. data/sample-apps/imports-contacts-app/.gitignore +37 -0
  154. data/sample-apps/imports-contacts-app/.rspec +1 -0
  155. data/sample-apps/imports-contacts-app/.ruby-version +1 -0
  156. data/sample-apps/imports-contacts-app/Dockerfile +22 -0
  157. data/sample-apps/imports-contacts-app/Gemfile +33 -0
  158. data/sample-apps/imports-contacts-app/Gemfile.lock +271 -0
  159. data/sample-apps/imports-contacts-app/README.md +27 -0
  160. data/sample-apps/imports-contacts-app/Rakefile +6 -0
  161. data/sample-apps/imports-contacts-app/app/assets/config/manifest.js +3 -0
  162. data/sample-apps/imports-contacts-app/app/assets/images/.keep +0 -0
  163. data/sample-apps/imports-contacts-app/app/assets/javascripts/application.js +15 -0
  164. data/sample-apps/imports-contacts-app/app/assets/javascripts/cable.js +13 -0
  165. data/sample-apps/imports-contacts-app/app/assets/javascripts/channels/.keep +0 -0
  166. data/sample-apps/imports-contacts-app/app/assets/stylesheets/application.css +87 -0
  167. data/sample-apps/imports-contacts-app/app/controllers/application_controller.rb +12 -0
  168. data/sample-apps/imports-contacts-app/app/controllers/concerns/.keep +0 -0
  169. data/sample-apps/imports-contacts-app/app/controllers/concerns/exception_handler.rb +12 -0
  170. data/sample-apps/imports-contacts-app/app/controllers/imports_controller.rb +24 -0
  171. data/sample-apps/imports-contacts-app/app/controllers/oauth/authorization_controller.rb +19 -0
  172. data/sample-apps/imports-contacts-app/app/helpers/application_helper.rb +2 -0
  173. data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/authorize_hubspot.rb +0 -0
  174. data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/get_authorization_uri.rb +1 -1
  175. data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/tokens/base.rb +0 -0
  176. data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/tokens/generate.rb +2 -2
  177. data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/tokens/refresh.rb +3 -4
  178. data/sample-apps/imports-contacts-app/app/lib/services/hubspot/imports/create.rb +52 -0
  179. data/sample-apps/imports-contacts-app/app/models/application_record.rb +3 -0
  180. data/sample-apps/imports-contacts-app/app/models/concerns/.keep +0 -0
  181. data/sample-apps/imports-contacts-app/app/views/imports/index.html.erb +70 -0
  182. data/sample-apps/imports-contacts-app/app/views/layouts/application.html.erb +23 -0
  183. data/sample-apps/imports-contacts-app/app/views/oauth/authorization/login.html.erb +15 -0
  184. data/sample-apps/imports-contacts-app/app/views/shared/_header.html.erb +15 -0
  185. data/sample-apps/imports-contacts-app/bin/bundle +3 -0
  186. data/sample-apps/imports-contacts-app/bin/rails +9 -0
  187. data/sample-apps/imports-contacts-app/bin/rake +9 -0
  188. data/sample-apps/imports-contacts-app/bin/setup +36 -0
  189. data/sample-apps/imports-contacts-app/bin/spring +17 -0
  190. data/sample-apps/imports-contacts-app/bin/update +31 -0
  191. data/sample-apps/imports-contacts-app/bin/yarn +11 -0
  192. data/sample-apps/imports-contacts-app/config.ru +5 -0
  193. data/sample-apps/imports-contacts-app/config/application.rb +19 -0
  194. data/sample-apps/imports-contacts-app/config/boot.rb +3 -0
  195. data/sample-apps/imports-contacts-app/config/cable.yml +10 -0
  196. data/sample-apps/imports-contacts-app/config/database.yml +25 -0
  197. data/sample-apps/imports-contacts-app/config/environment.rb +5 -0
  198. data/sample-apps/imports-contacts-app/config/environments/development.rb +61 -0
  199. data/sample-apps/imports-contacts-app/config/environments/production.rb +94 -0
  200. data/sample-apps/imports-contacts-app/config/environments/test.rb +46 -0
  201. data/sample-apps/imports-contacts-app/config/initializers/assets.rb +14 -0
  202. data/sample-apps/imports-contacts-app/config/initializers/filter_parameter_logging.rb +4 -0
  203. data/sample-apps/imports-contacts-app/config/initializers/hubspot-api-client.rb +3 -0
  204. data/sample-apps/imports-contacts-app/config/initializers/mime_types.rb +1 -0
  205. data/sample-apps/imports-contacts-app/config/initializers/wrap_parameters.rb +14 -0
  206. data/sample-apps/imports-contacts-app/config/locales/en.yml +33 -0
  207. data/sample-apps/imports-contacts-app/config/puma.rb +34 -0
  208. data/sample-apps/imports-contacts-app/config/routes.rb +11 -0
  209. data/sample-apps/imports-contacts-app/config/spring.rb +6 -0
  210. data/sample-apps/imports-contacts-app/db/seeds.rb +7 -0
  211. data/sample-apps/imports-contacts-app/docker-compose.yml +11 -0
  212. data/sample-apps/imports-contacts-app/docker-entrypoint.sh +8 -0
  213. data/sample-apps/imports-contacts-app/lib/assets/.keep +0 -0
  214. data/sample-apps/imports-contacts-app/lib/tasks/.keep +0 -0
  215. data/sample-apps/imports-contacts-app/log/.keep +0 -0
  216. data/sample-apps/imports-contacts-app/package.json +5 -0
  217. data/sample-apps/imports-contacts-app/public/404.html +67 -0
  218. data/sample-apps/imports-contacts-app/public/422.html +67 -0
  219. data/sample-apps/imports-contacts-app/public/500.html +66 -0
  220. data/sample-apps/imports-contacts-app/public/apple-touch-icon-precomposed.png +0 -0
  221. data/sample-apps/imports-contacts-app/public/apple-touch-icon.png +0 -0
  222. data/sample-apps/imports-contacts-app/public/examples/example.csv +2 -0
  223. data/sample-apps/imports-contacts-app/public/favicon.ico +0 -0
  224. data/sample-apps/imports-contacts-app/public/robots.txt +1 -0
  225. data/sample-apps/imports-contacts-app/tmp/.keep +0 -0
  226. data/sample-apps/search-result-paging-app/.env.template +4 -0
  227. data/sample-apps/search-result-paging-app/.gitignore +35 -0
  228. data/sample-apps/search-result-paging-app/.rspec +1 -0
  229. data/sample-apps/search-result-paging-app/.ruby-version +1 -0
  230. data/sample-apps/search-result-paging-app/Dockerfile +22 -0
  231. data/sample-apps/search-result-paging-app/Gemfile +35 -0
  232. data/sample-apps/search-result-paging-app/Gemfile.lock +279 -0
  233. data/sample-apps/search-result-paging-app/README.md +0 -0
  234. data/sample-apps/search-result-paging-app/Rakefile +6 -0
  235. data/sample-apps/search-result-paging-app/app/assets/config/manifest.js +3 -0
  236. data/sample-apps/search-result-paging-app/app/assets/images/.keep +0 -0
  237. data/sample-apps/search-result-paging-app/app/assets/javascripts/application.js +25 -0
  238. data/sample-apps/search-result-paging-app/app/assets/javascripts/cable.js +13 -0
  239. data/sample-apps/search-result-paging-app/app/assets/javascripts/channels/.keep +0 -0
  240. data/sample-apps/search-result-paging-app/app/assets/stylesheets/application.css +77 -0
  241. data/sample-apps/search-result-paging-app/app/controllers/application_controller.rb +12 -0
  242. data/sample-apps/search-result-paging-app/app/controllers/concerns/.keep +0 -0
  243. data/sample-apps/search-result-paging-app/app/controllers/concerns/exception_handler.rb +12 -0
  244. data/sample-apps/search-result-paging-app/app/controllers/home_controller.rb +14 -0
  245. data/sample-apps/search-result-paging-app/app/controllers/oauth/authorization_controller.rb +19 -0
  246. data/sample-apps/search-result-paging-app/app/helpers/application_helper.rb +2 -0
  247. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/authorization/authorize.rb +17 -0
  248. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/authorization/get_authorization_uri.rb +35 -0
  249. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/authorization/tokens/base.rb +21 -0
  250. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/authorization/tokens/generate.rb +28 -0
  251. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/authorization/tokens/refresh.rb +35 -0
  252. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/contacts/get_page.rb +26 -0
  253. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/contacts/search.rb +35 -0
  254. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/properties/create.rb +23 -0
  255. data/sample-apps/search-result-paging-app/app/lib/services/hubspot/properties/destroy.rb +16 -0
  256. data/sample-apps/search-result-paging-app/app/models/application_record.rb +3 -0
  257. data/sample-apps/search-result-paging-app/app/models/concerns/.keep +0 -0
  258. data/sample-apps/search-result-paging-app/app/views/home/index.html.erb +13 -0
  259. data/sample-apps/search-result-paging-app/app/views/layouts/application.html.erb +23 -0
  260. data/sample-apps/search-result-paging-app/app/views/oauth/authorization/login.html.erb +15 -0
  261. data/sample-apps/search-result-paging-app/app/views/shared/_header.html.erb +18 -0
  262. data/sample-apps/search-result-paging-app/bin/bundle +3 -0
  263. data/sample-apps/search-result-paging-app/bin/rails +9 -0
  264. data/sample-apps/search-result-paging-app/bin/rake +9 -0
  265. data/sample-apps/search-result-paging-app/bin/setup +36 -0
  266. data/sample-apps/search-result-paging-app/bin/spring +17 -0
  267. data/sample-apps/search-result-paging-app/bin/update +31 -0
  268. data/sample-apps/search-result-paging-app/bin/yarn +11 -0
  269. data/sample-apps/search-result-paging-app/config.ru +5 -0
  270. data/sample-apps/search-result-paging-app/config/application.rb +19 -0
  271. data/sample-apps/search-result-paging-app/config/boot.rb +3 -0
  272. data/sample-apps/search-result-paging-app/config/cable.yml +10 -0
  273. data/sample-apps/search-result-paging-app/config/database.yml +25 -0
  274. data/sample-apps/search-result-paging-app/config/environment.rb +5 -0
  275. data/sample-apps/search-result-paging-app/config/environments/development.rb +61 -0
  276. data/sample-apps/search-result-paging-app/config/environments/production.rb +94 -0
  277. data/sample-apps/search-result-paging-app/config/environments/test.rb +46 -0
  278. data/sample-apps/search-result-paging-app/config/initializers/assets.rb +14 -0
  279. data/sample-apps/search-result-paging-app/config/initializers/filter_parameter_logging.rb +4 -0
  280. data/sample-apps/search-result-paging-app/config/initializers/hubspot-api-client.rb +3 -0
  281. data/sample-apps/search-result-paging-app/config/initializers/mime_types.rb +1 -0
  282. data/sample-apps/search-result-paging-app/config/initializers/wrap_parameters.rb +14 -0
  283. data/sample-apps/search-result-paging-app/config/locales/en.yml +33 -0
  284. data/sample-apps/search-result-paging-app/config/puma.rb +34 -0
  285. data/sample-apps/search-result-paging-app/config/routes.rb +7 -0
  286. data/sample-apps/search-result-paging-app/config/spring.rb +6 -0
  287. data/sample-apps/search-result-paging-app/db/seeds.rb +7 -0
  288. data/sample-apps/search-result-paging-app/docker-compose.yml +11 -0
  289. data/sample-apps/search-result-paging-app/docker-entrypoint.sh +8 -0
  290. data/sample-apps/search-result-paging-app/lib/assets/.keep +0 -0
  291. data/sample-apps/search-result-paging-app/lib/tasks/.keep +0 -0
  292. data/sample-apps/search-result-paging-app/lib/tasks/search_contacts.rake +36 -0
  293. data/sample-apps/search-result-paging-app/log/.keep +0 -0
  294. data/sample-apps/search-result-paging-app/package.json +5 -0
  295. data/sample-apps/search-result-paging-app/public/404.html +67 -0
  296. data/sample-apps/search-result-paging-app/public/422.html +67 -0
  297. data/sample-apps/search-result-paging-app/public/500.html +66 -0
  298. data/sample-apps/search-result-paging-app/public/apple-touch-icon-precomposed.png +0 -0
  299. data/sample-apps/search-result-paging-app/public/apple-touch-icon.png +0 -0
  300. data/sample-apps/search-result-paging-app/public/favicon.ico +0 -0
  301. data/sample-apps/search-result-paging-app/public/robots.txt +1 -0
  302. data/sample-apps/search-result-paging-app/tmp/.keep +0 -0
  303. data/sample-apps/trello-integration-app/.env +13 -0
  304. data/sample-apps/webhooks-contacts-app/.env.template +3 -1
  305. data/sample-apps/webhooks-contacts-app/Gemfile.lock +1 -1
  306. data/sample-apps/webhooks-contacts-app/README.md +24 -21
  307. data/sample-apps/webhooks-contacts-app/app/assets/stylesheets/application.css +7 -55
  308. data/sample-apps/webhooks-contacts-app/app/controllers/events_controller.rb +8 -10
  309. data/sample-apps/webhooks-contacts-app/app/controllers/home_controller.rb +44 -0
  310. data/sample-apps/webhooks-contacts-app/app/controllers/oauth/authorization_controller.rb +6 -6
  311. data/sample-apps/webhooks-contacts-app/app/controllers/webhooks_controller.rb +1 -1
  312. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/authorize.rb +17 -0
  313. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/get_authorization_uri.rb +35 -0
  314. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/tokens/base.rb +21 -0
  315. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/tokens/generate.rb +28 -0
  316. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/tokens/refresh.rb +35 -0
  317. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/webhooks/configure_target_url.rb +25 -0
  318. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/webhooks/create_or_activate_subscription.rb +44 -0
  319. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/webhooks/handle.rb +13 -1
  320. data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/webhooks/pause_active_subscriptions.rb +39 -0
  321. data/sample-apps/webhooks-contacts-app/app/models/event.rb +3 -0
  322. data/sample-apps/webhooks-contacts-app/app/views/events/index.html.erb +14 -16
  323. data/sample-apps/webhooks-contacts-app/app/views/home/index.html.erb +47 -0
  324. data/sample-apps/webhooks-contacts-app/app/views/oauth/authorization/login.html.erb +6 -6
  325. data/sample-apps/webhooks-contacts-app/app/views/shared/_header.html.erb +3 -0
  326. data/sample-apps/webhooks-contacts-app/config/database.yml +9 -9
  327. data/sample-apps/webhooks-contacts-app/config/routes.rb +2 -0
  328. data/sample-apps/webhooks-contacts-app/db/schema.rb +2 -5
  329. data/sample-apps/webhooks-contacts-app/docker-compose.yml +13 -10
  330. metadata +618 -7
@@ -0,0 +1,306 @@
1
+ =begin
2
+ #URL redirects
3
+
4
+ #URL redirect operations
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 UrlRedirects
18
+ class UrlMappingCreateRequestBody
19
+ attr_accessor :route_prefix
20
+
21
+ attr_accessor :destination
22
+
23
+ attr_accessor :redirect_style
24
+
25
+ attr_accessor :precedence
26
+
27
+ attr_accessor :is_only_after_not_found
28
+
29
+ attr_accessor :is_match_full_url
30
+
31
+ attr_accessor :is_match_query_string
32
+
33
+ attr_accessor :is_pattern
34
+
35
+ attr_accessor :is_trailing_slash_optional
36
+
37
+ attr_accessor :is_protocol_agnostic
38
+
39
+ # Attribute mapping from ruby-style variable name to JSON key.
40
+ def self.attribute_map
41
+ {
42
+ :'route_prefix' => :'routePrefix',
43
+ :'destination' => :'destination',
44
+ :'redirect_style' => :'redirectStyle',
45
+ :'precedence' => :'precedence',
46
+ :'is_only_after_not_found' => :'isOnlyAfterNotFound',
47
+ :'is_match_full_url' => :'isMatchFullUrl',
48
+ :'is_match_query_string' => :'isMatchQueryString',
49
+ :'is_pattern' => :'isPattern',
50
+ :'is_trailing_slash_optional' => :'isTrailingSlashOptional',
51
+ :'is_protocol_agnostic' => :'isProtocolAgnostic'
52
+ }
53
+ end
54
+
55
+ # Attribute type mapping.
56
+ def self.openapi_types
57
+ {
58
+ :'route_prefix' => :'String',
59
+ :'destination' => :'String',
60
+ :'redirect_style' => :'Integer',
61
+ :'precedence' => :'Integer',
62
+ :'is_only_after_not_found' => :'Boolean',
63
+ :'is_match_full_url' => :'Boolean',
64
+ :'is_match_query_string' => :'Boolean',
65
+ :'is_pattern' => :'Boolean',
66
+ :'is_trailing_slash_optional' => :'Boolean',
67
+ :'is_protocol_agnostic' => :'Boolean'
68
+ }
69
+ end
70
+
71
+ # List of attributes with nullable: true
72
+ def self.openapi_nullable
73
+ Set.new([
74
+ ])
75
+ end
76
+
77
+ # Initializes the object
78
+ # @param [Hash] attributes Model attributes in the form of hash
79
+ def initialize(attributes = {})
80
+ if (!attributes.is_a?(Hash))
81
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Cms::UrlRedirects::UrlMappingCreateRequestBody` initialize method"
82
+ end
83
+
84
+ # check to see if the attribute exists and convert string to symbol for hash key
85
+ attributes = attributes.each_with_object({}) { |(k, v), h|
86
+ if (!self.class.attribute_map.key?(k.to_sym))
87
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Cms::UrlRedirects::UrlMappingCreateRequestBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
88
+ end
89
+ h[k.to_sym] = v
90
+ }
91
+
92
+ if attributes.key?(:'route_prefix')
93
+ self.route_prefix = attributes[:'route_prefix']
94
+ end
95
+
96
+ if attributes.key?(:'destination')
97
+ self.destination = attributes[:'destination']
98
+ end
99
+
100
+ if attributes.key?(:'redirect_style')
101
+ self.redirect_style = attributes[:'redirect_style']
102
+ end
103
+
104
+ if attributes.key?(:'precedence')
105
+ self.precedence = attributes[:'precedence']
106
+ end
107
+
108
+ if attributes.key?(:'is_only_after_not_found')
109
+ self.is_only_after_not_found = attributes[:'is_only_after_not_found']
110
+ end
111
+
112
+ if attributes.key?(:'is_match_full_url')
113
+ self.is_match_full_url = attributes[:'is_match_full_url']
114
+ end
115
+
116
+ if attributes.key?(:'is_match_query_string')
117
+ self.is_match_query_string = attributes[:'is_match_query_string']
118
+ end
119
+
120
+ if attributes.key?(:'is_pattern')
121
+ self.is_pattern = attributes[:'is_pattern']
122
+ end
123
+
124
+ if attributes.key?(:'is_trailing_slash_optional')
125
+ self.is_trailing_slash_optional = attributes[:'is_trailing_slash_optional']
126
+ end
127
+
128
+ if attributes.key?(:'is_protocol_agnostic')
129
+ self.is_protocol_agnostic = attributes[:'is_protocol_agnostic']
130
+ end
131
+ end
132
+
133
+ # Show invalid properties with the reasons. Usually used together with valid?
134
+ # @return Array for valid properties with the reasons
135
+ def list_invalid_properties
136
+ invalid_properties = Array.new
137
+ if @route_prefix.nil?
138
+ invalid_properties.push('invalid value for "route_prefix", route_prefix cannot be nil.')
139
+ end
140
+
141
+ if @destination.nil?
142
+ invalid_properties.push('invalid value for "destination", destination cannot be nil.')
143
+ end
144
+
145
+ if @redirect_style.nil?
146
+ invalid_properties.push('invalid value for "redirect_style", redirect_style cannot be nil.')
147
+ end
148
+
149
+ invalid_properties
150
+ end
151
+
152
+ # Check to see if the all the properties in the model are valid
153
+ # @return true if the model is valid
154
+ def valid?
155
+ return false if @route_prefix.nil?
156
+ return false if @destination.nil?
157
+ return false if @redirect_style.nil?
158
+ true
159
+ end
160
+
161
+ # Checks equality by comparing each attribute.
162
+ # @param [Object] Object to be compared
163
+ def ==(o)
164
+ return true if self.equal?(o)
165
+ self.class == o.class &&
166
+ route_prefix == o.route_prefix &&
167
+ destination == o.destination &&
168
+ redirect_style == o.redirect_style &&
169
+ precedence == o.precedence &&
170
+ is_only_after_not_found == o.is_only_after_not_found &&
171
+ is_match_full_url == o.is_match_full_url &&
172
+ is_match_query_string == o.is_match_query_string &&
173
+ is_pattern == o.is_pattern &&
174
+ is_trailing_slash_optional == o.is_trailing_slash_optional &&
175
+ is_protocol_agnostic == o.is_protocol_agnostic
176
+ end
177
+
178
+ # @see the `==` method
179
+ # @param [Object] Object to be compared
180
+ def eql?(o)
181
+ self == o
182
+ end
183
+
184
+ # Calculates hash code according to all attributes.
185
+ # @return [Integer] Hash code
186
+ def hash
187
+ [route_prefix, destination, redirect_style, precedence, is_only_after_not_found, is_match_full_url, is_match_query_string, is_pattern, is_trailing_slash_optional, is_protocol_agnostic].hash
188
+ end
189
+
190
+ # Builds the object from hash
191
+ # @param [Hash] attributes Model attributes in the form of hash
192
+ # @return [Object] Returns the model itself
193
+ def self.build_from_hash(attributes)
194
+ new.build_from_hash(attributes)
195
+ end
196
+
197
+ # Builds the object from hash
198
+ # @param [Hash] attributes Model attributes in the form of hash
199
+ # @return [Object] Returns the model itself
200
+ def build_from_hash(attributes)
201
+ return nil unless attributes.is_a?(Hash)
202
+ self.class.openapi_types.each_pair do |key, type|
203
+ if type =~ /\AArray<(.*)>/i
204
+ # check to ensure the input is an array given that the attribute
205
+ # is documented as an array but the input is not
206
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
207
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
208
+ end
209
+ elsif !attributes[self.class.attribute_map[key]].nil?
210
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
211
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
212
+ end
213
+
214
+ self
215
+ end
216
+
217
+ # Deserializes the data based on type
218
+ # @param string type Data type
219
+ # @param string value Value to be deserialized
220
+ # @return [Object] Deserialized data
221
+ def _deserialize(type, value)
222
+ case type.to_sym
223
+ when :DateTime
224
+ DateTime.parse(value)
225
+ when :Date
226
+ Date.parse(value)
227
+ when :String
228
+ value.to_s
229
+ when :Integer
230
+ value.to_i
231
+ when :Float
232
+ value.to_f
233
+ when :Boolean
234
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
235
+ true
236
+ else
237
+ false
238
+ end
239
+ when :Object
240
+ # generic object (usually a Hash), return directly
241
+ value
242
+ when /\AArray<(?<inner_type>.+)>\z/
243
+ inner_type = Regexp.last_match[:inner_type]
244
+ value.map { |v| _deserialize(inner_type, v) }
245
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
246
+ k_type = Regexp.last_match[:k_type]
247
+ v_type = Regexp.last_match[:v_type]
248
+ {}.tap do |hash|
249
+ value.each do |k, v|
250
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
251
+ end
252
+ end
253
+ else # model
254
+ Hubspot::Cms::UrlRedirects.const_get(type).build_from_hash(value)
255
+ end
256
+ end
257
+
258
+ # Returns the string representation of the object
259
+ # @return [String] String presentation of the object
260
+ def to_s
261
+ to_hash.to_s
262
+ end
263
+
264
+ # to_body is an alias to to_hash (backward compatibility)
265
+ # @return [Hash] Returns the object in the form of hash
266
+ def to_body
267
+ to_hash
268
+ end
269
+
270
+ # Returns the object in the form of hash
271
+ # @return [Hash] Returns the object in the form of hash
272
+ def to_hash
273
+ hash = {}
274
+ self.class.attribute_map.each_pair do |attr, param|
275
+ value = self.send(attr)
276
+ if value.nil?
277
+ is_nullable = self.class.openapi_nullable.include?(attr)
278
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
279
+ end
280
+
281
+ hash[param] = _to_hash(value)
282
+ end
283
+ hash
284
+ end
285
+
286
+ # Outputs non-array value in the form of hash
287
+ # For object, use to_hash. Otherwise, just return the value
288
+ # @param [Object] value Any valid value
289
+ # @return [Hash] Returns the value in the form of hash
290
+ def _to_hash(value)
291
+ if value.is_a?(Array)
292
+ value.compact.map { |v| _to_hash(v) }
293
+ elsif value.is_a?(Hash)
294
+ {}.tap do |hash|
295
+ value.each { |k, v| hash[k] = _to_hash(v) }
296
+ end
297
+ elsif value.respond_to? :to_hash
298
+ value.to_hash
299
+ else
300
+ value
301
+ end
302
+ end
303
+ end
304
+ end
305
+ end
306
+ end
@@ -194,6 +194,13 @@ module Hubspot
194
194
  # Returns Auth Settings hash for api client.
195
195
  def auth_settings
196
196
  {
197
+ 'developer-hapikey' =>
198
+ {
199
+ type: 'api_key',
200
+ in: 'query',
201
+ key: 'hapikey',
202
+ value: api_key_with_prefix('hapikey')
203
+ },
197
204
  'hapikey' =>
198
205
  {
199
206
  type: 'api_key',
@@ -99,7 +99,7 @@ module Hubspot
99
99
  return data, status_code, headers
100
100
  end
101
101
 
102
- # Associate two companies
102
+ # Associate a company with another object
103
103
  # @param company_id [String]
104
104
  # @param to_object_type [String]
105
105
  # @param to_object_id [String]
@@ -111,7 +111,7 @@ module Hubspot
111
111
  data
112
112
  end
113
113
 
114
- # Associate two companies
114
+ # Associate a company with another object
115
115
  # @param company_id [String]
116
116
  # @param to_object_type [String]
117
117
  # @param to_object_id [String]
@@ -87,23 +87,27 @@ module Hubspot
87
87
 
88
88
  # Create
89
89
  # Create a company with the given properties and return a copy of the object, including the ID. Documentation and examples for creating native companies is provided.
90
+ # @param simple_public_object_input [SimplePublicObjectInput]
90
91
  # @param [Hash] opts the optional parameters
91
- # @option opts [SimplePublicObjectInput] :simple_public_object_input
92
92
  # @return [SimplePublicObject]
93
- def create(opts = {})
94
- data, _status_code, _headers = create_with_http_info(opts)
93
+ def create(simple_public_object_input, opts = {})
94
+ data, _status_code, _headers = create_with_http_info(simple_public_object_input, opts)
95
95
  data
96
96
  end
97
97
 
98
98
  # Create
99
99
  # Create a company with the given properties and return a copy of the object, including the ID. Documentation and examples for creating native companies is provided.
100
+ # @param simple_public_object_input [SimplePublicObjectInput]
100
101
  # @param [Hash] opts the optional parameters
101
- # @option opts [SimplePublicObjectInput] :simple_public_object_input
102
102
  # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
103
- def create_with_http_info(opts = {})
103
+ def create_with_http_info(simple_public_object_input, opts = {})
104
104
  if @api_client.config.debugging
105
105
  @api_client.config.logger.debug 'Calling API: BasicApi.create ...'
106
106
  end
107
+ # verify the required parameter 'simple_public_object_input' is set
108
+ if @api_client.config.client_side_validation && simple_public_object_input.nil?
109
+ fail ArgumentError, "Missing the required parameter 'simple_public_object_input' when calling BasicApi.create"
110
+ end
107
111
  # resource path
108
112
  local_var_path = '/crm/v3/objects/companies'
109
113
 
@@ -121,7 +125,7 @@ module Hubspot
121
125
  form_params = opts[:form_params] || {}
122
126
 
123
127
  # http body (model)
124
- post_body = opts[:body] || @api_client.object_to_http_body(opts[:'simple_public_object_input'])
128
+ post_body = opts[:body] || @api_client.object_to_http_body(simple_public_object_input)
125
129
 
126
130
  # return_type
127
131
  return_type = opts[:return_type] || 'SimplePublicObject'
@@ -293,21 +297,21 @@ module Hubspot
293
297
  # Update
294
298
  # Perform a partial update of an Object identified by `{companyId}`. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
295
299
  # @param company_id [String]
300
+ # @param simple_public_object_input [SimplePublicObjectInput]
296
301
  # @param [Hash] opts the optional parameters
297
- # @option opts [SimplePublicObjectInput] :simple_public_object_input
298
302
  # @return [SimplePublicObject]
299
- def update(company_id, opts = {})
300
- data, _status_code, _headers = update_with_http_info(company_id, opts)
303
+ def update(company_id, simple_public_object_input, opts = {})
304
+ data, _status_code, _headers = update_with_http_info(company_id, simple_public_object_input, opts)
301
305
  data
302
306
  end
303
307
 
304
308
  # Update
305
309
  # Perform a partial update of an Object identified by &#x60;{companyId}&#x60;. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
306
310
  # @param company_id [String]
311
+ # @param simple_public_object_input [SimplePublicObjectInput]
307
312
  # @param [Hash] opts the optional parameters
308
- # @option opts [SimplePublicObjectInput] :simple_public_object_input
309
313
  # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
310
- def update_with_http_info(company_id, opts = {})
314
+ def update_with_http_info(company_id, simple_public_object_input, opts = {})
311
315
  if @api_client.config.debugging
312
316
  @api_client.config.logger.debug 'Calling API: BasicApi.update ...'
313
317
  end
@@ -315,6 +319,10 @@ module Hubspot
315
319
  if @api_client.config.client_side_validation && company_id.nil?
316
320
  fail ArgumentError, "Missing the required parameter 'company_id' when calling BasicApi.update"
317
321
  end
322
+ # verify the required parameter 'simple_public_object_input' is set
323
+ if @api_client.config.client_side_validation && simple_public_object_input.nil?
324
+ fail ArgumentError, "Missing the required parameter 'simple_public_object_input' when calling BasicApi.update"
325
+ end
318
326
  # resource path
319
327
  local_var_path = '/crm/v3/objects/companies/{companyId}'.sub('{' + 'companyId' + '}', CGI.escape(company_id.to_s))
320
328
 
@@ -332,7 +340,7 @@ module Hubspot
332
340
  form_params = opts[:form_params] || {}
333
341
 
334
342
  # http body (model)
335
- post_body = opts[:body] || @api_client.object_to_http_body(opts[:'simple_public_object_input'])
343
+ post_body = opts[:body] || @api_client.object_to_http_body(simple_public_object_input)
336
344
 
337
345
  # return_type
338
346
  return_type = opts[:return_type] || 'SimplePublicObject'
@@ -23,23 +23,27 @@ module Hubspot
23
23
  end
24
24
  # Archive a batch of companies by ID
25
25
  # Archive a list of companies given a collection of IDs. This method will return a `204 No Content` response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).
26
+ # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId]
26
27
  # @param [Hash] opts the optional parameters
27
- # @option opts [BatchInputSimplePublicObjectId] :batch_input_simple_public_object_id
28
28
  # @return [nil]
29
- def archive(opts = {})
30
- archive_with_http_info(opts)
29
+ def archive(batch_input_simple_public_object_id, opts = {})
30
+ archive_with_http_info(batch_input_simple_public_object_id, opts)
31
31
  nil
32
32
  end
33
33
 
34
34
  # Archive a batch of companies by ID
35
35
  # Archive a list of companies given a collection of IDs. This method will return a &#x60;204 No Content&#x60; response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).
36
+ # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId]
36
37
  # @param [Hash] opts the optional parameters
37
- # @option opts [BatchInputSimplePublicObjectId] :batch_input_simple_public_object_id
38
38
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
39
- def archive_with_http_info(opts = {})
39
+ def archive_with_http_info(batch_input_simple_public_object_id, opts = {})
40
40
  if @api_client.config.debugging
41
41
  @api_client.config.logger.debug 'Calling API: BatchApi.archive ...'
42
42
  end
43
+ # verify the required parameter 'batch_input_simple_public_object_id' is set
44
+ if @api_client.config.client_side_validation && batch_input_simple_public_object_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_id' when calling BatchApi.archive"
46
+ end
43
47
  # resource path
44
48
  local_var_path = '/crm/v3/objects/companies/batch/archive'
45
49
 
@@ -57,7 +61,7 @@ module Hubspot
57
61
  form_params = opts[:form_params] || {}
58
62
 
59
63
  # http body (model)
60
- post_body = opts[:body] || @api_client.object_to_http_body(opts[:'batch_input_simple_public_object_id'])
64
+ post_body = opts[:body] || @api_client.object_to_http_body(batch_input_simple_public_object_id)
61
65
 
62
66
  # return_type
63
67
  return_type = opts[:return_type]
@@ -83,23 +87,27 @@ module Hubspot
83
87
 
84
88
  # Create a batch of companies
85
89
  # Create a batch of companies. This follows the same rules as creating an individual object.
90
+ # @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput]
86
91
  # @param [Hash] opts the optional parameters
87
- # @option opts [BatchInputSimplePublicObjectInput] :batch_input_simple_public_object_input
88
92
  # @return [BatchResponseSimplePublicObject]
89
- def create(opts = {})
90
- data, _status_code, _headers = create_with_http_info(opts)
93
+ def create(batch_input_simple_public_object_input, opts = {})
94
+ data, _status_code, _headers = create_with_http_info(batch_input_simple_public_object_input, opts)
91
95
  data
92
96
  end
93
97
 
94
98
  # Create a batch of companies
95
99
  # Create a batch of companies. This follows the same rules as creating an individual object.
100
+ # @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput]
96
101
  # @param [Hash] opts the optional parameters
97
- # @option opts [BatchInputSimplePublicObjectInput] :batch_input_simple_public_object_input
98
102
  # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
99
- def create_with_http_info(opts = {})
103
+ def create_with_http_info(batch_input_simple_public_object_input, opts = {})
100
104
  if @api_client.config.debugging
101
105
  @api_client.config.logger.debug 'Calling API: BatchApi.create ...'
102
106
  end
107
+ # verify the required parameter 'batch_input_simple_public_object_input' is set
108
+ if @api_client.config.client_side_validation && batch_input_simple_public_object_input.nil?
109
+ fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_input' when calling BatchApi.create"
110
+ end
103
111
  # resource path
104
112
  local_var_path = '/crm/v3/objects/companies/batch/create'
105
113
 
@@ -117,7 +125,7 @@ module Hubspot
117
125
  form_params = opts[:form_params] || {}
118
126
 
119
127
  # http body (model)
120
- post_body = opts[:body] || @api_client.object_to_http_body(opts[:'batch_input_simple_public_object_input'])
128
+ post_body = opts[:body] || @api_client.object_to_http_body(batch_input_simple_public_object_input)
121
129
 
122
130
  # return_type
123
131
  return_type = opts[:return_type] || 'BatchResponseSimplePublicObject'
@@ -143,25 +151,29 @@ module Hubspot
143
151
 
144
152
  # Read a batch of companies by internal ID, or unique property values
145
153
  # Read a list of companies given a collection of IDs. Use the `properties` request body property to control which properties are returned.
154
+ # @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId]
146
155
  # @param [Hash] opts the optional parameters
147
156
  # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
148
- # @option opts [BatchReadInputSimplePublicObjectId] :batch_read_input_simple_public_object_id
149
157
  # @return [BatchResponseSimplePublicObject]
150
- def read(opts = {})
151
- data, _status_code, _headers = read_with_http_info(opts)
158
+ def read(batch_read_input_simple_public_object_id, opts = {})
159
+ data, _status_code, _headers = read_with_http_info(batch_read_input_simple_public_object_id, opts)
152
160
  data
153
161
  end
154
162
 
155
163
  # Read a batch of companies by internal ID, or unique property values
156
164
  # Read a list of companies given a collection of IDs. Use the &#x60;properties&#x60; request body property to control which properties are returned.
165
+ # @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId]
157
166
  # @param [Hash] opts the optional parameters
158
167
  # @option opts [Boolean] :archived Whether to return only results that have been archived.
159
- # @option opts [BatchReadInputSimplePublicObjectId] :batch_read_input_simple_public_object_id
160
168
  # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
161
- def read_with_http_info(opts = {})
169
+ def read_with_http_info(batch_read_input_simple_public_object_id, opts = {})
162
170
  if @api_client.config.debugging
163
171
  @api_client.config.logger.debug 'Calling API: BatchApi.read ...'
164
172
  end
173
+ # verify the required parameter 'batch_read_input_simple_public_object_id' is set
174
+ if @api_client.config.client_side_validation && batch_read_input_simple_public_object_id.nil?
175
+ fail ArgumentError, "Missing the required parameter 'batch_read_input_simple_public_object_id' when calling BatchApi.read"
176
+ end
165
177
  # resource path
166
178
  local_var_path = '/crm/v3/objects/companies/batch/read'
167
179
 
@@ -180,7 +192,7 @@ module Hubspot
180
192
  form_params = opts[:form_params] || {}
181
193
 
182
194
  # http body (model)
183
- post_body = opts[:body] || @api_client.object_to_http_body(opts[:'batch_read_input_simple_public_object_id'])
195
+ post_body = opts[:body] || @api_client.object_to_http_body(batch_read_input_simple_public_object_id)
184
196
 
185
197
  # return_type
186
198
  return_type = opts[:return_type] || 'BatchResponseSimplePublicObject'
@@ -206,23 +218,27 @@ module Hubspot
206
218
 
207
219
  # Update a batch of companies
208
220
  # Perform a partial upate on a batch of companies. This follows the same rules as performing partial updates on an individual object.
221
+ # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput]
209
222
  # @param [Hash] opts the optional parameters
210
- # @option opts [BatchInputSimplePublicObjectBatchInput] :batch_input_simple_public_object_batch_input
211
223
  # @return [BatchResponseSimplePublicObject]
212
- def update(opts = {})
213
- data, _status_code, _headers = update_with_http_info(opts)
224
+ def update(batch_input_simple_public_object_batch_input, opts = {})
225
+ data, _status_code, _headers = update_with_http_info(batch_input_simple_public_object_batch_input, opts)
214
226
  data
215
227
  end
216
228
 
217
229
  # Update a batch of companies
218
230
  # Perform a partial upate on a batch of companies. This follows the same rules as performing partial updates on an individual object.
231
+ # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput]
219
232
  # @param [Hash] opts the optional parameters
220
- # @option opts [BatchInputSimplePublicObjectBatchInput] :batch_input_simple_public_object_batch_input
221
233
  # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
222
- def update_with_http_info(opts = {})
234
+ def update_with_http_info(batch_input_simple_public_object_batch_input, opts = {})
223
235
  if @api_client.config.debugging
224
236
  @api_client.config.logger.debug 'Calling API: BatchApi.update ...'
225
237
  end
238
+ # verify the required parameter 'batch_input_simple_public_object_batch_input' is set
239
+ if @api_client.config.client_side_validation && batch_input_simple_public_object_batch_input.nil?
240
+ fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_batch_input' when calling BatchApi.update"
241
+ end
226
242
  # resource path
227
243
  local_var_path = '/crm/v3/objects/companies/batch/update'
228
244
 
@@ -240,7 +256,7 @@ module Hubspot
240
256
  form_params = opts[:form_params] || {}
241
257
 
242
258
  # http body (model)
243
- post_body = opts[:body] || @api_client.object_to_http_body(opts[:'batch_input_simple_public_object_batch_input'])
259
+ post_body = opts[:body] || @api_client.object_to_http_body(batch_input_simple_public_object_batch_input)
244
260
 
245
261
  # return_type
246
262
  return_type = opts[:return_type] || 'BatchResponseSimplePublicObject'