hubspot-api-client 9.3.0 → 9.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (265) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -0
  3. data/Gemfile.lock +3 -1
  4. data/hubspot-api-client.gemspec +1 -0
  5. data/lib/hubspot-api-client.rb +5 -664
  6. data/lib/hubspot/codegen/crm/extensions/accounting/api/callbacks_api.rb +728 -0
  7. data/lib/hubspot/codegen/crm/extensions/accounting/api/invoice_api.rb +247 -0
  8. data/lib/hubspot/codegen/crm/extensions/accounting/api/settings_api.rb +160 -0
  9. data/lib/hubspot/codegen/crm/extensions/accounting/api/sync_api.rb +168 -0
  10. data/lib/hubspot/codegen/crm/extensions/accounting/api/user_accounts_api.rb +154 -0
  11. data/lib/hubspot/codegen/crm/extensions/accounting/api_client.rb +394 -0
  12. data/lib/hubspot/codegen/crm/extensions/accounting/api_error.rb +63 -0
  13. data/lib/hubspot/codegen/crm/extensions/accounting/configuration.rb +265 -0
  14. data/lib/hubspot/codegen/crm/extensions/accounting/models/accounting_app_settings.rb +241 -0
  15. data/lib/hubspot/codegen/crm/extensions/accounting/models/accounting_app_urls.rb +381 -0
  16. data/lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_customer.rb +262 -0
  17. data/lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb +357 -0
  18. data/lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_term.rb +253 -0
  19. data/lib/hubspot/codegen/crm/extensions/accounting/models/accounting_features.rb +248 -0
  20. data/lib/hubspot/codegen/crm/extensions/accounting/models/action_response.rb +299 -0
  21. data/lib/hubspot/codegen/crm/extensions/accounting/models/address.rb +253 -0
  22. data/lib/hubspot/codegen/crm/extensions/accounting/models/create_invoice_feature.rb +232 -0
  23. data/lib/hubspot/codegen/crm/extensions/accounting/models/create_invoice_sub_features.rb +293 -0
  24. data/lib/hubspot/codegen/crm/extensions/accounting/models/create_user_account_request_external.rb +248 -0
  25. data/lib/hubspot/codegen/crm/extensions/accounting/models/customer_search_response_external.rb +269 -0
  26. data/lib/hubspot/codegen/crm/extensions/accounting/models/error.rb +294 -0
  27. data/lib/hubspot/codegen/crm/extensions/accounting/models/error_detail.rb +260 -0
  28. data/lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb +297 -0
  29. data/lib/hubspot/codegen/crm/extensions/accounting/models/import_invoice_feature.rb +218 -0
  30. data/lib/hubspot/codegen/crm/extensions/accounting/models/invoice_create_payment_request.rb +263 -0
  31. data/lib/hubspot/codegen/crm/extensions/accounting/models/invoice_pdf_response.rb +283 -0
  32. data/lib/hubspot/codegen/crm/extensions/accounting/models/invoice_read_response.rb +455 -0
  33. data/lib/hubspot/codegen/crm/extensions/accounting/models/invoice_search_response.rb +264 -0
  34. data/lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_request.rb +281 -0
  35. data/lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb +441 -0
  36. data/lib/hubspot/codegen/crm/extensions/accounting/models/invoices_response_external.rb +264 -0
  37. data/lib/hubspot/codegen/crm/extensions/accounting/models/object_sync_feature.rb +218 -0
  38. data/lib/hubspot/codegen/crm/extensions/accounting/models/product.rb +281 -0
  39. data/lib/hubspot/codegen/crm/extensions/accounting/models/product_search_response.rb +264 -0
  40. data/lib/hubspot/codegen/crm/extensions/accounting/models/result_id_accounting_response.rb +267 -0
  41. data/lib/hubspot/codegen/crm/extensions/accounting/models/sync_contacts_request.rb +235 -0
  42. data/lib/hubspot/codegen/crm/extensions/accounting/models/sync_products_request.rb +235 -0
  43. data/lib/hubspot/codegen/crm/extensions/accounting/models/tax.rb +248 -0
  44. data/lib/hubspot/codegen/crm/extensions/accounting/models/tax_search_response.rb +264 -0
  45. data/lib/hubspot/codegen/crm/extensions/accounting/models/tax_type.rb +228 -0
  46. data/lib/hubspot/codegen/crm/extensions/accounting/models/terms_response.rb +264 -0
  47. data/lib/hubspot/codegen/crm/extensions/accounting/models/unit_price.rb +228 -0
  48. data/lib/hubspot/codegen/crm/extensions/accounting/models/updated_contact.rb +319 -0
  49. data/lib/hubspot/codegen/crm/extensions/accounting/models/updated_product.rb +324 -0
  50. data/lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb +284 -0
  51. data/lib/hubspot/codegen/crm/extensions/calling/api_client.rb +394 -0
  52. data/lib/hubspot/codegen/crm/extensions/calling/api_error.rb +63 -0
  53. data/lib/hubspot/codegen/crm/extensions/calling/configuration.rb +258 -0
  54. data/lib/hubspot/codegen/crm/extensions/calling/models/error.rb +294 -0
  55. data/lib/hubspot/codegen/crm/extensions/calling/models/error_detail.rb +260 -0
  56. data/lib/hubspot/codegen/crm/extensions/calling/models/settings_patch_request.rb +253 -0
  57. data/lib/hubspot/codegen/crm/extensions/calling/models/settings_request.rb +263 -0
  58. data/lib/hubspot/codegen/crm/extensions/calling/models/settings_response.rb +308 -0
  59. data/lib/hubspot/codegen/crm/extensions/videoconferencing/api/settings_api.rb +222 -0
  60. data/lib/hubspot/codegen/crm/extensions/videoconferencing/api_client.rb +394 -0
  61. data/lib/hubspot/codegen/crm/extensions/videoconferencing/api_error.rb +63 -0
  62. data/lib/hubspot/codegen/crm/extensions/videoconferencing/configuration.rb +258 -0
  63. data/lib/hubspot/codegen/crm/extensions/videoconferencing/models/error.rb +294 -0
  64. data/lib/hubspot/codegen/crm/extensions/videoconferencing/models/error_detail.rb +260 -0
  65. data/lib/hubspot/codegen/crm/extensions/videoconferencing/models/external_settings.rb +248 -0
  66. data/lib/hubspot/codegen/crm/objects/feedback_submissions/api/associations_api.rb +103 -0
  67. data/lib/hubspot/codegen/crm/objects/feedback_submissions/api/basic_api.rb +181 -0
  68. data/lib/hubspot/codegen/crm/objects/feedback_submissions/api/batch_api.rb +95 -0
  69. data/lib/hubspot/codegen/crm/objects/feedback_submissions/api/search_api.rb +92 -0
  70. data/lib/hubspot/codegen/crm/objects/feedback_submissions/api_client.rb +394 -0
  71. data/lib/hubspot/codegen/crm/objects/feedback_submissions/api_error.rb +63 -0
  72. data/lib/hubspot/codegen/crm/objects/feedback_submissions/configuration.rb +258 -0
  73. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/associated_id.rb +231 -0
  74. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/batch_input_simple_public_object_batch_input.rb +219 -0
  75. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/batch_input_simple_public_object_id.rb +219 -0
  76. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/batch_input_simple_public_object_input.rb +219 -0
  77. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/batch_read_input_simple_public_object_id.rb +244 -0
  78. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/batch_response_simple_public_object.rb +315 -0
  79. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/batch_response_simple_public_object_with_errors.rb +335 -0
  80. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/collection_response_associated_id.rb +228 -0
  81. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/collection_response_simple_public_object.rb +228 -0
  82. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/collection_response_with_total_simple_public_object.rb +243 -0
  83. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/error.rb +294 -0
  84. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/error_category.rb +265 -0
  85. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/error_detail.rb +260 -0
  86. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/filter.rb +274 -0
  87. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/filter_group.rb +219 -0
  88. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/next_page.rb +226 -0
  89. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/paging.rb +221 -0
  90. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/previous_page.rb +226 -0
  91. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/public_object_search_request.rb +288 -0
  92. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/simple_public_object.rb +290 -0
  93. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/simple_public_object_batch_input.rb +233 -0
  94. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/simple_public_object_id.rb +217 -0
  95. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/simple_public_object_input.rb +219 -0
  96. data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/standard_error.rb +311 -0
  97. data/lib/hubspot/codegen/files/files/api/files_api.rb +787 -0
  98. data/lib/hubspot/codegen/files/files/api/folders_api.rb +579 -0
  99. data/lib/hubspot/codegen/files/files/api_client.rb +392 -0
  100. data/lib/hubspot/codegen/files/files/api_error.rb +61 -0
  101. data/lib/hubspot/codegen/files/files/configuration.rb +263 -0
  102. data/lib/hubspot/codegen/files/files/models/collection_response_file.rb +226 -0
  103. data/lib/hubspot/codegen/files/files/models/collection_response_folder.rb +226 -0
  104. data/lib/hubspot/codegen/files/files/models/error.rb +292 -0
  105. data/lib/hubspot/codegen/files/files/models/error_category.rb +263 -0
  106. data/lib/hubspot/codegen/files/files/models/error_detail.rb +258 -0
  107. data/lib/hubspot/codegen/files/files/models/file.rb +440 -0
  108. data/lib/hubspot/codegen/files/files/models/file_action_response.rb +348 -0
  109. data/lib/hubspot/codegen/files/files/models/file_update_input.rb +285 -0
  110. data/lib/hubspot/codegen/files/files/models/folder.rb +301 -0
  111. data/lib/hubspot/codegen/files/files/models/folder_action_response.rb +348 -0
  112. data/lib/hubspot/codegen/files/files/models/folder_input.rb +236 -0
  113. data/lib/hubspot/codegen/files/files/models/folder_update_input.rb +236 -0
  114. data/lib/hubspot/codegen/files/files/models/folder_update_task_locator.rb +228 -0
  115. data/lib/hubspot/codegen/files/files/models/import_from_url_input.rb +374 -0
  116. data/lib/hubspot/codegen/files/files/models/import_from_url_task_locator.rb +228 -0
  117. data/lib/hubspot/codegen/files/files/models/next_page.rb +224 -0
  118. data/lib/hubspot/codegen/files/files/models/paging.rb +219 -0
  119. data/lib/hubspot/codegen/files/files/models/previous_page.rb +224 -0
  120. data/lib/hubspot/codegen/files/files/models/signed_url.rb +311 -0
  121. data/lib/hubspot/codegen/files/files/models/standard_error.rb +309 -0
  122. data/lib/hubspot/codegen/marketing/transactional/api/default_api.rb +400 -0
  123. data/lib/hubspot/codegen/marketing/transactional/api_client.rb +392 -0
  124. data/lib/hubspot/codegen/marketing/transactional/api_error.rb +61 -0
  125. data/lib/hubspot/codegen/marketing/transactional/configuration.rb +263 -0
  126. data/lib/hubspot/codegen/marketing/transactional/models/collection_response_smtp_api_token_view.rb +227 -0
  127. data/lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb +326 -0
  128. data/lib/hubspot/codegen/marketing/transactional/models/error.rb +292 -0
  129. data/lib/hubspot/codegen/marketing/transactional/models/error_detail.rb +258 -0
  130. data/lib/hubspot/codegen/marketing/transactional/models/event_id_view.rb +231 -0
  131. data/lib/hubspot/codegen/marketing/transactional/models/next_page.rb +224 -0
  132. data/lib/hubspot/codegen/marketing/transactional/models/paging.rb +210 -0
  133. data/lib/hubspot/codegen/marketing/transactional/models/public_single_send_email.rb +282 -0
  134. data/lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb +262 -0
  135. data/lib/hubspot/codegen/marketing/transactional/models/smtp_api_token_request_egg.rb +231 -0
  136. data/lib/hubspot/codegen/marketing/transactional/models/smtp_api_token_view.rb +301 -0
  137. data/lib/hubspot/version.rb +1 -1
  138. data/spec/codegen/crm/extensions/accounting/api/callbacks_api_spec.rb +165 -0
  139. data/spec/codegen/crm/extensions/accounting/api/invoice_api_spec.rb +76 -0
  140. data/spec/codegen/crm/extensions/accounting/api/settings_api_spec.rb +60 -0
  141. data/spec/codegen/crm/extensions/accounting/api/sync_api_spec.rb +61 -0
  142. data/spec/codegen/crm/extensions/accounting/api/user_accounts_api_spec.rb +59 -0
  143. data/spec/codegen/crm/extensions/accounting/models/accounting_app_settings_spec.rb +53 -0
  144. data/spec/codegen/crm/extensions/accounting/models/accounting_app_urls_spec.rb +125 -0
  145. data/spec/codegen/crm/extensions/accounting/models/accounting_extension_customer_spec.rb +65 -0
  146. data/spec/codegen/crm/extensions/accounting/models/accounting_extension_invoice_spec.rb +93 -0
  147. data/spec/codegen/crm/extensions/accounting/models/accounting_extension_term_spec.rb +59 -0
  148. data/spec/codegen/crm/extensions/accounting/models/accounting_features_spec.rb +53 -0
  149. data/spec/codegen/crm/extensions/accounting/models/action_response_spec.rb +69 -0
  150. data/spec/codegen/crm/extensions/accounting/models/address_spec.rb +65 -0
  151. data/spec/codegen/crm/extensions/accounting/models/create_invoice_feature_spec.rb +47 -0
  152. data/spec/codegen/crm/extensions/accounting/models/create_invoice_sub_features_spec.rb +71 -0
  153. data/spec/codegen/crm/extensions/accounting/models/create_user_account_request_external_spec.rb +53 -0
  154. data/spec/codegen/crm/extensions/accounting/models/customer_search_response_external_spec.rb +51 -0
  155. data/spec/codegen/crm/extensions/accounting/models/error_detail_spec.rb +65 -0
  156. data/spec/codegen/crm/extensions/accounting/models/error_spec.rb +77 -0
  157. data/spec/codegen/crm/extensions/accounting/models/exchange_rate_response_spec.rb +63 -0
  158. data/spec/codegen/crm/extensions/accounting/models/import_invoice_feature_spec.rb +41 -0
  159. data/spec/codegen/crm/extensions/accounting/models/invoice_create_payment_request_spec.rb +59 -0
  160. data/spec/codegen/crm/extensions/accounting/models/invoice_pdf_response_spec.rb +51 -0
  161. data/spec/codegen/crm/extensions/accounting/models/invoice_read_response_spec.rb +135 -0
  162. data/spec/codegen/crm/extensions/accounting/models/invoice_search_response_spec.rb +51 -0
  163. data/spec/codegen/crm/extensions/accounting/models/invoice_update_request_spec.rb +83 -0
  164. data/spec/codegen/crm/extensions/accounting/models/invoice_update_response_spec.rb +135 -0
  165. data/spec/codegen/crm/extensions/accounting/models/invoices_response_external_spec.rb +51 -0
  166. data/spec/codegen/crm/extensions/accounting/models/object_sync_feature_spec.rb +41 -0
  167. data/spec/codegen/crm/extensions/accounting/models/product_search_response_spec.rb +51 -0
  168. data/spec/codegen/crm/extensions/accounting/models/product_spec.rb +71 -0
  169. data/spec/codegen/crm/extensions/accounting/models/result_id_accounting_response_spec.rb +51 -0
  170. data/spec/codegen/crm/extensions/accounting/models/sync_contacts_request_spec.rb +47 -0
  171. data/spec/codegen/crm/extensions/accounting/models/sync_products_request_spec.rb +47 -0
  172. data/spec/codegen/crm/extensions/accounting/models/tax_search_response_spec.rb +51 -0
  173. data/spec/codegen/crm/extensions/accounting/models/tax_spec.rb +53 -0
  174. data/spec/codegen/crm/extensions/accounting/models/tax_type_spec.rb +47 -0
  175. data/spec/codegen/crm/extensions/accounting/models/terms_response_spec.rb +51 -0
  176. data/spec/codegen/crm/extensions/accounting/models/unit_price_spec.rb +47 -0
  177. data/spec/codegen/crm/extensions/accounting/models/updated_contact_spec.rb +73 -0
  178. data/spec/codegen/crm/extensions/accounting/models/updated_product_spec.rb +75 -0
  179. data/spec/codegen/crm/extensions/calling/api/settings_api_spec.rb +85 -0
  180. data/spec/codegen/crm/extensions/calling/models/error_detail_spec.rb +65 -0
  181. data/spec/codegen/crm/extensions/calling/models/error_spec.rb +77 -0
  182. data/spec/codegen/crm/extensions/calling/models/settings_patch_request_spec.rb +65 -0
  183. data/spec/codegen/crm/extensions/calling/models/settings_request_spec.rb +65 -0
  184. data/spec/codegen/crm/extensions/calling/models/settings_response_spec.rb +77 -0
  185. data/spec/codegen/crm/extensions/videoconferencing/api/settings_api_spec.rb +72 -0
  186. data/spec/codegen/crm/extensions/videoconferencing/models/error_detail_spec.rb +65 -0
  187. data/spec/codegen/crm/extensions/videoconferencing/models/error_spec.rb +77 -0
  188. data/spec/codegen/crm/extensions/videoconferencing/models/external_settings_spec.rb +59 -0
  189. data/spec/codegen/crm/objects/feedback_submissions/api/associations_api_spec.rb +50 -0
  190. data/spec/codegen/crm/objects/feedback_submissions/api/basic_api_spec.rb +69 -0
  191. data/spec/codegen/crm/objects/feedback_submissions/api/batch_api_spec.rb +48 -0
  192. data/spec/codegen/crm/objects/feedback_submissions/api/search_api_spec.rb +47 -0
  193. data/spec/codegen/crm/objects/feedback_submissions/models/associated_id_spec.rb +47 -0
  194. data/spec/codegen/crm/objects/feedback_submissions/models/batch_input_simple_public_object_batch_input_spec.rb +41 -0
  195. data/spec/codegen/crm/objects/feedback_submissions/models/batch_input_simple_public_object_id_spec.rb +41 -0
  196. data/spec/codegen/crm/objects/feedback_submissions/models/batch_input_simple_public_object_input_spec.rb +41 -0
  197. data/spec/codegen/crm/objects/feedback_submissions/models/batch_read_input_simple_public_object_id_spec.rb +53 -0
  198. data/spec/codegen/crm/objects/feedback_submissions/models/batch_response_simple_public_object_spec.rb +75 -0
  199. data/spec/codegen/crm/objects/feedback_submissions/models/batch_response_simple_public_object_with_errors_spec.rb +87 -0
  200. data/spec/codegen/crm/objects/feedback_submissions/models/collection_response_associated_id_spec.rb +47 -0
  201. data/spec/codegen/crm/objects/feedback_submissions/models/collection_response_simple_public_object_spec.rb +47 -0
  202. data/spec/codegen/crm/objects/feedback_submissions/models/collection_response_with_total_simple_public_object_spec.rb +53 -0
  203. data/spec/codegen/crm/objects/feedback_submissions/models/error_category_spec.rb +51 -0
  204. data/spec/codegen/crm/objects/feedback_submissions/models/error_detail_spec.rb +65 -0
  205. data/spec/codegen/crm/objects/feedback_submissions/models/error_spec.rb +77 -0
  206. data/spec/codegen/crm/objects/feedback_submissions/models/filter_group_spec.rb +41 -0
  207. data/spec/codegen/crm/objects/feedback_submissions/models/filter_spec.rb +57 -0
  208. data/spec/codegen/crm/objects/feedback_submissions/models/next_page_spec.rb +47 -0
  209. data/spec/codegen/crm/objects/feedback_submissions/models/paging_spec.rb +47 -0
  210. data/spec/codegen/crm/objects/feedback_submissions/models/previous_page_spec.rb +47 -0
  211. data/spec/codegen/crm/objects/feedback_submissions/models/public_object_search_request_spec.rb +71 -0
  212. data/spec/codegen/crm/objects/feedback_submissions/models/simple_public_object_batch_input_spec.rb +47 -0
  213. data/spec/codegen/crm/objects/feedback_submissions/models/simple_public_object_id_spec.rb +41 -0
  214. data/spec/codegen/crm/objects/feedback_submissions/models/simple_public_object_input_spec.rb +41 -0
  215. data/spec/codegen/crm/objects/feedback_submissions/models/simple_public_object_spec.rb +77 -0
  216. data/spec/codegen/crm/objects/feedback_submissions/models/standard_error_spec.rb +83 -0
  217. data/spec/codegen/files/files/api/files_api_spec.rb +189 -0
  218. data/spec/codegen/files/files/api/folders_api_spec.rb +143 -0
  219. data/spec/codegen/files/files/models/collection_response_file_spec.rb +47 -0
  220. data/spec/codegen/files/files/models/collection_response_folder_spec.rb +47 -0
  221. data/spec/codegen/files/files/models/error_category_spec.rb +51 -0
  222. data/spec/codegen/files/files/models/error_detail_spec.rb +65 -0
  223. data/spec/codegen/files/files/models/error_spec.rb +77 -0
  224. data/spec/codegen/files/files/models/file_action_response_spec.rb +93 -0
  225. data/spec/codegen/files/files/models/file_spec.rb +147 -0
  226. data/spec/codegen/files/files/models/file_update_input_spec.rb +69 -0
  227. data/spec/codegen/files/files/models/folder_action_response_spec.rb +93 -0
  228. data/spec/codegen/files/files/models/folder_input_spec.rb +53 -0
  229. data/spec/codegen/files/files/models/folder_spec.rb +83 -0
  230. data/spec/codegen/files/files/models/folder_update_input_spec.rb +53 -0
  231. data/spec/codegen/files/files/models/folder_update_task_locator_spec.rb +47 -0
  232. data/spec/codegen/files/files/models/import_from_url_input_spec.rb +101 -0
  233. data/spec/codegen/files/files/models/import_from_url_task_locator_spec.rb +47 -0
  234. data/spec/codegen/files/files/models/next_page_spec.rb +47 -0
  235. data/spec/codegen/files/files/models/paging_spec.rb +47 -0
  236. data/spec/codegen/files/files/models/previous_page_spec.rb +47 -0
  237. data/spec/codegen/files/files/models/signed_url_spec.rb +83 -0
  238. data/spec/codegen/files/files/models/standard_error_spec.rb +83 -0
  239. data/spec/codegen/marketing/transactional/api/default_api_spec.rb +110 -0
  240. data/spec/codegen/marketing/transactional/models/collection_response_smtp_api_token_view_spec.rb +47 -0
  241. data/spec/codegen/marketing/transactional/models/email_send_status_view_spec.rb +85 -0
  242. data/spec/codegen/marketing/transactional/models/error_detail_spec.rb +65 -0
  243. data/spec/codegen/marketing/transactional/models/error_spec.rb +77 -0
  244. data/spec/codegen/marketing/transactional/models/event_id_view_spec.rb +47 -0
  245. data/spec/codegen/marketing/transactional/models/next_page_spec.rb +47 -0
  246. data/spec/codegen/marketing/transactional/models/paging_spec.rb +41 -0
  247. data/spec/codegen/marketing/transactional/models/public_single_send_email_spec.rb +71 -0
  248. data/spec/codegen/marketing/transactional/models/public_single_send_request_egg_spec.rb +59 -0
  249. data/spec/codegen/marketing/transactional/models/smtp_api_token_request_egg_spec.rb +47 -0
  250. data/spec/codegen/marketing/transactional/models/smtp_api_token_view_spec.rb +77 -0
  251. data/spec/features/crm/extensions/accounting/callbacks_api_spec.rb +16 -0
  252. data/spec/features/crm/extensions/accounting/invoice_api_spec.rb +9 -0
  253. data/spec/features/crm/extensions/accounting/settings_api_spec.rb +8 -0
  254. data/spec/features/crm/extensions/accounting/sync_api_spec.rb +8 -0
  255. data/spec/features/crm/extensions/accounting/user_accounts_api_spec.rb +8 -0
  256. data/spec/features/crm/extensions/calling/settings_api_spec.rb +10 -0
  257. data/spec/features/crm/extensions/videoconferencing/settings_api_spec.rb +9 -0
  258. data/spec/features/crm/objects/feedback_submissions/associations_api_spec.rb +7 -0
  259. data/spec/features/crm/objects/feedback_submissions/basic_api_spec.rb +8 -0
  260. data/spec/features/crm/objects/feedback_submissions/batch_api_spec.rb +7 -0
  261. data/spec/features/crm/objects/feedback_submissions/search_api_spec.rb +7 -0
  262. data/spec/features/files/files/files_api_spec.rb +16 -0
  263. data/spec/features/files/files/folders_api_spec.rb +14 -0
  264. data/spec/features/marketing/transactional/default_api_spec.rb +12 -0
  265. metadata +401 -2
@@ -0,0 +1,400 @@
1
+ =begin
2
+ #Transactional Email
3
+
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
+
6
+ The version of the OpenAPI document: v3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Hubspot
16
+ module Marketing
17
+ module Transactional
18
+ class DefaultApi
19
+ attr_accessor :api_client
20
+
21
+ def initialize(api_client = ApiClient.default)
22
+ @api_client = api_client
23
+ end
24
+ # Delete a single token by ID.
25
+ # Delete a single token by ID.
26
+ # @param token_id [String] Identifier generated when a token is created.
27
+ # @param [Hash] opts the optional parameters
28
+ # @return [nil]
29
+ def archive_token(token_id, opts = {})
30
+ archive_token_with_http_info(token_id, opts)
31
+ nil
32
+ end
33
+
34
+ # Delete a single token by ID.
35
+ # Delete a single token by ID.
36
+ # @param token_id [String] Identifier generated when a token is created.
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
39
+ def archive_token_with_http_info(token_id, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: DefaultApi.archive_token ...'
42
+ end
43
+ # verify the required parameter 'token_id' is set
44
+ if @api_client.config.client_side_validation && token_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'token_id' when calling DefaultApi.archive_token"
46
+ end
47
+ # resource path
48
+ local_var_path = '/marketing/v3/transactional/smtp-tokens/{tokenId}'.sub('{' + 'tokenId' + '}', CGI.escape(token_id.to_s))
49
+
50
+ # query parameters
51
+ query_params = opts[:query_params] || {}
52
+
53
+ # header parameters
54
+ header_params = opts[:header_params] || {}
55
+ # HTTP header 'Accept' (if needed)
56
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
57
+
58
+ # form parameters
59
+ form_params = opts[:form_params] || {}
60
+
61
+ # http body (model)
62
+ post_body = opts[:body]
63
+
64
+ # return_type
65
+ return_type = opts[:return_type]
66
+
67
+ # auth_names
68
+ auth_names = opts[:auth_names] || ['hapikey']
69
+
70
+ new_options = opts.merge(
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => return_type
77
+ )
78
+
79
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
80
+ if @api_client.config.debugging
81
+ @api_client.config.logger.debug "API called: DefaultApi#archive_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
+ end
83
+ return data, status_code, headers
84
+ end
85
+
86
+ # Query a single token by ID.
87
+ # Query a single token by ID.
88
+ # @param token_id [String] Identifier generated when a token is created.
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [SmtpApiTokenView]
91
+ def get_token_by_id(token_id, opts = {})
92
+ data, _status_code, _headers = get_token_by_id_with_http_info(token_id, opts)
93
+ data
94
+ end
95
+
96
+ # Query a single token by ID.
97
+ # Query a single token by ID.
98
+ # @param token_id [String] Identifier generated when a token is created.
99
+ # @param [Hash] opts the optional parameters
100
+ # @return [Array<(SmtpApiTokenView, Integer, Hash)>] SmtpApiTokenView data, response status code and response headers
101
+ def get_token_by_id_with_http_info(token_id, opts = {})
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug 'Calling API: DefaultApi.get_token_by_id ...'
104
+ end
105
+ # verify the required parameter 'token_id' is set
106
+ if @api_client.config.client_side_validation && token_id.nil?
107
+ fail ArgumentError, "Missing the required parameter 'token_id' when calling DefaultApi.get_token_by_id"
108
+ end
109
+ # resource path
110
+ local_var_path = '/marketing/v3/transactional/smtp-tokens/{tokenId}'.sub('{' + 'tokenId' + '}', CGI.escape(token_id.to_s))
111
+
112
+ # query parameters
113
+ query_params = opts[:query_params] || {}
114
+
115
+ # header parameters
116
+ header_params = opts[:header_params] || {}
117
+ # HTTP header 'Accept' (if needed)
118
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
119
+
120
+ # form parameters
121
+ form_params = opts[:form_params] || {}
122
+
123
+ # http body (model)
124
+ post_body = opts[:body]
125
+
126
+ # return_type
127
+ return_type = opts[:return_type] || 'SmtpApiTokenView'
128
+
129
+ # auth_names
130
+ auth_names = opts[:auth_names] || ['hapikey']
131
+
132
+ new_options = opts.merge(
133
+ :header_params => header_params,
134
+ :query_params => query_params,
135
+ :form_params => form_params,
136
+ :body => post_body,
137
+ :auth_names => auth_names,
138
+ :return_type => return_type
139
+ )
140
+
141
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
142
+ if @api_client.config.debugging
143
+ @api_client.config.logger.debug "API called: DefaultApi#get_token_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
144
+ end
145
+ return data, status_code, headers
146
+ end
147
+
148
+ # Query SMTP API tokens by campaign name or an emailCampaignId.
149
+ # Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId.
150
+ # @param [Hash] opts the optional parameters
151
+ # @option opts [String] :campaign_name A name for the campaign tied to the SMTP API token.
152
+ # @option opts [String] :email_campaign_id Identifier assigned to the campaign provided during the token creation.
153
+ # @option opts [String] :after Starting point to get the next set of results.
154
+ # @option opts [Integer] :limit Maximum number of tokens to return.
155
+ # @return [CollectionResponseSmtpApiTokenView]
156
+ def get_tokens_page(opts = {})
157
+ data, _status_code, _headers = get_tokens_page_with_http_info(opts)
158
+ data
159
+ end
160
+
161
+ # Query SMTP API tokens by campaign name or an emailCampaignId.
162
+ # Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId.
163
+ # @param [Hash] opts the optional parameters
164
+ # @option opts [String] :campaign_name A name for the campaign tied to the SMTP API token.
165
+ # @option opts [String] :email_campaign_id Identifier assigned to the campaign provided during the token creation.
166
+ # @option opts [String] :after Starting point to get the next set of results.
167
+ # @option opts [Integer] :limit Maximum number of tokens to return.
168
+ # @return [Array<(CollectionResponseSmtpApiTokenView, Integer, Hash)>] CollectionResponseSmtpApiTokenView data, response status code and response headers
169
+ def get_tokens_page_with_http_info(opts = {})
170
+ if @api_client.config.debugging
171
+ @api_client.config.logger.debug 'Calling API: DefaultApi.get_tokens_page ...'
172
+ end
173
+ # resource path
174
+ local_var_path = '/marketing/v3/transactional/smtp-tokens'
175
+
176
+ # query parameters
177
+ query_params = opts[:query_params] || {}
178
+ query_params[:'campaignName'] = opts[:'campaign_name'] if !opts[:'campaign_name'].nil?
179
+ query_params[:'emailCampaignId'] = opts[:'email_campaign_id'] if !opts[:'email_campaign_id'].nil?
180
+ query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
181
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
182
+
183
+ # header parameters
184
+ header_params = opts[:header_params] || {}
185
+ # HTTP header 'Accept' (if needed)
186
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
187
+
188
+ # form parameters
189
+ form_params = opts[:form_params] || {}
190
+
191
+ # http body (model)
192
+ post_body = opts[:body]
193
+
194
+ # return_type
195
+ return_type = opts[:return_type] || 'CollectionResponseSmtpApiTokenView'
196
+
197
+ # auth_names
198
+ auth_names = opts[:auth_names] || ['hapikey']
199
+
200
+ new_options = opts.merge(
201
+ :header_params => header_params,
202
+ :query_params => query_params,
203
+ :form_params => form_params,
204
+ :body => post_body,
205
+ :auth_names => auth_names,
206
+ :return_type => return_type
207
+ )
208
+
209
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
210
+ if @api_client.config.debugging
211
+ @api_client.config.logger.debug "API called: DefaultApi#get_tokens_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
212
+ end
213
+ return data, status_code, headers
214
+ end
215
+
216
+ # Create a SMTP API token.
217
+ # Create a SMTP API token.
218
+ # @param [Hash] opts the optional parameters
219
+ # @option opts [SmtpApiTokenRequestEgg] :smtp_api_token_request_egg A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails.
220
+ # @return [SmtpApiTokenView]
221
+ def create_token(opts = {})
222
+ data, _status_code, _headers = create_token_with_http_info(opts)
223
+ data
224
+ end
225
+
226
+ # Create a SMTP API token.
227
+ # Create a SMTP API token.
228
+ # @param [Hash] opts the optional parameters
229
+ # @option opts [SmtpApiTokenRequestEgg] :smtp_api_token_request_egg A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails.
230
+ # @return [Array<(SmtpApiTokenView, Integer, Hash)>] SmtpApiTokenView data, response status code and response headers
231
+ def create_token_with_http_info(opts = {})
232
+ if @api_client.config.debugging
233
+ @api_client.config.logger.debug 'Calling API: DefaultApi.create_token ...'
234
+ end
235
+ # resource path
236
+ local_var_path = '/marketing/v3/transactional/smtp-tokens'
237
+
238
+ # query parameters
239
+ query_params = opts[:query_params] || {}
240
+
241
+ # header parameters
242
+ header_params = opts[:header_params] || {}
243
+ # HTTP header 'Accept' (if needed)
244
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
245
+ # HTTP header 'Content-Type'
246
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
247
+
248
+ # form parameters
249
+ form_params = opts[:form_params] || {}
250
+
251
+ # http body (model)
252
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'smtp_api_token_request_egg'])
253
+
254
+ # return_type
255
+ return_type = opts[:return_type] || 'SmtpApiTokenView'
256
+
257
+ # auth_names
258
+ auth_names = opts[:auth_names] || ['hapikey']
259
+
260
+ new_options = opts.merge(
261
+ :header_params => header_params,
262
+ :query_params => query_params,
263
+ :form_params => form_params,
264
+ :body => post_body,
265
+ :auth_names => auth_names,
266
+ :return_type => return_type
267
+ )
268
+
269
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
270
+ if @api_client.config.debugging
271
+ @api_client.config.logger.debug "API called: DefaultApi#create_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
272
+ end
273
+ return data, status_code, headers
274
+ end
275
+
276
+ # Reset the password of an existing token.
277
+ # Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid.
278
+ # @param token_id [String] Identifier generated when a token is created.
279
+ # @param [Hash] opts the optional parameters
280
+ # @return [SmtpApiTokenView]
281
+ def reset_password(token_id, opts = {})
282
+ data, _status_code, _headers = reset_password_with_http_info(token_id, opts)
283
+ data
284
+ end
285
+
286
+ # Reset the password of an existing token.
287
+ # Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid.
288
+ # @param token_id [String] Identifier generated when a token is created.
289
+ # @param [Hash] opts the optional parameters
290
+ # @return [Array<(SmtpApiTokenView, Integer, Hash)>] SmtpApiTokenView data, response status code and response headers
291
+ def reset_password_with_http_info(token_id, opts = {})
292
+ if @api_client.config.debugging
293
+ @api_client.config.logger.debug 'Calling API: DefaultApi.reset_password ...'
294
+ end
295
+ # verify the required parameter 'token_id' is set
296
+ if @api_client.config.client_side_validation && token_id.nil?
297
+ fail ArgumentError, "Missing the required parameter 'token_id' when calling DefaultApi.reset_password"
298
+ end
299
+ # resource path
300
+ local_var_path = '/marketing/v3/transactional/smtp-tokens/{tokenId}/password-reset'.sub('{' + 'tokenId' + '}', CGI.escape(token_id.to_s))
301
+
302
+ # query parameters
303
+ query_params = opts[:query_params] || {}
304
+
305
+ # header parameters
306
+ header_params = opts[:header_params] || {}
307
+ # HTTP header 'Accept' (if needed)
308
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
309
+
310
+ # form parameters
311
+ form_params = opts[:form_params] || {}
312
+
313
+ # http body (model)
314
+ post_body = opts[:body]
315
+
316
+ # return_type
317
+ return_type = opts[:return_type] || 'SmtpApiTokenView'
318
+
319
+ # auth_names
320
+ auth_names = opts[:auth_names] || ['hapikey']
321
+
322
+ new_options = opts.merge(
323
+ :header_params => header_params,
324
+ :query_params => query_params,
325
+ :form_params => form_params,
326
+ :body => post_body,
327
+ :auth_names => auth_names,
328
+ :return_type => return_type
329
+ )
330
+
331
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
332
+ if @api_client.config.debugging
333
+ @api_client.config.logger.debug "API called: DefaultApi#reset_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
334
+ end
335
+ return data, status_code, headers
336
+ end
337
+
338
+ # Send a single transactional email asynchronously.
339
+ # Asynchronously send a transactional email. Returns the status of the email send with a statusId that can be used to continuously query for the status using the Email Send Status API.
340
+ # @param [Hash] opts the optional parameters
341
+ # @option opts [PublicSingleSendRequestEgg] :public_single_send_request_egg A request object describing the email to send.
342
+ # @return [EmailSendStatusView]
343
+ def send_email(opts = {})
344
+ data, _status_code, _headers = send_email_with_http_info(opts)
345
+ data
346
+ end
347
+
348
+ # Send a single transactional email asynchronously.
349
+ # Asynchronously send a transactional email. Returns the status of the email send with a statusId that can be used to continuously query for the status using the Email Send Status API.
350
+ # @param [Hash] opts the optional parameters
351
+ # @option opts [PublicSingleSendRequestEgg] :public_single_send_request_egg A request object describing the email to send.
352
+ # @return [Array<(EmailSendStatusView, Integer, Hash)>] EmailSendStatusView data, response status code and response headers
353
+ def send_email_with_http_info(opts = {})
354
+ if @api_client.config.debugging
355
+ @api_client.config.logger.debug 'Calling API: DefaultApi.send_email ...'
356
+ end
357
+ # resource path
358
+ local_var_path = '/marketing/v3/transactional/single-email/send'
359
+
360
+ # query parameters
361
+ query_params = opts[:query_params] || {}
362
+
363
+ # header parameters
364
+ header_params = opts[:header_params] || {}
365
+ # HTTP header 'Accept' (if needed)
366
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
367
+ # HTTP header 'Content-Type'
368
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
369
+
370
+ # form parameters
371
+ form_params = opts[:form_params] || {}
372
+
373
+ # http body (model)
374
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'public_single_send_request_egg'])
375
+
376
+ # return_type
377
+ return_type = opts[:return_type] || 'EmailSendStatusView'
378
+
379
+ # auth_names
380
+ auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
381
+
382
+ new_options = opts.merge(
383
+ :header_params => header_params,
384
+ :query_params => query_params,
385
+ :form_params => form_params,
386
+ :body => post_body,
387
+ :auth_names => auth_names,
388
+ :return_type => return_type
389
+ )
390
+
391
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
392
+ if @api_client.config.debugging
393
+ @api_client.config.logger.debug "API called: DefaultApi#send_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
394
+ end
395
+ return data, status_code, headers
396
+ end
397
+ end
398
+ end
399
+ end
400
+ end
@@ -0,0 +1,392 @@
1
+ =begin
2
+ #Transactional Email
3
+
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
+
6
+ The version of the OpenAPI document: v3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'json'
15
+ require 'logger'
16
+ require 'tempfile'
17
+ require 'typhoeus'
18
+
19
+ module Hubspot
20
+ module Marketing
21
+ module Transactional
22
+ class ApiClient
23
+ # The Configuration object holding settings to be used in the API client.
24
+ attr_accessor :config
25
+
26
+ # Defines the headers to be used in HTTP requests of all API calls by default.
27
+ #
28
+ # @return [Hash]
29
+ attr_accessor :default_headers
30
+
31
+ # Initializes the ApiClient
32
+ # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
33
+ def initialize(config = Configuration.default)
34
+ @config = config
35
+ @user_agent = "hubspot-api-client-ruby; #{VERSION}"
36
+ @default_headers = {
37
+ 'Content-Type' => 'application/json',
38
+ 'User-Agent' => @user_agent
39
+ }
40
+ end
41
+
42
+ def self.default
43
+ @@default ||= ApiClient.new
44
+ end
45
+
46
+ # Call an API with given options.
47
+ #
48
+ # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
49
+ # the data deserialized from response body (could be nil), response status code and response headers.
50
+ def call_api(http_method, path, opts = {})
51
+ request = build_request(http_method, path, opts)
52
+ response = request.run
53
+
54
+ if @config.debugging
55
+ @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
56
+ end
57
+
58
+ unless response.success?
59
+ if response.timed_out?
60
+ fail ApiError.new('Connection timed out')
61
+ elsif response.code == 0
62
+ # Errors from libcurl will be made visible here
63
+ fail ApiError.new(:code => 0,
64
+ :message => response.return_message)
65
+ else
66
+ fail ApiError.new(:code => response.code,
67
+ :response_headers => response.headers,
68
+ :response_body => response.body),
69
+ response.status_message
70
+ end
71
+ end
72
+
73
+ if opts[:return_type]
74
+ data = deserialize(response, opts[:return_type])
75
+ else
76
+ data = nil
77
+ end
78
+ return data, response.code, response.headers
79
+ end
80
+
81
+ # Builds the HTTP request
82
+ #
83
+ # @param [String] http_method HTTP method/verb (e.g. POST)
84
+ # @param [String] path URL path (e.g. /account/new)
85
+ # @option opts [Hash] :header_params Header parameters
86
+ # @option opts [Hash] :query_params Query parameters
87
+ # @option opts [Hash] :form_params Query parameters
88
+ # @option opts [Object] :body HTTP body (JSON/XML)
89
+ # @return [Typhoeus::Request] A Typhoeus Request
90
+ def build_request(http_method, path, opts = {})
91
+ url = build_request_url(path)
92
+ http_method = http_method.to_sym.downcase
93
+
94
+ header_params = @default_headers.merge(opts[:header_params] || {})
95
+ query_params = opts[:query_params] || {}
96
+ form_params = opts[:form_params] || {}
97
+
98
+ update_params_for_auth! header_params, query_params, opts[:auth_names]
99
+
100
+ # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
101
+ _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
102
+
103
+ req_opts = {
104
+ :method => http_method,
105
+ :headers => header_params,
106
+ :params => query_params,
107
+ :params_encoding => @config.params_encoding,
108
+ :timeout => @config.timeout,
109
+ :ssl_verifypeer => @config.verify_ssl,
110
+ :ssl_verifyhost => _verify_ssl_host,
111
+ :sslcert => @config.cert_file,
112
+ :sslkey => @config.key_file,
113
+ :verbose => @config.debugging
114
+ }
115
+
116
+ # set custom cert, if provided
117
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
118
+
119
+ if [:post, :patch, :put, :delete].include?(http_method)
120
+ req_body = build_request_body(header_params, form_params, opts[:body])
121
+ req_opts.update :body => req_body
122
+ if @config.debugging
123
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
124
+ end
125
+ end
126
+
127
+ request = Typhoeus::Request.new(url, req_opts)
128
+ download_file(request) if opts[:return_type] == 'File'
129
+ request
130
+ end
131
+
132
+ # Builds the HTTP request body
133
+ #
134
+ # @param [Hash] header_params Header parameters
135
+ # @param [Hash] form_params Query parameters
136
+ # @param [Object] body HTTP body (JSON/XML)
137
+ # @return [String] HTTP body data in the form of string
138
+ def build_request_body(header_params, form_params, body)
139
+ # http form
140
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
141
+ header_params['Content-Type'] == 'multipart/form-data'
142
+ data = {}
143
+ form_params.each do |key, value|
144
+ case value
145
+ when ::File, ::Array, nil
146
+ # let typhoeus handle File, Array and nil parameters
147
+ data[key] = value
148
+ else
149
+ data[key] = value.to_s
150
+ end
151
+ end
152
+ elsif body
153
+ data = body.is_a?(String) ? body : body.to_json
154
+ else
155
+ data = nil
156
+ end
157
+ data
158
+ end
159
+
160
+ # Check if the given MIME is a JSON MIME.
161
+ # JSON MIME examples:
162
+ # application/json
163
+ # application/json; charset=UTF8
164
+ # APPLICATION/JSON
165
+ # */*
166
+ # @param [String] mime MIME
167
+ # @return [Boolean] True if the MIME is application/json
168
+ def json_mime?(mime)
169
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
170
+ end
171
+
172
+ # Deserialize the response to the given return type.
173
+ #
174
+ # @param [Response] response HTTP response
175
+ # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
176
+ def deserialize(response, return_type)
177
+ body = response.body
178
+
179
+ # handle file downloading - return the File instance processed in request callbacks
180
+ # note that response body is empty when the file is written in chunks in request on_body callback
181
+ return @tempfile if return_type == 'File'
182
+
183
+ return nil if body.nil? || body.empty?
184
+
185
+ # return response body directly for String return type
186
+ return body if return_type == 'String'
187
+
188
+ # ensuring a default content type
189
+ content_type = response.headers['Content-Type'] || 'application/json'
190
+
191
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
192
+
193
+ begin
194
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
195
+ rescue JSON::ParserError => e
196
+ if %w(String Date DateTime).include?(return_type)
197
+ data = body
198
+ else
199
+ raise e
200
+ end
201
+ end
202
+
203
+ convert_to_type data, return_type
204
+ end
205
+
206
+ # Convert data to the given return type.
207
+ # @param [Object] data Data to be converted
208
+ # @param [String] return_type Return type
209
+ # @return [Mixed] Data in a particular type
210
+ def convert_to_type(data, return_type)
211
+ return nil if data.nil?
212
+ case return_type
213
+ when 'String'
214
+ data.to_s
215
+ when 'Integer'
216
+ data.to_i
217
+ when 'Float'
218
+ data.to_f
219
+ when 'Boolean'
220
+ data == true
221
+ when 'DateTime'
222
+ # parse date time (expecting ISO 8601 format)
223
+ DateTime.parse data
224
+ when 'Date'
225
+ # parse date time (expecting ISO 8601 format)
226
+ Date.parse data
227
+ when 'Object'
228
+ # generic object (usually a Hash), return directly
229
+ data
230
+ when /\AArray<(.+)>\z/
231
+ # e.g. Array<Pet>
232
+ sub_type = $1
233
+ data.map { |item| convert_to_type(item, sub_type) }
234
+ when /\AHash\<String, (.+)\>\z/
235
+ # e.g. Hash<String, Integer>
236
+ sub_type = $1
237
+ {}.tap do |hash|
238
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
239
+ end
240
+ else
241
+ # models, e.g. Pet
242
+ Hubspot::Marketing::Transactional.const_get(return_type).build_from_hash(data)
243
+ end
244
+ end
245
+
246
+ # Save response body into a file in (the defined) temporary folder, using the filename
247
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
248
+ # The response body is written to the file in chunks in order to handle files which
249
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
250
+ # process can use.
251
+ #
252
+ # @see Configuration#temp_folder_path
253
+ def download_file(request)
254
+ tempfile = nil
255
+ encoding = nil
256
+ request.on_headers do |response|
257
+ content_disposition = response.headers['Content-Disposition']
258
+ if content_disposition && content_disposition =~ /filename=/i
259
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
260
+ prefix = sanitize_filename(filename)
261
+ else
262
+ prefix = 'download-'
263
+ end
264
+ prefix = prefix + '-' unless prefix.end_with?('-')
265
+ encoding = response.body.encoding
266
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
267
+ @tempfile = tempfile
268
+ end
269
+ request.on_body do |chunk|
270
+ chunk.force_encoding(encoding)
271
+ tempfile.write(chunk)
272
+ end
273
+ request.on_complete do |response|
274
+ if tempfile
275
+ tempfile.close
276
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
277
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
278
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
279
+ "explicitly with `tempfile.delete`"
280
+ end
281
+ end
282
+ end
283
+
284
+ # Sanitize filename by removing path.
285
+ # e.g. ../../sun.gif becomes sun.gif
286
+ #
287
+ # @param [String] filename the filename to be sanitized
288
+ # @return [String] the sanitized filename
289
+ def sanitize_filename(filename)
290
+ filename.gsub(/.*[\/\\]/, '')
291
+ end
292
+
293
+ def build_request_url(path)
294
+ # Add leading and trailing slashes to path
295
+ path = "/#{path}".gsub(/\/+/, '/')
296
+ @config.base_url + path
297
+ end
298
+
299
+ # Update hearder and query params based on authentication settings.
300
+ #
301
+ # @param [Hash] header_params Header parameters
302
+ # @param [Hash] query_params Query parameters
303
+ # @param [String] auth_names Authentication scheme name
304
+ def update_params_for_auth!(header_params, query_params, auth_names)
305
+ Array(auth_names).each do |auth_name|
306
+ auth_setting = @config.auth_settings[auth_name]
307
+ next unless auth_setting
308
+ case auth_setting[:in]
309
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
310
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
311
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
312
+ end
313
+ end
314
+ end
315
+
316
+ # Sets user agent in HTTP header
317
+ #
318
+ # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
319
+ def user_agent=(user_agent)
320
+ @user_agent = user_agent
321
+ @default_headers['User-Agent'] = @user_agent
322
+ end
323
+
324
+ # Return Accept header based on an array of accepts provided.
325
+ # @param [Array] accepts array for Accept
326
+ # @return [String] the Accept header (e.g. application/json)
327
+ def select_header_accept(accepts)
328
+ return nil if accepts.nil? || accepts.empty?
329
+ # use JSON when present, otherwise use all of the provided
330
+ json_accept = accepts.find { |s| json_mime?(s) }
331
+ json_accept || accepts.join(',')
332
+ end
333
+
334
+ # Return Content-Type header based on an array of content types provided.
335
+ # @param [Array] content_types array for Content-Type
336
+ # @return [String] the Content-Type header (e.g. application/json)
337
+ def select_header_content_type(content_types)
338
+ # use application/json by default
339
+ return 'application/json' if content_types.nil? || content_types.empty?
340
+ # use JSON when present, otherwise use the first one
341
+ json_content_type = content_types.find { |s| json_mime?(s) }
342
+ json_content_type || content_types.first
343
+ end
344
+
345
+ # Convert object (array, hash, object, etc) to JSON string.
346
+ # @param [Object] model object to be converted into JSON string
347
+ # @return [String] JSON string representation of the object
348
+ def object_to_http_body(model)
349
+ return model if model.nil? || model.is_a?(String)
350
+ local_body = nil
351
+ if model.is_a?(Array)
352
+ local_body = model.map { |m| object_to_hash(m) }
353
+ else
354
+ local_body = object_to_hash(model)
355
+ end
356
+ local_body.to_json
357
+ end
358
+
359
+ # Convert object(non-array) to hash.
360
+ # @param [Object] obj object to be converted into JSON string
361
+ # @return [String] JSON string representation of the object
362
+ def object_to_hash(obj)
363
+ if obj.respond_to?(:to_hash)
364
+ obj.to_hash
365
+ else
366
+ obj
367
+ end
368
+ end
369
+
370
+ # Build parameter value according to the given collection format.
371
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
372
+ def build_collection_param(param, collection_format)
373
+ case collection_format
374
+ when :csv
375
+ param.join(',')
376
+ when :ssv
377
+ param.join(' ')
378
+ when :tsv
379
+ param.join("\t")
380
+ when :pipes
381
+ param.join('|')
382
+ when :multi
383
+ # return the array directly as typhoeus will handle it as expected
384
+ param
385
+ else
386
+ fail "unknown collection format: #{collection_format.inspect}"
387
+ end
388
+ end
389
+ end
390
+ end
391
+ end
392
+ end