merge_ruby_client 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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
@@ -0,0 +1,59 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+ require_relative "screening_question"
5
+
6
+ module Merge
7
+ module Ats
8
+ # The screening question associated with the candidate’s answer. To determine the
9
+ # data type of the answer, you can expand on the screening question by adding
10
+ # `screening_question_answers.question` to the `expand` query parameter.
11
+ class ScreeningQuestionAnswerRequestQuestion
12
+ # Deserialize a JSON object to an instance of
13
+ # ScreeningQuestionAnswerRequestQuestion
14
+ #
15
+ # @param json_object [String]
16
+ # @return [Merge::Ats::ScreeningQuestionAnswerRequestQuestion]
17
+ def self.from_json(json_object:)
18
+ struct = JSON.parse(json_object, object_class: OpenStruct)
19
+ begin
20
+ struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
21
+ return struct unless struct.nil?
22
+
23
+ return nil
24
+ rescue StandardError
25
+ # noop
26
+ end
27
+ begin
28
+ Merge::Ats::ScreeningQuestion.validate_raw(obj: struct)
29
+ return Merge::Ats::ScreeningQuestion.from_json(json_object: struct) unless struct.nil?
30
+
31
+ return nil
32
+ rescue StandardError
33
+ # noop
34
+ end
35
+ struct
36
+ end
37
+
38
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
39
+ # hash and check each fields type against the current object's property
40
+ # definitions.
41
+ #
42
+ # @param obj [Object]
43
+ # @return [Void]
44
+ def self.validate_raw(obj:)
45
+ begin
46
+ return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
47
+ rescue StandardError
48
+ # noop
49
+ end
50
+ begin
51
+ return Merge::Ats::ScreeningQuestion.validate_raw(obj: obj)
52
+ rescue StandardError
53
+ # noop
54
+ end
55
+ raise("Passed value matched no type within the union, validation failed.")
56
+ end
57
+ end
58
+ end
59
+ end
@@ -23,6 +23,9 @@ module Merge
23
23
  attr_reader :modified_at
24
24
  # @return [String] Available response options
25
25
  attr_reader :label
26
+ # @return [Boolean] Indicates whether or not this object has been deleted in the third party
27
+ # platform.
28
+ attr_reader :remote_was_deleted
26
29
  # @return [OpenStruct] Additional properties unmapped to the current class definition
27
30
  attr_reader :additional_properties
28
31
  # @return [Object]
@@ -36,22 +39,26 @@ module Merge
36
39
  # @param created_at [DateTime] The datetime that this object was created by Merge.
37
40
  # @param modified_at [DateTime] The datetime that this object was modified by Merge.
38
41
  # @param label [String] Available response options
42
+ # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
43
+ # platform.
39
44
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
40
45
  # @return [Merge::Ats::ScreeningQuestionOption]
41
46
  def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, label: OMIT,
42
- additional_properties: nil)
47
+ remote_was_deleted: OMIT, additional_properties: nil)
43
48
  @id = id if id != OMIT
44
49
  @remote_id = remote_id if remote_id != OMIT
45
50
  @created_at = created_at if created_at != OMIT
46
51
  @modified_at = modified_at if modified_at != OMIT
47
52
  @label = label if label != OMIT
53
+ @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
48
54
  @additional_properties = additional_properties
49
55
  @_field_set = {
50
56
  "id": id,
51
57
  "remote_id": remote_id,
52
58
  "created_at": created_at,
53
59
  "modified_at": modified_at,
54
- "label": label
60
+ "label": label,
61
+ "remote_was_deleted": remote_was_deleted
55
62
  }.reject do |_k, v|
56
63
  v == OMIT
57
64
  end
@@ -69,12 +76,14 @@ module Merge
69
76
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
70
77
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
71
78
  label = parsed_json["label"]
79
+ remote_was_deleted = parsed_json["remote_was_deleted"]
72
80
  new(
73
81
  id: id,
74
82
  remote_id: remote_id,
75
83
  created_at: created_at,
76
84
  modified_at: modified_at,
77
85
  label: label,
86
+ remote_was_deleted: remote_was_deleted,
78
87
  additional_properties: struct
79
88
  )
80
89
  end
@@ -98,6 +107,7 @@ module Merge
98
107
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
99
108
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
100
109
  obj.label&.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
110
+ obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
101
111
  end
102
112
  end
103
113
  end
@@ -29,6 +29,9 @@ module Merge
29
29
  # - `OTHER` - OTHER
30
30
  # - `JOB_POSTING` - JOB_POSTING
31
31
  attr_reader :url_type
32
+ # @return [Boolean] Indicates whether or not this object has been deleted in the third party
33
+ # platform.
34
+ attr_reader :remote_was_deleted
32
35
  # @return [OpenStruct] Additional properties unmapped to the current class definition
33
36
  attr_reader :additional_properties
34
37
  # @return [Object]
@@ -48,19 +51,24 @@ module Merge
48
51
  # - `SOCIAL_MEDIA` - SOCIAL_MEDIA
49
52
  # - `OTHER` - OTHER
50
53
  # - `JOB_POSTING` - JOB_POSTING
54
+ # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
55
+ # platform.
51
56
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
52
57
  # @return [Merge::Ats::Url]
53
- def initialize(created_at: OMIT, modified_at: OMIT, value: OMIT, url_type: OMIT, additional_properties: nil)
58
+ def initialize(created_at: OMIT, modified_at: OMIT, value: OMIT, url_type: OMIT, remote_was_deleted: OMIT,
59
+ additional_properties: nil)
54
60
  @created_at = created_at if created_at != OMIT
55
61
  @modified_at = modified_at if modified_at != OMIT
56
62
  @value = value if value != OMIT
57
63
  @url_type = url_type if url_type != OMIT
64
+ @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
58
65
  @additional_properties = additional_properties
59
66
  @_field_set = {
60
67
  "created_at": created_at,
61
68
  "modified_at": modified_at,
62
69
  "value": value,
63
- "url_type": url_type
70
+ "url_type": url_type,
71
+ "remote_was_deleted": remote_was_deleted
64
72
  }.reject do |_k, v|
65
73
  v == OMIT
66
74
  end
@@ -77,11 +85,13 @@ module Merge
77
85
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
78
86
  value = parsed_json["value"]
79
87
  url_type = parsed_json["url_type"]
88
+ remote_was_deleted = parsed_json["remote_was_deleted"]
80
89
  new(
81
90
  created_at: created_at,
82
91
  modified_at: modified_at,
83
92
  value: value,
84
93
  url_type: url_type,
94
+ remote_was_deleted: remote_was_deleted,
85
95
  additional_properties: struct
86
96
  )
87
97
  end
@@ -104,6 +114,7 @@ module Merge
104
114
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
105
115
  obj.value&.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
106
116
  obj.url_type&.is_a?(Merge::Ats::UrlTypeEnum) != false || raise("Passed value for field obj.url_type is not the expected type, validation failed.")
117
+ obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
107
118
  end
108
119
  end
109
120
  end
@@ -294,6 +294,8 @@ module Merge
294
294
  # produce these models.
295
295
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
296
296
  # common models, in a normalized format.
297
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
298
+ # is_common_model_field value
297
299
  # @param page_size [Integer] Number of results to return per page.
298
300
  # @param request_options [Merge::RequestOptions]
299
301
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -305,7 +307,7 @@ module Merge
305
307
  # )
306
308
  # api.crm.accounts.remote_field_classes_list
307
309
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
308
- include_remote_fields: nil, page_size: nil, request_options: nil)
310
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
309
311
  response = @request_client.conn.get do |req|
310
312
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
311
313
  req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -321,6 +323,7 @@ module Merge
321
323
  "include_deleted_data": include_deleted_data,
322
324
  "include_remote_data": include_remote_data,
323
325
  "include_remote_fields": include_remote_fields,
326
+ "is_common_model_field": is_common_model_field,
324
327
  "page_size": page_size
325
328
  }.compact
326
329
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -625,6 +628,8 @@ module Merge
625
628
  # produce these models.
626
629
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
627
630
  # common models, in a normalized format.
631
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
632
+ # is_common_model_field value
628
633
  # @param page_size [Integer] Number of results to return per page.
629
634
  # @param request_options [Merge::RequestOptions]
630
635
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -636,7 +641,7 @@ module Merge
636
641
  # )
637
642
  # api.crm.accounts.remote_field_classes_list
638
643
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
639
- include_remote_fields: nil, page_size: nil, request_options: nil)
644
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
640
645
  Async do
641
646
  response = @request_client.conn.get do |req|
642
647
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -653,6 +658,7 @@ module Merge
653
658
  "include_deleted_data": include_deleted_data,
654
659
  "include_remote_data": include_remote_data,
655
660
  "include_remote_fields": include_remote_fields,
661
+ "is_common_model_field": is_common_model_field,
656
662
  "page_size": page_size
657
663
  }.compact
658
664
  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.
@@ -337,6 +337,8 @@ module Merge
337
337
  # produce these models.
338
338
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
339
339
  # common models, in a normalized format.
340
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
341
+ # is_common_model_field value
340
342
  # @param page_size [Integer] Number of results to return per page.
341
343
  # @param request_options [Merge::RequestOptions]
342
344
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -348,7 +350,7 @@ module Merge
348
350
  # )
349
351
  # api.crm.contacts.remote_field_classes_list
350
352
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
351
- include_remote_fields: nil, page_size: nil, request_options: nil)
353
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
352
354
  response = @request_client.conn.get do |req|
353
355
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
354
356
  req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -364,6 +366,7 @@ module Merge
364
366
  "include_deleted_data": include_deleted_data,
365
367
  "include_remote_data": include_remote_data,
366
368
  "include_remote_fields": include_remote_fields,
369
+ "is_common_model_field": is_common_model_field,
367
370
  "page_size": page_size
368
371
  }.compact
369
372
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -710,6 +713,8 @@ module Merge
710
713
  # produce these models.
711
714
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
712
715
  # common models, in a normalized format.
716
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
717
+ # is_common_model_field value
713
718
  # @param page_size [Integer] Number of results to return per page.
714
719
  # @param request_options [Merge::RequestOptions]
715
720
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -721,7 +726,7 @@ module Merge
721
726
  # )
722
727
  # api.crm.contacts.remote_field_classes_list
723
728
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
724
- include_remote_fields: nil, page_size: nil, request_options: nil)
729
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
725
730
  Async do
726
731
  response = @request_client.conn.get do |req|
727
732
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -738,6 +743,7 @@ module Merge
738
743
  "include_deleted_data": include_deleted_data,
739
744
  "include_remote_data": include_remote_data,
740
745
  "include_remote_fields": include_remote_fields,
746
+ "is_common_model_field": is_common_model_field,
741
747
  "page_size": page_size
742
748
  }.compact
743
749
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -7,6 +7,7 @@ require_relative "../types/custom_object_request"
7
7
  require_relative "../types/crm_custom_object_response"
8
8
  require_relative "../types/custom_object"
9
9
  require_relative "../types/meta_response"
10
+ require_relative "../types/paginated_remote_field_class_list"
10
11
  require "async"
11
12
 
12
13
  module Merge
@@ -189,6 +190,54 @@ module Merge
189
190
  end
190
191
  Merge::Crm::MetaResponse.from_json(json_object: response.body)
191
192
  end
193
+
194
+ # Returns a list of `RemoteFieldClass` objects.
195
+ #
196
+ # @param cursor [String] The pagination cursor value.
197
+ # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
198
+ # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
199
+ # produce these models.
200
+ # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
201
+ # common models, in a normalized format.
202
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
203
+ # is_common_model_field value
204
+ # @param page_size [Integer] Number of results to return per page.
205
+ # @param request_options [Merge::RequestOptions]
206
+ # @return [Merge::Crm::PaginatedRemoteFieldClassList]
207
+ # @example
208
+ # api = Merge::Client.new(
209
+ # base_url: "https://api.example.com",
210
+ # environment: Merge::Environment::PRODUCTION,
211
+ # api_key: "YOUR_AUTH_TOKEN"
212
+ # )
213
+ # api.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list
214
+ def custom_object_classes_custom_objects_remote_field_classes_list(cursor: nil, include_deleted_data: nil,
215
+ include_remote_data: nil, include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
216
+ response = @request_client.conn.get do |req|
217
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
218
+ req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
219
+ req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
220
+ req.headers = {
221
+ **(req.headers || {}),
222
+ **@request_client.get_headers,
223
+ **(request_options&.additional_headers || {})
224
+ }.compact
225
+ req.params = {
226
+ **(request_options&.additional_query_parameters || {}),
227
+ "cursor": cursor,
228
+ "include_deleted_data": include_deleted_data,
229
+ "include_remote_data": include_remote_data,
230
+ "include_remote_fields": include_remote_fields,
231
+ "is_common_model_field": is_common_model_field,
232
+ "page_size": page_size
233
+ }.compact
234
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
235
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
236
+ end
237
+ req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/custom-object-classes/custom-objects/remote-field-classes"
238
+ end
239
+ Merge::Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
240
+ end
192
241
  end
193
242
 
194
243
  class AsyncCustomObjectsClient
@@ -377,6 +426,56 @@ module Merge
377
426
  Merge::Crm::MetaResponse.from_json(json_object: response.body)
378
427
  end
379
428
  end
429
+
430
+ # Returns a list of `RemoteFieldClass` objects.
431
+ #
432
+ # @param cursor [String] The pagination cursor value.
433
+ # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
434
+ # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
435
+ # produce these models.
436
+ # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
437
+ # common models, in a normalized format.
438
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
439
+ # is_common_model_field value
440
+ # @param page_size [Integer] Number of results to return per page.
441
+ # @param request_options [Merge::RequestOptions]
442
+ # @return [Merge::Crm::PaginatedRemoteFieldClassList]
443
+ # @example
444
+ # api = Merge::Client.new(
445
+ # base_url: "https://api.example.com",
446
+ # environment: Merge::Environment::PRODUCTION,
447
+ # api_key: "YOUR_AUTH_TOKEN"
448
+ # )
449
+ # api.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list
450
+ def custom_object_classes_custom_objects_remote_field_classes_list(cursor: nil, include_deleted_data: nil,
451
+ include_remote_data: nil, include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
452
+ Async do
453
+ response = @request_client.conn.get do |req|
454
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
455
+ req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
456
+ req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
457
+ req.headers = {
458
+ **(req.headers || {}),
459
+ **@request_client.get_headers,
460
+ **(request_options&.additional_headers || {})
461
+ }.compact
462
+ req.params = {
463
+ **(request_options&.additional_query_parameters || {}),
464
+ "cursor": cursor,
465
+ "include_deleted_data": include_deleted_data,
466
+ "include_remote_data": include_remote_data,
467
+ "include_remote_fields": include_remote_fields,
468
+ "is_common_model_field": is_common_model_field,
469
+ "page_size": page_size
470
+ }.compact
471
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
472
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
473
+ end
474
+ req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/custom-object-classes/custom-objects/remote-field-classes"
475
+ end
476
+ Merge::Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
477
+ end
478
+ end
380
479
  end
381
480
  end
382
481
  end
@@ -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.engagement_types.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.engagement_types.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?
@@ -298,6 +298,8 @@ module Merge
298
298
  # produce these models.
299
299
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
300
300
  # common models, in a normalized format.
301
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
302
+ # is_common_model_field value
301
303
  # @param page_size [Integer] Number of results to return per page.
302
304
  # @param request_options [Merge::RequestOptions]
303
305
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -309,7 +311,7 @@ module Merge
309
311
  # )
310
312
  # api.crm.engagements.remote_field_classes_list
311
313
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
312
- include_remote_fields: nil, page_size: nil, request_options: nil)
314
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
313
315
  response = @request_client.conn.get do |req|
314
316
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
315
317
  req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -325,6 +327,7 @@ module Merge
325
327
  "include_deleted_data": include_deleted_data,
326
328
  "include_remote_data": include_remote_data,
327
329
  "include_remote_fields": include_remote_fields,
330
+ "is_common_model_field": is_common_model_field,
328
331
  "page_size": page_size
329
332
  }.compact
330
333
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -631,6 +634,8 @@ module Merge
631
634
  # produce these models.
632
635
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
633
636
  # common models, in a normalized format.
637
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
638
+ # is_common_model_field value
634
639
  # @param page_size [Integer] Number of results to return per page.
635
640
  # @param request_options [Merge::RequestOptions]
636
641
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -642,7 +647,7 @@ module Merge
642
647
  # )
643
648
  # api.crm.engagements.remote_field_classes_list
644
649
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
645
- include_remote_fields: nil, page_size: nil, request_options: nil)
650
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
646
651
  Async do
647
652
  response = @request_client.conn.get do |req|
648
653
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -659,6 +664,7 @@ module Merge
659
664
  "include_deleted_data": include_deleted_data,
660
665
  "include_remote_data": include_remote_data,
661
666
  "include_remote_fields": include_remote_fields,
667
+ "is_common_model_field": is_common_model_field,
662
668
  "page_size": page_size
663
669
  }.compact
664
670
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -19,7 +19,7 @@ module Merge
19
19
  @request_client = request_client
20
20
  end
21
21
 
22
- # Gets issues.
22
+ # Gets all issues for Organization.
23
23
  #
24
24
  # @param account_token [String]
25
25
  # @param cursor [String] The pagination cursor value.
@@ -36,6 +36,8 @@ module Merge
36
36
  # datetime.
37
37
  # @param last_incident_time_before [DateTime] If provided, will only return issues whose last incident time was before this
38
38
  # datetime.
39
+ # @param linked_account_id [String] If provided, will only include issues pertaining to the linked account passed
40
+ # in.
39
41
  # @param page_size [Integer] Number of results to return per page.
40
42
  # @param start_date [String] If included, will only include issues whose most recent action occurred after
41
43
  # this time
@@ -52,7 +54,7 @@ module Merge
52
54
  # )
53
55
  # api.crm.issues.list
54
56
  def list(account_token: nil, cursor: nil, end_date: nil, end_user_organization_name: nil,
55
- first_incident_time_after: nil, first_incident_time_before: nil, include_muted: nil, integration_name: nil, last_incident_time_after: nil, last_incident_time_before: nil, page_size: nil, start_date: nil, status: nil, request_options: nil)
57
+ first_incident_time_after: nil, first_incident_time_before: nil, include_muted: nil, integration_name: nil, last_incident_time_after: nil, last_incident_time_before: nil, linked_account_id: nil, page_size: nil, start_date: nil, status: nil, request_options: nil)
56
58
  response = @request_client.conn.get do |req|
57
59
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
58
60
  req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -74,6 +76,7 @@ module Merge
74
76
  "integration_name": integration_name,
75
77
  "last_incident_time_after": last_incident_time_after,
76
78
  "last_incident_time_before": last_incident_time_before,
79
+ "linked_account_id": linked_account_id,
77
80
  "page_size": page_size,
78
81
  "start_date": start_date,
79
82
  "status": status
@@ -130,7 +133,7 @@ module Merge
130
133
  @request_client = request_client
131
134
  end
132
135
 
133
- # Gets issues.
136
+ # Gets all issues for Organization.
134
137
  #
135
138
  # @param account_token [String]
136
139
  # @param cursor [String] The pagination cursor value.
@@ -147,6 +150,8 @@ module Merge
147
150
  # datetime.
148
151
  # @param last_incident_time_before [DateTime] If provided, will only return issues whose last incident time was before this
149
152
  # datetime.
153
+ # @param linked_account_id [String] If provided, will only include issues pertaining to the linked account passed
154
+ # in.
150
155
  # @param page_size [Integer] Number of results to return per page.
151
156
  # @param start_date [String] If included, will only include issues whose most recent action occurred after
152
157
  # this time
@@ -163,7 +168,7 @@ module Merge
163
168
  # )
164
169
  # api.crm.issues.list
165
170
  def list(account_token: nil, cursor: nil, end_date: nil, end_user_organization_name: nil,
166
- first_incident_time_after: nil, first_incident_time_before: nil, include_muted: nil, integration_name: nil, last_incident_time_after: nil, last_incident_time_before: nil, page_size: nil, start_date: nil, status: nil, request_options: nil)
171
+ first_incident_time_after: nil, first_incident_time_before: nil, include_muted: nil, integration_name: nil, last_incident_time_after: nil, last_incident_time_before: nil, linked_account_id: nil, page_size: nil, start_date: nil, status: nil, request_options: nil)
167
172
  Async do
168
173
  response = @request_client.conn.get do |req|
169
174
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -186,6 +191,7 @@ module Merge
186
191
  "integration_name": integration_name,
187
192
  "last_incident_time_after": last_incident_time_after,
188
193
  "last_incident_time_before": last_incident_time_before,
194
+ "linked_account_id": linked_account_id,
189
195
  "page_size": page_size,
190
196
  "start_date": start_date,
191
197
  "status": status
@@ -227,6 +227,8 @@ module Merge
227
227
  # produce these models.
228
228
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
229
229
  # common models, in a normalized format.
230
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
231
+ # is_common_model_field value
230
232
  # @param page_size [Integer] Number of results to return per page.
231
233
  # @param request_options [Merge::RequestOptions]
232
234
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -238,7 +240,7 @@ module Merge
238
240
  # )
239
241
  # api.crm.leads.remote_field_classes_list
240
242
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
241
- include_remote_fields: nil, page_size: nil, request_options: nil)
243
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
242
244
  response = @request_client.conn.get do |req|
243
245
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
244
246
  req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -254,6 +256,7 @@ module Merge
254
256
  "include_deleted_data": include_deleted_data,
255
257
  "include_remote_data": include_remote_data,
256
258
  "include_remote_fields": include_remote_fields,
259
+ "is_common_model_field": is_common_model_field,
257
260
  "page_size": page_size
258
261
  }.compact
259
262
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -486,6 +489,8 @@ module Merge
486
489
  # produce these models.
487
490
  # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
488
491
  # common models, in a normalized format.
492
+ # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
493
+ # is_common_model_field value
489
494
  # @param page_size [Integer] Number of results to return per page.
490
495
  # @param request_options [Merge::RequestOptions]
491
496
  # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -497,7 +502,7 @@ module Merge
497
502
  # )
498
503
  # api.crm.leads.remote_field_classes_list
499
504
  def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
500
- include_remote_fields: nil, page_size: nil, request_options: nil)
505
+ include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
501
506
  Async do
502
507
  response = @request_client.conn.get do |req|
503
508
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -514,6 +519,7 @@ module Merge
514
519
  "include_deleted_data": include_deleted_data,
515
520
  "include_remote_data": include_remote_data,
516
521
  "include_remote_fields": include_remote_fields,
522
+ "is_common_model_field": is_common_model_field,
517
523
  "page_size": page_size
518
524
  }.compact
519
525
  unless request_options.nil? || request_options&.additional_body_parameters.nil?