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,345 @@
1
+ # MergeCRMClient::OpportunitiesApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/crm/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**opportunities_create**](OpportunitiesApi.md#opportunities_create) | **POST** /opportunities | |
8
+ | [**opportunities_list**](OpportunitiesApi.md#opportunities_list) | **GET** /opportunities | |
9
+ | [**opportunities_meta_post_retrieve**](OpportunitiesApi.md#opportunities_meta_post_retrieve) | **GET** /opportunities/meta/post | |
10
+ | [**opportunities_retrieve**](OpportunitiesApi.md#opportunities_retrieve) | **GET** /opportunities/{id} | |
11
+
12
+
13
+ ## opportunities_create
14
+
15
+ > <OpportunityResponse> opportunities_create(x_account_token, opportunity_endpoint_request, opts)
16
+
17
+
18
+
19
+ Creates an `Opportunity` object with the given values.
20
+
21
+ ### Examples
22
+
23
+ ```ruby
24
+ require 'time'
25
+ require 'merge_crm_client'
26
+ # setup authorization
27
+ MergeCRMClient.configure do |config|
28
+ # Configure API key authorization: tokenAuth
29
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
30
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
31
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
32
+ end
33
+
34
+ api_instance = MergeCRMClient::OpportunitiesApi.new
35
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
36
+ opportunity_endpoint_request = MergeCRMClient::OpportunityEndpointRequest.new({model: MergeCRMClient::OpportunityRequest.new}) # OpportunityEndpointRequest |
37
+ opts = {
38
+ is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
39
+ run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
40
+ }
41
+
42
+ begin
43
+
44
+ result = api_instance.opportunities_create(x_account_token, opportunity_endpoint_request, opts)
45
+ p result
46
+ rescue MergeCRMClient::ApiError => e
47
+ puts "Error when calling OpportunitiesApi->opportunities_create: #{e}"
48
+ end
49
+ ```
50
+
51
+ #### Using the opportunities_create_with_http_info variant
52
+
53
+ This returns an Array which contains the response data, status code and headers.
54
+
55
+ > <Array(<OpportunityResponse>, Integer, Hash)> opportunities_create_with_http_info(x_account_token, opportunity_endpoint_request, opts)
56
+
57
+ ```ruby
58
+ begin
59
+
60
+ data, status_code, headers = api_instance.opportunities_create_with_http_info(x_account_token, opportunity_endpoint_request, opts)
61
+ p status_code # => 2xx
62
+ p headers # => { ... }
63
+ p data # => <OpportunityResponse>
64
+ rescue MergeCRMClient::ApiError => e
65
+ puts "Error when calling OpportunitiesApi->opportunities_create_with_http_info: #{e}"
66
+ end
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ | Name | Type | Description | Notes |
72
+ | ---- | ---- | ----------- | ----- |
73
+ | **x_account_token** | **String** | Token identifying the end user. | |
74
+ | **opportunity_endpoint_request** | [**OpportunityEndpointRequest**](OpportunityEndpointRequest.md) | | |
75
+ | **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
76
+ | **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
77
+
78
+ ### Return type
79
+
80
+ [**OpportunityResponse**](OpportunityResponse.md)
81
+
82
+ ### Authorization
83
+
84
+ [tokenAuth](../README.md#tokenAuth)
85
+
86
+ ### HTTP request headers
87
+
88
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
89
+ - **Accept**: application/json
90
+
91
+
92
+ ## opportunities_list
93
+
94
+ > <PaginatedOpportunityList> opportunities_list(x_account_token, opts)
95
+
96
+
97
+
98
+ Returns a list of `Opportunity` objects.
99
+
100
+ ### Examples
101
+
102
+ ```ruby
103
+ require 'time'
104
+ require 'merge_crm_client'
105
+ # setup authorization
106
+ MergeCRMClient.configure do |config|
107
+ # Configure API key authorization: tokenAuth
108
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
109
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
110
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
111
+ end
112
+
113
+ api_instance = MergeCRMClient::OpportunitiesApi.new
114
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
115
+ opts = {
116
+ account_id: 'account_id_example', # String | If provided, will only return opportunities with this account.
117
+ created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
118
+ created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
119
+ cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
120
+ expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
121
+ include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
122
+ include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
123
+ modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
124
+ modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
125
+ owner_id: 'owner_id_example', # String | If provided, will only return opportunities with this owner.
126
+ page_size: 56, # Integer | Number of results to return per page.
127
+ remote_fields: 'status', # String | Which fields should be returned in non-normalized form.
128
+ remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
129
+ stage_id: 'stage_id_example', # String | If provided, will only return opportunities with this stage.
130
+ status: 'LOST' # String | If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')
131
+ }
132
+
133
+ begin
134
+
135
+ result = api_instance.opportunities_list(x_account_token, opts)
136
+ p result
137
+ rescue MergeCRMClient::ApiError => e
138
+ puts "Error when calling OpportunitiesApi->opportunities_list: #{e}"
139
+ end
140
+ ```
141
+
142
+ #### Using the opportunities_list_with_http_info variant
143
+
144
+ This returns an Array which contains the response data, status code and headers.
145
+
146
+ > <Array(<PaginatedOpportunityList>, Integer, Hash)> opportunities_list_with_http_info(x_account_token, opts)
147
+
148
+ ```ruby
149
+ begin
150
+
151
+ data, status_code, headers = api_instance.opportunities_list_with_http_info(x_account_token, opts)
152
+ p status_code # => 2xx
153
+ p headers # => { ... }
154
+ p data # => <PaginatedOpportunityList>
155
+ rescue MergeCRMClient::ApiError => e
156
+ puts "Error when calling OpportunitiesApi->opportunities_list_with_http_info: #{e}"
157
+ end
158
+ ```
159
+
160
+ ### Parameters
161
+
162
+ | Name | Type | Description | Notes |
163
+ | ---- | ---- | ----------- | ----- |
164
+ | **x_account_token** | **String** | Token identifying the end user. | |
165
+ | **account_id** | **String** | If provided, will only return opportunities with this account. | [optional] |
166
+ | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
167
+ | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
168
+ | **cursor** | **String** | The pagination cursor value. | [optional] |
169
+ | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
170
+ | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
171
+ | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
172
+ | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
173
+ | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
174
+ | **owner_id** | **String** | If provided, will only return opportunities with this owner. | [optional] |
175
+ | **page_size** | **Integer** | Number of results to return per page. | [optional] |
176
+ | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
177
+ | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
178
+ | **stage_id** | **String** | If provided, will only return opportunities with this stage. | [optional] |
179
+ | **status** | **String** | If provided, will only return opportunities with this status. Options: (&#39;OPEN&#39;, &#39;WON&#39;, &#39;LOST&#39;) | [optional] |
180
+
181
+ ### Return type
182
+
183
+ [**PaginatedOpportunityList**](PaginatedOpportunityList.md)
184
+
185
+ ### Authorization
186
+
187
+ [tokenAuth](../README.md#tokenAuth)
188
+
189
+ ### HTTP request headers
190
+
191
+ - **Content-Type**: Not defined
192
+ - **Accept**: application/json
193
+
194
+
195
+ ## opportunities_meta_post_retrieve
196
+
197
+ > <MetaResponse> opportunities_meta_post_retrieve(x_account_token)
198
+
199
+
200
+
201
+ Returns metadata for `Opportunity` POSTs.
202
+
203
+ ### Examples
204
+
205
+ ```ruby
206
+ require 'time'
207
+ require 'merge_crm_client'
208
+ # setup authorization
209
+ MergeCRMClient.configure do |config|
210
+ # Configure API key authorization: tokenAuth
211
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
212
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
213
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
214
+ end
215
+
216
+ api_instance = MergeCRMClient::OpportunitiesApi.new
217
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
218
+
219
+ begin
220
+
221
+ result = api_instance.opportunities_meta_post_retrieve(x_account_token)
222
+ p result
223
+ rescue MergeCRMClient::ApiError => e
224
+ puts "Error when calling OpportunitiesApi->opportunities_meta_post_retrieve: #{e}"
225
+ end
226
+ ```
227
+
228
+ #### Using the opportunities_meta_post_retrieve_with_http_info variant
229
+
230
+ This returns an Array which contains the response data, status code and headers.
231
+
232
+ > <Array(<MetaResponse>, Integer, Hash)> opportunities_meta_post_retrieve_with_http_info(x_account_token)
233
+
234
+ ```ruby
235
+ begin
236
+
237
+ data, status_code, headers = api_instance.opportunities_meta_post_retrieve_with_http_info(x_account_token)
238
+ p status_code # => 2xx
239
+ p headers # => { ... }
240
+ p data # => <MetaResponse>
241
+ rescue MergeCRMClient::ApiError => e
242
+ puts "Error when calling OpportunitiesApi->opportunities_meta_post_retrieve_with_http_info: #{e}"
243
+ end
244
+ ```
245
+
246
+ ### Parameters
247
+
248
+ | Name | Type | Description | Notes |
249
+ | ---- | ---- | ----------- | ----- |
250
+ | **x_account_token** | **String** | Token identifying the end user. | |
251
+
252
+ ### Return type
253
+
254
+ [**MetaResponse**](MetaResponse.md)
255
+
256
+ ### Authorization
257
+
258
+ [tokenAuth](../README.md#tokenAuth)
259
+
260
+ ### HTTP request headers
261
+
262
+ - **Content-Type**: Not defined
263
+ - **Accept**: application/json
264
+
265
+
266
+ ## opportunities_retrieve
267
+
268
+ > <Opportunity> opportunities_retrieve(x_account_token, id, opts)
269
+
270
+
271
+
272
+ Returns an `Opportunity` object with the given `id`.
273
+
274
+ ### Examples
275
+
276
+ ```ruby
277
+ require 'time'
278
+ require 'merge_crm_client'
279
+ # setup authorization
280
+ MergeCRMClient.configure do |config|
281
+ # Configure API key authorization: tokenAuth
282
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
283
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
284
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
285
+ end
286
+
287
+ api_instance = MergeCRMClient::OpportunitiesApi.new
288
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
289
+ id = TODO # String |
290
+ opts = {
291
+ expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
292
+ include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
293
+ remote_fields: 'status' # String | Which fields should be returned in non-normalized form.
294
+ }
295
+
296
+ begin
297
+
298
+ result = api_instance.opportunities_retrieve(x_account_token, id, opts)
299
+ p result
300
+ rescue MergeCRMClient::ApiError => e
301
+ puts "Error when calling OpportunitiesApi->opportunities_retrieve: #{e}"
302
+ end
303
+ ```
304
+
305
+ #### Using the opportunities_retrieve_with_http_info variant
306
+
307
+ This returns an Array which contains the response data, status code and headers.
308
+
309
+ > <Array(<Opportunity>, Integer, Hash)> opportunities_retrieve_with_http_info(x_account_token, id, opts)
310
+
311
+ ```ruby
312
+ begin
313
+
314
+ data, status_code, headers = api_instance.opportunities_retrieve_with_http_info(x_account_token, id, opts)
315
+ p status_code # => 2xx
316
+ p headers # => { ... }
317
+ p data # => <Opportunity>
318
+ rescue MergeCRMClient::ApiError => e
319
+ puts "Error when calling OpportunitiesApi->opportunities_retrieve_with_http_info: #{e}"
320
+ end
321
+ ```
322
+
323
+ ### Parameters
324
+
325
+ | Name | Type | Description | Notes |
326
+ | ---- | ---- | ----------- | ----- |
327
+ | **x_account_token** | **String** | Token identifying the end user. | |
328
+ | **id** | [**String**](.md) | | |
329
+ | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
330
+ | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
331
+ | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
332
+
333
+ ### Return type
334
+
335
+ [**Opportunity**](Opportunity.md)
336
+
337
+ ### Authorization
338
+
339
+ [tokenAuth](../README.md#tokenAuth)
340
+
341
+ ### HTTP request headers
342
+
343
+ - **Content-Type**: Not defined
344
+ - **Accept**: application/json
345
+
@@ -0,0 +1,44 @@
1
+ # MergeCRMClient::Opportunity
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **name** | **String** | The opportunity&#39;s name. | [optional] |
10
+ | **description** | **String** | The opportunity&#39;s description. | [optional] |
11
+ | **amount** | **Integer** | The opportunity&#39;s amount. | [optional] |
12
+ | **owner** | **String** | | [optional] |
13
+ | **account** | **String** | | [optional] |
14
+ | **stage** | **String** | | [optional] |
15
+ | **status** | [**OpportunityStatusEnum**](OpportunityStatusEnum.md) | The opportunity&#39;s status. | [optional] |
16
+ | **last_activity_at** | **Time** | When the opportunity&#39;s last activity occurred. | [optional] |
17
+ | **close_date** | **Time** | When the opportunity was closed. | [optional] |
18
+ | **remote_created_at** | **Time** | When the third party&#39;s opportunity was created. | [optional] |
19
+ | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
20
+ | **remote_was_deleted** | **Boolean** | | [optional][readonly] |
21
+
22
+ ## Example
23
+
24
+ ```ruby
25
+ require 'merge_crm_client'
26
+
27
+ instance = MergeCRMClient::Opportunity.new(
28
+ id: null,
29
+ remote_id: 19202938,
30
+ name: Needs Integrations,
31
+ description: Needs a Unified API for Integrations!,
32
+ amount: 100000,
33
+ owner: 0358cbc6-2040-430a-848e-aafacbadf3aa,
34
+ account: 0958cbc6-6040-430a-848e-aafacbadf4ae,
35
+ stage: 1968cbc6-6040-430a-848e-aafacbadf4ad,
36
+ status: WON,
37
+ last_activity_at: 2022-02-10T00:00Z,
38
+ close_date: 2022-02-10T00:00Z,
39
+ remote_created_at: 2021-11-10T00:00Z,
40
+ remote_data: [{&quot;path&quot;:&quot;/opportunities&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}],
41
+ remote_was_deleted: null
42
+ )
43
+ ```
44
+
@@ -0,0 +1,18 @@
1
+ # MergeCRMClient::OpportunityEndpointRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model** | [**OpportunityRequest**](OpportunityRequest.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'merge_crm_client'
13
+
14
+ instance = MergeCRMClient::OpportunityEndpointRequest.new(
15
+ model: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,42 @@
1
+ # MergeCRMClient::OpportunityRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
8
+ | **name** | **String** | The opportunity&#39;s name. | [optional] |
9
+ | **description** | **String** | The opportunity&#39;s description. | [optional] |
10
+ | **amount** | **Integer** | The opportunity&#39;s amount. | [optional] |
11
+ | **owner** | **String** | | [optional] |
12
+ | **account** | **String** | | [optional] |
13
+ | **stage** | **String** | | [optional] |
14
+ | **status** | [**OpportunityStatusEnum**](OpportunityStatusEnum.md) | The opportunity&#39;s status. | [optional] |
15
+ | **last_activity_at** | **Time** | When the opportunity&#39;s last activity occurred. | [optional] |
16
+ | **close_date** | **Time** | When the opportunity was closed. | [optional] |
17
+ | **remote_created_at** | **Time** | When the third party&#39;s opportunity was created. | [optional] |
18
+ | **integration_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
19
+ | **linked_account_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'merge_crm_client'
25
+
26
+ instance = MergeCRMClient::OpportunityRequest.new(
27
+ remote_id: 19202938,
28
+ name: Needs Integrations,
29
+ description: Needs a Unified API for Integrations!,
30
+ amount: 100000,
31
+ owner: 0358cbc6-2040-430a-848e-aafacbadf3aa,
32
+ account: 0958cbc6-6040-430a-848e-aafacbadf4ae,
33
+ stage: 1968cbc6-6040-430a-848e-aafacbadf4ad,
34
+ status: WON,
35
+ last_activity_at: 2022-02-10T00:00Z,
36
+ close_date: 2022-02-10T00:00Z,
37
+ remote_created_at: 2021-11-10T00:00Z,
38
+ integration_params: null,
39
+ linked_account_params: null
40
+ )
41
+ ```
42
+
@@ -0,0 +1,24 @@
1
+ # MergeCRMClient::OpportunityResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model** | [**Opportunity**](Opportunity.md) | | |
8
+ | **warnings** | [**Array&lt;WarningValidationProblem&gt;**](WarningValidationProblem.md) | | |
9
+ | **errors** | [**Array&lt;ErrorValidationProblem&gt;**](ErrorValidationProblem.md) | | |
10
+ | **logs** | [**Array&lt;DebugModeLog&gt;**](DebugModeLog.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'merge_crm_client'
16
+
17
+ instance = MergeCRMClient::OpportunityResponse.new(
18
+ model: null,
19
+ warnings: null,
20
+ errors: null,
21
+ logs: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,15 @@
1
+ # MergeCRMClient::OpportunityStatusEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'merge_crm_client'
12
+
13
+ instance = MergeCRMClient::OpportunityStatusEnum.new()
14
+ ```
15
+
@@ -0,0 +1,22 @@
1
+ # MergeCRMClient::PaginatedAccountDetailsAndActionsList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;AccountDetailsAndActions&gt;**](AccountDetailsAndActions.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_crm_client'
15
+
16
+ instance = MergeCRMClient::PaginatedAccountDetailsAndActionsList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeCRMClient::PaginatedAccountList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;Account&gt;**](Account.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_crm_client'
15
+
16
+ instance = MergeCRMClient::PaginatedAccountList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeCRMClient::PaginatedContactList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;Contact&gt;**](Contact.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_crm_client'
15
+
16
+ instance = MergeCRMClient::PaginatedContactList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeCRMClient::PaginatedEngagementList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;Engagement&gt;**](Engagement.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_crm_client'
15
+
16
+ instance = MergeCRMClient::PaginatedEngagementList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeCRMClient::PaginatedEngagementTypeList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;EngagementType&gt;**](EngagementType.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_crm_client'
15
+
16
+ instance = MergeCRMClient::PaginatedEngagementTypeList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeCRMClient::PaginatedIssueList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;Issue&gt;**](Issue.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_crm_client'
15
+
16
+ instance = MergeCRMClient::PaginatedIssueList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeCRMClient::PaginatedLeadList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;Lead&gt;**](Lead.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_crm_client'
15
+
16
+ instance = MergeCRMClient::PaginatedLeadList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeCRMClient::PaginatedNoteList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;Note&gt;**](Note.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_crm_client'
15
+
16
+ instance = MergeCRMClient::PaginatedNoteList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+