card-management-sdk 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (198) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +28 -0
  3. data/README.md +88 -0
  4. data/lib/shell_card_management_ap_is/api_helper.rb +10 -0
  5. data/lib/shell_card_management_ap_is/client.rb +85 -0
  6. data/lib/shell_card_management_ap_is/configuration.rb +117 -0
  7. data/lib/shell_card_management_ap_is/controllers/base_controller.rb +66 -0
  8. data/lib/shell_card_management_ap_is/controllers/card_controller.rb +1047 -0
  9. data/lib/shell_card_management_ap_is/controllers/customer_controller.rb +538 -0
  10. data/lib/shell_card_management_ap_is/controllers/o_auth_authorization_controller.rb +42 -0
  11. data/lib/shell_card_management_ap_is/controllers/restriction_controller.rb +496 -0
  12. data/lib/shell_card_management_ap_is/exceptions/api_exception.rb +10 -0
  13. data/lib/shell_card_management_ap_is/exceptions/default_error_exception.rb +32 -0
  14. data/lib/shell_card_management_ap_is/exceptions/error_object_exception.rb +54 -0
  15. data/lib/shell_card_management_ap_is/exceptions/error_user_access_error1_exception.rb +32 -0
  16. data/lib/shell_card_management_ap_is/exceptions/o_auth_provider_exception.rb +48 -0
  17. data/lib/shell_card_management_ap_is/http/auth/basic_auth.rb +50 -0
  18. data/lib/shell_card_management_ap_is/http/auth/bearer_token.rb +89 -0
  19. data/lib/shell_card_management_ap_is/http/http_call_back.rb +10 -0
  20. data/lib/shell_card_management_ap_is/http/http_method_enum.rb +10 -0
  21. data/lib/shell_card_management_ap_is/http/http_request.rb +10 -0
  22. data/lib/shell_card_management_ap_is/http/http_response.rb +10 -0
  23. data/lib/shell_card_management_ap_is/models/account_access.rb +128 -0
  24. data/lib/shell_card_management_ap_is/models/account_request.rb +252 -0
  25. data/lib/shell_card_management_ap_is/models/account_response.rb +111 -0
  26. data/lib/shell_card_management_ap_is/models/account_response_accounts_items.rb +750 -0
  27. data/lib/shell_card_management_ap_is/models/account_restriction_request.rb +131 -0
  28. data/lib/shell_card_management_ap_is/models/account_restriction_response.rb +60 -0
  29. data/lib/shell_card_management_ap_is/models/account_velocity_limit.rb +145 -0
  30. data/lib/shell_card_management_ap_is/models/accounts.rb +65 -0
  31. data/lib/shell_card_management_ap_is/models/address.rb +174 -0
  32. data/lib/shell_card_management_ap_is/models/audit_request.rb +256 -0
  33. data/lib/shell_card_management_ap_is/models/audit_response.rb +111 -0
  34. data/lib/shell_card_management_ap_is/models/audit_response_audits_items.rb +450 -0
  35. data/lib/shell_card_management_ap_is/models/auto_renew_card_request.rb +111 -0
  36. data/lib/shell_card_management_ap_is/models/auto_renew_card_request_auto_renew_cards_items.rb +98 -0
  37. data/lib/shell_card_management_ap_is/models/auto_renew_card_response.rb +92 -0
  38. data/lib/shell_card_management_ap_is/models/auto_renew_card_response_data_items.rb +64 -0
  39. data/lib/shell_card_management_ap_is/models/bank_account.rb +192 -0
  40. data/lib/shell_card_management_ap_is/models/base_model.rb +62 -0
  41. data/lib/shell_card_management_ap_is/models/bundle_restriction.rb +166 -0
  42. data/lib/shell_card_management_ap_is/models/cancel_card_request.rb +107 -0
  43. data/lib/shell_card_management_ap_is/models/cancel_card_response.rb +127 -0
  44. data/lib/shell_card_management_ap_is/models/card.rb +696 -0
  45. data/lib/shell_card_management_ap_is/models/card_block_schedule.rb +65 -0
  46. data/lib/shell_card_management_ap_is/models/card_day_time_restrictions.rb +159 -0
  47. data/lib/shell_card_management_ap_is/models/card_delivery_contact.rb +230 -0
  48. data/lib/shell_card_management_ap_is/models/card_detail.rb +661 -0
  49. data/lib/shell_card_management_ap_is/models/card_detail_auto_renew_enum.rb +28 -0
  50. data/lib/shell_card_management_ap_is/models/card_details_request.rb +260 -0
  51. data/lib/shell_card_management_ap_is/models/card_details_response.rb +1058 -0
  52. data/lib/shell_card_management_ap_is/models/card_details_response_card_block_schedules_items_all_of0.rb +60 -0
  53. data/lib/shell_card_management_ap_is/models/card_details_response_card_delivery_address.rb +227 -0
  54. data/lib/shell_card_management_ap_is/models/card_details_response_fuel_sets_items.rb +58 -0
  55. data/lib/shell_card_management_ap_is/models/card_details_response_international_pos_language_code_enum.rb +118 -0
  56. data/lib/shell_card_management_ap_is/models/card_details_response_international_pos_language_id_enum.rb +118 -0
  57. data/lib/shell_card_management_ap_is/models/card_details_response_local_pos_language_code_enum.rb +118 -0
  58. data/lib/shell_card_management_ap_is/models/card_details_response_local_pos_language_id_enum.rb +118 -0
  59. data/lib/shell_card_management_ap_is/models/card_details_response_non_fuel_sets_items.rb +58 -0
  60. data/lib/shell_card_management_ap_is/models/card_details_response_pin_delivery_address.rb +231 -0
  61. data/lib/shell_card_management_ap_is/models/card_details_response_pin_type_enum.rb +23 -0
  62. data/lib/shell_card_management_ap_is/models/card_details_response_reissue_setting_enum.rb +26 -0
  63. data/lib/shell_card_management_ap_is/models/card_details_response_renewed_card_reissue_setting_enum.rb +25 -0
  64. data/lib/shell_card_management_ap_is/models/card_details_response_status_id_enum.rb +83 -0
  65. data/lib/shell_card_management_ap_is/models/card_group_request.rb +178 -0
  66. data/lib/shell_card_management_ap_is/models/card_group_response.rb +109 -0
  67. data/lib/shell_card_management_ap_is/models/card_group_response_card_groups_items.rb +301 -0
  68. data/lib/shell_card_management_ap_is/models/card_move_request.rb +163 -0
  69. data/lib/shell_card_management_ap_is/models/card_move_request_cards_items.rb +80 -0
  70. data/lib/shell_card_management_ap_is/models/card_move_response.rb +112 -0
  71. data/lib/shell_card_management_ap_is/models/card_move_response_error_cards_items.rb +112 -0
  72. data/lib/shell_card_management_ap_is/models/card_move_response_successful_requests_items.rb +97 -0
  73. data/lib/shell_card_management_ap_is/models/card_search_response.rb +126 -0
  74. data/lib/shell_card_management_ap_is/models/card_summary_request.rb +52 -0
  75. data/lib/shell_card_management_ap_is/models/card_summary_response.rb +82 -0
  76. data/lib/shell_card_management_ap_is/models/card_type_request.rb +145 -0
  77. data/lib/shell_card_management_ap_is/models/card_type_response.rb +79 -0
  78. data/lib/shell_card_management_ap_is/models/card_type_response_customer_card_types_items.rb +470 -0
  79. data/lib/shell_card_management_ap_is/models/card_type_response_error.rb +60 -0
  80. data/lib/shell_card_management_ap_is/models/card_usage_restrictions.rb +281 -0
  81. data/lib/shell_card_management_ap_is/models/col_co_access.rb +88 -0
  82. data/lib/shell_card_management_ap_is/models/create_bundle_request.rb +167 -0
  83. data/lib/shell_card_management_ap_is/models/create_bundle_request_restrictions.rb +147 -0
  84. data/lib/shell_card_management_ap_is/models/create_bundle_response.rb +98 -0
  85. data/lib/shell_card_management_ap_is/models/create_bundle_response_data_items.rb +125 -0
  86. data/lib/shell_card_management_ap_is/models/create_bundle_response_data_items_cards_items.rb +50 -0
  87. data/lib/shell_card_management_ap_is/models/create_card_group_request.rb +161 -0
  88. data/lib/shell_card_management_ap_is/models/create_card_group_request_cards_items.rb +84 -0
  89. data/lib/shell_card_management_ap_is/models/create_card_group_response.rb +130 -0
  90. data/lib/shell_card_management_ap_is/models/create_card_group_response_error_cards_items.rb +81 -0
  91. data/lib/shell_card_management_ap_is/models/create_card_group_response_successful_requests_items.rb +71 -0
  92. data/lib/shell_card_management_ap_is/models/create_card_response.rb +65 -0
  93. data/lib/shell_card_management_ap_is/models/customer_contract.rb +63 -0
  94. data/lib/shell_card_management_ap_is/models/customer_detail_request.rb +123 -0
  95. data/lib/shell_card_management_ap_is/models/customer_detail_response.rb +437 -0
  96. data/lib/shell_card_management_ap_is/models/day_time_restrictions.rb +162 -0
  97. data/lib/shell_card_management_ap_is/models/default_error_fault.rb +60 -0
  98. data/lib/shell_card_management_ap_is/models/default_error_fault_detail.rb +50 -0
  99. data/lib/shell_card_management_ap_is/models/delete_bundle_request.rb +126 -0
  100. data/lib/shell_card_management_ap_is/models/delete_bundle_response.rb +60 -0
  101. data/lib/shell_card_management_ap_is/models/delivery_address_update.rb +112 -0
  102. data/lib/shell_card_management_ap_is/models/delivery_address_update_references.rb +102 -0
  103. data/lib/shell_card_management_ap_is/models/delivery_address_update_request.rb +129 -0
  104. data/lib/shell_card_management_ap_is/models/delivery_address_update_response.rb +94 -0
  105. data/lib/shell_card_management_ap_is/models/delivery_addresses.rb +258 -0
  106. data/lib/shell_card_management_ap_is/models/eid_access.rb +75 -0
  107. data/lib/shell_card_management_ap_is/models/error_details.rb +81 -0
  108. data/lib/shell_card_management_ap_is/models/error_status.rb +60 -0
  109. data/lib/shell_card_management_ap_is/models/error_user_access.rb +50 -0
  110. data/lib/shell_card_management_ap_is/models/error_user_access_error.rb +60 -0
  111. data/lib/shell_card_management_ap_is/models/finance_currency.rb +98 -0
  112. data/lib/shell_card_management_ap_is/models/generate_pin_key_response.rb +60 -0
  113. data/lib/shell_card_management_ap_is/models/invoice_distribution_method.rb +99 -0
  114. data/lib/shell_card_management_ap_is/models/location_restrictions.rb +125 -0
  115. data/lib/shell_card_management_ap_is/models/location_restrictions_country_restrictions.rb +65 -0
  116. data/lib/shell_card_management_ap_is/models/location_restrictions_network_restrictions_items.rb +77 -0
  117. data/lib/shell_card_management_ap_is/models/location_restrictions_partner_site_restrictions_items.rb +95 -0
  118. data/lib/shell_card_management_ap_is/models/location_restrictions_shell_site_restrictions_items.rb +95 -0
  119. data/lib/shell_card_management_ap_is/models/logged_in_user_request.rb +107 -0
  120. data/lib/shell_card_management_ap_is/models/logged_in_user_response.rb +394 -0
  121. data/lib/shell_card_management_ap_is/models/o_auth_provider_error_enum.rb +45 -0
  122. data/lib/shell_card_management_ap_is/models/o_auth_token.rb +100 -0
  123. data/lib/shell_card_management_ap_is/models/order_card_enquiry.rb +502 -0
  124. data/lib/shell_card_management_ap_is/models/order_card_enquiry_req.rb +208 -0
  125. data/lib/shell_card_management_ap_is/models/order_card_enquiry_req_reference_type_enum.rb +32 -0
  126. data/lib/shell_card_management_ap_is/models/order_card_enquiry_request.rb +51 -0
  127. data/lib/shell_card_management_ap_is/models/order_card_enquiry_response.rb +79 -0
  128. data/lib/shell_card_management_ap_is/models/order_card_request.rb +60 -0
  129. data/lib/shell_card_management_ap_is/models/order_card_response.rb +90 -0
  130. data/lib/shell_card_management_ap_is/models/payer_access.rb +147 -0
  131. data/lib/shell_card_management_ap_is/models/payer_details.rb +1412 -0
  132. data/lib/shell_card_management_ap_is/models/payer_request.rb +126 -0
  133. data/lib/shell_card_management_ap_is/models/payer_response.rb +115 -0
  134. data/lib/shell_card_management_ap_is/models/payers.rb +109 -0
  135. data/lib/shell_card_management_ap_is/models/pin_advice_types.rb +80 -0
  136. data/lib/shell_card_management_ap_is/models/pin_delivery_contact.rb +242 -0
  137. data/lib/shell_card_management_ap_is/models/pin_delivery_details.rb +169 -0
  138. data/lib/shell_card_management_ap_is/models/pin_reminder_card_details.rb +137 -0
  139. data/lib/shell_card_management_ap_is/models/pin_reminder_reference.rb +99 -0
  140. data/lib/shell_card_management_ap_is/models/pin_reminder_request.rb +135 -0
  141. data/lib/shell_card_management_ap_is/models/pin_reminder_response.rb +90 -0
  142. data/lib/shell_card_management_ap_is/models/product_all_of0.rb +62 -0
  143. data/lib/shell_card_management_ap_is/models/product_group.rb +116 -0
  144. data/lib/shell_card_management_ap_is/models/product_restrictions.rb +66 -0
  145. data/lib/shell_card_management_ap_is/models/purchase_categories.rb +114 -0
  146. data/lib/shell_card_management_ap_is/models/purchase_category1_all_of0.rb +140 -0
  147. data/lib/shell_card_management_ap_is/models/purchase_category_request.rb +114 -0
  148. data/lib/shell_card_management_ap_is/models/purchase_category_response.rb +69 -0
  149. data/lib/shell_card_management_ap_is/models/replace_card_settings.rb +641 -0
  150. data/lib/shell_card_management_ap_is/models/restriction_card_request.rb +115 -0
  151. data/lib/shell_card_management_ap_is/models/restriction_card_request_cards_items.rb +220 -0
  152. data/lib/shell_card_management_ap_is/models/restriction_card_response.rb +91 -0
  153. data/lib/shell_card_management_ap_is/models/restriction_card_response_data_items.rb +240 -0
  154. data/lib/shell_card_management_ap_is/models/restriction_search_card_request.rb +50 -0
  155. data/lib/shell_card_management_ap_is/models/restriction_search_card_request_filters.rb +177 -0
  156. data/lib/shell_card_management_ap_is/models/restriction_search_card_request_filters_cards_items.rb +63 -0
  157. data/lib/shell_card_management_ap_is/models/restriction_search_card_response.rb +79 -0
  158. data/lib/shell_card_management_ap_is/models/restriction_search_card_response_data_items.rb +514 -0
  159. data/lib/shell_card_management_ap_is/models/role.rb +102 -0
  160. data/lib/shell_card_management_ap_is/models/schedule_card_block_cards_items.rb +249 -0
  161. data/lib/shell_card_management_ap_is/models/schedule_card_block_request.rb +77 -0
  162. data/lib/shell_card_management_ap_is/models/schedule_card_block_response.rb +91 -0
  163. data/lib/shell_card_management_ap_is/models/schedule_card_block_response_data_items.rb +89 -0
  164. data/lib/shell_card_management_ap_is/models/search_account_limit_request.rb +50 -0
  165. data/lib/shell_card_management_ap_is/models/search_account_limit_request_filters.rb +118 -0
  166. data/lib/shell_card_management_ap_is/models/search_account_limit_response.rb +70 -0
  167. data/lib/shell_card_management_ap_is/models/search_account_limit_response_data.rb +106 -0
  168. data/lib/shell_card_management_ap_is/models/search_card.rb +66 -0
  169. data/lib/shell_card_management_ap_is/models/search_card_request.rb +72 -0
  170. data/lib/shell_card_management_ap_is/models/search_card_response_restrictions.rb +99 -0
  171. data/lib/shell_card_management_ap_is/models/search_product_restriction.rb +78 -0
  172. data/lib/shell_card_management_ap_is/models/search_request.rb +724 -0
  173. data/lib/shell_card_management_ap_is/models/submitted_card.rb +183 -0
  174. data/lib/shell_card_management_ap_is/models/summary_of_bundle_request.rb +50 -0
  175. data/lib/shell_card_management_ap_is/models/summary_of_bundle_response.rb +79 -0
  176. data/lib/shell_card_management_ap_is/models/summary_of_bundle_response_data_items.rb +123 -0
  177. data/lib/shell_card_management_ap_is/models/summary_of_bundle_response_data_items_card_bundles_items.rb +86 -0
  178. data/lib/shell_card_management_ap_is/models/summary_request.rb +598 -0
  179. data/lib/shell_card_management_ap_is/models/summary_response.rb +184 -0
  180. data/lib/shell_card_management_ap_is/models/summaryof_bundle.rb +126 -0
  181. data/lib/shell_card_management_ap_is/models/update_bundle_request.rb +194 -0
  182. data/lib/shell_card_management_ap_is/models/update_bundle_response.rb +70 -0
  183. data/lib/shell_card_management_ap_is/models/update_card.rb +316 -0
  184. data/lib/shell_card_management_ap_is/models/update_card_group_request.rb +258 -0
  185. data/lib/shell_card_management_ap_is/models/update_card_group_response.rb +130 -0
  186. data/lib/shell_card_management_ap_is/models/update_card_group_response_move_card_references_items.rb +77 -0
  187. data/lib/shell_card_management_ap_is/models/update_card_renewal_address.rb +163 -0
  188. data/lib/shell_card_management_ap_is/models/update_card_status_request.rb +124 -0
  189. data/lib/shell_card_management_ap_is/models/update_card_status_response.rb +133 -0
  190. data/lib/shell_card_management_ap_is/models/update_m_pay_reg_status_request.rb +112 -0
  191. data/lib/shell_card_management_ap_is/models/update_m_pay_reg_status_request_m_pay_requests_items.rb +105 -0
  192. data/lib/shell_card_management_ap_is/models/update_m_pay_reg_status_response.rb +60 -0
  193. data/lib/shell_card_management_ap_is/models/url_enum.rb +23 -0
  194. data/lib/shell_card_management_ap_is/models/usage_restrictions.rb +311 -0
  195. data/lib/shell_card_management_ap_is/utilities/date_time_helper.rb +11 -0
  196. data/lib/shell_card_management_ap_is/utilities/file_wrapper.rb +16 -0
  197. data/lib/shell_card_management_ap_is.rb +288 -0
  198. metadata +283 -0
@@ -0,0 +1,538 @@
1
+ # shell_card_management_ap_is
2
+ #
3
+ # This file was automatically generated by APIMATIC v2.0
4
+ # ( https://apimatic.io ).
5
+
6
+ module ShellCardManagementApIs
7
+ # CustomerController
8
+ class CustomerController < BaseController
9
+ # This API allows querying the user data of the logged in user.</br>
10
+ # This API will return the user access details such as payers and/or
11
+ # accounts. </br>
12
+ # This API will also validate that logged in user has access to the
13
+ # requested API, on failure it will return HasAPIAccess flag as false in
14
+ # response.</br>
15
+ # @param [String] apikey Required parameter: This is the API key of the
16
+ # specific environment which needs to be passed by the client.
17
+ # @param [String] request_id Required parameter: Mandatory UUID (according
18
+ # to RFC 4122 standards) for requests and responses. This will be played
19
+ # back in the response from the request.
20
+ # @param [LoggedInUserRequest] body Optional parameter: Logged in user
21
+ # request body
22
+ # @return [LoggedInUserResponse] response from the API call
23
+ def loggedin_user(apikey,
24
+ request_id,
25
+ body: nil)
26
+ new_api_call_builder
27
+ .request(new_request_builder(HttpMethodEnum::POST,
28
+ '/fleetmanagement/v1/user/loggedinuser',
29
+ Server::DEFAULT)
30
+ .header_param(new_parameter(apikey, key: 'apikey'))
31
+ .header_param(new_parameter(request_id, key: 'RequestId'))
32
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
33
+ .body_param(new_parameter(body))
34
+ .header_param(new_parameter('application/json', key: 'accept'))
35
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
36
+ .auth(Single.new('BasicAuth')))
37
+ .response(new_response_handler
38
+ .deserializer(APIHelper.method(:custom_type_deserializer))
39
+ .deserialize_into(LoggedInUserResponse.method(:from_hash))
40
+ .local_error('400',
41
+ "The server cannot or will not process the request due to'\
42
+ ' something that is perceived to be a client\r\n error (e.g.,'\
43
+ ' malformed request syntax, invalid \r\n request message framing,'\
44
+ ' or deceptive request routing).",
45
+ DefaultErrorException)
46
+ .local_error('401',
47
+ "The request has not been applied because it lacks valid '\
48
+ ' authentication credentials for the target resource.\r\n",
49
+ DefaultErrorException)
50
+ .local_error('403',
51
+ "The server understood the request but refuses to authorize it.'\
52
+ '\r\n",
53
+ ErrorUserAccessError1Exception)
54
+ .local_error('404',
55
+ "The origin server did not find a current representation for'\
56
+ ' the target resource or is not willing to disclose that one'\
57
+ ' exists.\r\n",
58
+ DefaultErrorException)
59
+ .local_error('500',
60
+ "The server encountered an unexpected condition the prevented it'\
61
+ ' from fulfilling the request.\r\n",
62
+ DefaultErrorException))
63
+ .execute
64
+ end
65
+
66
+ # This API allows querying the payer accounts details from the Shell Cards
67
+ # Platform. It provides flexible search criteria for searching payer
68
+ # information and supports paging.
69
+ # Paging is applicable only when all the
70
+ # payers passed in the input are from the same ColCo.
71
+ # However, paging will
72
+ # be ignored and the API will return all the matching data by merging the
73
+ # data queried from each ColCo when payers passed in the input are from
74
+ # multiple ColCos.
75
+ # @param [String] apikey Required parameter: This is the API key of the
76
+ # specific environment which needs to be passed by the client.
77
+ # @param [String] request_id Required parameter: Mandatory UUID (according
78
+ # to RFC 4122 standards) for requests and responses. This will be played
79
+ # back in the response from the request.
80
+ # @param [PayerRequest] body Optional parameter: Serach payers request
81
+ # body
82
+ # @return [PayerResponse] response from the API call
83
+ def payers(apikey,
84
+ request_id,
85
+ body: nil)
86
+ new_api_call_builder
87
+ .request(new_request_builder(HttpMethodEnum::POST,
88
+ '/fleetmanagement/v1/customer/payers',
89
+ Server::DEFAULT)
90
+ .header_param(new_parameter(apikey, key: 'apikey'))
91
+ .header_param(new_parameter(request_id, key: 'RequestId'))
92
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
93
+ .body_param(new_parameter(body))
94
+ .header_param(new_parameter('application/json', key: 'accept'))
95
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
96
+ .auth(Single.new('BasicAuth')))
97
+ .response(new_response_handler
98
+ .deserializer(APIHelper.method(:custom_type_deserializer))
99
+ .deserialize_into(PayerResponse.method(:from_hash))
100
+ .local_error('400',
101
+ "The server cannot or will not process the request due to'\
102
+ ' something that is perceived to be a client\r\n error (e.g.,'\
103
+ ' malformed request syntax, invalid \r\n request message framing,'\
104
+ ' or deceptive request routing).",
105
+ DefaultErrorException)
106
+ .local_error('401',
107
+ "The request has not been applied because it lacks valid '\
108
+ ' authentication credentials for the target resource.\r\n",
109
+ DefaultErrorException)
110
+ .local_error('403',
111
+ "The server understood the request but refuses to authorize it.'\
112
+ '\r\n",
113
+ ErrorUserAccessError1Exception)
114
+ .local_error('404',
115
+ "The origin server did not find a current representation for'\
116
+ ' the target resource or is not willing to disclose that one'\
117
+ ' exists.\r\n",
118
+ DefaultErrorException)
119
+ .local_error('500',
120
+ "The server encountered an unexpected condition the prevented it'\
121
+ ' from fulfilling the request.\r\n",
122
+ DefaultErrorException))
123
+ .execute
124
+ end
125
+
126
+ # This API allows querying the card delivery addresses of a given account
127
+ # from the Shell Cards Platform.
128
+ # Only active delivery addresses will be returned.
129
+ # @param [String] apikey Required parameter: This is the API key of the
130
+ # specific environment which needs to be passed by the client.
131
+ # @param [String] request_id Required parameter: Mandatory UUID (according
132
+ # to RFC 4122 standards) for requests and responses. This will be played
133
+ # back in the response from the request.
134
+ # @param [CustomerDetailRequest] body Optional parameter: Customerdetails
135
+ # request body
136
+ # @return [CustomerDetailResponse] response from the API call
137
+ def customer(apikey,
138
+ request_id,
139
+ body: nil)
140
+ new_api_call_builder
141
+ .request(new_request_builder(HttpMethodEnum::POST,
142
+ '/fleetmanagement/v1/customer/customer',
143
+ Server::DEFAULT)
144
+ .header_param(new_parameter(apikey, key: 'apikey'))
145
+ .header_param(new_parameter(request_id, key: 'RequestId'))
146
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
147
+ .body_param(new_parameter(body))
148
+ .header_param(new_parameter('application/json', key: 'accept'))
149
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
150
+ .auth(Single.new('BasicAuth')))
151
+ .response(new_response_handler
152
+ .deserializer(APIHelper.method(:custom_type_deserializer))
153
+ .deserialize_into(CustomerDetailResponse.method(:from_hash))
154
+ .local_error('400',
155
+ "The server cannot or will not process the request due to'\
156
+ ' something that is perceived to be a client\r\n error (e.g.,'\
157
+ ' malformed request syntax, invalid \r\n request message framing,'\
158
+ ' or deceptive request routing).",
159
+ DefaultErrorException)
160
+ .local_error('401',
161
+ "The request has not been applied because it lacks valid '\
162
+ ' authentication credentials for the target resource.\r\n",
163
+ DefaultErrorException)
164
+ .local_error('403',
165
+ "The server understood the request but refuses to authorize it.'\
166
+ '\r\n",
167
+ ErrorUserAccessError1Exception)
168
+ .local_error('404',
169
+ "The origin server did not find a current representation for'\
170
+ ' the target resource or is not willing to disclose that one'\
171
+ ' exists.\r\n",
172
+ DefaultErrorException)
173
+ .local_error('500',
174
+ "The server encountered an unexpected condition the prevented it'\
175
+ ' from fulfilling the request.\r\n",
176
+ DefaultErrorException))
177
+ .execute
178
+ end
179
+
180
+ # This API allows querying the customer account details from the Shell Cards
181
+ # Platform.
182
+ # It provides a flexible search criterion and supports paging".
183
+ # @param [String] apikey Required parameter: This is the API key of the
184
+ # specific environment which needs to be passed by the client.
185
+ # @param [String] request_id Required parameter: Mandatory UUID (according
186
+ # to RFC 4122 standards) for requests and responses. This will be played
187
+ # back in the response from the request.
188
+ # @param [AccountRequest] body Optional parameter: Example:
189
+ # @return [AccountResponse] response from the API call
190
+ def accounts(apikey,
191
+ request_id,
192
+ body: nil)
193
+ new_api_call_builder
194
+ .request(new_request_builder(HttpMethodEnum::POST,
195
+ '/fleetmanagement/v1/customer/accounts',
196
+ Server::DEFAULT)
197
+ .header_param(new_parameter(apikey, key: 'apikey'))
198
+ .header_param(new_parameter(request_id, key: 'RequestId'))
199
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
200
+ .body_param(new_parameter(body))
201
+ .header_param(new_parameter('application/json', key: 'accept'))
202
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
203
+ .auth(Single.new('BasicAuth')))
204
+ .response(new_response_handler
205
+ .deserializer(APIHelper.method(:custom_type_deserializer))
206
+ .deserialize_into(AccountResponse.method(:from_hash))
207
+ .local_error('400',
208
+ "The server cannot or will not process the request due to'\
209
+ ' something that is perceived to be a client\r\n error (e.g.,'\
210
+ ' malformed request syntax, invalid \r\n request message framing,'\
211
+ ' or deceptive request routing).",
212
+ DefaultErrorException)
213
+ .local_error('401',
214
+ "The request has not been applied because it lacks valid '\
215
+ ' authentication credentials for the target resource.\r\n",
216
+ DefaultErrorException)
217
+ .local_error('403',
218
+ "The server understood the request but refuses to authorize it.'\
219
+ '\r\n",
220
+ ErrorUserAccessError1Exception)
221
+ .local_error('404',
222
+ "The origin server did not find a current representation for'\
223
+ ' the target resource or is not willing to disclose that one'\
224
+ ' exists.\r\n",
225
+ DefaultErrorException)
226
+ .local_error('500',
227
+ "The server encountered an unexpected condition the prevented it'\
228
+ ' from fulfilling the request.\r\n",
229
+ DefaultErrorException))
230
+ .execute
231
+ end
232
+
233
+ # This operation allows querying card types that are associated to the given
234
+ # account and are allowed to be shown to users.
235
+ # @param [String] apikey Required parameter: This is the API key of the
236
+ # specific environment which needs to be passed by the client.
237
+ # @param [String] request_id Required parameter: Mandatory UUID (according
238
+ # to RFC 4122 standards) for requests and responses. This will be played
239
+ # back in the response from the request.
240
+ # @param [CardTypeRequest] body Optional parameter: Get CardType Request
241
+ # Body
242
+ # @return [CardTypeResponse] response from the API call
243
+ def card_type(apikey,
244
+ request_id,
245
+ body: nil)
246
+ new_api_call_builder
247
+ .request(new_request_builder(HttpMethodEnum::POST,
248
+ '/fleetmanagement/v2/customer/cardtype',
249
+ Server::DEFAULT)
250
+ .header_param(new_parameter(apikey, key: 'apikey'))
251
+ .header_param(new_parameter(request_id, key: 'RequestId'))
252
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
253
+ .body_param(new_parameter(body))
254
+ .header_param(new_parameter('application/json', key: 'accept'))
255
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
256
+ .auth(Single.new('BasicAuth')))
257
+ .response(new_response_handler
258
+ .deserializer(APIHelper.method(:custom_type_deserializer))
259
+ .deserialize_into(CardTypeResponse.method(:from_hash))
260
+ .local_error('400',
261
+ "The server cannot or will not process the request due to'\
262
+ ' something that is perceived to be a client\r\n error (e.g.,'\
263
+ ' malformed request syntax, invalid \r\n request message framing,'\
264
+ ' or deceptive request routing).",
265
+ DefaultErrorException)
266
+ .local_error('401',
267
+ "The request has not been applied because it lacks valid '\
268
+ ' authentication credentials for the target resource.\r\n",
269
+ DefaultErrorException)
270
+ .local_error('403',
271
+ "The server understood the request but refuses to authorize it.'\
272
+ '\r\n",
273
+ ErrorUserAccessError1Exception)
274
+ .local_error('404',
275
+ "The origin server did not find a current representation for'\
276
+ ' the target resource or is not willing to disclose that one'\
277
+ ' exists.\r\n",
278
+ DefaultErrorException)
279
+ .local_error('500',
280
+ "The server encountered an unexpected condition the prevented it'\
281
+ ' from fulfilling the request.\r\n",
282
+ DefaultErrorException))
283
+ .execute
284
+ end
285
+
286
+ # This operation allows querying the card group details . It provides
287
+ # flexible search criteria and supports paging.\
288
+ # When the card group type is configured as ‘Vertical’ in cards platform,
289
+ # this operation will return all card groups from the given account or if no
290
+ # account is passed in the input, then will return card groups from all the
291
+ # accounts under the payer.
292
+ # When the card group type is configured as ‘Horizontal’ in cards platform,
293
+ # this API will return all card groups configured directly under the payer.
294
+ # Accounts with cancelled status will not be considered for cardgroups
295
+ # search for the configured (E.g., SFH) set of client apps.
296
+ # @param [String] apikey Required parameter: This is the API key of the
297
+ # specific environment which needs to be passed by the client.
298
+ # @param [String] request_id Required parameter: Mandatory UUID (according
299
+ # to RFC 4122 standards) for requests and responses. This will be played
300
+ # back in the response from the request.
301
+ # @param [CardGroupRequest] body Optional parameter: Request Body
302
+ # @return [CardGroupResponse] response from the API call
303
+ def card_groups(apikey,
304
+ request_id,
305
+ body: nil)
306
+ new_api_call_builder
307
+ .request(new_request_builder(HttpMethodEnum::POST,
308
+ '/fleetmanagement/v1/customer/cardgroups',
309
+ Server::DEFAULT)
310
+ .header_param(new_parameter(apikey, key: 'apikey'))
311
+ .header_param(new_parameter(request_id, key: 'RequestId'))
312
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
313
+ .body_param(new_parameter(body))
314
+ .header_param(new_parameter('application/json', key: 'accept'))
315
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
316
+ .auth(Single.new('BasicAuth')))
317
+ .response(new_response_handler
318
+ .deserializer(APIHelper.method(:custom_type_deserializer))
319
+ .deserialize_into(CardGroupResponse.method(:from_hash))
320
+ .local_error('400',
321
+ "The server cannot or will not process the request due to'\
322
+ ' something that is perceived to be a client\r\n error (e.g.,'\
323
+ ' malformed request syntax, invalid \r\n request message framing,'\
324
+ ' or deceptive request routing).",
325
+ DefaultErrorException)
326
+ .local_error('401',
327
+ "The request has not been applied because it lacks valid '\
328
+ ' authentication credentials for the target resource.\r\n",
329
+ DefaultErrorException)
330
+ .local_error('403',
331
+ "The server understood the request but refuses to authorize it.'\
332
+ '\r\n",
333
+ ErrorUserAccessError1Exception)
334
+ .local_error('404',
335
+ "The origin server did not find a current representation for'\
336
+ ' the target resource or is not willing to disclose that one'\
337
+ ' exists.\r\n",
338
+ DefaultErrorException)
339
+ .local_error('500',
340
+ "The server encountered an unexpected condition the prevented it'\
341
+ ' from fulfilling the request.\r\n",
342
+ DefaultErrorException))
343
+ .execute
344
+ end
345
+
346
+ # This operation allows users to fetch audit data of account or card
347
+ # operations performed by users of a given customer
348
+ # The audit data includes details of below API operations
349
+ # * Order Card
350
+ # * Create Card Group
351
+ # * PIN reminder
352
+ # * Move Cards
353
+ # * Update Card Status
354
+ # * Update Card Group
355
+ # * Auto renew
356
+ # * Bulk card order
357
+ # * Bulk card block
358
+ # * Bulk Card Order (Multi Account)
359
+ # * BCOSummary
360
+ # * BCOMultiAccountSummary
361
+ # * BCBSummary
362
+ # * Mobile Payment
363
+ # * Registration
364
+ # * Fund Transfer (Scheduled & Realtime)
365
+ # * Delivery Address Update.
366
+ # @param [String] apikey Required parameter: This is the API key of the
367
+ # specific environment which needs to be passed by the client.
368
+ # @param [String] request_id Required parameter: Mandatory UUID (according
369
+ # to RFC 4122 standards) for requests and responses. This will be played
370
+ # back in the response from the request.
371
+ # @param [AuditRequest] body Optional parameter: request body
372
+ # @return [AuditResponse] response from the API call
373
+ def audit_report(apikey,
374
+ request_id,
375
+ body: nil)
376
+ new_api_call_builder
377
+ .request(new_request_builder(HttpMethodEnum::POST,
378
+ '/fleetmanagement/v1/customer/auditreport',
379
+ Server::DEFAULT)
380
+ .header_param(new_parameter(apikey, key: 'apikey'))
381
+ .header_param(new_parameter(request_id, key: 'RequestId'))
382
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
383
+ .body_param(new_parameter(body))
384
+ .header_param(new_parameter('application/json', key: 'accept'))
385
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
386
+ .auth(Single.new('BasicAuth')))
387
+ .response(new_response_handler
388
+ .deserializer(APIHelper.method(:custom_type_deserializer))
389
+ .deserialize_into(AuditResponse.method(:from_hash))
390
+ .local_error('400',
391
+ "The server cannot or will not process the request due to'\
392
+ ' something that is perceived to be a client\r\n error (e.g.,'\
393
+ ' malformed request syntax, invalid \r\n request message framing,'\
394
+ ' or deceptive request routing).",
395
+ DefaultErrorException)
396
+ .local_error('401',
397
+ "The request has not been applied because it lacks valid '\
398
+ ' authentication credentials for the target resource.\r\n",
399
+ DefaultErrorException)
400
+ .local_error('403',
401
+ "The server understood the request but refuses to authorize it.'\
402
+ '\r\n",
403
+ ErrorUserAccessError1Exception)
404
+ .local_error('404',
405
+ "The origin server did not find a current representation for'\
406
+ ' the target resource or is not willing to disclose that one'\
407
+ ' exists.\r\n",
408
+ DefaultErrorException)
409
+ .local_error('500',
410
+ "The server encountered an unexpected condition the prevented it'\
411
+ ' from fulfilling the request.\r\n",
412
+ DefaultErrorException))
413
+ .execute
414
+ end
415
+
416
+ # This API allows creating a new Card Group in the Shell Cards Platform. It
417
+ # will
418
+ # also allow moving of cards (up to 500 cards) into the newly created
419
+ # card-group.
420
+ # ### Move Card requests are queued after passing the below validations
421
+ # * Given PAN matches with only one card.
422
+ # * Card is allowed to be moved to the Target Card Group and/or
423
+ # * Target account requested.
424
+ # * There is no pending Move Card request for the same card in the queue
425
+ # which is submitted on the same date
426
+ # and is yet to be processed or has been processed
427
+ # successfully
428
+ # @param [String] apikey Required parameter: This is the API key of the
429
+ # specific environment which needs to be passed by the client.
430
+ # @param [String] request_id Required parameter: Mandatory UUID (according
431
+ # to RFC 4122 standards) for requests and responses. This will be played
432
+ # back in the response from the request.
433
+ # @param [CreateCardGroupRequest] body Optional parameter: CreateCardGroup
434
+ # request body
435
+ # @return [CreateCardGroupResponse] response from the API call
436
+ def create_card_group(apikey,
437
+ request_id,
438
+ body: nil)
439
+ new_api_call_builder
440
+ .request(new_request_builder(HttpMethodEnum::POST,
441
+ '/fleetmanagement/v1/customer/createcardgroup',
442
+ Server::DEFAULT)
443
+ .header_param(new_parameter(apikey, key: 'apikey'))
444
+ .header_param(new_parameter(request_id, key: 'RequestId'))
445
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
446
+ .body_param(new_parameter(body))
447
+ .header_param(new_parameter('application/json', key: 'accept'))
448
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
449
+ .auth(Single.new('BasicAuth')))
450
+ .response(new_response_handler
451
+ .deserializer(APIHelper.method(:custom_type_deserializer))
452
+ .deserialize_into(CreateCardGroupResponse.method(:from_hash))
453
+ .local_error('400',
454
+ "The server cannot or will not process the request due to'\
455
+ ' something that is perceived to be a client\r\n error (e.g.,'\
456
+ ' malformed request syntax, invalid \r\n request message framing,'\
457
+ ' or deceptive request routing).",
458
+ DefaultErrorException)
459
+ .local_error('401',
460
+ "The request has not been applied because it lacks valid '\
461
+ ' authentication credentials for the target resource.\r\n",
462
+ DefaultErrorException)
463
+ .local_error('403',
464
+ "The server understood the request but refuses to authorize it.'\
465
+ '\r\n",
466
+ ErrorUserAccessError1Exception)
467
+ .local_error('404',
468
+ "The origin server did not find a current representation for'\
469
+ ' the target resource or is not willing to disclose that one'\
470
+ ' exists.\r\n",
471
+ DefaultErrorException)
472
+ .local_error('500',
473
+ "The server encountered an unexpected condition the prevented it'\
474
+ ' from fulfilling the request.\r\n",
475
+ DefaultErrorException))
476
+ .execute
477
+ end
478
+
479
+ # This API allows updating or removing a Card Group in the Shell Cards
480
+ # Platform.
481
+ # It also allows moving of cards out of a card group or from one card group
482
+ # to another existing card group.
483
+ # The request for updating or removing of the card group, creationg of a new
484
+ # card group (where-applicable) and moving of card into another card group
485
+ # will be queued at Microservices after passing the basic
486
+ # validations.
487
+ # @param [String] apikey Required parameter: This is the API key of the
488
+ # specific environment which needs to be passed by the client.
489
+ # @param [String] request_id Required parameter: Mandatory UUID (according
490
+ # to RFC 4122 standards) for requests and responses. This will be played
491
+ # back in the response from the request.
492
+ # @param [UpdateCardGroupRequest] body Optional parameter: request body of
493
+ # customer card group
494
+ # @return [UpdateCardGroupResponse] response from the API call
495
+ def update_card_group(apikey,
496
+ request_id,
497
+ body: nil)
498
+ new_api_call_builder
499
+ .request(new_request_builder(HttpMethodEnum::POST,
500
+ '/fleetmanagement/v1/customer/updatecardgroup',
501
+ Server::DEFAULT)
502
+ .header_param(new_parameter(apikey, key: 'apikey'))
503
+ .header_param(new_parameter(request_id, key: 'RequestId'))
504
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
505
+ .body_param(new_parameter(body))
506
+ .header_param(new_parameter('application/json', key: 'accept'))
507
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
508
+ .auth(Single.new('BasicAuth')))
509
+ .response(new_response_handler
510
+ .deserializer(APIHelper.method(:custom_type_deserializer))
511
+ .deserialize_into(UpdateCardGroupResponse.method(:from_hash))
512
+ .local_error('400',
513
+ "The server cannot or will not process the request due to'\
514
+ ' something that is perceived to be a client\r\n error (e.g.,'\
515
+ ' malformed request syntax, invalid \r\n request message framing,'\
516
+ ' or deceptive request routing).",
517
+ DefaultErrorException)
518
+ .local_error('401',
519
+ "The request has not been applied because it lacks valid '\
520
+ ' authentication credentials for the target resource.\r\n",
521
+ DefaultErrorException)
522
+ .local_error('403',
523
+ "The server understood the request but refuses to authorize it.'\
524
+ '\r\n",
525
+ ErrorUserAccessError1Exception)
526
+ .local_error('404',
527
+ "The origin server did not find a current representation for'\
528
+ ' the target resource or is not willing to disclose that one'\
529
+ ' exists.\r\n",
530
+ DefaultErrorException)
531
+ .local_error('500',
532
+ "The server encountered an unexpected condition the prevented it'\
533
+ ' from fulfilling the request.\r\n",
534
+ DefaultErrorException))
535
+ .execute
536
+ end
537
+ end
538
+ end
@@ -0,0 +1,42 @@
1
+ # shell_card_management_ap_is
2
+ #
3
+ # This file was automatically generated by APIMATIC v2.0
4
+ # ( https://apimatic.io ).
5
+
6
+ module ShellCardManagementApIs
7
+ # OAuthAuthorizationController
8
+ class OAuthAuthorizationController < BaseController
9
+ # Create a new OAuth 2 token.
10
+ # @param [String] authorization Required parameter: Authorization header in
11
+ # Basic auth format
12
+ # @param [String] scope Optional parameter: Requested scopes as a
13
+ # space-delimited list.
14
+ # @param [Hash] _field_parameters Additional optional form parameters are
15
+ # supported by this endpoint.
16
+ # @return [OAuthToken] response from the API call
17
+ def request_token_bearer_token(authorization,
18
+ scope: nil,
19
+ _field_parameters: nil)
20
+ new_api_call_builder
21
+ .request(new_request_builder(HttpMethodEnum::POST,
22
+ '/token',
23
+ Server::ACCESS_TOKEN_SERVER)
24
+ .form_param(new_parameter('client_credentials', key: 'grant_type'))
25
+ .header_param(new_parameter(authorization, key: 'Authorization'))
26
+ .form_param(new_parameter(scope, key: 'scope'))
27
+ .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
28
+ .header_param(new_parameter('application/json', key: 'accept'))
29
+ .additional_form_params(_field_parameters))
30
+ .response(new_response_handler
31
+ .deserializer(APIHelper.method(:custom_type_deserializer))
32
+ .deserialize_into(OAuthToken.method(:from_hash))
33
+ .local_error('400',
34
+ 'OAuth 2 provider returned an error.',
35
+ OAuthProviderException)
36
+ .local_error('401',
37
+ 'OAuth 2 provider says client authentication failed.',
38
+ OAuthProviderException))
39
+ .execute
40
+ end
41
+ end
42
+ end