merge_ruby_client 0.1.3 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (88) hide show
  1. checksums.yaml +4 -4
  2. data/lib/merge_ruby_client/accounting/types/credit_note_line_item.rb +4 -4
  3. data/lib/merge_ruby_client/accounting/types/purchase_order_line_item.rb +4 -4
  4. data/lib/merge_ruby_client/accounting/types/purchase_order_line_item_request.rb +4 -4
  5. data/lib/merge_ruby_client/accounting/types/transaction_line_item.rb +4 -4
  6. data/lib/merge_ruby_client/accounting/types/vendor_credit_line.rb +4 -4
  7. data/lib/merge_ruby_client/ats/applications/client.rb +2 -0
  8. data/lib/merge_ruby_client/ats/applications/types/applications_list_request_expand.rb +192 -0
  9. data/lib/merge_ruby_client/ats/applications/types/applications_retrieve_request_expand.rb +192 -0
  10. data/lib/merge_ruby_client/ats/audit_trail/client.rb +4 -2
  11. data/lib/merge_ruby_client/ats/issues/client.rb +10 -4
  12. data/lib/merge_ruby_client/ats/link_token/client.rb +10 -2
  13. data/lib/merge_ruby_client/ats/types/account_integration.rb +16 -2
  14. data/lib/merge_ruby_client/ats/types/activity.rb +2 -2
  15. data/lib/merge_ruby_client/ats/types/activity_request.rb +2 -2
  16. data/lib/merge_ruby_client/ats/types/application.rb +13 -1
  17. data/lib/merge_ruby_client/ats/types/application_request.rb +13 -1
  18. data/lib/merge_ruby_client/ats/types/application_request_screening_question_answers_item.rb +56 -0
  19. data/lib/merge_ruby_client/ats/types/application_screening_question_answers_item.rb +56 -0
  20. data/lib/merge_ruby_client/ats/types/audit_log_event.rb +2 -0
  21. data/lib/merge_ruby_client/ats/types/email_address.rb +12 -2
  22. data/lib/merge_ruby_client/ats/types/event_type_enum.rb +2 -0
  23. data/lib/merge_ruby_client/ats/types/phone_number.rb +12 -2
  24. data/lib/merge_ruby_client/ats/types/remote_field_api.rb +3 -3
  25. data/lib/merge_ruby_client/ats/types/screening_question.rb +12 -2
  26. data/lib/merge_ruby_client/ats/types/screening_question_answer.rb +132 -0
  27. data/lib/merge_ruby_client/ats/types/screening_question_answer_question.rb +58 -0
  28. data/lib/merge_ruby_client/ats/types/screening_question_answer_request.rb +113 -0
  29. data/lib/merge_ruby_client/ats/types/screening_question_answer_request_question.rb +59 -0
  30. data/lib/merge_ruby_client/ats/types/screening_question_option.rb +12 -2
  31. data/lib/merge_ruby_client/ats/types/url.rb +13 -2
  32. data/lib/merge_ruby_client/crm/accounts/client.rb +8 -2
  33. data/lib/merge_ruby_client/crm/audit_trail/client.rb +4 -2
  34. data/lib/merge_ruby_client/crm/contacts/client.rb +8 -2
  35. data/lib/merge_ruby_client/crm/custom_objects/client.rb +99 -0
  36. data/lib/merge_ruby_client/crm/engagement_types/client.rb +8 -2
  37. data/lib/merge_ruby_client/crm/engagements/client.rb +8 -2
  38. data/lib/merge_ruby_client/crm/issues/client.rb +10 -4
  39. data/lib/merge_ruby_client/crm/leads/client.rb +8 -2
  40. data/lib/merge_ruby_client/crm/link_token/client.rb +10 -2
  41. data/lib/merge_ruby_client/crm/notes/client.rb +8 -2
  42. data/lib/merge_ruby_client/crm/opportunities/client.rb +16 -4
  43. data/lib/merge_ruby_client/crm/stages/client.rb +8 -2
  44. data/lib/merge_ruby_client/crm/tasks/client.rb +8 -2
  45. data/lib/merge_ruby_client/crm/types/account_integration.rb +16 -2
  46. data/lib/merge_ruby_client/crm/types/association.rb +6 -6
  47. data/lib/merge_ruby_client/crm/types/audit_log_event.rb +2 -0
  48. data/lib/merge_ruby_client/crm/types/event_type_enum.rb +2 -0
  49. data/lib/merge_ruby_client/crm/types/remote_field.rb +3 -3
  50. data/lib/merge_ruby_client/crm/types/remote_field_api.rb +3 -3
  51. data/lib/merge_ruby_client/crm/types/remote_field_request.rb +3 -3
  52. data/lib/merge_ruby_client/crm/users/client.rb +8 -2
  53. data/lib/merge_ruby_client/filestorage/audit_trail/client.rb +4 -2
  54. data/lib/merge_ruby_client/filestorage/files/client.rb +2 -2
  55. data/lib/merge_ruby_client/filestorage/issues/client.rb +10 -4
  56. data/lib/merge_ruby_client/filestorage/link_token/client.rb +10 -2
  57. data/lib/merge_ruby_client/filestorage/linked_accounts/client.rb +2 -4
  58. data/lib/merge_ruby_client/filestorage/types/account_integration.rb +16 -2
  59. data/lib/merge_ruby_client/filestorage/types/audit_log_event.rb +2 -0
  60. data/lib/merge_ruby_client/filestorage/types/event_type_enum.rb +2 -0
  61. data/lib/merge_ruby_client/filestorage/types/group.rb +1 -1
  62. data/lib/merge_ruby_client/filestorage/types/remote_field_api.rb +3 -3
  63. data/lib/merge_ruby_client/hris/audit_trail/client.rb +4 -2
  64. data/lib/merge_ruby_client/hris/bank_info/client.rb +4 -2
  65. data/lib/merge_ruby_client/hris/employments/client.rb +4 -2
  66. data/lib/merge_ruby_client/hris/issues/client.rb +10 -4
  67. data/lib/merge_ruby_client/hris/link_token/client.rb +10 -2
  68. data/lib/merge_ruby_client/hris/linked_accounts/client.rb +2 -4
  69. data/lib/merge_ruby_client/hris/timesheet_entries/client.rb +10 -12
  70. data/lib/merge_ruby_client/hris/types/account_integration.rb +16 -2
  71. data/lib/merge_ruby_client/hris/types/audit_log_event.rb +2 -0
  72. data/lib/merge_ruby_client/hris/types/event_type_enum.rb +2 -0
  73. data/lib/merge_ruby_client/hris/types/remote_field_api.rb +3 -3
  74. data/lib/merge_ruby_client/ticketing/attachments/client.rb +2 -2
  75. data/lib/merge_ruby_client/ticketing/audit_trail/client.rb +4 -2
  76. data/lib/merge_ruby_client/ticketing/issues/client.rb +10 -4
  77. data/lib/merge_ruby_client/ticketing/link_token/client.rb +10 -2
  78. data/lib/merge_ruby_client/ticketing/linked_accounts/client.rb +2 -4
  79. data/lib/merge_ruby_client/ticketing/tickets/client.rb +20 -8
  80. data/lib/merge_ruby_client/ticketing/types/account_integration.rb +16 -2
  81. data/lib/merge_ruby_client/ticketing/types/audit_log_event.rb +2 -0
  82. data/lib/merge_ruby_client/ticketing/types/event_type_enum.rb +2 -0
  83. data/lib/merge_ruby_client/ticketing/types/remote_field_api.rb +3 -3
  84. data/lib/merge_ruby_client/ticketing/types/tag.rb +10 -2
  85. data/lib/merge_ruby_client.rb +7 -7
  86. data/lib/requests.rb +2 -2
  87. data/lib/types_export.rb +112 -106
  88. metadata +8 -2
@@ -35,6 +35,9 @@ module Merge
35
35
  # @param should_create_magic_link_url [Boolean] Whether to generate a Magic Link URL. Defaults to false. For more information on
36
36
  # Magic Link, see
37
37
  # https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
38
+ # @param hide_admin_magic_link [Boolean] Whether to generate a Magic Link URL on the Admin Needed screen during the
39
+ # linking flow. Defaults to false. For more information on Magic Link, see
40
+ # https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
38
41
  # @param common_models [Array<Hash>] An array of objects to specify the models and fields that will be disabled for a
39
42
  # given Linked Account. Each object uses model_id, enabled_actions, and
40
43
  # disabled_fields to specify the model, method, and fields that are scoped for a
@@ -62,7 +65,7 @@ module Merge
62
65
  # categories: [HRIS, ATS]
63
66
  # )
64
67
  def create(end_user_email_address:, end_user_organization_name:, end_user_origin_id:, categories:,
65
- integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, common_models: nil, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
68
+ integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, hide_admin_magic_link: nil, common_models: nil, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
66
69
  response = @request_client.conn.post do |req|
67
70
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
68
71
  req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -84,6 +87,7 @@ module Merge
84
87
  integration: integration,
85
88
  link_expiry_mins: link_expiry_mins,
86
89
  should_create_magic_link_url: should_create_magic_link_url,
90
+ hide_admin_magic_link: hide_admin_magic_link,
87
91
  common_models: common_models,
88
92
  category_common_model_scopes: category_common_model_scopes,
89
93
  language: language,
@@ -122,6 +126,9 @@ module Merge
122
126
  # @param should_create_magic_link_url [Boolean] Whether to generate a Magic Link URL. Defaults to false. For more information on
123
127
  # Magic Link, see
124
128
  # https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
129
+ # @param hide_admin_magic_link [Boolean] Whether to generate a Magic Link URL on the Admin Needed screen during the
130
+ # linking flow. Defaults to false. For more information on Magic Link, see
131
+ # https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
125
132
  # @param common_models [Array<Hash>] An array of objects to specify the models and fields that will be disabled for a
126
133
  # given Linked Account. Each object uses model_id, enabled_actions, and
127
134
  # disabled_fields to specify the model, method, and fields that are scoped for a
@@ -149,7 +156,7 @@ module Merge
149
156
  # categories: [HRIS, ATS]
150
157
  # )
151
158
  def create(end_user_email_address:, end_user_organization_name:, end_user_origin_id:, categories:,
152
- integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, common_models: nil, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
159
+ integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, hide_admin_magic_link: nil, common_models: nil, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
153
160
  Async do
154
161
  response = @request_client.conn.post do |req|
155
162
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -172,6 +179,7 @@ module Merge
172
179
  integration: integration,
173
180
  link_expiry_mins: link_expiry_mins,
174
181
  should_create_magic_link_url: should_create_magic_link_url,
182
+ hide_admin_magic_link: hide_admin_magic_link,
175
183
  common_models: common_models,
176
184
  category_common_model_scopes: category_common_model_scopes,
177
185
  language: language,
@@ -216,6 +216,8 @@ module Merge
216
216
  # produce these models.
217
217
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
218
218
  # common models, in a normalized format.
219
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
220
+ # is_common_model_field value
219
221
  # @param page_size [Integer] Number of results to return per page.
220
222
  # @param request_options [Merge::RequestOptions]
221
223
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -227,7 +229,7 @@ module Merge
227
229
  # )
228
230
  # api.crm.notes.remote_field_classes_list
229
231
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
230
- include_remote_fields: nil, page_size: nil, request_options: nil)
232
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
231
233
  response = @request_client.conn.get do |req|
232
234
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
233
235
  req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -243,6 +245,7 @@ module Merge
243
245
  "include_deleted_data": include_deleted_data,
244
246
  "include_remote_data": include_remote_data,
245
247
  "include_remote_fields": include_remote_fields,
248
+ "is_common_model_field": is_common_model_field,
246
249
  "page_size": page_size
247
250
  }.compact
248
251
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -464,6 +467,8 @@ module Merge
464
467
  # produce these models.
465
468
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
466
469
  # common models, in a normalized format.
470
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
471
+ # is_common_model_field value
467
472
  # @param page_size [Integer] Number of results to return per page.
468
473
  # @param request_options [Merge::RequestOptions]
469
474
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -475,7 +480,7 @@ module Merge
475
480
  # )
476
481
  # api.crm.notes.remote_field_classes_list
477
482
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
478
- include_remote_fields: nil, page_size: nil, request_options: nil)
483
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
479
484
  Async do
480
485
  response = @request_client.conn.get do |req|
481
486
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -492,6 +497,7 @@ module Merge
492
497
  "include_deleted_data": include_deleted_data,
493
498
  "include_remote_data": include_remote_data,
494
499
  "include_remote_fields": include_remote_fields,
500
+ "is_common_model_field": is_common_model_field,
495
501
  "page_size": page_size
496
502
  }.compact
497
503
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -44,6 +44,8 @@ module Merge
44
44
  # returned.
45
45
  # @param owner_id [String] If provided, will only return opportunities with this owner.
46
46
  # @param page_size [Integer] Number of results to return per page.
47
+ # @param remote_created_after [DateTime] If provided, will only return opportunities created in the third party platform
48
+ # after this datetime.
47
49
  # @param remote_fields [String] Deprecated. Use show_enum_origins.
48
50
  # @param remote_id [String] The API provider's ID for the given object.
49
51
  # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
@@ -65,7 +67,7 @@ module Merge
65
67
  # )
66
68
  # api.crm.opportunities.list
67
69
  def list(account_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
68
- include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, owner_id: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, stage_id: nil, status: nil, request_options: nil)
70
+ include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, owner_id: nil, page_size: nil, remote_created_after: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, stage_id: nil, status: nil, request_options: nil)
69
71
  response = @request_client.conn.get do |req|
70
72
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
71
73
  req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -89,6 +91,7 @@ module Merge
89
91
  "modified_before": modified_before,
90
92
  "owner_id": owner_id,
91
93
  "page_size": page_size,
94
+ "remote_created_after": remote_created_after,
92
95
  "remote_fields": remote_fields,
93
96
  "remote_id": remote_id,
94
97
  "show_enum_origins": show_enum_origins,
@@ -320,6 +323,8 @@ module Merge
320
323
  # produce these models.
321
324
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
322
325
  # common models, in a normalized format.
326
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
327
+ # is_common_model_field value
323
328
  # @param page_size [Integer] Number of results to return per page.
324
329
  # @param request_options [Merge::RequestOptions]
325
330
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -331,7 +336,7 @@ module Merge
331
336
  # )
332
337
  # api.crm.opportunities.remote_field_classes_list
333
338
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
334
- include_remote_fields: nil, page_size: nil, request_options: nil)
339
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
335
340
  response = @request_client.conn.get do |req|
336
341
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
337
342
  req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -347,6 +352,7 @@ module Merge
347
352
  "include_deleted_data": include_deleted_data,
348
353
  "include_remote_data": include_remote_data,
349
354
  "include_remote_fields": include_remote_fields,
355
+ "is_common_model_field": is_common_model_field,
350
356
  "page_size": page_size
351
357
  }.compact
352
358
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -386,6 +392,8 @@ module Merge
386
392
  # returned.
387
393
  # @param owner_id [String] If provided, will only return opportunities with this owner.
388
394
  # @param page_size [Integer] Number of results to return per page.
395
+ # @param remote_created_after [DateTime] If provided, will only return opportunities created in the third party platform
396
+ # after this datetime.
389
397
  # @param remote_fields [String] Deprecated. Use show_enum_origins.
390
398
  # @param remote_id [String] The API provider's ID for the given object.
391
399
  # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
@@ -407,7 +415,7 @@ module Merge
407
415
  # )
408
416
  # api.crm.opportunities.list
409
417
  def list(account_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
410
- include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, owner_id: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, stage_id: nil, status: nil, request_options: nil)
418
+ include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, owner_id: nil, page_size: nil, remote_created_after: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, stage_id: nil, status: nil, request_options: nil)
411
419
  Async do
412
420
  response = @request_client.conn.get do |req|
413
421
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -432,6 +440,7 @@ module Merge
432
440
  "modified_before": modified_before,
433
441
  "owner_id": owner_id,
434
442
  "page_size": page_size,
443
+ "remote_created_after": remote_created_after,
435
444
  "remote_fields": remote_fields,
436
445
  "remote_id": remote_id,
437
446
  "show_enum_origins": show_enum_origins,
@@ -674,6 +683,8 @@ module Merge
674
683
  # produce these models.
675
684
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
676
685
  # common models, in a normalized format.
686
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
687
+ # is_common_model_field value
677
688
  # @param page_size [Integer] Number of results to return per page.
678
689
  # @param request_options [Merge::RequestOptions]
679
690
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -685,7 +696,7 @@ module Merge
685
696
  # )
686
697
  # api.crm.opportunities.remote_field_classes_list
687
698
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
688
- include_remote_fields: nil, page_size: nil, request_options: nil)
699
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
689
700
  Async do
690
701
  response = @request_client.conn.get do |req|
691
702
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -702,6 +713,7 @@ module Merge
702
713
  "include_deleted_data": include_deleted_data,
703
714
  "include_remote_data": include_remote_data,
704
715
  "include_remote_fields": include_remote_fields,
716
+ "is_common_model_field": is_common_model_field,
705
717
  "page_size": page_size
706
718
  }.compact
707
719
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -122,6 +122,8 @@ module Merge
122
122
  # produce these models.
123
123
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
124
124
  # common models, in a normalized format.
125
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
126
+ # is_common_model_field value
125
127
  # @param page_size [Integer] Number of results to return per page.
126
128
  # @param request_options [Merge::RequestOptions]
127
129
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -133,7 +135,7 @@ module Merge
133
135
  # )
134
136
  # api.crm.stages.remote_field_classes_list
135
137
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
136
- include_remote_fields: nil, page_size: nil, request_options: nil)
138
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
137
139
  response = @request_client.conn.get do |req|
138
140
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
139
141
  req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -149,6 +151,7 @@ module Merge
149
151
  "include_deleted_data": include_deleted_data,
150
152
  "include_remote_data": include_remote_data,
151
153
  "include_remote_fields": include_remote_fields,
154
+ "is_common_model_field": is_common_model_field,
152
155
  "page_size": page_size
153
156
  }.compact
154
157
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -277,6 +280,8 @@ module Merge
277
280
  # produce these models.
278
281
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
279
282
  # common models, in a normalized format.
283
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
284
+ # is_common_model_field value
280
285
  # @param page_size [Integer] Number of results to return per page.
281
286
  # @param request_options [Merge::RequestOptions]
282
287
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -288,7 +293,7 @@ module Merge
288
293
  # )
289
294
  # api.crm.stages.remote_field_classes_list
290
295
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
291
- include_remote_fields: nil, page_size: nil, request_options: nil)
296
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
292
297
  Async do
293
298
  response = @request_client.conn.get do |req|
294
299
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -305,6 +310,7 @@ module Merge
305
310
  "include_deleted_data": include_deleted_data,
306
311
  "include_remote_data": include_remote_data,
307
312
  "include_remote_fields": include_remote_fields,
313
+ "is_common_model_field": is_common_model_field,
308
314
  "page_size": page_size
309
315
  }.compact
310
316
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -292,6 +292,8 @@ module Merge
292
292
  # produce these models.
293
293
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
294
294
  # common models, in a normalized format.
295
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
296
+ # is_common_model_field value
295
297
  # @param page_size [Integer] Number of results to return per page.
296
298
  # @param request_options [Merge::RequestOptions]
297
299
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -303,7 +305,7 @@ module Merge
303
305
  # )
304
306
  # api.crm.tasks.remote_field_classes_list
305
307
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
306
- include_remote_fields: nil, page_size: nil, request_options: nil)
308
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
307
309
  response = @request_client.conn.get do |req|
308
310
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
309
311
  req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -319,6 +321,7 @@ module Merge
319
321
  "include_deleted_data": include_deleted_data,
320
322
  "include_remote_data": include_remote_data,
321
323
  "include_remote_fields": include_remote_fields,
324
+ "is_common_model_field": is_common_model_field,
322
325
  "page_size": page_size
323
326
  }.compact
324
327
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -619,6 +622,8 @@ module Merge
619
622
  # produce these models.
620
623
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
621
624
  # common models, in a normalized format.
625
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
626
+ # is_common_model_field value
622
627
  # @param page_size [Integer] Number of results to return per page.
623
628
  # @param request_options [Merge::RequestOptions]
624
629
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -630,7 +635,7 @@ module Merge
630
635
  # )
631
636
  # api.crm.tasks.remote_field_classes_list
632
637
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
633
- include_remote_fields: nil, page_size: nil, request_options: nil)
638
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
634
639
  Async do
635
640
  response = @request_client.conn.get do |req|
636
641
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -647,6 +652,7 @@ module Merge
647
652
  "include_deleted_data": include_deleted_data,
648
653
  "include_remote_data": include_remote_data,
649
654
  "include_remote_fields": include_remote_fields,
655
+ "is_common_model_field": is_common_model_field,
650
656
  "page_size": page_size
651
657
  }.compact
652
658
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -9,6 +9,11 @@ module Merge
9
9
  class AccountIntegration
10
10
  # @return [String] Company name.
11
11
  attr_reader :name
12
+ # @return [String] Optional. This shortened name appears in places with limited space, usually in
13
+ # conjunction with the platform's logo (e.g., Merge Link menu).<br><br>Example:
14
+ # <i>Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP
15
+ # SuccessFactors)</i>
16
+ attr_reader :abbreviated_name
12
17
  # @return [Array<Merge::Crm::CategoriesEnum>] Category or categories this integration belongs to. Multiple categories should
13
18
  # be comma separated, i.e. [ats, hris].
14
19
  attr_reader :categories
@@ -41,6 +46,10 @@ module Merge
41
46
  OMIT = Object.new
42
47
 
43
48
  # @param name [String] Company name.
49
+ # @param abbreviated_name [String] Optional. This shortened name appears in places with limited space, usually in
50
+ # conjunction with the platform's logo (e.g., Merge Link menu).<br><br>Example:
51
+ # <i>Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP
52
+ # SuccessFactors)</i>
44
53
  # @param categories [Array<Merge::Crm::CategoriesEnum>] Category or categories this integration belongs to. Multiple categories should
45
54
  # be comma separated, i.e. [ats, hris].
46
55
  # @param image [String] Company logo in rectangular shape. <b>Upload an image with a clear
@@ -58,9 +67,10 @@ module Merge
58
67
  # @param category_beta_status [Hash{String => Object}] Category or categories this integration is in beta status for.
59
68
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
60
69
  # @return [Merge::Crm::AccountIntegration]
61
- def initialize(name:, categories: OMIT, image: OMIT, square_image: OMIT, color: OMIT, slug: OMIT,
62
- api_endpoints_to_documentation_urls: OMIT, webhook_setup_guide_url: OMIT, category_beta_status: OMIT, additional_properties: nil)
70
+ def initialize(name:, abbreviated_name: OMIT, categories: OMIT, image: OMIT, square_image: OMIT, color: OMIT,
71
+ slug: OMIT, api_endpoints_to_documentation_urls: OMIT, webhook_setup_guide_url: OMIT, category_beta_status: OMIT, additional_properties: nil)
63
72
  @name = name
73
+ @abbreviated_name = abbreviated_name if abbreviated_name != OMIT
64
74
  @categories = categories if categories != OMIT
65
75
  @image = image if image != OMIT
66
76
  @square_image = square_image if square_image != OMIT
@@ -74,6 +84,7 @@ module Merge
74
84
  @additional_properties = additional_properties
75
85
  @_field_set = {
76
86
  "name": name,
87
+ "abbreviated_name": abbreviated_name,
77
88
  "categories": categories,
78
89
  "image": image,
79
90
  "square_image": square_image,
@@ -95,6 +106,7 @@ module Merge
95
106
  struct = JSON.parse(json_object, object_class: OpenStruct)
96
107
  parsed_json = JSON.parse(json_object)
97
108
  name = parsed_json["name"]
109
+ abbreviated_name = parsed_json["abbreviated_name"]
98
110
  categories = parsed_json["categories"]
99
111
  image = parsed_json["image"]
100
112
  square_image = parsed_json["square_image"]
@@ -105,6 +117,7 @@ module Merge
105
117
  category_beta_status = parsed_json["category_beta_status"]
106
118
  new(
107
119
  name: name,
120
+ abbreviated_name: abbreviated_name,
108
121
  categories: categories,
109
122
  image: image,
110
123
  square_image: square_image,
@@ -132,6 +145,7 @@ module Merge
132
145
  # @return [Void]
133
146
  def self.validate_raw(obj:)
134
147
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
148
+ obj.abbreviated_name&.is_a?(String) != false || raise("Passed value for field obj.abbreviated_name is not the expected type, validation failed.")
135
149
  obj.categories&.is_a?(Array) != false || raise("Passed value for field obj.categories is not the expected type, validation failed.")
136
150
  obj.image&.is_a?(String) != false || raise("Passed value for field obj.image is not the expected type, validation failed.")
137
151
  obj.square_image&.is_a?(String) != false || raise("Passed value for field obj.square_image is not the expected type, validation failed.")
@@ -17,9 +17,9 @@ module Merge
17
17
  attr_reader :created_at
18
18
  # @return [DateTime] The datetime that this object was modified by Merge.
19
19
  attr_reader :modified_at
20
- # @return [Hash{String => Object}]
20
+ # @return [String]
21
21
  attr_reader :source_object
22
- # @return [Hash{String => Object}]
22
+ # @return [String]
23
23
  attr_reader :target_object
24
24
  # @return [Merge::Crm::AssociationAssociationType] The association type the association belongs to.
25
25
  attr_reader :association_type
@@ -33,8 +33,8 @@ module Merge
33
33
 
34
34
  # @param created_at [DateTime] The datetime that this object was created by Merge.
35
35
  # @param modified_at [DateTime] The datetime that this object was modified by Merge.
36
- # @param source_object [Hash{String => Object}]
37
- # @param target_object [Hash{String => Object}]
36
+ # @param source_object [String]
37
+ # @param target_object [String]
38
38
  # @param association_type [Merge::Crm::AssociationAssociationType] The association type the association belongs to.
39
39
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
40
40
  # @return [Merge::Crm::Association]
@@ -100,8 +100,8 @@ module Merge
100
100
  def self.validate_raw(obj:)
101
101
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
102
102
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
103
- obj.source_object&.is_a?(Hash) != false || raise("Passed value for field obj.source_object is not the expected type, validation failed.")
104
- obj.target_object&.is_a?(Hash) != false || raise("Passed value for field obj.target_object is not the expected type, validation failed.")
103
+ obj.source_object&.is_a?(String) != false || raise("Passed value for field obj.source_object is not the expected type, validation failed.")
104
+ obj.target_object&.is_a?(String) != false || raise("Passed value for field obj.target_object is not the expected type, validation failed.")
105
105
  obj.association_type.nil? || Merge::Crm::AssociationAssociationType.validate_raw(obj: obj.association_type)
106
106
  end
107
107
  end
@@ -71,6 +71,7 @@ module Merge
71
71
  # - `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK
72
72
  # - `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK
73
73
  # - `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED
74
+ # - `END_USER_CREDENTIALS_ACCESSED` - END_USER_CREDENTIALS_ACCESSED
74
75
  attr_reader :event_type
75
76
  # @return [String]
76
77
  attr_reader :event_description
@@ -141,6 +142,7 @@ module Merge
141
142
  # - `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK
142
143
  # - `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK
143
144
  # - `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED
145
+ # - `END_USER_CREDENTIALS_ACCESSED` - END_USER_CREDENTIALS_ACCESSED
144
146
  # @param event_description [String]
145
147
  # @param created_at [DateTime]
146
148
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
@@ -46,6 +46,7 @@ module Merge
46
46
  # - `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK
47
47
  # - `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK
48
48
  # - `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED
49
+ # - `END_USER_CREDENTIALS_ACCESSED` - END_USER_CREDENTIALS_ACCESSED
49
50
  class EventTypeEnum
50
51
  CREATED_REMOTE_PRODUCTION_API_KEY = "CREATED_REMOTE_PRODUCTION_API_KEY"
51
52
  DELETED_REMOTE_PRODUCTION_API_KEY = "DELETED_REMOTE_PRODUCTION_API_KEY"
@@ -84,6 +85,7 @@ module Merge
84
85
  ENABLED_MERGE_WEBHOOK = "ENABLED_MERGE_WEBHOOK"
85
86
  DISABLED_MERGE_WEBHOOK = "DISABLED_MERGE_WEBHOOK"
86
87
  MERGE_WEBHOOK_TARGET_CHANGED = "MERGE_WEBHOOK_TARGET_CHANGED"
88
+ END_USER_CREDENTIALS_ACCESSED = "END_USER_CREDENTIALS_ACCESSED"
87
89
  end
88
90
  end
89
91
  end
@@ -9,7 +9,7 @@ module Merge
9
9
  class RemoteField
10
10
  # @return [Merge::Crm::RemoteFieldRemoteFieldClass]
11
11
  attr_reader :remote_field_class
12
- # @return [Hash{String => Object}]
12
+ # @return [Object]
13
13
  attr_reader :value
14
14
  # @return [OpenStruct] Additional properties unmapped to the current class definition
15
15
  attr_reader :additional_properties
@@ -20,7 +20,7 @@ module Merge
20
20
  OMIT = Object.new
21
21
 
22
22
  # @param remote_field_class [Merge::Crm::RemoteFieldRemoteFieldClass]
23
- # @param value [Hash{String => Object}]
23
+ # @param value [Object]
24
24
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
25
25
  # @return [Merge::Crm::RemoteField]
26
26
  def initialize(remote_field_class:, value: OMIT, additional_properties: nil)
@@ -68,7 +68,7 @@ module Merge
68
68
  # @return [Void]
69
69
  def self.validate_raw(obj:)
70
70
  Merge::Crm::RemoteFieldRemoteFieldClass.validate_raw(obj: obj.remote_field_class)
71
- obj.value&.is_a?(Hash) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
71
+ obj.value&.is_a?(Object) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
72
72
  end
73
73
  end
74
74
  end
@@ -37,12 +37,12 @@ module Merge
37
37
  # @param coverage [Merge::Crm::RemoteFieldApiCoverage]
38
38
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
39
39
  # @return [Merge::Crm::RemoteFieldApi]
40
- def initialize(schema:, remote_key_name:, remote_endpoint_info:, example_values:, advanced_metadata: OMIT,
40
+ def initialize(schema:, remote_key_name:, remote_endpoint_info:, example_values: OMIT, advanced_metadata: OMIT,
41
41
  coverage: OMIT, additional_properties: nil)
42
42
  @schema = schema
43
43
  @remote_key_name = remote_key_name
44
44
  @remote_endpoint_info = remote_endpoint_info
45
- @example_values = example_values
45
+ @example_values = example_values if example_values != OMIT
46
46
  @advanced_metadata = advanced_metadata if advanced_metadata != OMIT
47
47
  @coverage = coverage if coverage != OMIT
48
48
  @additional_properties = additional_properties
@@ -114,7 +114,7 @@ module Merge
114
114
  obj.schema.is_a?(Hash) != false || raise("Passed value for field obj.schema is not the expected type, validation failed.")
115
115
  obj.remote_key_name.is_a?(String) != false || raise("Passed value for field obj.remote_key_name is not the expected type, validation failed.")
116
116
  Merge::Crm::RemoteEndpointInfo.validate_raw(obj: obj.remote_endpoint_info)
117
- obj.example_values.is_a?(Array) != false || raise("Passed value for field obj.example_values is not the expected type, validation failed.")
117
+ obj.example_values&.is_a?(Array) != false || raise("Passed value for field obj.example_values is not the expected type, validation failed.")
118
118
  obj.advanced_metadata.nil? || Merge::Crm::AdvancedMetadata.validate_raw(obj: obj.advanced_metadata)
119
119
  obj.coverage.nil? || Merge::Crm::RemoteFieldApiCoverage.validate_raw(obj: obj.coverage)
120
120
  end
@@ -9,7 +9,7 @@ module Merge
9
9
  class RemoteFieldRequest
10
10
  # @return [Merge::Crm::RemoteFieldRequestRemoteFieldClass]
11
11
  attr_reader :remote_field_class
12
- # @return [String]
12
+ # @return [Object]
13
13
  attr_reader :value
14
14
  # @return [OpenStruct] Additional properties unmapped to the current class definition
15
15
  attr_reader :additional_properties
@@ -20,7 +20,7 @@ module Merge
20
20
  OMIT = Object.new
21
21
 
22
22
  # @param remote_field_class [Merge::Crm::RemoteFieldRequestRemoteFieldClass]
23
- # @param value [String]
23
+ # @param value [Object]
24
24
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
25
25
  # @return [Merge::Crm::RemoteFieldRequest]
26
26
  def initialize(remote_field_class:, value: OMIT, additional_properties: nil)
@@ -68,7 +68,7 @@ module Merge
68
68
  # @return [Void]
69
69
  def self.validate_raw(obj:)
70
70
  Merge::Crm::RemoteFieldRequestRemoteFieldClass.validate_raw(obj: obj.remote_field_class)
71
- obj.value&.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
71
+ obj.value&.is_a?(Object) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
72
72
  end
73
73
  end
74
74
  end
@@ -159,6 +159,8 @@ module Merge
159
159
  # produce these models.
160
160
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
161
161
  # common models, in a normalized format.
162
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
163
+ # is_common_model_field value
162
164
  # @param page_size [Integer] Number of results to return per page.
163
165
  # @param request_options [Merge::RequestOptions]
164
166
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -170,7 +172,7 @@ module Merge
170
172
  # )
171
173
  # api.crm.users.remote_field_classes_list
172
174
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
173
- include_remote_fields: nil, page_size: nil, request_options: nil)
175
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
174
176
  response = @request_client.conn.get do |req|
175
177
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
176
178
  req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -186,6 +188,7 @@ module Merge
186
188
  "include_deleted_data": include_deleted_data,
187
189
  "include_remote_data": include_remote_data,
188
190
  "include_remote_fields": include_remote_fields,
191
+ "is_common_model_field": is_common_model_field,
189
192
  "page_size": page_size
190
193
  }.compact
191
194
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -352,6 +355,8 @@ module Merge
352
355
  # produce these models.
353
356
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
354
357
  # common models, in a normalized format.
358
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
359
+ # is_common_model_field value
355
360
  # @param page_size [Integer] Number of results to return per page.
356
361
  # @param request_options [Merge::RequestOptions]
357
362
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -363,7 +368,7 @@ module Merge
363
368
  # )
364
369
  # api.crm.users.remote_field_classes_list
365
370
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
366
- include_remote_fields: nil, page_size: nil, request_options: nil)
371
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
367
372
  Async do
368
373
  response = @request_client.conn.get do |req|
369
374
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -380,6 +385,7 @@ module Merge
380
385
  "include_deleted_data": include_deleted_data,
381
386
  "include_remote_data": include_remote_data,
382
387
  "include_remote_fields": include_remote_fields,
388
+ "is_common_model_field": is_common_model_field,
383
389
  "page_size": page_size
384
390
  }.compact
385
391
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -40,7 +40,8 @@ module Merge
40
40
  # `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`,
41
41
  # `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`,
42
42
  # `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`,
43
- # `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`
43
+ # `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`,
44
+ # `END_USER_CREDENTIALS_ACCESSED`
44
45
  # @param page_size [Integer] Number of results to return per page.
45
46
  # @param start_date [String] If included, will only include audit trail events that occurred after this time
46
47
  # @param user_email [String] If provided, this will return events associated with the specified user email.
@@ -118,7 +119,8 @@ module Merge
118
119
  # `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`,
119
120
  # `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`,
120
121
  # `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`,
121
- # `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`
122
+ # `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`,
123
+ # `END_USER_CREDENTIALS_ACCESSED`
122
124
  # @param page_size [Integer] Number of results to return per page.
123
125
  # @param start_date [String] If included, will only include audit trail events that occurred after this time
124
126
  # @param user_email [String] If provided, this will return events associated with the specified user email.
@@ -176,7 +176,7 @@ module Merge
176
176
  Merge::Filestorage::File.from_json(json_object: response.body)
177
177
  end
178
178
 
179
- # Returns a `File` object with the given `id`.
179
+ # Returns the `File` content with the given `id` as a stream of bytes.
180
180
  #
181
181
  # @param id [String]
182
182
  # @param mime_type [String] If provided, specifies the export format of the file to be downloaded. For
@@ -417,7 +417,7 @@ module Merge
417
417
  end
418
418
  end
419
419
 
420
- # Returns a `File` object with the given `id`.
420
+ # Returns the `File` content with the given `id` as a stream of bytes.
421
421
  #
422
422
  # @param id [String]
423
423
  # @param mime_type [String] If provided, specifies the export format of the file to be downloaded. For