data-and-reporting-sdk 1.3.0 → 2.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 (216) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +66 -35
  3. data/lib/shell_data_reporting_ap_is/api_helper.rb +2 -2
  4. data/lib/shell_data_reporting_ap_is/client.rb +11 -12
  5. data/lib/shell_data_reporting_ap_is/configuration.rb +23 -25
  6. data/lib/shell_data_reporting_ap_is/controllers/base_controller.rb +3 -9
  7. data/lib/shell_data_reporting_ap_is/controllers/customer_controller.rb +251 -288
  8. data/lib/shell_data_reporting_ap_is/controllers/invoice_controller.rb +20 -20
  9. data/lib/shell_data_reporting_ap_is/controllers/o_auth_authorization_controller.rb +7 -7
  10. data/lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb +204 -259
  11. data/lib/shell_data_reporting_ap_is/exceptions/api_exception.rb +2 -2
  12. data/lib/shell_data_reporting_ap_is/exceptions/error_object_exception.rb +7 -5
  13. data/lib/shell_data_reporting_ap_is/exceptions/o_auth_provider_exception.rb +7 -5
  14. data/lib/shell_data_reporting_ap_is/http/auth/{bearer_token.rb → o_auth2.rb} +28 -27
  15. data/lib/shell_data_reporting_ap_is/http/http_call_back.rb +2 -2
  16. data/lib/shell_data_reporting_ap_is/http/http_method_enum.rb +2 -2
  17. data/lib/shell_data_reporting_ap_is/http/http_request.rb +2 -2
  18. data/lib/shell_data_reporting_ap_is/http/http_response.rb +2 -2
  19. data/lib/shell_data_reporting_ap_is/http/proxy_settings.rb +13 -0
  20. data/lib/shell_data_reporting_ap_is/models/account_access.rb +2 -2
  21. data/lib/shell_data_reporting_ap_is/models/account_req.rb +84 -0
  22. data/lib/shell_data_reporting_ap_is/models/account_request.rb +3 -3
  23. data/lib/shell_data_reporting_ap_is/models/account_res.rb +158 -0
  24. data/lib/shell_data_reporting_ap_is/models/account_response_accounts_items.rb +2 -2
  25. data/lib/shell_data_reporting_ap_is/models/accounts.rb +2 -2
  26. data/lib/shell_data_reporting_ap_is/models/address.rb +2 -2
  27. data/lib/shell_data_reporting_ap_is/models/associated_account.rb +2 -2
  28. data/lib/shell_data_reporting_ap_is/models/audit_array_elements.rb +71 -0
  29. data/lib/shell_data_reporting_ap_is/models/audit_req.rb +84 -0
  30. data/lib/shell_data_reporting_ap_is/models/audit_request.rb +29 -41
  31. data/lib/shell_data_reporting_ap_is/models/audit_response.rb +88 -53
  32. data/lib/shell_data_reporting_ap_is/models/audit_response_audits_items.rb +29 -6
  33. data/lib/shell_data_reporting_ap_is/models/bank_account.rb +2 -2
  34. data/lib/shell_data_reporting_ap_is/models/base_model.rb +2 -2
  35. data/lib/shell_data_reporting_ap_is/models/bonus_configuration.rb +2 -2
  36. data/lib/shell_data_reporting_ap_is/models/bonus_history.rb +2 -2
  37. data/lib/shell_data_reporting_ap_is/models/card_day_time_restrictions.rb +2 -2
  38. data/lib/shell_data_reporting_ap_is/models/card_exceptions.rb +2 -2
  39. data/lib/shell_data_reporting_ap_is/models/card_group_req.rb +84 -0
  40. data/lib/shell_data_reporting_ap_is/models/card_group_request.rb +6 -31
  41. data/lib/shell_data_reporting_ap_is/models/card_group_res.rb +158 -0
  42. data/lib/shell_data_reporting_ap_is/models/card_group_response_card_groups_items.rb +2 -2
  43. data/lib/shell_data_reporting_ap_is/models/{error_user_access.rb → card_type_req.rb} +14 -14
  44. data/lib/shell_data_reporting_ap_is/models/card_type_request.rb +2 -2
  45. data/lib/shell_data_reporting_ap_is/models/card_type_res.rb +91 -0
  46. data/lib/shell_data_reporting_ap_is/models/card_type_response_customer_card_types_items.rb +3 -3
  47. data/lib/shell_data_reporting_ap_is/models/card_usage_restrictions.rb +2 -2
  48. data/lib/shell_data_reporting_ap_is/models/card_usage_summary_req.rb +62 -0
  49. data/lib/shell_data_reporting_ap_is/models/card_usage_summary_request.rb +2 -2
  50. data/lib/shell_data_reporting_ap_is/models/card_usage_summary_res.rb +116 -0
  51. data/lib/shell_data_reporting_ap_is/models/card_usage_summary_response.rb +6 -26
  52. data/lib/shell_data_reporting_ap_is/models/col_co_access.rb +4 -4
  53. data/lib/shell_data_reporting_ap_is/models/current_volume.rb +2 -2
  54. data/lib/shell_data_reporting_ap_is/models/customer_contract.rb +2 -2
  55. data/lib/shell_data_reporting_ap_is/models/customer_detail_request.rb +4 -4
  56. data/lib/shell_data_reporting_ap_is/models/customer_detail_response.rb +5 -32
  57. data/lib/shell_data_reporting_ap_is/models/customer_price_list_req.rb +62 -0
  58. data/lib/shell_data_reporting_ap_is/models/customer_price_list_request.rb +2 -2
  59. data/lib/shell_data_reporting_ap_is/models/customer_price_list_res.rb +91 -0
  60. data/lib/shell_data_reporting_ap_is/models/customer_price_list_response.rb +7 -29
  61. data/lib/shell_data_reporting_ap_is/models/{default_error_fault_detail.rb → customer_req.rb} +15 -15
  62. data/lib/shell_data_reporting_ap_is/models/customer_res.rb +91 -0
  63. data/lib/shell_data_reporting_ap_is/models/delivery_addresses.rb +2 -2
  64. data/lib/shell_data_reporting_ap_is/models/eid_access.rb +3 -3
  65. data/lib/shell_data_reporting_ap_is/models/eid_document.rb +2 -2
  66. data/lib/shell_data_reporting_ap_is/models/eid_document_response.rb +2 -2
  67. data/lib/shell_data_reporting_ap_is/models/eid_download_req.rb +2 -2
  68. data/lib/shell_data_reporting_ap_is/models/eid_download_request.rb +2 -2
  69. data/lib/shell_data_reporting_ap_is/models/eid_search_req.rb +2 -2
  70. data/lib/shell_data_reporting_ap_is/models/eid_search_request.rb +2 -2
  71. data/lib/shell_data_reporting_ap_is/models/error_details.rb +2 -2
  72. data/lib/shell_data_reporting_ap_is/models/exception_product.rb +2 -2
  73. data/lib/shell_data_reporting_ap_is/models/exception_site_location.rb +2 -2
  74. data/lib/shell_data_reporting_ap_is/models/fee_item.rb +2 -2
  75. data/lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb +2 -2
  76. data/lib/shell_data_reporting_ap_is/models/fee_rule_location.rb +2 -2
  77. data/lib/shell_data_reporting_ap_is/models/fee_rule_product.rb +2 -2
  78. data/lib/shell_data_reporting_ap_is/models/fee_rule_tier.rb +2 -2
  79. data/lib/shell_data_reporting_ap_is/models/fee_summary_response.rb +57 -38
  80. data/lib/shell_data_reporting_ap_is/models/fees_fee_rule_tiers.rb +2 -2
  81. data/lib/shell_data_reporting_ap_is/models/filters.rb +522 -0
  82. data/lib/shell_data_reporting_ap_is/models/{finance_currency.rb → finance_currency2.rb} +8 -9
  83. data/lib/shell_data_reporting_ap_is/models/fleetmanagement_v1_user_loggedinuser_request.rb +2 -2
  84. data/lib/shell_data_reporting_ap_is/models/fuel_consumption_card.rb +2 -2
  85. data/lib/shell_data_reporting_ap_is/models/fuel_consumption_data.rb +2 -2
  86. data/lib/shell_data_reporting_ap_is/models/fuel_consumption_req.rb +62 -0
  87. data/lib/shell_data_reporting_ap_is/models/fuel_consumption_request.rb +2 -2
  88. data/lib/shell_data_reporting_ap_is/models/fuel_consumption_response.rb +58 -33
  89. data/lib/shell_data_reporting_ap_is/models/invoice_dates_data.rb +2 -2
  90. data/lib/shell_data_reporting_ap_is/models/invoice_dates_request.rb +2 -2
  91. data/lib/shell_data_reporting_ap_is/models/invoice_dates_request_filters.rb +2 -2
  92. data/lib/shell_data_reporting_ap_is/models/invoice_dates_response_data.rb +2 -2
  93. data/lib/shell_data_reporting_ap_is/models/invoice_distribution_method.rb +2 -2
  94. data/lib/shell_data_reporting_ap_is/models/invoice_download_req.rb +2 -2
  95. data/lib/shell_data_reporting_ap_is/models/invoice_download_request.rb +2 -2
  96. data/lib/shell_data_reporting_ap_is/models/invoice_search_additional_document.rb +2 -2
  97. data/lib/shell_data_reporting_ap_is/models/invoice_search_details.rb +2 -2
  98. data/lib/shell_data_reporting_ap_is/models/invoice_search_request.rb +2 -2
  99. data/lib/shell_data_reporting_ap_is/models/invoice_search_request_filters.rb +2 -2
  100. data/lib/shell_data_reporting_ap_is/models/invoice_search_response.rb +2 -2
  101. data/lib/shell_data_reporting_ap_is/models/invoice_summary_details.rb +2 -2
  102. data/lib/shell_data_reporting_ap_is/models/invoice_summary_request.rb +2 -2
  103. data/lib/shell_data_reporting_ap_is/models/invoice_summary_request_filters.rb +2 -2
  104. data/lib/shell_data_reporting_ap_is/models/invoice_summary_response.rb +2 -2
  105. data/lib/shell_data_reporting_ap_is/models/invoices_summaries.rb +2 -2
  106. data/lib/shell_data_reporting_ap_is/models/last_statement_of_account.rb +2 -2
  107. data/lib/shell_data_reporting_ap_is/models/last_statement_of_account2.rb +457 -0
  108. data/lib/shell_data_reporting_ap_is/models/{error_user_access_error.rb → location.rb} +25 -22
  109. data/lib/shell_data_reporting_ap_is/models/logged_in_user_req.rb +63 -0
  110. data/lib/shell_data_reporting_ap_is/models/logged_in_user_res.rb +91 -0
  111. data/lib/shell_data_reporting_ap_is/models/logged_in_user_response.rb +6 -30
  112. data/lib/shell_data_reporting_ap_is/models/monthly_invoice_trend.rb +2 -2
  113. data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_req.rb +84 -0
  114. data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_request.rb +2 -2
  115. data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_request_accounts_items.rb +2 -2
  116. data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_res.rb +158 -0
  117. data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_response.rb +6 -57
  118. data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_response_transactions_items.rb +2 -2
  119. data/lib/shell_data_reporting_ap_is/models/o_auth_provider_error_enum.rb +2 -2
  120. data/lib/shell_data_reporting_ap_is/models/o_auth_token.rb +2 -2
  121. data/lib/shell_data_reporting_ap_is/models/past_statement_of_accounts.rb +2 -2
  122. data/lib/shell_data_reporting_ap_is/models/payer_access.rb +2 -2
  123. data/lib/shell_data_reporting_ap_is/models/payer_details.rb +8 -6
  124. data/lib/shell_data_reporting_ap_is/models/payer_req.rb +84 -0
  125. data/lib/shell_data_reporting_ap_is/models/payer_request.rb +6 -33
  126. data/lib/shell_data_reporting_ap_is/models/payer_res.rb +158 -0
  127. data/lib/shell_data_reporting_ap_is/models/payers.rb +2 -2
  128. data/lib/shell_data_reporting_ap_is/models/payments_since_last_soa.rb +2 -2
  129. data/lib/shell_data_reporting_ap_is/models/pin_advice_types.rb +2 -2
  130. data/lib/shell_data_reporting_ap_is/models/price_list.rb +2 -2
  131. data/lib/shell_data_reporting_ap_is/models/price_trans_summary_req.rb +62 -0
  132. data/lib/shell_data_reporting_ap_is/models/price_trans_summary_request.rb +2 -2
  133. data/lib/shell_data_reporting_ap_is/models/price_transaction_req.rb +84 -0
  134. data/lib/shell_data_reporting_ap_is/models/price_transaction_request.rb +2 -2
  135. data/lib/shell_data_reporting_ap_is/models/priced_request_data.rb +4 -8
  136. data/lib/shell_data_reporting_ap_is/models/priced_response_data.rb +2 -2
  137. data/lib/shell_data_reporting_ap_is/models/priced_trans_summary_resp.rb +116 -0
  138. data/lib/shell_data_reporting_ap_is/models/priced_trans_summary_response_transactions_summary_items.rb +2 -2
  139. data/lib/shell_data_reporting_ap_is/models/priced_transaction_items_location_items.rb +2 -2
  140. data/lib/shell_data_reporting_ap_is/models/priced_transaction_req_v2_invoice_status_enum.rb +2 -2
  141. data/lib/shell_data_reporting_ap_is/models/priced_transaction_req_v2_period_enum.rb +2 -2
  142. data/lib/shell_data_reporting_ap_is/models/priced_transaction_req_v2_sort_order_enum.rb +2 -2
  143. data/lib/shell_data_reporting_ap_is/models/priced_transaction_request_v2.rb +5 -7
  144. data/lib/shell_data_reporting_ap_is/models/priced_transaction_res.rb +158 -0
  145. data/lib/shell_data_reporting_ap_is/models/priced_transaction_resp_v2_refund_flag_enum.rb +2 -2
  146. data/lib/shell_data_reporting_ap_is/models/priced_transaction_response.rb +2 -2
  147. data/lib/shell_data_reporting_ap_is/models/priced_transaction_response_transactions_items.rb +6 -27
  148. data/lib/shell_data_reporting_ap_is/models/priced_transaction_response_v2.rb +2 -2
  149. data/lib/shell_data_reporting_ap_is/models/pricing_current_volume.rb +2 -2
  150. data/lib/shell_data_reporting_ap_is/models/pricing_history.rb +2 -2
  151. data/lib/shell_data_reporting_ap_is/models/purchase_categories.rb +2 -2
  152. data/lib/shell_data_reporting_ap_is/models/recent_transaction_req.rb +2 -2
  153. data/lib/shell_data_reporting_ap_is/models/recent_transaction_request.rb +2 -2
  154. data/lib/shell_data_reporting_ap_is/models/recent_transactions.rb +2 -2
  155. data/lib/shell_data_reporting_ap_is/models/recent_transactions_response.rb +2 -2
  156. data/lib/shell_data_reporting_ap_is/models/role.rb +2 -2
  157. data/lib/shell_data_reporting_ap_is/models/search_doc_req.rb +2 -2
  158. data/lib/shell_data_reporting_ap_is/models/search_documents_invoice.rb +2 -2
  159. data/lib/shell_data_reporting_ap_is/models/search_documents_request.rb +2 -2
  160. data/lib/shell_data_reporting_ap_is/models/search_documents_response.rb +2 -2
  161. data/lib/shell_data_reporting_ap_is/models/search_soa_req.rb +2 -2
  162. data/lib/shell_data_reporting_ap_is/models/search_statement_of_account.rb +2 -2
  163. data/lib/shell_data_reporting_ap_is/models/search_statement_of_account_request.rb +2 -2
  164. data/lib/shell_data_reporting_ap_is/models/search_statement_of_account_response.rb +2 -2
  165. data/lib/shell_data_reporting_ap_is/models/site_location.rb +2 -2
  166. data/lib/shell_data_reporting_ap_is/models/statement_of_account_request.rb +2 -2
  167. data/lib/shell_data_reporting_ap_is/models/statement_of_account_request_filters.rb +2 -2
  168. data/lib/shell_data_reporting_ap_is/models/statement_of_account_resp.rb +9 -9
  169. data/lib/shell_data_reporting_ap_is/models/statement_of_account_response.rb +2 -2
  170. data/lib/shell_data_reporting_ap_is/models/tier.rb +2 -2
  171. data/lib/shell_data_reporting_ap_is/models/transaction_exceptions.rb +5 -5
  172. data/lib/shell_data_reporting_ap_is/models/transaction_exceptions_req.rb +62 -0
  173. data/lib/shell_data_reporting_ap_is/models/transaction_exceptions_request.rb +2 -2
  174. data/lib/shell_data_reporting_ap_is/models/transaction_exceptions_res.rb +116 -0
  175. data/lib/shell_data_reporting_ap_is/models/transaction_exceptions_response.rb +6 -26
  176. data/lib/shell_data_reporting_ap_is/models/transaction_fees_req.rb +84 -0
  177. data/lib/shell_data_reporting_ap_is/models/transaction_fees_request.rb +6 -28
  178. data/lib/shell_data_reporting_ap_is/models/transaction_fees_res.rb +158 -0
  179. data/lib/shell_data_reporting_ap_is/models/transaction_fees_summary_req.rb +62 -0
  180. data/lib/shell_data_reporting_ap_is/models/update_odometer.rb +2 -2
  181. data/lib/shell_data_reporting_ap_is/models/update_odometer_reference.rb +2 -2
  182. data/lib/shell_data_reporting_ap_is/models/update_odometer_request.rb +2 -2
  183. data/lib/shell_data_reporting_ap_is/models/update_odometer_resp.rb +116 -0
  184. data/lib/shell_data_reporting_ap_is/models/update_odometer_response.rb +6 -26
  185. data/lib/shell_data_reporting_ap_is/models/usage_summary.rb +2 -2
  186. data/lib/shell_data_reporting_ap_is/models/volume_based_bonus_req.rb +62 -0
  187. data/lib/shell_data_reporting_ap_is/models/volume_based_bonus_request.rb +2 -2
  188. data/lib/shell_data_reporting_ap_is/models/volume_based_bonus_res.rb +116 -0
  189. data/lib/shell_data_reporting_ap_is/models/volume_based_bonus_response.rb +6 -27
  190. data/lib/shell_data_reporting_ap_is/models/volume_based_pricing_req.rb +62 -0
  191. data/lib/shell_data_reporting_ap_is/models/volume_based_pricing_request.rb +2 -2
  192. data/lib/shell_data_reporting_ap_is/models/volume_based_pricing_res.rb +91 -0
  193. data/lib/shell_data_reporting_ap_is/models/volume_based_pricing_response.rb +28 -24
  194. data/lib/shell_data_reporting_ap_is/models/warning.rb +69 -0
  195. data/lib/shell_data_reporting_ap_is/utilities/date_time_helper.rb +2 -2
  196. data/lib/shell_data_reporting_ap_is/utilities/file_wrapper.rb +2 -2
  197. data/lib/shell_data_reporting_ap_is/utilities/union_type_lookup.rb +2 -2
  198. data/lib/shell_data_reporting_ap_is.rb +54 -29
  199. data/test/controllers/controller_test_base.rb +2 -2
  200. data/test/controllers/test_invoice_controller.rb +3 -12
  201. data/test/controllers/test_transaction_controller.rb +3 -5
  202. data/test/http_response_catcher.rb +3 -3
  203. metadata +50 -26
  204. data/lib/shell_data_reporting_ap_is/exceptions/default_error_exception.rb +0 -44
  205. data/lib/shell_data_reporting_ap_is/exceptions/error_user_access_error1_exception.rb +0 -44
  206. data/lib/shell_data_reporting_ap_is/http/auth/basic_auth.rb +0 -50
  207. data/lib/shell_data_reporting_ap_is/models/account_response.rb +0 -123
  208. data/lib/shell_data_reporting_ap_is/models/card_group_response.rb +0 -121
  209. data/lib/shell_data_reporting_ap_is/models/card_type_response.rb +0 -91
  210. data/lib/shell_data_reporting_ap_is/models/card_type_response_error.rb +0 -71
  211. data/lib/shell_data_reporting_ap_is/models/default_error_fault.rb +0 -71
  212. data/lib/shell_data_reporting_ap_is/models/error_status.rb +0 -81
  213. data/lib/shell_data_reporting_ap_is/models/logged_in_user_request.rb +0 -121
  214. data/lib/shell_data_reporting_ap_is/models/payer_response.rb +0 -127
  215. data/lib/shell_data_reporting_ap_is/models/priced_trans_summary_response.rb +0 -91
  216. data/lib/shell_data_reporting_ap_is/models/transaction_fees_response.rb +0 -123
@@ -0,0 +1,84 @@
1
+ # shell_data_reporting_ap_is
2
+ #
3
+ # This file was automatically generated by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
+
6
+ module ShellDataReportingApIs
7
+ # AuditReq Model.
8
+ class AuditReq < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # TODO: Write general description for this method
13
+ # @return [AuditRequest]
14
+ attr_accessor :filters
15
+
16
+ # Page Number (as shown to the users)
17
+ # @return [Integer]
18
+ attr_accessor :page
19
+
20
+ # Page Size – Number of records to show on a page.
21
+ # @return [Integer]
22
+ attr_accessor :page_size
23
+
24
+ # A mapping from model property names to API property names.
25
+ def self.names
26
+ @_hash = {} if @_hash.nil?
27
+ @_hash['filters'] = 'Filters'
28
+ @_hash['page'] = 'Page'
29
+ @_hash['page_size'] = 'PageSize'
30
+ @_hash
31
+ end
32
+
33
+ # An array for optional fields
34
+ def self.optionals
35
+ %w[
36
+ filters
37
+ page
38
+ page_size
39
+ ]
40
+ end
41
+
42
+ # An array for nullable fields
43
+ def self.nullables
44
+ %w[
45
+ page
46
+ page_size
47
+ ]
48
+ end
49
+
50
+ def initialize(filters = SKIP, page = 1, page_size = 50)
51
+ @filters = filters unless filters == SKIP
52
+ @page = page unless page == SKIP
53
+ @page_size = page_size unless page_size == SKIP
54
+ end
55
+
56
+ # Creates an instance of the object from a hash.
57
+ def self.from_hash(hash)
58
+ return nil unless hash
59
+
60
+ # Extract variables from the hash.
61
+ filters = AuditRequest.from_hash(hash['Filters']) if hash['Filters']
62
+ page = hash['Page'] ||= 1
63
+ page_size = hash['PageSize'] ||= 50
64
+
65
+ # Create object from extracted values.
66
+ AuditReq.new(filters,
67
+ page,
68
+ page_size)
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} filters: #{@filters}, page: #{@page}, page_size: #{@page_size}>"
75
+ end
76
+
77
+ # Provides a debugging-friendly string with detailed object information.
78
+ def inspect
79
+ class_name = self.class.name.split('::').last
80
+ "<#{class_name} filters: #{@filters.inspect}, page: #{@page.inspect}, page_size:"\
81
+ " #{@page_size.inspect}>"
82
+ end
83
+ end
84
+ end
@@ -1,7 +1,7 @@
1
1
  # shell_data_reporting_ap_is
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module ShellDataReportingApIs
7
7
  # AuditRequest Model.
@@ -65,20 +65,26 @@ module ShellDataReportingApIs
65
65
  # @return [Accounts]
66
66
  attr_accessor :accounts
67
67
 
68
- # Page Size – Number of records to show on a page
68
+ # Type of requests to be fetched.
69
69
  # Optional
70
- # Default value 50
71
- # @return [Integer]
72
- attr_accessor :page_size
73
-
74
- # To search for requests submitted until this date.
75
- # Optional
76
- # Format: yyyyMMdd
77
- # Example: 20200130
78
- # If ToDate is not provided and FromDate is provided, then ToDate will be
79
- # considered as current date or 30 days from FromDate, whichever is earlier.
80
- # However, when both FromDate and ToDate is not provided then last 30 days
81
- # will be considered for filtering.
70
+ # Allowed values:
71
+ # • OrderCard
72
+ # • CreateCardGroup
73
+ # • PINReminder
74
+ # • MoveCard
75
+ # • UpdateCardStatus
76
+ # • UpdateCardGroup
77
+ # • AutoRenew
78
+ # • BulkCardOrder
79
+ # • BulkCardBlock
80
+ # • BulkCardOrderMultiAccount
81
+ # • MobilePaymentRegistration
82
+ # • UpdateCompanyInfo
83
+ # • BCOSummary
84
+ # • BCOMultiAccountSummary
85
+ # • BCBSummary
86
+ # • FundTransfer
87
+ # • DeliveryAddressUpdate
82
88
  # @return [Array[String]]
83
89
  attr_accessor :requested_operation
84
90
 
@@ -100,12 +106,6 @@ module ShellDataReportingApIs
100
106
  # @return [String]
101
107
  attr_accessor :search_text
102
108
 
103
- # Page Number (as shown to the users)
104
- # Optional
105
- # Default value 1
106
- # @return [Integer]
107
- attr_accessor :current_page
108
-
109
109
  # To search for requests submitted from this date.
110
110
  # Optional
111
111
  # Maximum of X days duration allowed per search. The X value is configurable
@@ -139,11 +139,9 @@ module ShellDataReportingApIs
139
139
  @_hash['col_co_code'] = 'ColCoCode'
140
140
  @_hash['col_co_id'] = 'ColCoId'
141
141
  @_hash['accounts'] = 'Accounts'
142
- @_hash['page_size'] = 'PageSize'
143
142
  @_hash['requested_operation'] = 'RequestedOperation'
144
143
  @_hash['sort_order'] = 'SortOrder'
145
144
  @_hash['search_text'] = 'SearchText'
146
- @_hash['current_page'] = 'CurrentPage'
147
145
  @_hash['from_date'] = 'FromDate'
148
146
  @_hash['to_date'] = 'ToDate'
149
147
  @_hash
@@ -159,11 +157,9 @@ module ShellDataReportingApIs
159
157
  col_co_code
160
158
  col_co_id
161
159
  accounts
162
- page_size
163
160
  requested_operation
164
161
  sort_order
165
162
  search_text
166
- current_page
167
163
  from_date
168
164
  to_date
169
165
  ]
@@ -179,7 +175,6 @@ module ShellDataReportingApIs
179
175
  col_co_id
180
176
  sort_order
181
177
  search_text
182
- current_page
183
178
  from_date
184
179
  to_date
185
180
  ]
@@ -187,9 +182,8 @@ module ShellDataReportingApIs
187
182
 
188
183
  def initialize(status = SKIP, payer_number = SKIP, payer_id = SKIP,
189
184
  account_number = SKIP, col_co_code = SKIP, col_co_id = SKIP,
190
- accounts = SKIP, page_size = SKIP,
191
- requested_operation = SKIP, sort_order = SKIP,
192
- search_text = SKIP, current_page = SKIP, from_date = SKIP,
185
+ accounts = SKIP, requested_operation = SKIP,
186
+ sort_order = SKIP, search_text = SKIP, from_date = SKIP,
193
187
  to_date = SKIP)
194
188
  @status = status unless status == SKIP
195
189
  @payer_number = payer_number unless payer_number == SKIP
@@ -198,11 +192,9 @@ module ShellDataReportingApIs
198
192
  @col_co_code = col_co_code unless col_co_code == SKIP
199
193
  @col_co_id = col_co_id unless col_co_id == SKIP
200
194
  @accounts = accounts unless accounts == SKIP
201
- @page_size = page_size unless page_size == SKIP
202
195
  @requested_operation = requested_operation unless requested_operation == SKIP
203
196
  @sort_order = sort_order unless sort_order == SKIP
204
197
  @search_text = search_text unless search_text == SKIP
205
- @current_page = current_page unless current_page == SKIP
206
198
  @from_date = from_date unless from_date == SKIP
207
199
  @to_date = to_date unless to_date == SKIP
208
200
  end
@@ -219,12 +211,10 @@ module ShellDataReportingApIs
219
211
  col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
220
212
  col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
221
213
  accounts = Accounts.from_hash(hash['Accounts']) if hash['Accounts']
222
- page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
223
214
  requested_operation =
224
215
  hash.key?('RequestedOperation') ? hash['RequestedOperation'] : SKIP
225
216
  sort_order = hash.key?('SortOrder') ? hash['SortOrder'] : SKIP
226
217
  search_text = hash.key?('SearchText') ? hash['SearchText'] : SKIP
227
- current_page = hash.key?('CurrentPage') ? hash['CurrentPage'] : SKIP
228
218
  from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
229
219
  to_date = hash.key?('ToDate') ? hash['ToDate'] : SKIP
230
220
 
@@ -236,11 +226,9 @@ module ShellDataReportingApIs
236
226
  col_co_code,
237
227
  col_co_id,
238
228
  accounts,
239
- page_size,
240
229
  requested_operation,
241
230
  sort_order,
242
231
  search_text,
243
- current_page,
244
232
  from_date,
245
233
  to_date)
246
234
  end
@@ -250,9 +238,9 @@ module ShellDataReportingApIs
250
238
  class_name = self.class.name.split('::').last
251
239
  "<#{class_name} status: #{@status}, payer_number: #{@payer_number}, payer_id: #{@payer_id},"\
252
240
  " account_number: #{@account_number}, col_co_code: #{@col_co_code}, col_co_id:"\
253
- " #{@col_co_id}, accounts: #{@accounts}, page_size: #{@page_size}, requested_operation:"\
254
- " #{@requested_operation}, sort_order: #{@sort_order}, search_text: #{@search_text},"\
255
- " current_page: #{@current_page}, from_date: #{@from_date}, to_date: #{@to_date}>"
241
+ " #{@col_co_id}, accounts: #{@accounts}, requested_operation: #{@requested_operation},"\
242
+ " sort_order: #{@sort_order}, search_text: #{@search_text}, from_date: #{@from_date},"\
243
+ " to_date: #{@to_date}>"
256
244
  end
257
245
 
258
246
  # Provides a debugging-friendly string with detailed object information.
@@ -261,9 +249,9 @@ module ShellDataReportingApIs
261
249
  "<#{class_name} status: #{@status.inspect}, payer_number: #{@payer_number.inspect},"\
262
250
  " payer_id: #{@payer_id.inspect}, account_number: #{@account_number.inspect}, col_co_code:"\
263
251
  " #{@col_co_code.inspect}, col_co_id: #{@col_co_id.inspect}, accounts: #{@accounts.inspect},"\
264
- " page_size: #{@page_size.inspect}, requested_operation: #{@requested_operation.inspect},"\
265
- " sort_order: #{@sort_order.inspect}, search_text: #{@search_text.inspect}, current_page:"\
266
- " #{@current_page.inspect}, from_date: #{@from_date.inspect}, to_date: #{@to_date.inspect}>"
252
+ " requested_operation: #{@requested_operation.inspect}, sort_order: #{@sort_order.inspect},"\
253
+ " search_text: #{@search_text.inspect}, from_date: #{@from_date.inspect}, to_date:"\
254
+ " #{@to_date.inspect}>"
267
255
  end
268
256
  end
269
257
  end
@@ -1,7 +1,7 @@
1
1
  # shell_data_reporting_ap_is
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module ShellDataReportingApIs
7
7
  # AuditResponse Model.
@@ -9,53 +9,71 @@ module ShellDataReportingApIs
9
9
  SKIP = Object.new
10
10
  private_constant :SKIP
11
11
 
12
- # TODO: Write general description for this method
13
- # @return [Array[AuditResponseAuditsItems]]
14
- attr_accessor :audits
12
+ # Unique identifier for the request. This will be played back in the
13
+ # response from the request.
14
+ # @return [String]
15
+ attr_accessor :request_id
16
+
17
+ # Status of the request
18
+ # @return [String]
19
+ attr_accessor :status
20
+
21
+ # Status of the request
22
+ # @return [Array[AuditArrayElements]]
23
+ attr_accessor :data
15
24
 
16
25
  # Current Page
17
26
  # @return [Integer]
18
- attr_accessor :current_page
27
+ attr_accessor :page
19
28
 
20
29
  # Total row count matched for the given input criteria
21
30
  # @return [Integer]
22
- attr_accessor :row_count
31
+ attr_accessor :total_records
23
32
 
24
33
  # Calculated page count based on page size from the incoming API request and
25
- # total number of rows matched for the given input criteria
34
+ # total number of rows matched for the given input criteria. Return 1 if the
35
+ # page size is -1 as all records are returned.
26
36
  # @return [Integer]
27
37
  attr_accessor :total_pages
28
38
 
29
- # Calculated page count based on page size from the incoming API request and
30
- # total number of rows matched for the given input criteria
31
- # @return [ErrorStatus]
32
- attr_accessor :error
39
+ # Page Size Number of records to show on current page.
40
+ # @return [Integer]
41
+ attr_accessor :page_size
33
42
 
34
- # API RequestId
35
- # @return [String]
36
- attr_accessor :request_id
43
+ # A list of Warning entity.
44
+ # This entity will hold the details of the scheduled System Outages of any
45
+ # dependent applications of this service.
46
+ # Note: If there is no scheduled outage information available, in the
47
+ # configuration in AMS, for this service, this parameter won’t be present in
48
+ # output.
49
+ # @return [Array[Warning]]
50
+ attr_accessor :warnings
37
51
 
38
52
  # A mapping from model property names to API property names.
39
53
  def self.names
40
54
  @_hash = {} if @_hash.nil?
41
- @_hash['audits'] = 'Audits'
42
- @_hash['current_page'] = 'CurrentPage'
43
- @_hash['row_count'] = 'RowCount'
44
- @_hash['total_pages'] = 'TotalPages'
45
- @_hash['error'] = 'Error'
46
55
  @_hash['request_id'] = 'RequestId'
56
+ @_hash['status'] = 'Status'
57
+ @_hash['data'] = 'Data'
58
+ @_hash['page'] = 'Page'
59
+ @_hash['total_records'] = 'TotalRecords'
60
+ @_hash['total_pages'] = 'TotalPages'
61
+ @_hash['page_size'] = 'PageSize'
62
+ @_hash['warnings'] = 'Warnings'
47
63
  @_hash
48
64
  end
49
65
 
50
66
  # An array for optional fields
51
67
  def self.optionals
52
68
  %w[
53
- audits
54
- current_page
55
- row_count
56
- total_pages
57
- error
58
69
  request_id
70
+ status
71
+ data
72
+ page
73
+ total_records
74
+ total_pages
75
+ page_size
76
+ warnings
59
77
  ]
60
78
  end
61
79
 
@@ -64,14 +82,17 @@ module ShellDataReportingApIs
64
82
  []
65
83
  end
66
84
 
67
- def initialize(audits = SKIP, current_page = SKIP, row_count = SKIP,
68
- total_pages = SKIP, error = SKIP, request_id = SKIP)
69
- @audits = audits unless audits == SKIP
70
- @current_page = current_page unless current_page == SKIP
71
- @row_count = row_count unless row_count == SKIP
72
- @total_pages = total_pages unless total_pages == SKIP
73
- @error = error unless error == SKIP
85
+ def initialize(request_id = SKIP, status = SKIP, data = SKIP, page = SKIP,
86
+ total_records = SKIP, total_pages = SKIP, page_size = SKIP,
87
+ warnings = SKIP)
74
88
  @request_id = request_id unless request_id == SKIP
89
+ @status = status unless status == SKIP
90
+ @data = data unless data == SKIP
91
+ @page = page unless page == SKIP
92
+ @total_records = total_records unless total_records == SKIP
93
+ @total_pages = total_pages unless total_pages == SKIP
94
+ @page_size = page_size unless page_size == SKIP
95
+ @warnings = warnings unless warnings == SKIP
75
96
  end
76
97
 
77
98
  # Creates an instance of the object from a hash.
@@ -79,45 +100,59 @@ module ShellDataReportingApIs
79
100
  return nil unless hash
80
101
 
81
102
  # Extract variables from the hash.
103
+ request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
104
+ status = hash.key?('Status') ? hash['Status'] : SKIP
82
105
  # Parameter is an array, so we need to iterate through it
83
- audits = nil
84
- unless hash['Audits'].nil?
85
- audits = []
86
- hash['Audits'].each do |structure|
87
- audits << (AuditResponseAuditsItems.from_hash(structure) if structure)
106
+ data = nil
107
+ unless hash['Data'].nil?
108
+ data = []
109
+ hash['Data'].each do |structure|
110
+ data << (AuditArrayElements.from_hash(structure) if structure)
88
111
  end
89
112
  end
90
113
 
91
- audits = SKIP unless hash.key?('Audits')
92
- current_page = hash.key?('CurrentPage') ? hash['CurrentPage'] : SKIP
93
- row_count = hash.key?('RowCount') ? hash['RowCount'] : SKIP
114
+ data = SKIP unless hash.key?('Data')
115
+ page = hash.key?('Page') ? hash['Page'] : SKIP
116
+ total_records = hash.key?('TotalRecords') ? hash['TotalRecords'] : SKIP
94
117
  total_pages = hash.key?('TotalPages') ? hash['TotalPages'] : SKIP
95
- error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
96
- request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
118
+ page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
119
+ # Parameter is an array, so we need to iterate through it
120
+ warnings = nil
121
+ unless hash['Warnings'].nil?
122
+ warnings = []
123
+ hash['Warnings'].each do |structure|
124
+ warnings << (Warning.from_hash(structure) if structure)
125
+ end
126
+ end
127
+
128
+ warnings = SKIP unless hash.key?('Warnings')
97
129
 
98
130
  # Create object from extracted values.
99
- AuditResponse.new(audits,
100
- current_page,
101
- row_count,
131
+ AuditResponse.new(request_id,
132
+ status,
133
+ data,
134
+ page,
135
+ total_records,
102
136
  total_pages,
103
- error,
104
- request_id)
137
+ page_size,
138
+ warnings)
105
139
  end
106
140
 
107
141
  # Provides a human-readable string representation of the object.
108
142
  def to_s
109
143
  class_name = self.class.name.split('::').last
110
- "<#{class_name} audits: #{@audits}, current_page: #{@current_page}, row_count:"\
111
- " #{@row_count}, total_pages: #{@total_pages}, error: #{@error}, request_id:"\
112
- " #{@request_id}>"
144
+ "<#{class_name} request_id: #{@request_id}, status: #{@status}, data: #{@data}, page:"\
145
+ " #{@page}, total_records: #{@total_records}, total_pages: #{@total_pages}, page_size:"\
146
+ " #{@page_size}, warnings: #{@warnings}>"
113
147
  end
114
148
 
115
149
  # Provides a debugging-friendly string with detailed object information.
116
150
  def inspect
117
151
  class_name = self.class.name.split('::').last
118
- "<#{class_name} audits: #{@audits.inspect}, current_page: #{@current_page.inspect},"\
119
- " row_count: #{@row_count.inspect}, total_pages: #{@total_pages.inspect}, error:"\
120
- " #{@error.inspect}, request_id: #{@request_id.inspect}>"
152
+ "<#{class_name} request_id: #{@request_id.inspect}, status: #{@status.inspect}, data:"\
153
+ " #{@data.inspect}, page: #{@page.inspect}, total_records: #{@total_records.inspect},"\
154
+ " total_pages: #{@total_pages.inspect}, page_size: #{@page_size.inspect}, warnings:"\
155
+ " #{@warnings.inspect}>"
121
156
  end
122
157
  end
123
158
  end
@@ -1,7 +1,7 @@
1
1
  # shell_data_reporting_ap_is
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module ShellDataReportingApIs
7
7
  # AuditResponseAuditsItems Model.
@@ -187,6 +187,16 @@ module ShellDataReportingApIs
187
187
  # @return [String]
188
188
  attr_accessor :user_display_name
189
189
 
190
+ # PAN ID of the card.
191
+ # This will be null when the PAN is not available in the request.
192
+ # @return [String]
193
+ attr_accessor :panid
194
+
195
+ # Masked PAN of the card.
196
+ # This will be null when the Masked PAN is not available in the request.
197
+ # @return [String]
198
+ attr_accessor :masked_pan
199
+
190
200
  # A mapping from model property names to API property names.
191
201
  def self.names
192
202
  @_hash = {} if @_hash.nil?
@@ -221,6 +231,8 @@ module ShellDataReportingApIs
221
231
  @_hash['submitted_on'] = 'SubmittedOn'
222
232
  @_hash['sub_request_reference'] = 'SubRequestReference'
223
233
  @_hash['user_display_name'] = 'UserDisplayName'
234
+ @_hash['panid'] = 'PANID'
235
+ @_hash['masked_pan'] = 'MaskedPAN'
224
236
  @_hash
225
237
  end
226
238
 
@@ -258,6 +270,8 @@ module ShellDataReportingApIs
258
270
  submitted_on
259
271
  sub_request_reference
260
272
  user_display_name
273
+ panid
274
+ masked_pan
261
275
  ]
262
276
  end
263
277
 
@@ -294,6 +308,8 @@ module ShellDataReportingApIs
294
308
  submitted_on
295
309
  sub_request_reference
296
310
  user_display_name
311
+ panid
312
+ masked_pan
297
313
  ]
298
314
  end
299
315
 
@@ -314,7 +330,7 @@ module ShellDataReportingApIs
314
330
  requested_by = SKIP, requested_operation = SKIP,
315
331
  request_reference = SKIP, request_type = SKIP, status = SKIP,
316
332
  submitted_on = SKIP, sub_request_reference = SKIP,
317
- user_display_name = SKIP)
333
+ user_display_name = SKIP, panid = SKIP, masked_pan = SKIP)
318
334
  @account_id = account_id unless account_id == SKIP
319
335
  @account_number = account_number unless account_number == SKIP
320
336
  @additional_information1 = additional_information1 unless additional_information1 == SKIP
@@ -346,6 +362,8 @@ module ShellDataReportingApIs
346
362
  @submitted_on = submitted_on unless submitted_on == SKIP
347
363
  @sub_request_reference = sub_request_reference unless sub_request_reference == SKIP
348
364
  @user_display_name = user_display_name unless user_display_name == SKIP
365
+ @panid = panid unless panid == SKIP
366
+ @masked_pan = masked_pan unless masked_pan == SKIP
349
367
  end
350
368
 
351
369
  # Creates an instance of the object from a hash.
@@ -399,6 +417,8 @@ module ShellDataReportingApIs
399
417
  hash.key?('SubRequestReference') ? hash['SubRequestReference'] : SKIP
400
418
  user_display_name =
401
419
  hash.key?('UserDisplayName') ? hash['UserDisplayName'] : SKIP
420
+ panid = hash.key?('PANID') ? hash['PANID'] : SKIP
421
+ masked_pan = hash.key?('MaskedPAN') ? hash['MaskedPAN'] : SKIP
402
422
 
403
423
  # Create object from extracted values.
404
424
  AuditResponseAuditsItems.new(account_id,
@@ -431,7 +451,9 @@ module ShellDataReportingApIs
431
451
  status,
432
452
  submitted_on,
433
453
  sub_request_reference,
434
- user_display_name)
454
+ user_display_name,
455
+ panid,
456
+ masked_pan)
435
457
  end
436
458
 
437
459
  # Provides a human-readable string representation of the object.
@@ -452,7 +474,7 @@ module ShellDataReportingApIs
452
474
  " #{@requested_operation}, request_reference: #{@request_reference}, request_type:"\
453
475
  " #{@request_type}, status: #{@status}, submitted_on: #{@submitted_on},"\
454
476
  " sub_request_reference: #{@sub_request_reference}, user_display_name:"\
455
- " #{@user_display_name}>"
477
+ " #{@user_display_name}, panid: #{@panid}, masked_pan: #{@masked_pan}>"
456
478
  end
457
479
 
458
480
  # Provides a debugging-friendly string with detailed object information.
@@ -477,7 +499,8 @@ module ShellDataReportingApIs
477
499
  " #{@requested_operation.inspect}, request_reference: #{@request_reference.inspect},"\
478
500
  " request_type: #{@request_type.inspect}, status: #{@status.inspect}, submitted_on:"\
479
501
  " #{@submitted_on.inspect}, sub_request_reference: #{@sub_request_reference.inspect},"\
480
- " user_display_name: #{@user_display_name.inspect}>"
502
+ " user_display_name: #{@user_display_name.inspect}, panid: #{@panid.inspect}, masked_pan:"\
503
+ " #{@masked_pan.inspect}>"
481
504
  end
482
505
  end
483
506
  end
@@ -1,7 +1,7 @@
1
1
  # shell_data_reporting_ap_is
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module ShellDataReportingApIs
7
7
  # BankAccount Model.
@@ -1,7 +1,7 @@
1
1
  # shell_data_reporting_ap_is
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module ShellDataReportingApIs
7
7
  # Base model.
@@ -1,7 +1,7 @@
1
1
  # shell_data_reporting_ap_is
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module ShellDataReportingApIs
7
7
  # BonusConfiguration Model.
@@ -1,7 +1,7 @@
1
1
  # shell_data_reporting_ap_is
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module ShellDataReportingApIs
7
7
  # BonusHistory Model.
@@ -1,7 +1,7 @@
1
1
  # shell_data_reporting_ap_is
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module ShellDataReportingApIs
7
7
  # CardDayTimeRestrictions Model.
@@ -1,7 +1,7 @@
1
1
  # shell_data_reporting_ap_is
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module ShellDataReportingApIs
7
7
  # CardExceptions Model.