wp-sdk 1.0.0

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 (211) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +28 -0
  3. data/README.md +152 -0
  4. data/bin/console +15 -0
  5. data/lib/reporting_settlement_research_api/api_helper.rb +10 -0
  6. data/lib/reporting_settlement_research_api/apis/base_api.rb +65 -0
  7. data/lib/reporting_settlement_research_api/apis/settlement_batches_api.rb +67 -0
  8. data/lib/reporting_settlement_research_api/apis/settlement_daily_totals_api.rb +39 -0
  9. data/lib/reporting_settlement_research_api/apis/settlement_errors_api.rb +67 -0
  10. data/lib/reporting_settlement_research_api/apis/settlements_api.rb +40 -0
  11. data/lib/reporting_settlement_research_api/apis/transaction_status_api.rb +33 -0
  12. data/lib/reporting_settlement_research_api/apis/transaction_type_api.rb +33 -0
  13. data/lib/reporting_settlement_research_api/client.rb +105 -0
  14. data/lib/reporting_settlement_research_api/configuration.rb +164 -0
  15. data/lib/reporting_settlement_research_api/exceptions/api_exception.rb +21 -0
  16. data/lib/reporting_settlement_research_api/exceptions/search_date0_error_exception.rb +58 -0
  17. data/lib/reporting_settlement_research_api/exceptions/search_store0_error_exception.rb +58 -0
  18. data/lib/reporting_settlement_research_api/exceptions/settlementerrors_pendingsettlementbatches_search0_error_exception.rb +58 -0
  19. data/lib/reporting_settlement_research_api/exceptions/settlementerrors_settlementfileerrors_search0_error_exception.rb +58 -0
  20. data/lib/reporting_settlement_research_api/exceptions/settlements_daily_totals_search0_error_exception.rb +58 -0
  21. data/lib/reporting_settlement_research_api/exceptions/settlements_search0_error_exception.rb +58 -0
  22. data/lib/reporting_settlement_research_api/exceptions/transaction_statuses0_error_exception.rb +58 -0
  23. data/lib/reporting_settlement_research_api/exceptions/transaction_types0_error_exception.rb +58 -0
  24. data/lib/reporting_settlement_research_api/http/api_response.rb +19 -0
  25. data/lib/reporting_settlement_research_api/http/auth/custom_header_authentication.rb +52 -0
  26. data/lib/reporting_settlement_research_api/http/http_call_back.rb +10 -0
  27. data/lib/reporting_settlement_research_api/http/http_method_enum.rb +10 -0
  28. data/lib/reporting_settlement_research_api/http/http_request.rb +10 -0
  29. data/lib/reporting_settlement_research_api/http/http_response.rb +10 -0
  30. data/lib/reporting_settlement_research_api/http/proxy_settings.rb +22 -0
  31. data/lib/reporting_settlement_research_api/logging/configuration/api_logging_configuration.rb +186 -0
  32. data/lib/reporting_settlement_research_api/logging/sdk_logger.rb +17 -0
  33. data/lib/reporting_settlement_research_api/models/account_name_inquiry.rb +98 -0
  34. data/lib/reporting_settlement_research_api/models/aci.rb +98 -0
  35. data/lib/reporting_settlement_research_api/models/additional_details.rb +135 -0
  36. data/lib/reporting_settlement_research_api/models/authorization_currency.rb +98 -0
  37. data/lib/reporting_settlement_research_api/models/authorization_source.rb +98 -0
  38. data/lib/reporting_settlement_research_api/models/avs_response_code.rb +98 -0
  39. data/lib/reporting_settlement_research_api/models/bank_card_rej_real_time_transaction.rb +172 -0
  40. data/lib/reporting_settlement_research_api/models/bank_card_rejects_search_request.rb +159 -0
  41. data/lib/reporting_settlement_research_api/models/bank_card_rejects_search_response.rb +94 -0
  42. data/lib/reporting_settlement_research_api/models/base_model.rb +110 -0
  43. data/lib/reporting_settlement_research_api/models/batch_card_type.rb +41 -0
  44. data/lib/reporting_settlement_research_api/models/batch_card_type1.rb +41 -0
  45. data/lib/reporting_settlement_research_api/models/batch_hold_status.rb +98 -0
  46. data/lib/reporting_settlement_research_api/models/billing_indicator.rb +98 -0
  47. data/lib/reporting_settlement_research_api/models/card_account_term.rb +98 -0
  48. data/lib/reporting_settlement_research_api/models/card_details.rb +381 -0
  49. data/lib/reporting_settlement_research_api/models/card_details2.rb +381 -0
  50. data/lib/reporting_settlement_research_api/models/card_network.rb +98 -0
  51. data/lib/reporting_settlement_research_api/models/card_networks.rb +118 -0
  52. data/lib/reporting_settlement_research_api/models/card_product_results.rb +98 -0
  53. data/lib/reporting_settlement_research_api/models/card_product_type.rb +98 -0
  54. data/lib/reporting_settlement_research_api/models/card_types.rb +49 -0
  55. data/lib/reporting_settlement_research_api/models/card_types1.rb +44 -0
  56. data/lib/reporting_settlement_research_api/models/cardholder_id.rb +98 -0
  57. data/lib/reporting_settlement_research_api/models/code_and_description.rb +98 -0
  58. data/lib/reporting_settlement_research_api/models/code_and_description1.rb +85 -0
  59. data/lib/reporting_settlement_research_api/models/country_of_origin.rb +98 -0
  60. data/lib/reporting_settlement_research_api/models/credit_additional_details.rb +135 -0
  61. data/lib/reporting_settlement_research_api/models/credit_card_details.rb +230 -0
  62. data/lib/reporting_settlement_research_api/models/credit_interchange_details.rb +215 -0
  63. data/lib/reporting_settlement_research_api/models/credit_merchant_hierarchy_details.rb +112 -0
  64. data/lib/reporting_settlement_research_api/models/credit_other_services_details.rb +157 -0
  65. data/lib/reporting_settlement_research_api/models/credit_premium_payback_details.rb +120 -0
  66. data/lib/reporting_settlement_research_api/models/credit_transaction_details.rb +435 -0
  67. data/lib/reporting_settlement_research_api/models/customer_fields.rb +95 -0
  68. data/lib/reporting_settlement_research_api/models/customer_fields2.rb +95 -0
  69. data/lib/reporting_settlement_research_api/models/cvv2_presence_indicator.rb +98 -0
  70. data/lib/reporting_settlement_research_api/models/cvv2_response_code.rb +98 -0
  71. data/lib/reporting_settlement_research_api/models/date_range1.rb +85 -0
  72. data/lib/reporting_settlement_research_api/models/date_type.rb +36 -0
  73. data/lib/reporting_settlement_research_api/models/daterange.rb +85 -0
  74. data/lib/reporting_settlement_research_api/models/emv_details.rb +113 -0
  75. data/lib/reporting_settlement_research_api/models/emv_details2.rb +113 -0
  76. data/lib/reporting_settlement_research_api/models/entity.rb +99 -0
  77. data/lib/reporting_settlement_research_api/models/entry_mode.rb +98 -0
  78. data/lib/reporting_settlement_research_api/models/error.rb +96 -0
  79. data/lib/reporting_settlement_research_api/models/field_name.rb +93 -0
  80. data/lib/reporting_settlement_research_api/models/field_name1.rb +69 -0
  81. data/lib/reporting_settlement_research_api/models/field_name2.rb +57 -0
  82. data/lib/reporting_settlement_research_api/models/field_name3.rb +57 -0
  83. data/lib/reporting_settlement_research_api/models/field_name4.rb +61 -0
  84. data/lib/reporting_settlement_research_api/models/field_name5.rb +49 -0
  85. data/lib/reporting_settlement_research_api/models/fraud_coverage_type.rb +98 -0
  86. data/lib/reporting_settlement_research_api/models/fraud_detection_stage.rb +98 -0
  87. data/lib/reporting_settlement_research_api/models/fraud_fields.rb +99 -0
  88. data/lib/reporting_settlement_research_api/models/fraud_fields2.rb +99 -0
  89. data/lib/reporting_settlement_research_api/models/fraud_fields_fraud_score.rb +86 -0
  90. data/lib/reporting_settlement_research_api/models/fraud_response_code.rb +52 -0
  91. data/lib/reporting_settlement_research_api/models/fraud_response_code2.rb +98 -0
  92. data/lib/reporting_settlement_research_api/models/fraud_rule_result.rb +49 -0
  93. data/lib/reporting_settlement_research_api/models/fraud_rule_result2.rb +98 -0
  94. data/lib/reporting_settlement_research_api/models/fraud_score.rb +85 -0
  95. data/lib/reporting_settlement_research_api/models/fraud_sight_details.rb +124 -0
  96. data/lib/reporting_settlement_research_api/models/fraud_sight_details2.rb +124 -0
  97. data/lib/reporting_settlement_research_api/models/funded_net_settle.rb +110 -0
  98. data/lib/reporting_settlement_research_api/models/funded_net_settle2.rb +110 -0
  99. data/lib/reporting_settlement_research_api/models/hierarchy.rb +99 -0
  100. data/lib/reporting_settlement_research_api/models/hierarchy1.rb +99 -0
  101. data/lib/reporting_settlement_research_api/models/hierarchy10.rb +141 -0
  102. data/lib/reporting_settlement_research_api/models/hierarchy2.rb +85 -0
  103. data/lib/reporting_settlement_research_api/models/hierarchy4.rb +112 -0
  104. data/lib/reporting_settlement_research_api/models/hierarchy6.rb +99 -0
  105. data/lib/reporting_settlement_research_api/models/hierarchy7.rb +131 -0
  106. data/lib/reporting_settlement_research_api/models/hierarchy9.rb +119 -0
  107. data/lib/reporting_settlement_research_api/models/hierarchy_level.rb +99 -0
  108. data/lib/reporting_settlement_research_api/models/hierarchy_levels.rb +99 -0
  109. data/lib/reporting_settlement_research_api/models/interchange_code.rb +85 -0
  110. data/lib/reporting_settlement_research_api/models/interchange_data.rb +116 -0
  111. data/lib/reporting_settlement_research_api/models/interchange_details.rb +215 -0
  112. data/lib/reporting_settlement_research_api/models/interchange_details1.rb +116 -0
  113. data/lib/reporting_settlement_research_api/models/international_indicator.rb +98 -0
  114. data/lib/reporting_settlement_research_api/models/level.rb +45 -0
  115. data/lib/reporting_settlement_research_api/models/level1.rb +49 -0
  116. data/lib/reporting_settlement_research_api/models/level2.rb +37 -0
  117. data/lib/reporting_settlement_research_api/models/level3.rb +67 -0
  118. data/lib/reporting_settlement_research_api/models/level_indicator.rb +98 -0
  119. data/lib/reporting_settlement_research_api/models/location_details.rb +199 -0
  120. data/lib/reporting_settlement_research_api/models/location_details2.rb +198 -0
  121. data/lib/reporting_settlement_research_api/models/mail_phone_indicator.rb +98 -0
  122. data/lib/reporting_settlement_research_api/models/market_specific_data_indicator.rb +98 -0
  123. data/lib/reporting_settlement_research_api/models/mastercard_tic_indicator.rb +98 -0
  124. data/lib/reporting_settlement_research_api/models/merchant_category.rb +98 -0
  125. data/lib/reporting_settlement_research_api/models/merchant_hierarchy.rb +119 -0
  126. data/lib/reporting_settlement_research_api/models/merchant_hierarchy_detail.rb +131 -0
  127. data/lib/reporting_settlement_research_api/models/merchant_info.rb +141 -0
  128. data/lib/reporting_settlement_research_api/models/network_group.rb +98 -0
  129. data/lib/reporting_settlement_research_api/models/order_by.rb +36 -0
  130. data/lib/reporting_settlement_research_api/models/order_by_for_settled_daily_totals.rb +85 -0
  131. data/lib/reporting_settlement_research_api/models/order_by_for_settled_transactions_type.rb +85 -0
  132. data/lib/reporting_settlement_research_api/models/origin_type.rb +98 -0
  133. data/lib/reporting_settlement_research_api/models/other_services.rb +179 -0
  134. data/lib/reporting_settlement_research_api/models/other_services2.rb +179 -0
  135. data/lib/reporting_settlement_research_api/models/pagination.rb +87 -0
  136. data/lib/reporting_settlement_research_api/models/pagination4.rb +108 -0
  137. data/lib/reporting_settlement_research_api/models/pagination_response.rb +108 -0
  138. data/lib/reporting_settlement_research_api/models/paginationtype.rb +87 -0
  139. data/lib/reporting_settlement_research_api/models/payment_gateway_details.rb +127 -0
  140. data/lib/reporting_settlement_research_api/models/payment_gateway_details1.rb +127 -0
  141. data/lib/reporting_settlement_research_api/models/pin_less.rb +98 -0
  142. data/lib/reporting_settlement_research_api/models/pos_condition_code.rb +98 -0
  143. data/lib/reporting_settlement_research_api/models/premium_payback.rb +120 -0
  144. data/lib/reporting_settlement_research_api/models/processdaterange.rb +85 -0
  145. data/lib/reporting_settlement_research_api/models/rejection_reason.rb +98 -0
  146. data/lib/reporting_settlement_research_api/models/search_auth_transactions.rb +200 -0
  147. data/lib/reporting_settlement_research_api/models/search_daily_totals.rb +95 -0
  148. data/lib/reporting_settlement_research_api/models/search_daily_totals_details.rb +172 -0
  149. data/lib/reporting_settlement_research_api/models/search_date_request.rb +116 -0
  150. data/lib/reporting_settlement_research_api/models/search_date_response.rb +94 -0
  151. data/lib/reporting_settlement_research_api/models/search_requesttransaction_amount_range.rb +105 -0
  152. data/lib/reporting_settlement_research_api/models/search_settle_daily_totals_request.rb +135 -0
  153. data/lib/reporting_settlement_research_api/models/search_settle_transactions_request.rb +248 -0
  154. data/lib/reporting_settlement_research_api/models/search_store_request.rb +116 -0
  155. data/lib/reporting_settlement_research_api/models/search_store_response.rb +94 -0
  156. data/lib/reporting_settlement_research_api/models/search_transaction_details_response.rb +95 -0
  157. data/lib/reporting_settlement_research_api/models/settlement_batches_date_request.rb +116 -0
  158. data/lib/reporting_settlement_research_api/models/settlement_batches_date_response.rb +94 -0
  159. data/lib/reporting_settlement_research_api/models/settlement_batches_entity.rb +85 -0
  160. data/lib/reporting_settlement_research_api/models/settlement_batches_hierarchy.rb +112 -0
  161. data/lib/reporting_settlement_research_api/models/settlement_batches_sort_store.rb +85 -0
  162. data/lib/reporting_settlement_research_api/models/settlement_batches_sortbankcarddetails.rb +85 -0
  163. data/lib/reporting_settlement_research_api/models/settlement_batches_store_request.rb +116 -0
  164. data/lib/reporting_settlement_research_api/models/settlement_batches_store_response.rb +94 -0
  165. data/lib/reporting_settlement_research_api/models/settlement_batches_transaction_date.rb +195 -0
  166. data/lib/reporting_settlement_research_api/models/settlement_batches_transaction_store.rb +195 -0
  167. data/lib/reporting_settlement_research_api/models/settlement_rej_real_time_transaction.rb +152 -0
  168. data/lib/reporting_settlement_research_api/models/settlement_rejects_search_request.rb +104 -0
  169. data/lib/reporting_settlement_research_api/models/settlement_rejects_search_response.rb +94 -0
  170. data/lib/reporting_settlement_research_api/models/settlementerrors_pendingsettlementbatches_search_request.rb +159 -0
  171. data/lib/reporting_settlement_research_api/models/settlementerrors_pendingsettlementbatches_search_response.rb +94 -0
  172. data/lib/reporting_settlement_research_api/models/settlementerrors_settlementfileerrors_search_request.rb +104 -0
  173. data/lib/reporting_settlement_research_api/models/settlementerrors_settlementfileerrors_search_response.rb +94 -0
  174. data/lib/reporting_settlement_research_api/models/settlements_daily_totals_search_request.rb +135 -0
  175. data/lib/reporting_settlement_research_api/models/settlements_daily_totals_search_response.rb +94 -0
  176. data/lib/reporting_settlement_research_api/models/settlements_search_request.rb +248 -0
  177. data/lib/reporting_settlement_research_api/models/settlements_search_response.rb +95 -0
  178. data/lib/reporting_settlement_research_api/models/signature_capabilities_indicator.rb +98 -0
  179. data/lib/reporting_settlement_research_api/models/signature_compression.rb +98 -0
  180. data/lib/reporting_settlement_research_api/models/signature_pen.rb +98 -0
  181. data/lib/reporting_settlement_research_api/models/signify_details.rb +103 -0
  182. data/lib/reporting_settlement_research_api/models/signifyd_detail.rb +103 -0
  183. data/lib/reporting_settlement_research_api/models/sort_results_by.rb +85 -0
  184. data/lib/reporting_settlement_research_api/models/sort_results_by1.rb +85 -0
  185. data/lib/reporting_settlement_research_api/models/sort_results_by2.rb +85 -0
  186. data/lib/reporting_settlement_research_api/models/sort_results_by3.rb +85 -0
  187. data/lib/reporting_settlement_research_api/models/sort_results_by4.rb +85 -0
  188. data/lib/reporting_settlement_research_api/models/sort_results_by5.rb +85 -0
  189. data/lib/reporting_settlement_research_api/models/sortbankcarddetails.rb +85 -0
  190. data/lib/reporting_settlement_research_api/models/sortsettlementfiledetails.rb +85 -0
  191. data/lib/reporting_settlement_research_api/models/stand_in_indicator.rb +98 -0
  192. data/lib/reporting_settlement_research_api/models/stand_in_level.rb +98 -0
  193. data/lib/reporting_settlement_research_api/models/surcharge_reason.rb +85 -0
  194. data/lib/reporting_settlement_research_api/models/terminal.rb +109 -0
  195. data/lib/reporting_settlement_research_api/models/terminal_capability.rb +98 -0
  196. data/lib/reporting_settlement_research_api/models/terminal_details.rb +109 -0
  197. data/lib/reporting_settlement_research_api/models/transaction_amount_range.rb +105 -0
  198. data/lib/reporting_settlement_research_api/models/transaction_details.rb +723 -0
  199. data/lib/reporting_settlement_research_api/models/transaction_details2.rb +723 -0
  200. data/lib/reporting_settlement_research_api/models/transaction_status.rb +98 -0
  201. data/lib/reporting_settlement_research_api/models/transaction_status_code.rb +98 -0
  202. data/lib/reporting_settlement_research_api/models/transaction_status_code1.rb +1029 -0
  203. data/lib/reporting_settlement_research_api/models/transaction_summary.rb +182 -0
  204. data/lib/reporting_settlement_research_api/models/transaction_summary_data.rb +182 -0
  205. data/lib/reporting_settlement_research_api/models/transaction_type.rb +98 -0
  206. data/lib/reporting_settlement_research_api/models/transaction_type_code.rb +98 -0
  207. data/lib/reporting_settlement_research_api/models/transaction_type_code1.rb +221 -0
  208. data/lib/reporting_settlement_research_api/utilities/date_time_helper.rb +11 -0
  209. data/lib/reporting_settlement_research_api/utilities/file_wrapper.rb +28 -0
  210. data/lib/reporting_settlement_research_api.rb +302 -0
  211. metadata +294 -0
@@ -0,0 +1,85 @@
1
+ # reporting_settlement_research_api
2
+ #
3
+ # This file was automatically generated
4
+ # by APIMATIC v3.0 ( https://www.apimatic.io ).
5
+
6
+ module ReportingSettlementResearchApi
7
+ # Used for sorting.
8
+ class SettlementBatchesSortbankcarddetails < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # TODO: Write general description for this method
13
+ # @return [FieldName3]
14
+ attr_accessor :field_name
15
+
16
+ # TODO: Write general description for this method
17
+ # @return [OrderBy]
18
+ attr_accessor :order_by
19
+
20
+ # A mapping from model property names to API property names.
21
+ def self.names
22
+ @_hash = {} if @_hash.nil?
23
+ @_hash['field_name'] = 'fieldName'
24
+ @_hash['order_by'] = 'orderBy'
25
+ @_hash
26
+ end
27
+
28
+ # An array for optional fields
29
+ def self.optionals
30
+ %w[
31
+ field_name
32
+ order_by
33
+ ]
34
+ end
35
+
36
+ # An array for nullable fields
37
+ def self.nullables
38
+ []
39
+ end
40
+
41
+ def initialize(field_name: SKIP, order_by: SKIP, additional_properties: nil)
42
+ # Add additional model properties to the instance
43
+ additional_properties = {} if additional_properties.nil?
44
+
45
+ @field_name = field_name unless field_name == SKIP
46
+ @order_by = order_by unless order_by == SKIP
47
+ @additional_properties = additional_properties
48
+ end
49
+
50
+ # Creates an instance of the object from a hash.
51
+ def self.from_hash(hash)
52
+ return nil unless hash
53
+
54
+ # Extract variables from the hash.
55
+ field_name = hash.key?('fieldName') ? hash['fieldName'] : SKIP
56
+ order_by = hash.key?('orderBy') ? hash['orderBy'] : SKIP
57
+
58
+ # Create a new hash for additional properties, removing known properties.
59
+ new_hash = hash.reject { |k, _| names.value?(k) }
60
+
61
+ additional_properties = APIHelper.get_additional_properties(
62
+ new_hash, proc { |value| value }
63
+ )
64
+
65
+ # Create object from extracted values.
66
+ SettlementBatchesSortbankcarddetails.new(field_name: field_name,
67
+ order_by: order_by,
68
+ additional_properties: additional_properties)
69
+ end
70
+
71
+ # Provides a human-readable string representation of the object.
72
+ def to_s
73
+ class_name = self.class.name.split('::').last
74
+ "<#{class_name} field_name: #{@field_name}, order_by: #{@order_by}, additional_properties:"\
75
+ " #{@additional_properties}>"
76
+ end
77
+
78
+ # Provides a debugging-friendly string with detailed object information.
79
+ def inspect
80
+ class_name = self.class.name.split('::').last
81
+ "<#{class_name} field_name: #{@field_name.inspect}, order_by: #{@order_by.inspect},"\
82
+ " additional_properties: #{@additional_properties}>"
83
+ end
84
+ end
85
+ end
@@ -0,0 +1,116 @@
1
+ # reporting_settlement_research_api
2
+ #
3
+ # This file was automatically generated
4
+ # by APIMATIC v3.0 ( https://www.apimatic.io ).
5
+
6
+ module ReportingSettlementResearchApi
7
+ # Request fields for settlement batches for stores.
8
+ class SettlementBatchesStoreRequest < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # TODO: Write general description for this method
13
+ # @return [Pagination]
14
+ attr_accessor :pagination
15
+
16
+ # TODO: Write general description for this method
17
+ # @return [Hierarchy2]
18
+ attr_accessor :hierarchy
19
+
20
+ # TODO: Write general description for this method
21
+ # @return [DateRange1]
22
+ attr_accessor :date_range
23
+
24
+ # TODO: Write general description for this method
25
+ # @return [BatchCardType]
26
+ attr_accessor :batch_card_type
27
+
28
+ # TODO: Write general description for this method
29
+ # @return [SortResultsBy2]
30
+ attr_accessor :sort_results_by
31
+
32
+ # A mapping from model property names to API property names.
33
+ def self.names
34
+ @_hash = {} if @_hash.nil?
35
+ @_hash['pagination'] = 'pagination'
36
+ @_hash['hierarchy'] = 'hierarchy'
37
+ @_hash['date_range'] = 'dateRange'
38
+ @_hash['batch_card_type'] = 'batchCardType'
39
+ @_hash['sort_results_by'] = 'sortResultsBy'
40
+ @_hash
41
+ end
42
+
43
+ # An array for optional fields
44
+ def self.optionals
45
+ %w[
46
+ pagination
47
+ batch_card_type
48
+ sort_results_by
49
+ ]
50
+ end
51
+
52
+ # An array for nullable fields
53
+ def self.nullables
54
+ []
55
+ end
56
+
57
+ def initialize(hierarchy:, date_range:, pagination: SKIP,
58
+ batch_card_type: SKIP, sort_results_by: SKIP,
59
+ additional_properties: nil)
60
+ # Add additional model properties to the instance
61
+ additional_properties = {} if additional_properties.nil?
62
+
63
+ @pagination = pagination unless pagination == SKIP
64
+ @hierarchy = hierarchy
65
+ @date_range = date_range
66
+ @batch_card_type = batch_card_type unless batch_card_type == SKIP
67
+ @sort_results_by = sort_results_by unless sort_results_by == SKIP
68
+ @additional_properties = additional_properties
69
+ end
70
+
71
+ # Creates an instance of the object from a hash.
72
+ def self.from_hash(hash)
73
+ return nil unless hash
74
+
75
+ # Extract variables from the hash.
76
+ hierarchy = Hierarchy2.from_hash(hash['hierarchy']) if hash['hierarchy']
77
+ date_range = DateRange1.from_hash(hash['dateRange']) if hash['dateRange']
78
+ pagination = Pagination.from_hash(hash['pagination']) if hash['pagination']
79
+ batch_card_type =
80
+ hash.key?('batchCardType') ? hash['batchCardType'] : SKIP
81
+ sort_results_by = SortResultsBy2.from_hash(hash['sortResultsBy']) if hash['sortResultsBy']
82
+
83
+ # Create a new hash for additional properties, removing known properties.
84
+ new_hash = hash.reject { |k, _| names.value?(k) }
85
+
86
+ additional_properties = APIHelper.get_additional_properties(
87
+ new_hash, proc { |value| value }
88
+ )
89
+
90
+ # Create object from extracted values.
91
+ SettlementBatchesStoreRequest.new(hierarchy: hierarchy,
92
+ date_range: date_range,
93
+ pagination: pagination,
94
+ batch_card_type: batch_card_type,
95
+ sort_results_by: sort_results_by,
96
+ additional_properties: additional_properties)
97
+ end
98
+
99
+ # Provides a human-readable string representation of the object.
100
+ def to_s
101
+ class_name = self.class.name.split('::').last
102
+ "<#{class_name} pagination: #{@pagination}, hierarchy: #{@hierarchy}, date_range:"\
103
+ " #{@date_range}, batch_card_type: #{@batch_card_type}, sort_results_by:"\
104
+ " #{@sort_results_by}, additional_properties: #{@additional_properties}>"
105
+ end
106
+
107
+ # Provides a debugging-friendly string with detailed object information.
108
+ def inspect
109
+ class_name = self.class.name.split('::').last
110
+ "<#{class_name} pagination: #{@pagination.inspect}, hierarchy: #{@hierarchy.inspect},"\
111
+ " date_range: #{@date_range.inspect}, batch_card_type: #{@batch_card_type.inspect},"\
112
+ " sort_results_by: #{@sort_results_by.inspect}, additional_properties:"\
113
+ " #{@additional_properties}>"
114
+ end
115
+ end
116
+ end
@@ -0,0 +1,94 @@
1
+ # reporting_settlement_research_api
2
+ #
3
+ # This file was automatically generated
4
+ # by APIMATIC v3.0 ( https://www.apimatic.io ).
5
+
6
+ module ReportingSettlementResearchApi
7
+ # Response used for pagination.
8
+ class SettlementBatchesStoreResponse < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # TODO: Write general description for this method
13
+ # @return [Pagination4]
14
+ attr_accessor :pagination
15
+
16
+ # The settlement batches details.
17
+ # @return [Array[SettlementBatchesTransactionStore]]
18
+ attr_accessor :details
19
+
20
+ # A mapping from model property names to API property names.
21
+ def self.names
22
+ @_hash = {} if @_hash.nil?
23
+ @_hash['pagination'] = 'pagination'
24
+ @_hash['details'] = 'details'
25
+ @_hash
26
+ end
27
+
28
+ # An array for optional fields
29
+ def self.optionals
30
+ %w[
31
+ pagination
32
+ details
33
+ ]
34
+ end
35
+
36
+ # An array for nullable fields
37
+ def self.nullables
38
+ []
39
+ end
40
+
41
+ def initialize(pagination: SKIP, details: SKIP, additional_properties: nil)
42
+ # Add additional model properties to the instance
43
+ additional_properties = {} if additional_properties.nil?
44
+
45
+ @pagination = pagination unless pagination == SKIP
46
+ @details = details unless details == SKIP
47
+ @additional_properties = additional_properties
48
+ end
49
+
50
+ # Creates an instance of the object from a hash.
51
+ def self.from_hash(hash)
52
+ return nil unless hash
53
+
54
+ # Extract variables from the hash.
55
+ pagination = Pagination4.from_hash(hash['pagination']) if hash['pagination']
56
+ # Parameter is an array, so we need to iterate through it
57
+ details = nil
58
+ unless hash['details'].nil?
59
+ details = []
60
+ hash['details'].each do |structure|
61
+ details << (SettlementBatchesTransactionStore.from_hash(structure) if structure)
62
+ end
63
+ end
64
+
65
+ details = SKIP unless hash.key?('details')
66
+
67
+ # Create a new hash for additional properties, removing known properties.
68
+ new_hash = hash.reject { |k, _| names.value?(k) }
69
+
70
+ additional_properties = APIHelper.get_additional_properties(
71
+ new_hash, proc { |value| value }
72
+ )
73
+
74
+ # Create object from extracted values.
75
+ SettlementBatchesStoreResponse.new(pagination: pagination,
76
+ details: details,
77
+ additional_properties: additional_properties)
78
+ end
79
+
80
+ # Provides a human-readable string representation of the object.
81
+ def to_s
82
+ class_name = self.class.name.split('::').last
83
+ "<#{class_name} pagination: #{@pagination}, details: #{@details}, additional_properties:"\
84
+ " #{@additional_properties}>"
85
+ end
86
+
87
+ # Provides a debugging-friendly string with detailed object information.
88
+ def inspect
89
+ class_name = self.class.name.split('::').last
90
+ "<#{class_name} pagination: #{@pagination.inspect}, details: #{@details.inspect},"\
91
+ " additional_properties: #{@additional_properties}>"
92
+ end
93
+ end
94
+ end
@@ -0,0 +1,195 @@
1
+ # reporting_settlement_research_api
2
+ #
3
+ # This file was automatically generated
4
+ # by APIMATIC v3.0 ( https://www.apimatic.io ).
5
+
6
+ module ReportingSettlementResearchApi
7
+ # The settlement batches transaction date.
8
+ class SettlementBatchesTransactionDate < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # TODO: Write general description for this method
13
+ # @return [Hierarchy4]
14
+ attr_accessor :hierarchy
15
+
16
+ # The date when the transaction has been processed for settlement between
17
+ # the two parties.
18
+ # @return [Date]
19
+ attr_accessor :process_date
20
+
21
+ # The 11-byte unique identifier assigned to a group of transactions that
22
+ # were handled together as a single unit.
23
+ # @return [Integer]
24
+ attr_accessor :batch_number
25
+
26
+ # The category or classification of a payment card based on the issuing
27
+ # network. The type is either Credit or Debit.
28
+ # @return [String]
29
+ attr_accessor :batch_card_type
30
+
31
+ # The number of items sold within a specific batch quantity.
32
+ # @return [Integer]
33
+ attr_accessor :sale_count
34
+
35
+ # The total revenue generated from selling items within a specific batch.
36
+ # @return [Float]
37
+ attr_accessor :sale_amount
38
+
39
+ # The number of items sent back within a batch.
40
+ # @return [Integer]
41
+ attr_accessor :return_count
42
+
43
+ # The amount refunded within a batch.
44
+ # @return [Float]
45
+ attr_accessor :return_amount
46
+
47
+ # The total number of cash advances issued.
48
+ # @return [Integer]
49
+ attr_accessor :cash_advance_count
50
+
51
+ # The sum of the borrowed funds.
52
+ # @return [Float]
53
+ attr_accessor :cash_advance_amount
54
+
55
+ # The total remaining amount after deductions.
56
+ # @return [Integer]
57
+ attr_accessor :net_count
58
+
59
+ # The count minus deductions.
60
+ # @return [Float]
61
+ attr_accessor :net_amount
62
+
63
+ # A mapping from model property names to API property names.
64
+ def self.names
65
+ @_hash = {} if @_hash.nil?
66
+ @_hash['hierarchy'] = 'hierarchy'
67
+ @_hash['process_date'] = 'processDate'
68
+ @_hash['batch_number'] = 'batchNumber'
69
+ @_hash['batch_card_type'] = 'batchCardType'
70
+ @_hash['sale_count'] = 'saleCount'
71
+ @_hash['sale_amount'] = 'saleAmount'
72
+ @_hash['return_count'] = 'returnCount'
73
+ @_hash['return_amount'] = 'returnAmount'
74
+ @_hash['cash_advance_count'] = 'cashAdvanceCount'
75
+ @_hash['cash_advance_amount'] = 'cashAdvanceAmount'
76
+ @_hash['net_count'] = 'netCount'
77
+ @_hash['net_amount'] = 'netAmount'
78
+ @_hash
79
+ end
80
+
81
+ # An array for optional fields
82
+ def self.optionals
83
+ %w[
84
+ hierarchy
85
+ process_date
86
+ batch_number
87
+ batch_card_type
88
+ sale_count
89
+ sale_amount
90
+ return_count
91
+ return_amount
92
+ cash_advance_count
93
+ cash_advance_amount
94
+ net_count
95
+ net_amount
96
+ ]
97
+ end
98
+
99
+ # An array for nullable fields
100
+ def self.nullables
101
+ []
102
+ end
103
+
104
+ def initialize(hierarchy: SKIP, process_date: SKIP, batch_number: SKIP,
105
+ batch_card_type: SKIP, sale_count: SKIP, sale_amount: SKIP,
106
+ return_count: SKIP, return_amount: SKIP,
107
+ cash_advance_count: SKIP, cash_advance_amount: SKIP,
108
+ net_count: SKIP, net_amount: SKIP,
109
+ additional_properties: nil)
110
+ # Add additional model properties to the instance
111
+ additional_properties = {} if additional_properties.nil?
112
+
113
+ @hierarchy = hierarchy unless hierarchy == SKIP
114
+ @process_date = process_date unless process_date == SKIP
115
+ @batch_number = batch_number unless batch_number == SKIP
116
+ @batch_card_type = batch_card_type unless batch_card_type == SKIP
117
+ @sale_count = sale_count unless sale_count == SKIP
118
+ @sale_amount = sale_amount unless sale_amount == SKIP
119
+ @return_count = return_count unless return_count == SKIP
120
+ @return_amount = return_amount unless return_amount == SKIP
121
+ @cash_advance_count = cash_advance_count unless cash_advance_count == SKIP
122
+ @cash_advance_amount = cash_advance_amount unless cash_advance_amount == SKIP
123
+ @net_count = net_count unless net_count == SKIP
124
+ @net_amount = net_amount unless net_amount == SKIP
125
+ @additional_properties = additional_properties
126
+ end
127
+
128
+ # Creates an instance of the object from a hash.
129
+ def self.from_hash(hash)
130
+ return nil unless hash
131
+
132
+ # Extract variables from the hash.
133
+ hierarchy = Hierarchy4.from_hash(hash['hierarchy']) if hash['hierarchy']
134
+ process_date = hash.key?('processDate') ? hash['processDate'] : SKIP
135
+ batch_number = hash.key?('batchNumber') ? hash['batchNumber'] : SKIP
136
+ batch_card_type =
137
+ hash.key?('batchCardType') ? hash['batchCardType'] : SKIP
138
+ sale_count = hash.key?('saleCount') ? hash['saleCount'] : SKIP
139
+ sale_amount = hash.key?('saleAmount') ? hash['saleAmount'] : SKIP
140
+ return_count = hash.key?('returnCount') ? hash['returnCount'] : SKIP
141
+ return_amount = hash.key?('returnAmount') ? hash['returnAmount'] : SKIP
142
+ cash_advance_count =
143
+ hash.key?('cashAdvanceCount') ? hash['cashAdvanceCount'] : SKIP
144
+ cash_advance_amount =
145
+ hash.key?('cashAdvanceAmount') ? hash['cashAdvanceAmount'] : SKIP
146
+ net_count = hash.key?('netCount') ? hash['netCount'] : SKIP
147
+ net_amount = hash.key?('netAmount') ? hash['netAmount'] : SKIP
148
+
149
+ # Create a new hash for additional properties, removing known properties.
150
+ new_hash = hash.reject { |k, _| names.value?(k) }
151
+
152
+ additional_properties = APIHelper.get_additional_properties(
153
+ new_hash, proc { |value| value }
154
+ )
155
+
156
+ # Create object from extracted values.
157
+ SettlementBatchesTransactionDate.new(hierarchy: hierarchy,
158
+ process_date: process_date,
159
+ batch_number: batch_number,
160
+ batch_card_type: batch_card_type,
161
+ sale_count: sale_count,
162
+ sale_amount: sale_amount,
163
+ return_count: return_count,
164
+ return_amount: return_amount,
165
+ cash_advance_count: cash_advance_count,
166
+ cash_advance_amount: cash_advance_amount,
167
+ net_count: net_count,
168
+ net_amount: net_amount,
169
+ additional_properties: additional_properties)
170
+ end
171
+
172
+ # Provides a human-readable string representation of the object.
173
+ def to_s
174
+ class_name = self.class.name.split('::').last
175
+ "<#{class_name} hierarchy: #{@hierarchy}, process_date: #{@process_date}, batch_number:"\
176
+ " #{@batch_number}, batch_card_type: #{@batch_card_type}, sale_count: #{@sale_count},"\
177
+ " sale_amount: #{@sale_amount}, return_count: #{@return_count}, return_amount:"\
178
+ " #{@return_amount}, cash_advance_count: #{@cash_advance_count}, cash_advance_amount:"\
179
+ " #{@cash_advance_amount}, net_count: #{@net_count}, net_amount: #{@net_amount},"\
180
+ " additional_properties: #{@additional_properties}>"
181
+ end
182
+
183
+ # Provides a debugging-friendly string with detailed object information.
184
+ def inspect
185
+ class_name = self.class.name.split('::').last
186
+ "<#{class_name} hierarchy: #{@hierarchy.inspect}, process_date: #{@process_date.inspect},"\
187
+ " batch_number: #{@batch_number.inspect}, batch_card_type: #{@batch_card_type.inspect},"\
188
+ " sale_count: #{@sale_count.inspect}, sale_amount: #{@sale_amount.inspect}, return_count:"\
189
+ " #{@return_count.inspect}, return_amount: #{@return_amount.inspect}, cash_advance_count:"\
190
+ " #{@cash_advance_count.inspect}, cash_advance_amount: #{@cash_advance_amount.inspect},"\
191
+ " net_count: #{@net_count.inspect}, net_amount: #{@net_amount.inspect},"\
192
+ " additional_properties: #{@additional_properties}>"
193
+ end
194
+ end
195
+ end
@@ -0,0 +1,195 @@
1
+ # reporting_settlement_research_api
2
+ #
3
+ # This file was automatically generated
4
+ # by APIMATIC v3.0 ( https://www.apimatic.io ).
5
+
6
+ module ReportingSettlementResearchApi
7
+ # Request fields for settlement batches for a store.
8
+ class SettlementBatchesTransactionStore < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # TODO: Write general description for this method
13
+ # @return [Hierarchy4]
14
+ attr_accessor :hierarchy
15
+
16
+ # The date when the transaction has been processed for settlement between
17
+ # the two parties.
18
+ # @return [Date]
19
+ attr_accessor :process_date
20
+
21
+ # Refers to a group of processed transaction records.
22
+ # @return [Integer]
23
+ attr_accessor :number_of_batches
24
+
25
+ # The category or classification of a payment card based on the issuing
26
+ # network. Types are CREDIT,DEBIT, and EBT.
27
+ # @return [String]
28
+ attr_accessor :batch_card_type
29
+
30
+ # Indicates the number of items sold within a specific batch quantity.
31
+ # @return [Float]
32
+ attr_accessor :sale_count
33
+
34
+ # Total revenue generated from selling items within a specific batch.
35
+ # @return [Float]
36
+ attr_accessor :sale_amount
37
+
38
+ # Indicates the number of items sent back within a batch.
39
+ # @return [Float]
40
+ attr_accessor :return_count
41
+
42
+ # Indicates amount refunded within a batch.
43
+ # @return [Float]
44
+ attr_accessor :return_amount
45
+
46
+ # The total number of cash advances that were issued.
47
+ # @return [Float]
48
+ attr_accessor :cash_advance_count
49
+
50
+ # The sum of the borrowed funds.
51
+ # @return [Float]
52
+ attr_accessor :cash_advance_amount
53
+
54
+ # The total remaining amount after deductions.
55
+ # @return [Float]
56
+ attr_accessor :net_count
57
+
58
+ # The count minus deductions.
59
+ # @return [Float]
60
+ attr_accessor :net_amount
61
+
62
+ # A mapping from model property names to API property names.
63
+ def self.names
64
+ @_hash = {} if @_hash.nil?
65
+ @_hash['hierarchy'] = 'hierarchy'
66
+ @_hash['process_date'] = 'processDate'
67
+ @_hash['number_of_batches'] = 'numberOfBatches'
68
+ @_hash['batch_card_type'] = 'batchCardType'
69
+ @_hash['sale_count'] = 'saleCount'
70
+ @_hash['sale_amount'] = 'saleAmount'
71
+ @_hash['return_count'] = 'returnCount'
72
+ @_hash['return_amount'] = 'returnAmount'
73
+ @_hash['cash_advance_count'] = 'cashAdvanceCount'
74
+ @_hash['cash_advance_amount'] = 'cashAdvanceAmount'
75
+ @_hash['net_count'] = 'netCount'
76
+ @_hash['net_amount'] = 'netAmount'
77
+ @_hash
78
+ end
79
+
80
+ # An array for optional fields
81
+ def self.optionals
82
+ %w[
83
+ hierarchy
84
+ process_date
85
+ number_of_batches
86
+ batch_card_type
87
+ sale_count
88
+ sale_amount
89
+ return_count
90
+ return_amount
91
+ cash_advance_count
92
+ cash_advance_amount
93
+ net_count
94
+ net_amount
95
+ ]
96
+ end
97
+
98
+ # An array for nullable fields
99
+ def self.nullables
100
+ []
101
+ end
102
+
103
+ def initialize(hierarchy: SKIP, process_date: SKIP, number_of_batches: SKIP,
104
+ batch_card_type: SKIP, sale_count: SKIP, sale_amount: SKIP,
105
+ return_count: SKIP, return_amount: SKIP,
106
+ cash_advance_count: SKIP, cash_advance_amount: SKIP,
107
+ net_count: SKIP, net_amount: SKIP,
108
+ additional_properties: nil)
109
+ # Add additional model properties to the instance
110
+ additional_properties = {} if additional_properties.nil?
111
+
112
+ @hierarchy = hierarchy unless hierarchy == SKIP
113
+ @process_date = process_date unless process_date == SKIP
114
+ @number_of_batches = number_of_batches unless number_of_batches == SKIP
115
+ @batch_card_type = batch_card_type unless batch_card_type == SKIP
116
+ @sale_count = sale_count unless sale_count == SKIP
117
+ @sale_amount = sale_amount unless sale_amount == SKIP
118
+ @return_count = return_count unless return_count == SKIP
119
+ @return_amount = return_amount unless return_amount == SKIP
120
+ @cash_advance_count = cash_advance_count unless cash_advance_count == SKIP
121
+ @cash_advance_amount = cash_advance_amount unless cash_advance_amount == SKIP
122
+ @net_count = net_count unless net_count == SKIP
123
+ @net_amount = net_amount unless net_amount == SKIP
124
+ @additional_properties = additional_properties
125
+ end
126
+
127
+ # Creates an instance of the object from a hash.
128
+ def self.from_hash(hash)
129
+ return nil unless hash
130
+
131
+ # Extract variables from the hash.
132
+ hierarchy = Hierarchy4.from_hash(hash['hierarchy']) if hash['hierarchy']
133
+ process_date = hash.key?('processDate') ? hash['processDate'] : SKIP
134
+ number_of_batches =
135
+ hash.key?('numberOfBatches') ? hash['numberOfBatches'] : SKIP
136
+ batch_card_type =
137
+ hash.key?('batchCardType') ? hash['batchCardType'] : SKIP
138
+ sale_count = hash.key?('saleCount') ? hash['saleCount'] : SKIP
139
+ sale_amount = hash.key?('saleAmount') ? hash['saleAmount'] : SKIP
140
+ return_count = hash.key?('returnCount') ? hash['returnCount'] : SKIP
141
+ return_amount = hash.key?('returnAmount') ? hash['returnAmount'] : SKIP
142
+ cash_advance_count =
143
+ hash.key?('cashAdvanceCount') ? hash['cashAdvanceCount'] : SKIP
144
+ cash_advance_amount =
145
+ hash.key?('cashAdvanceAmount') ? hash['cashAdvanceAmount'] : SKIP
146
+ net_count = hash.key?('netCount') ? hash['netCount'] : SKIP
147
+ net_amount = hash.key?('netAmount') ? hash['netAmount'] : SKIP
148
+
149
+ # Create a new hash for additional properties, removing known properties.
150
+ new_hash = hash.reject { |k, _| names.value?(k) }
151
+
152
+ additional_properties = APIHelper.get_additional_properties(
153
+ new_hash, proc { |value| value }
154
+ )
155
+
156
+ # Create object from extracted values.
157
+ SettlementBatchesTransactionStore.new(hierarchy: hierarchy,
158
+ process_date: process_date,
159
+ number_of_batches: number_of_batches,
160
+ batch_card_type: batch_card_type,
161
+ sale_count: sale_count,
162
+ sale_amount: sale_amount,
163
+ return_count: return_count,
164
+ return_amount: return_amount,
165
+ cash_advance_count: cash_advance_count,
166
+ cash_advance_amount: cash_advance_amount,
167
+ net_count: net_count,
168
+ net_amount: net_amount,
169
+ additional_properties: additional_properties)
170
+ end
171
+
172
+ # Provides a human-readable string representation of the object.
173
+ def to_s
174
+ class_name = self.class.name.split('::').last
175
+ "<#{class_name} hierarchy: #{@hierarchy}, process_date: #{@process_date},"\
176
+ " number_of_batches: #{@number_of_batches}, batch_card_type: #{@batch_card_type},"\
177
+ " sale_count: #{@sale_count}, sale_amount: #{@sale_amount}, return_count: #{@return_count},"\
178
+ " return_amount: #{@return_amount}, cash_advance_count: #{@cash_advance_count},"\
179
+ " cash_advance_amount: #{@cash_advance_amount}, net_count: #{@net_count}, net_amount:"\
180
+ " #{@net_amount}, additional_properties: #{@additional_properties}>"
181
+ end
182
+
183
+ # Provides a debugging-friendly string with detailed object information.
184
+ def inspect
185
+ class_name = self.class.name.split('::').last
186
+ "<#{class_name} hierarchy: #{@hierarchy.inspect}, process_date: #{@process_date.inspect},"\
187
+ " number_of_batches: #{@number_of_batches.inspect}, batch_card_type:"\
188
+ " #{@batch_card_type.inspect}, sale_count: #{@sale_count.inspect}, sale_amount:"\
189
+ " #{@sale_amount.inspect}, return_count: #{@return_count.inspect}, return_amount:"\
190
+ " #{@return_amount.inspect}, cash_advance_count: #{@cash_advance_count.inspect},"\
191
+ " cash_advance_amount: #{@cash_advance_amount.inspect}, net_count: #{@net_count.inspect},"\
192
+ " net_amount: #{@net_amount.inspect}, additional_properties: #{@additional_properties}>"
193
+ end
194
+ end
195
+ end