merge_crm_client 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (350) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/LICENSE.md +16 -0
  4. data/README.md +236 -0
  5. data/Rakefile +10 -0
  6. data/docs/Account.md +46 -0
  7. data/docs/AccountDetails.md +36 -0
  8. data/docs/AccountDetailsAndActions.md +36 -0
  9. data/docs/AccountDetailsAndActionsIntegration.md +32 -0
  10. data/docs/AccountDetailsAndActionsStatusEnum.md +15 -0
  11. data/docs/AccountDetailsApi.md +79 -0
  12. data/docs/AccountIntegration.md +28 -0
  13. data/docs/AccountRequest.md +40 -0
  14. data/docs/AccountToken.md +20 -0
  15. data/docs/AccountTokenApi.md +79 -0
  16. data/docs/AccountsApi.md +335 -0
  17. data/docs/ActivityTypeEnum.md +15 -0
  18. data/docs/Address.md +30 -0
  19. data/docs/AddressRequest.md +30 -0
  20. data/docs/AddressTypeEnum.md +15 -0
  21. data/docs/AvailableActions.md +22 -0
  22. data/docs/AvailableActionsApi.md +79 -0
  23. data/docs/CRMAccountEndpointRequest.md +18 -0
  24. data/docs/CRMAccountResponse.md +24 -0
  25. data/docs/CRMContactEndpointRequest.md +18 -0
  26. data/docs/CRMContactResponse.md +24 -0
  27. data/docs/CategoriesEnum.md +15 -0
  28. data/docs/CategoryEnum.md +15 -0
  29. data/docs/Contact.md +40 -0
  30. data/docs/ContactRequest.md +32 -0
  31. data/docs/ContactsApi.md +335 -0
  32. data/docs/CountryEnum.md +15 -0
  33. data/docs/DataPassthroughRequest.md +32 -0
  34. data/docs/DebugModeLog.md +22 -0
  35. data/docs/DebugModelLogSummary.md +22 -0
  36. data/docs/DeleteAccountApi.md +78 -0
  37. data/docs/DirectionEnum.md +15 -0
  38. data/docs/EmailAddress.md +20 -0
  39. data/docs/EmailAddressRequest.md +20 -0
  40. data/docs/EncodingEnum.md +15 -0
  41. data/docs/EndUserDetailsRequest.md +30 -0
  42. data/docs/Engagement.md +40 -0
  43. data/docs/EngagementEndpointRequest.md +18 -0
  44. data/docs/EngagementRequest.md +38 -0
  45. data/docs/EngagementResponse.md +24 -0
  46. data/docs/EngagementType.md +24 -0
  47. data/docs/EngagementTypesApi.md +177 -0
  48. data/docs/EngagementsApi.md +333 -0
  49. data/docs/ErrorValidationProblem.md +24 -0
  50. data/docs/ForceResyncApi.md +79 -0
  51. data/docs/GenerateKeyApi.md +79 -0
  52. data/docs/GenerateRemoteKeyRequest.md +18 -0
  53. data/docs/Issue.md +30 -0
  54. data/docs/IssueStatusEnum.md +15 -0
  55. data/docs/IssuesApi.md +177 -0
  56. data/docs/Lead.md +52 -0
  57. data/docs/LeadEndpointRequest.md +18 -0
  58. data/docs/LeadRequest.md +44 -0
  59. data/docs/LeadResponse.md +24 -0
  60. data/docs/LeadsApi.md +339 -0
  61. data/docs/LinkToken.md +22 -0
  62. data/docs/LinkTokenApi.md +79 -0
  63. data/docs/LinkedAccountStatus.md +20 -0
  64. data/docs/LinkedAccountsApi.md +105 -0
  65. data/docs/MetaResponse.md +24 -0
  66. data/docs/MethodEnum.md +15 -0
  67. data/docs/ModelOperation.md +24 -0
  68. data/docs/MultipartFormFieldRequest.md +26 -0
  69. data/docs/Note.md +38 -0
  70. data/docs/NoteEndpointRequest.md +18 -0
  71. data/docs/NoteRequest.md +36 -0
  72. data/docs/NoteResponse.md +24 -0
  73. data/docs/NotesApi.md +341 -0
  74. data/docs/OpportunitiesApi.md +345 -0
  75. data/docs/Opportunity.md +44 -0
  76. data/docs/OpportunityEndpointRequest.md +18 -0
  77. data/docs/OpportunityRequest.md +42 -0
  78. data/docs/OpportunityResponse.md +24 -0
  79. data/docs/OpportunityStatusEnum.md +15 -0
  80. data/docs/PaginatedAccountDetailsAndActionsList.md +22 -0
  81. data/docs/PaginatedAccountList.md +22 -0
  82. data/docs/PaginatedContactList.md +22 -0
  83. data/docs/PaginatedEngagementList.md +22 -0
  84. data/docs/PaginatedEngagementTypeList.md +22 -0
  85. data/docs/PaginatedIssueList.md +22 -0
  86. data/docs/PaginatedLeadList.md +22 -0
  87. data/docs/PaginatedNoteList.md +22 -0
  88. data/docs/PaginatedOpportunityList.md +22 -0
  89. data/docs/PaginatedStageList.md +22 -0
  90. data/docs/PaginatedSyncStatusList.md +22 -0
  91. data/docs/PaginatedTaskList.md +22 -0
  92. data/docs/PaginatedUserList.md +22 -0
  93. data/docs/PassthroughApi.md +81 -0
  94. data/docs/PhoneNumber.md +20 -0
  95. data/docs/PhoneNumberRequest.md +20 -0
  96. data/docs/RegenerateKeyApi.md +79 -0
  97. data/docs/RemoteData.md +20 -0
  98. data/docs/RemoteKey.md +20 -0
  99. data/docs/RemoteKeyForRegenerationRequest.md +18 -0
  100. data/docs/RemoteResponse.md +28 -0
  101. data/docs/RequestFormatEnum.md +15 -0
  102. data/docs/Stage.md +26 -0
  103. data/docs/StagesApi.md +177 -0
  104. data/docs/SyncStatus.md +28 -0
  105. data/docs/SyncStatusApi.md +85 -0
  106. data/docs/SyncStatusStatusEnum.md +15 -0
  107. data/docs/Task.md +38 -0
  108. data/docs/TaskStatusEnum.md +15 -0
  109. data/docs/TasksApi.md +181 -0
  110. data/docs/User.md +30 -0
  111. data/docs/UsersApi.md +177 -0
  112. data/docs/ValidationProblemSource.md +18 -0
  113. data/docs/WarningValidationProblem.md +24 -0
  114. data/docs/WebhookReceiver.md +22 -0
  115. data/docs/WebhookReceiverRequest.md +22 -0
  116. data/docs/WebhookReceiversApi.md +153 -0
  117. data/git_push.sh +58 -0
  118. data/lib/merge_crm_client/api/account_details_api.rb +84 -0
  119. data/lib/merge_crm_client/api/account_token_api.rb +83 -0
  120. data/lib/merge_crm_client/api/accounts_api.rb +337 -0
  121. data/lib/merge_crm_client/api/available_actions_api.rb +84 -0
  122. data/lib/merge_crm_client/api/contacts_api.rb +337 -0
  123. data/lib/merge_crm_client/api/delete_account_api.rb +82 -0
  124. data/lib/merge_crm_client/api/engagement_types_api.rb +182 -0
  125. data/lib/merge_crm_client/api/engagements_api.rb +334 -0
  126. data/lib/merge_crm_client/api/force_resync_api.rb +84 -0
  127. data/lib/merge_crm_client/api/generate_key_api.rb +85 -0
  128. data/lib/merge_crm_client/api/issues_api.rb +181 -0
  129. data/lib/merge_crm_client/api/leads_api.rb +343 -0
  130. data/lib/merge_crm_client/api/link_token_api.rb +85 -0
  131. data/lib/merge_crm_client/api/linked_accounts_api.rb +120 -0
  132. data/lib/merge_crm_client/api/notes_api.rb +346 -0
  133. data/lib/merge_crm_client/api/opportunities_api.rb +364 -0
  134. data/lib/merge_crm_client/api/passthrough_api.rb +92 -0
  135. data/lib/merge_crm_client/api/regenerate_key_api.rb +85 -0
  136. data/lib/merge_crm_client/api/stages_api.rb +182 -0
  137. data/lib/merge_crm_client/api/sync_status_api.rb +90 -0
  138. data/lib/merge_crm_client/api/tasks_api.rb +196 -0
  139. data/lib/merge_crm_client/api/users_api.rb +182 -0
  140. data/lib/merge_crm_client/api/webhook_receivers_api.rb +154 -0
  141. data/lib/merge_crm_client/api_client.rb +390 -0
  142. data/lib/merge_crm_client/api_error.rb +57 -0
  143. data/lib/merge_crm_client/configuration.rb +281 -0
  144. data/lib/merge_crm_client/models/account.rb +410 -0
  145. data/lib/merge_crm_client/models/account_details.rb +302 -0
  146. data/lib/merge_crm_client/models/account_details_and_actions.rb +327 -0
  147. data/lib/merge_crm_client/models/account_details_and_actions_integration.rb +310 -0
  148. data/lib/merge_crm_client/models/account_details_and_actions_status_enum.rb +46 -0
  149. data/lib/merge_crm_client/models/account_integration.rb +303 -0
  150. data/lib/merge_crm_client/models/account_request.rb +382 -0
  151. data/lib/merge_crm_client/models/account_token.rb +237 -0
  152. data/lib/merge_crm_client/models/activity_type_enum.rb +46 -0
  153. data/lib/merge_crm_client/models/address.rb +287 -0
  154. data/lib/merge_crm_client/models/address_request.rb +287 -0
  155. data/lib/merge_crm_client/models/address_type_enum.rb +45 -0
  156. data/lib/merge_crm_client/models/available_actions.rb +249 -0
  157. data/lib/merge_crm_client/models/categories_enum.rb +48 -0
  158. data/lib/merge_crm_client/models/category_enum.rb +48 -0
  159. data/lib/merge_crm_client/models/contact.rb +338 -0
  160. data/lib/merge_crm_client/models/contact_request.rb +299 -0
  161. data/lib/merge_crm_client/models/country_enum.rb +292 -0
  162. data/lib/merge_crm_client/models/crm_account_endpoint_request.rb +223 -0
  163. data/lib/merge_crm_client/models/crm_account_response.rb +266 -0
  164. data/lib/merge_crm_client/models/crm_contact_endpoint_request.rb +223 -0
  165. data/lib/merge_crm_client/models/crm_contact_response.rb +266 -0
  166. data/lib/merge_crm_client/models/data_passthrough_request.rb +352 -0
  167. data/lib/merge_crm_client/models/debug_mode_log.rb +251 -0
  168. data/lib/merge_crm_client/models/debug_model_log_summary.rb +251 -0
  169. data/lib/merge_crm_client/models/direction_enum.rb +45 -0
  170. data/lib/merge_crm_client/models/email_address.rb +232 -0
  171. data/lib/merge_crm_client/models/email_address_request.rb +232 -0
  172. data/lib/merge_crm_client/models/encoding_enum.rb +46 -0
  173. data/lib/merge_crm_client/models/end_user_details_request.rb +430 -0
  174. data/lib/merge_crm_client/models/engagement.rb +337 -0
  175. data/lib/merge_crm_client/models/engagement_endpoint_request.rb +223 -0
  176. data/lib/merge_crm_client/models/engagement_request.rb +330 -0
  177. data/lib/merge_crm_client/models/engagement_response.rb +266 -0
  178. data/lib/merge_crm_client/models/engagement_type.rb +252 -0
  179. data/lib/merge_crm_client/models/error_validation_problem.rb +260 -0
  180. data/lib/merge_crm_client/models/generate_remote_key_request.rb +243 -0
  181. data/lib/merge_crm_client/models/issue.rb +281 -0
  182. data/lib/merge_crm_client/models/issue_status_enum.rb +45 -0
  183. data/lib/merge_crm_client/models/lead.rb +402 -0
  184. data/lib/merge_crm_client/models/lead_endpoint_request.rb +223 -0
  185. data/lib/merge_crm_client/models/lead_request.rb +363 -0
  186. data/lib/merge_crm_client/models/lead_response.rb +266 -0
  187. data/lib/merge_crm_client/models/link_token.rb +246 -0
  188. data/lib/merge_crm_client/models/linked_account_status.rb +237 -0
  189. data/lib/merge_crm_client/models/meta_response.rb +262 -0
  190. data/lib/merge_crm_client/models/method_enum.rb +50 -0
  191. data/lib/merge_crm_client/models/model_operation.rb +272 -0
  192. data/lib/merge_crm_client/models/multipart_form_field_request.rb +341 -0
  193. data/lib/merge_crm_client/models/note.rb +324 -0
  194. data/lib/merge_crm_client/models/note_endpoint_request.rb +223 -0
  195. data/lib/merge_crm_client/models/note_request.rb +318 -0
  196. data/lib/merge_crm_client/models/note_response.rb +266 -0
  197. data/lib/merge_crm_client/models/opportunity.rb +382 -0
  198. data/lib/merge_crm_client/models/opportunity_endpoint_request.rb +223 -0
  199. data/lib/merge_crm_client/models/opportunity_request.rb +376 -0
  200. data/lib/merge_crm_client/models/opportunity_response.rb +266 -0
  201. data/lib/merge_crm_client/models/opportunity_status_enum.rb +46 -0
  202. data/lib/merge_crm_client/models/paginated_account_details_and_actions_list.rb +240 -0
  203. data/lib/merge_crm_client/models/paginated_account_list.rb +240 -0
  204. data/lib/merge_crm_client/models/paginated_contact_list.rb +240 -0
  205. data/lib/merge_crm_client/models/paginated_engagement_list.rb +240 -0
  206. data/lib/merge_crm_client/models/paginated_engagement_type_list.rb +240 -0
  207. data/lib/merge_crm_client/models/paginated_issue_list.rb +240 -0
  208. data/lib/merge_crm_client/models/paginated_lead_list.rb +240 -0
  209. data/lib/merge_crm_client/models/paginated_note_list.rb +240 -0
  210. data/lib/merge_crm_client/models/paginated_opportunity_list.rb +240 -0
  211. data/lib/merge_crm_client/models/paginated_stage_list.rb +240 -0
  212. data/lib/merge_crm_client/models/paginated_sync_status_list.rb +240 -0
  213. data/lib/merge_crm_client/models/paginated_task_list.rb +240 -0
  214. data/lib/merge_crm_client/models/paginated_user_list.rb +240 -0
  215. data/lib/merge_crm_client/models/phone_number.rb +232 -0
  216. data/lib/merge_crm_client/models/phone_number_request.rb +232 -0
  217. data/lib/merge_crm_client/models/remote_data.rb +234 -0
  218. data/lib/merge_crm_client/models/remote_key.rb +238 -0
  219. data/lib/merge_crm_client/models/remote_key_for_regeneration_request.rb +243 -0
  220. data/lib/merge_crm_client/models/remote_response.rb +290 -0
  221. data/lib/merge_crm_client/models/request_format_enum.rb +46 -0
  222. data/lib/merge_crm_client/models/stage.rb +263 -0
  223. data/lib/merge_crm_client/models/sync_status.rb +294 -0
  224. data/lib/merge_crm_client/models/sync_status_status_enum.rb +48 -0
  225. data/lib/merge_crm_client/models/task.rb +327 -0
  226. data/lib/merge_crm_client/models/task_status_enum.rb +45 -0
  227. data/lib/merge_crm_client/models/user.rb +285 -0
  228. data/lib/merge_crm_client/models/validation_problem_source.rb +223 -0
  229. data/lib/merge_crm_client/models/warning_validation_problem.rb +260 -0
  230. data/lib/merge_crm_client/models/webhook_receiver.rb +246 -0
  231. data/lib/merge_crm_client/models/webhook_receiver_request.rb +280 -0
  232. data/lib/merge_crm_client/version.rb +15 -0
  233. data/lib/merge_crm_client.rb +150 -0
  234. data/merge_crm_client.gemspec +38 -0
  235. data/pull_request_template.md +19 -0
  236. data/spec/api/account_details_api_spec.rb +46 -0
  237. data/spec/api/account_token_api_spec.rb +46 -0
  238. data/spec/api/accounts_api_spec.rb +96 -0
  239. data/spec/api/available_actions_api_spec.rb +46 -0
  240. data/spec/api/contacts_api_spec.rb +108 -0
  241. data/spec/api/delete_account_api_spec.rb +46 -0
  242. data/spec/api/engagement_types_api_spec.rb +68 -0
  243. data/spec/api/engagements_api_spec.rb +95 -0
  244. data/spec/api/force_resync_api_spec.rb +46 -0
  245. data/spec/api/generate_key_api_spec.rb +46 -0
  246. data/spec/api/issues_api_spec.rb +69 -0
  247. data/spec/api/leads_api_spec.rb +98 -0
  248. data/spec/api/link_token_api_spec.rb +46 -0
  249. data/spec/api/linked_accounts_api_spec.rb +58 -0
  250. data/spec/api/notes_api_spec.rb +99 -0
  251. data/spec/api/opportunities_api_spec.rb +101 -0
  252. data/spec/api/passthrough_api_spec.rb +47 -0
  253. data/spec/api/regenerate_key_api_spec.rb +46 -0
  254. data/spec/api/stages_api_spec.rb +68 -0
  255. data/spec/api/sync_status_api_spec.rb +48 -0
  256. data/spec/api/tasks_api_spec.rb +70 -0
  257. data/spec/api/users_api_spec.rb +68 -0
  258. data/spec/api/webhook_receivers_api_spec.rb +58 -0
  259. data/spec/api_client_spec.rb +226 -0
  260. data/spec/configuration_spec.rb +42 -0
  261. data/spec/models/account_details_and_actions_integration_spec.rb +76 -0
  262. data/spec/models/account_details_and_actions_spec.rb +88 -0
  263. data/spec/models/account_details_and_actions_status_enum_spec.rb +28 -0
  264. data/spec/models/account_details_spec.rb +88 -0
  265. data/spec/models/account_integration_spec.rb +64 -0
  266. data/spec/models/account_request_spec.rb +100 -0
  267. data/spec/models/account_spec.rb +118 -0
  268. data/spec/models/account_token_spec.rb +40 -0
  269. data/spec/models/activity_type_enum_spec.rb +28 -0
  270. data/spec/models/address_request_spec.rb +70 -0
  271. data/spec/models/address_spec.rb +70 -0
  272. data/spec/models/address_type_enum_spec.rb +28 -0
  273. data/spec/models/available_actions_spec.rb +46 -0
  274. data/spec/models/categories_enum_spec.rb +28 -0
  275. data/spec/models/category_enum_spec.rb +28 -0
  276. data/spec/models/contact_request_spec.rb +76 -0
  277. data/spec/models/contact_spec.rb +100 -0
  278. data/spec/models/country_enum_spec.rb +28 -0
  279. data/spec/models/crm_account_endpoint_request_spec.rb +34 -0
  280. data/spec/models/crm_account_response_spec.rb +52 -0
  281. data/spec/models/crm_contact_endpoint_request_spec.rb +34 -0
  282. data/spec/models/crm_contact_response_spec.rb +52 -0
  283. data/spec/models/data_passthrough_request_spec.rb +76 -0
  284. data/spec/models/debug_mode_log_spec.rb +46 -0
  285. data/spec/models/debug_model_log_summary_spec.rb +46 -0
  286. data/spec/models/direction_enum_spec.rb +28 -0
  287. data/spec/models/email_address_request_spec.rb +40 -0
  288. data/spec/models/email_address_spec.rb +40 -0
  289. data/spec/models/encoding_enum_spec.rb +28 -0
  290. data/spec/models/end_user_details_request_spec.rb +70 -0
  291. data/spec/models/engagement_endpoint_request_spec.rb +34 -0
  292. data/spec/models/engagement_request_spec.rb +94 -0
  293. data/spec/models/engagement_response_spec.rb +52 -0
  294. data/spec/models/engagement_spec.rb +100 -0
  295. data/spec/models/engagement_type_spec.rb +52 -0
  296. data/spec/models/error_validation_problem_spec.rb +52 -0
  297. data/spec/models/generate_remote_key_request_spec.rb +34 -0
  298. data/spec/models/issue_spec.rb +70 -0
  299. data/spec/models/issue_status_enum_spec.rb +35 -0
  300. data/spec/models/lead_endpoint_request_spec.rb +34 -0
  301. data/spec/models/lead_request_spec.rb +112 -0
  302. data/spec/models/lead_response_spec.rb +52 -0
  303. data/spec/models/lead_spec.rb +136 -0
  304. data/spec/models/link_token_spec.rb +46 -0
  305. data/spec/models/linked_account_status_spec.rb +40 -0
  306. data/spec/models/meta_response_spec.rb +52 -0
  307. data/spec/models/method_enum_spec.rb +28 -0
  308. data/spec/models/model_operation_spec.rb +52 -0
  309. data/spec/models/multipart_form_field_request_spec.rb +58 -0
  310. data/spec/models/note_endpoint_request_spec.rb +34 -0
  311. data/spec/models/note_request_spec.rb +88 -0
  312. data/spec/models/note_response_spec.rb +52 -0
  313. data/spec/models/note_spec.rb +94 -0
  314. data/spec/models/opportunity_endpoint_request_spec.rb +34 -0
  315. data/spec/models/opportunity_request_spec.rb +106 -0
  316. data/spec/models/opportunity_response_spec.rb +52 -0
  317. data/spec/models/opportunity_spec.rb +112 -0
  318. data/spec/models/opportunity_status_enum_spec.rb +28 -0
  319. data/spec/models/paginated_account_details_and_actions_list_spec.rb +46 -0
  320. data/spec/models/paginated_account_list_spec.rb +46 -0
  321. data/spec/models/paginated_contact_list_spec.rb +46 -0
  322. data/spec/models/paginated_engagement_list_spec.rb +46 -0
  323. data/spec/models/paginated_engagement_type_list_spec.rb +46 -0
  324. data/spec/models/paginated_issue_list_spec.rb +46 -0
  325. data/spec/models/paginated_lead_list_spec.rb +46 -0
  326. data/spec/models/paginated_note_list_spec.rb +46 -0
  327. data/spec/models/paginated_opportunity_list_spec.rb +46 -0
  328. data/spec/models/paginated_stage_list_spec.rb +46 -0
  329. data/spec/models/paginated_sync_status_list_spec.rb +46 -0
  330. data/spec/models/paginated_task_list_spec.rb +46 -0
  331. data/spec/models/paginated_user_list_spec.rb +46 -0
  332. data/spec/models/phone_number_request_spec.rb +40 -0
  333. data/spec/models/phone_number_spec.rb +40 -0
  334. data/spec/models/remote_data_spec.rb +40 -0
  335. data/spec/models/remote_key_for_regeneration_request_spec.rb +34 -0
  336. data/spec/models/remote_key_spec.rb +40 -0
  337. data/spec/models/remote_response_spec.rb +64 -0
  338. data/spec/models/request_format_enum_spec.rb +28 -0
  339. data/spec/models/stage_spec.rb +58 -0
  340. data/spec/models/sync_status_spec.rb +64 -0
  341. data/spec/models/sync_status_status_enum_spec.rb +28 -0
  342. data/spec/models/task_spec.rb +94 -0
  343. data/spec/models/task_status_enum_spec.rb +28 -0
  344. data/spec/models/user_spec.rb +70 -0
  345. data/spec/models/validation_problem_source_spec.rb +34 -0
  346. data/spec/models/warning_validation_problem_spec.rb +52 -0
  347. data/spec/models/webhook_receiver_request_spec.rb +46 -0
  348. data/spec/models/webhook_receiver_spec.rb +46 -0
  349. data/spec/spec_helper.rb +111 -0
  350. metadata +545 -0
@@ -0,0 +1,182 @@
1
+ =begin
2
+ #Merge CRM API
3
+
4
+ #The unified API for building rich integrations with multiple CRM platforms.
5
+
6
+ The version of the OpenAPI document: 1.0
7
+ Contact: hello@merge.dev
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MergeCRMClient
16
+ class StagesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Returns a list of `Stage` objects.
23
+ # @param x_account_token [String] Token identifying the end user.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
26
+ # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
27
+ # @option opts [String] :cursor The pagination cursor value.
28
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
29
+ # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
30
+ # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
31
+ # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
32
+ # @option opts [Integer] :page_size Number of results to return per page.
33
+ # @option opts [String] :remote_id The API provider's ID for the given object.
34
+ # @return [PaginatedStageList]
35
+ def stages_list(x_account_token, opts = {})
36
+ data, _status_code, _headers = stages_list_with_http_info(x_account_token, opts)
37
+ data
38
+ end
39
+
40
+ # Returns a list of `Stage` objects.
41
+ # @param x_account_token [String] Token identifying the end user.
42
+ # @param [Hash] opts the optional parameters
43
+ # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
44
+ # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
45
+ # @option opts [String] :cursor The pagination cursor value.
46
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
47
+ # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
48
+ # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
49
+ # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
50
+ # @option opts [Integer] :page_size Number of results to return per page.
51
+ # @option opts [String] :remote_id The API provider's ID for the given object.
52
+ # @return [Array<(PaginatedStageList, Integer, Hash)>] PaginatedStageList data, response status code and response headers
53
+ def stages_list_with_http_info(x_account_token, opts = {})
54
+ if @api_client.config.debugging
55
+ @api_client.config.logger.debug 'Calling API: StagesApi.stages_list ...'
56
+ end
57
+ # verify the required parameter 'x_account_token' is set
58
+ if @api_client.config.client_side_validation && x_account_token.nil?
59
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling StagesApi.stages_list"
60
+ end
61
+ # resource path
62
+ local_var_path = '/stages'
63
+
64
+ # query parameters
65
+ query_params = opts[:query_params] || {}
66
+ query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
67
+ query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
68
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
69
+ query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
70
+ query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
71
+ query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
72
+ query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
73
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
74
+ query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
75
+
76
+ # header parameters
77
+ header_params = opts[:header_params] || {}
78
+ # HTTP header 'Accept' (if needed)
79
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
80
+ header_params[:'X-Account-Token'] = x_account_token
81
+
82
+ # form parameters
83
+ form_params = opts[:form_params] || {}
84
+
85
+ # http body (model)
86
+ post_body = opts[:debug_body]
87
+
88
+ # return_type
89
+ return_type = opts[:debug_return_type] || 'PaginatedStageList'
90
+
91
+ # auth_names
92
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
93
+
94
+ new_options = opts.merge(
95
+ :operation => :"StagesApi.stages_list",
96
+ :header_params => header_params,
97
+ :query_params => query_params,
98
+ :form_params => form_params,
99
+ :body => post_body,
100
+ :auth_names => auth_names,
101
+ :return_type => return_type
102
+ )
103
+
104
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
105
+ if @api_client.config.debugging
106
+ @api_client.config.logger.debug "API called: StagesApi#stages_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
107
+ end
108
+ return data, status_code, headers
109
+ end
110
+
111
+ # Returns a `Stage` object with the given `id`.
112
+ # @param x_account_token [String] Token identifying the end user.
113
+ # @param id [String]
114
+ # @param [Hash] opts the optional parameters
115
+ # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
116
+ # @return [Stage]
117
+ def stages_retrieve(x_account_token, id, opts = {})
118
+ data, _status_code, _headers = stages_retrieve_with_http_info(x_account_token, id, opts)
119
+ data
120
+ end
121
+
122
+ # Returns a &#x60;Stage&#x60; object with the given &#x60;id&#x60;.
123
+ # @param x_account_token [String] Token identifying the end user.
124
+ # @param id [String]
125
+ # @param [Hash] opts the optional parameters
126
+ # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
127
+ # @return [Array<(Stage, Integer, Hash)>] Stage data, response status code and response headers
128
+ def stages_retrieve_with_http_info(x_account_token, id, opts = {})
129
+ if @api_client.config.debugging
130
+ @api_client.config.logger.debug 'Calling API: StagesApi.stages_retrieve ...'
131
+ end
132
+ # verify the required parameter 'x_account_token' is set
133
+ if @api_client.config.client_side_validation && x_account_token.nil?
134
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling StagesApi.stages_retrieve"
135
+ end
136
+ # verify the required parameter 'id' is set
137
+ if @api_client.config.client_side_validation && id.nil?
138
+ fail ArgumentError, "Missing the required parameter 'id' when calling StagesApi.stages_retrieve"
139
+ end
140
+ # resource path
141
+ local_var_path = '/stages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
142
+
143
+ # query parameters
144
+ query_params = opts[:query_params] || {}
145
+ query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
146
+
147
+ # header parameters
148
+ header_params = opts[:header_params] || {}
149
+ # HTTP header 'Accept' (if needed)
150
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
151
+ header_params[:'X-Account-Token'] = x_account_token
152
+
153
+ # form parameters
154
+ form_params = opts[:form_params] || {}
155
+
156
+ # http body (model)
157
+ post_body = opts[:debug_body]
158
+
159
+ # return_type
160
+ return_type = opts[:debug_return_type] || 'Stage'
161
+
162
+ # auth_names
163
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
164
+
165
+ new_options = opts.merge(
166
+ :operation => :"StagesApi.stages_retrieve",
167
+ :header_params => header_params,
168
+ :query_params => query_params,
169
+ :form_params => form_params,
170
+ :body => post_body,
171
+ :auth_names => auth_names,
172
+ :return_type => return_type
173
+ )
174
+
175
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
176
+ if @api_client.config.debugging
177
+ @api_client.config.logger.debug "API called: StagesApi#stages_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
178
+ end
179
+ return data, status_code, headers
180
+ end
181
+ end
182
+ end
@@ -0,0 +1,90 @@
1
+ =begin
2
+ #Merge CRM API
3
+
4
+ #The unified API for building rich integrations with multiple CRM platforms.
5
+
6
+ The version of the OpenAPI document: 1.0
7
+ Contact: hello@merge.dev
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MergeCRMClient
16
+ class SyncStatusApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PAUSED`, `SYNCING`
23
+ # @param x_account_token [String] Token identifying the end user.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [String] :cursor The pagination cursor value.
26
+ # @option opts [Integer] :page_size Number of results to return per page.
27
+ # @return [PaginatedSyncStatusList]
28
+ def sync_status_list(x_account_token, opts = {})
29
+ data, _status_code, _headers = sync_status_list_with_http_info(x_account_token, opts)
30
+ data
31
+ end
32
+
33
+ # Get syncing status. Possible values: &#x60;DISABLED&#x60;, &#x60;DONE&#x60;, &#x60;FAILED&#x60;, &#x60;PAUSED&#x60;, &#x60;SYNCING&#x60;
34
+ # @param x_account_token [String] Token identifying the end user.
35
+ # @param [Hash] opts the optional parameters
36
+ # @option opts [String] :cursor The pagination cursor value.
37
+ # @option opts [Integer] :page_size Number of results to return per page.
38
+ # @return [Array<(PaginatedSyncStatusList, Integer, Hash)>] PaginatedSyncStatusList data, response status code and response headers
39
+ def sync_status_list_with_http_info(x_account_token, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: SyncStatusApi.sync_status_list ...'
42
+ end
43
+ # verify the required parameter 'x_account_token' is set
44
+ if @api_client.config.client_side_validation && x_account_token.nil?
45
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling SyncStatusApi.sync_status_list"
46
+ end
47
+ # resource path
48
+ local_var_path = '/sync-status'
49
+
50
+ # query parameters
51
+ query_params = opts[:query_params] || {}
52
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
53
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
54
+
55
+ # header parameters
56
+ header_params = opts[:header_params] || {}
57
+ # HTTP header 'Accept' (if needed)
58
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
59
+ header_params[:'X-Account-Token'] = x_account_token
60
+
61
+ # form parameters
62
+ form_params = opts[:form_params] || {}
63
+
64
+ # http body (model)
65
+ post_body = opts[:debug_body]
66
+
67
+ # return_type
68
+ return_type = opts[:debug_return_type] || 'PaginatedSyncStatusList'
69
+
70
+ # auth_names
71
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
72
+
73
+ new_options = opts.merge(
74
+ :operation => :"SyncStatusApi.sync_status_list",
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => return_type
81
+ )
82
+
83
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "API called: SyncStatusApi#sync_status_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ end
87
+ return data, status_code, headers
88
+ end
89
+ end
90
+ end
@@ -0,0 +1,196 @@
1
+ =begin
2
+ #Merge CRM API
3
+
4
+ #The unified API for building rich integrations with multiple CRM platforms.
5
+
6
+ The version of the OpenAPI document: 1.0
7
+ Contact: hello@merge.dev
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MergeCRMClient
16
+ class TasksApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Returns a list of `Task` objects.
23
+ # @param x_account_token [String] Token identifying the end user.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
26
+ # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
27
+ # @option opts [String] :cursor The pagination cursor value.
28
+ # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
29
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
30
+ # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
31
+ # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
32
+ # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
33
+ # @option opts [Integer] :page_size Number of results to return per page.
34
+ # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
35
+ # @return [PaginatedTaskList]
36
+ def tasks_list(x_account_token, opts = {})
37
+ data, _status_code, _headers = tasks_list_with_http_info(x_account_token, opts)
38
+ data
39
+ end
40
+
41
+ # Returns a list of &#x60;Task&#x60; objects.
42
+ # @param x_account_token [String] Token identifying the end user.
43
+ # @param [Hash] opts the optional parameters
44
+ # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
45
+ # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
46
+ # @option opts [String] :cursor The pagination cursor value.
47
+ # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
48
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
49
+ # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
50
+ # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
51
+ # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
52
+ # @option opts [Integer] :page_size Number of results to return per page.
53
+ # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
54
+ # @return [Array<(PaginatedTaskList, Integer, Hash)>] PaginatedTaskList data, response status code and response headers
55
+ def tasks_list_with_http_info(x_account_token, opts = {})
56
+ if @api_client.config.debugging
57
+ @api_client.config.logger.debug 'Calling API: TasksApi.tasks_list ...'
58
+ end
59
+ # verify the required parameter 'x_account_token' is set
60
+ if @api_client.config.client_side_validation && x_account_token.nil?
61
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling TasksApi.tasks_list"
62
+ end
63
+ allowable_values = ["account", "owner", "owner,account"]
64
+ if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
65
+ fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
66
+ end
67
+ # resource path
68
+ local_var_path = '/tasks'
69
+
70
+ # query parameters
71
+ query_params = opts[:query_params] || {}
72
+ query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
73
+ query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
74
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
75
+ query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
76
+ query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
77
+ query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
78
+ query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
79
+ query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
80
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
81
+ query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
82
+
83
+ # header parameters
84
+ header_params = opts[:header_params] || {}
85
+ # HTTP header 'Accept' (if needed)
86
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
87
+ header_params[:'X-Account-Token'] = x_account_token
88
+
89
+ # form parameters
90
+ form_params = opts[:form_params] || {}
91
+
92
+ # http body (model)
93
+ post_body = opts[:debug_body]
94
+
95
+ # return_type
96
+ return_type = opts[:debug_return_type] || 'PaginatedTaskList'
97
+
98
+ # auth_names
99
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
100
+
101
+ new_options = opts.merge(
102
+ :operation => :"TasksApi.tasks_list",
103
+ :header_params => header_params,
104
+ :query_params => query_params,
105
+ :form_params => form_params,
106
+ :body => post_body,
107
+ :auth_names => auth_names,
108
+ :return_type => return_type
109
+ )
110
+
111
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
112
+ if @api_client.config.debugging
113
+ @api_client.config.logger.debug "API called: TasksApi#tasks_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
114
+ end
115
+ return data, status_code, headers
116
+ end
117
+
118
+ # Returns a `Task` object with the given `id`.
119
+ # @param x_account_token [String] Token identifying the end user.
120
+ # @param id [String]
121
+ # @param [Hash] opts the optional parameters
122
+ # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
123
+ # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
124
+ # @return [Task]
125
+ def tasks_retrieve(x_account_token, id, opts = {})
126
+ data, _status_code, _headers = tasks_retrieve_with_http_info(x_account_token, id, opts)
127
+ data
128
+ end
129
+
130
+ # Returns a &#x60;Task&#x60; object with the given &#x60;id&#x60;.
131
+ # @param x_account_token [String] Token identifying the end user.
132
+ # @param id [String]
133
+ # @param [Hash] opts the optional parameters
134
+ # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
135
+ # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
136
+ # @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers
137
+ def tasks_retrieve_with_http_info(x_account_token, id, opts = {})
138
+ if @api_client.config.debugging
139
+ @api_client.config.logger.debug 'Calling API: TasksApi.tasks_retrieve ...'
140
+ end
141
+ # verify the required parameter 'x_account_token' is set
142
+ if @api_client.config.client_side_validation && x_account_token.nil?
143
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling TasksApi.tasks_retrieve"
144
+ end
145
+ # verify the required parameter 'id' is set
146
+ if @api_client.config.client_side_validation && id.nil?
147
+ fail ArgumentError, "Missing the required parameter 'id' when calling TasksApi.tasks_retrieve"
148
+ end
149
+ allowable_values = ["account", "owner", "owner,account"]
150
+ if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
151
+ fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
152
+ end
153
+ # resource path
154
+ local_var_path = '/tasks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
155
+
156
+ # query parameters
157
+ query_params = opts[:query_params] || {}
158
+ query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
159
+ query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
160
+
161
+ # header parameters
162
+ header_params = opts[:header_params] || {}
163
+ # HTTP header 'Accept' (if needed)
164
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
165
+ header_params[:'X-Account-Token'] = x_account_token
166
+
167
+ # form parameters
168
+ form_params = opts[:form_params] || {}
169
+
170
+ # http body (model)
171
+ post_body = opts[:debug_body]
172
+
173
+ # return_type
174
+ return_type = opts[:debug_return_type] || 'Task'
175
+
176
+ # auth_names
177
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
178
+
179
+ new_options = opts.merge(
180
+ :operation => :"TasksApi.tasks_retrieve",
181
+ :header_params => header_params,
182
+ :query_params => query_params,
183
+ :form_params => form_params,
184
+ :body => post_body,
185
+ :auth_names => auth_names,
186
+ :return_type => return_type
187
+ )
188
+
189
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
190
+ if @api_client.config.debugging
191
+ @api_client.config.logger.debug "API called: TasksApi#tasks_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
192
+ end
193
+ return data, status_code, headers
194
+ end
195
+ end
196
+ end
@@ -0,0 +1,182 @@
1
+ =begin
2
+ #Merge CRM API
3
+
4
+ #The unified API for building rich integrations with multiple CRM platforms.
5
+
6
+ The version of the OpenAPI document: 1.0
7
+ Contact: hello@merge.dev
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MergeCRMClient
16
+ class UsersApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Returns a list of `User` objects.
23
+ # @param x_account_token [String] Token identifying the end user.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
26
+ # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
27
+ # @option opts [String] :cursor The pagination cursor value.
28
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
29
+ # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
30
+ # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
31
+ # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
32
+ # @option opts [Integer] :page_size Number of results to return per page.
33
+ # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
34
+ # @return [PaginatedUserList]
35
+ def users_list(x_account_token, opts = {})
36
+ data, _status_code, _headers = users_list_with_http_info(x_account_token, opts)
37
+ data
38
+ end
39
+
40
+ # Returns a list of &#x60;User&#x60; objects.
41
+ # @param x_account_token [String] Token identifying the end user.
42
+ # @param [Hash] opts the optional parameters
43
+ # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
44
+ # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
45
+ # @option opts [String] :cursor The pagination cursor value.
46
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
47
+ # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
48
+ # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
49
+ # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
50
+ # @option opts [Integer] :page_size Number of results to return per page.
51
+ # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
52
+ # @return [Array<(PaginatedUserList, Integer, Hash)>] PaginatedUserList data, response status code and response headers
53
+ def users_list_with_http_info(x_account_token, opts = {})
54
+ if @api_client.config.debugging
55
+ @api_client.config.logger.debug 'Calling API: UsersApi.users_list ...'
56
+ end
57
+ # verify the required parameter 'x_account_token' is set
58
+ if @api_client.config.client_side_validation && x_account_token.nil?
59
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling UsersApi.users_list"
60
+ end
61
+ # resource path
62
+ local_var_path = '/users'
63
+
64
+ # query parameters
65
+ query_params = opts[:query_params] || {}
66
+ query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
67
+ query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
68
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
69
+ query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
70
+ query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
71
+ query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
72
+ query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
73
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
74
+ query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
75
+
76
+ # header parameters
77
+ header_params = opts[:header_params] || {}
78
+ # HTTP header 'Accept' (if needed)
79
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
80
+ header_params[:'X-Account-Token'] = x_account_token
81
+
82
+ # form parameters
83
+ form_params = opts[:form_params] || {}
84
+
85
+ # http body (model)
86
+ post_body = opts[:debug_body]
87
+
88
+ # return_type
89
+ return_type = opts[:debug_return_type] || 'PaginatedUserList'
90
+
91
+ # auth_names
92
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
93
+
94
+ new_options = opts.merge(
95
+ :operation => :"UsersApi.users_list",
96
+ :header_params => header_params,
97
+ :query_params => query_params,
98
+ :form_params => form_params,
99
+ :body => post_body,
100
+ :auth_names => auth_names,
101
+ :return_type => return_type
102
+ )
103
+
104
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
105
+ if @api_client.config.debugging
106
+ @api_client.config.logger.debug "API called: UsersApi#users_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
107
+ end
108
+ return data, status_code, headers
109
+ end
110
+
111
+ # Returns a `User` object with the given `id`.
112
+ # @param x_account_token [String] Token identifying the end user.
113
+ # @param id [String]
114
+ # @param [Hash] opts the optional parameters
115
+ # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
116
+ # @return [User]
117
+ def users_retrieve(x_account_token, id, opts = {})
118
+ data, _status_code, _headers = users_retrieve_with_http_info(x_account_token, id, opts)
119
+ data
120
+ end
121
+
122
+ # Returns a &#x60;User&#x60; object with the given &#x60;id&#x60;.
123
+ # @param x_account_token [String] Token identifying the end user.
124
+ # @param id [String]
125
+ # @param [Hash] opts the optional parameters
126
+ # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
127
+ # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
128
+ def users_retrieve_with_http_info(x_account_token, id, opts = {})
129
+ if @api_client.config.debugging
130
+ @api_client.config.logger.debug 'Calling API: UsersApi.users_retrieve ...'
131
+ end
132
+ # verify the required parameter 'x_account_token' is set
133
+ if @api_client.config.client_side_validation && x_account_token.nil?
134
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling UsersApi.users_retrieve"
135
+ end
136
+ # verify the required parameter 'id' is set
137
+ if @api_client.config.client_side_validation && id.nil?
138
+ fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.users_retrieve"
139
+ end
140
+ # resource path
141
+ local_var_path = '/users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
142
+
143
+ # query parameters
144
+ query_params = opts[:query_params] || {}
145
+ query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
146
+
147
+ # header parameters
148
+ header_params = opts[:header_params] || {}
149
+ # HTTP header 'Accept' (if needed)
150
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
151
+ header_params[:'X-Account-Token'] = x_account_token
152
+
153
+ # form parameters
154
+ form_params = opts[:form_params] || {}
155
+
156
+ # http body (model)
157
+ post_body = opts[:debug_body]
158
+
159
+ # return_type
160
+ return_type = opts[:debug_return_type] || 'User'
161
+
162
+ # auth_names
163
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
164
+
165
+ new_options = opts.merge(
166
+ :operation => :"UsersApi.users_retrieve",
167
+ :header_params => header_params,
168
+ :query_params => query_params,
169
+ :form_params => form_params,
170
+ :body => post_body,
171
+ :auth_names => auth_names,
172
+ :return_type => return_type
173
+ )
174
+
175
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
176
+ if @api_client.config.debugging
177
+ @api_client.config.logger.debug "API called: UsersApi#users_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
178
+ end
179
+ return data, status_code, headers
180
+ end
181
+ end
182
+ end