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,641 @@
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
+ # Request entity object for ReplaceCardSettings
8
+ class ReplaceCardSettings < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # The encrypted value of self-selected PIN.<br />
13
+ # Optional – When not provided, the PIN will be auto generated(if the card
14
+ # token type supports PIN) and delivered based on the given PIN delivery
15
+ # option.<br />
16
+ # Max Length: 256
17
+ # @return [String]
18
+ attr_accessor :self_selected_encrypted_pin
19
+
20
+ # KeyId of the PIN encrypted value.<br />
21
+ # Mandatory, if opted for self-selected PIN else optional.<br />
22
+ # Max Length: 30
23
+ # @return [String]
24
+ attr_accessor :self_selected_pin_key_id
25
+
26
+ # Encoded message of the TCS form which is used for encrypting the PIN of
27
+ # this card.<br />
28
+ # The encode message forms are provided to clients by another API
29
+ # (“TCS”).<br />
30
+ # Instructions to encrypt the PIN is covered in the related API
31
+ # specifications document.<br />
32
+ # Mandatory –If opted for self-selected PIN else optional.
33
+ # Max Length: 1024
34
+ # @return [String]
35
+ attr_accessor :self_selected_pin_session_key
36
+
37
+ # True/False.<br />
38
+ # Optional <br />
39
+ # Default: False<br />
40
+ # For cards ordered with Validate Fleet Id parameter set to true, CFGW will
41
+ # be notified to enable this validation for the card.<br />
42
+ # Note: When “FleetIdInputRequired” is not set on the card, validate fleet
43
+ # id will be considered false regardless of the value passed on this
44
+ # parameter.
45
+ # @return [TrueClass | FalseClass]
46
+ attr_accessor :validate_fleet_id
47
+
48
+ # Existing Card Group ID, under which the replacement card is to be
49
+ # created.<br />
50
+ # Pass “-1” if the replacement card should not be assigned to any card
51
+ # group.<br />
52
+ # Optional <br />
53
+ # If not provided, the replacement card will be created under the same card
54
+ # group as the current card.
55
+ # @return [Integer]
56
+ attr_accessor :card_group_id
57
+
58
+ # Card delivery type.<br />
59
+ # Mandatory <br />
60
+ # Allowed Value: <br />
61
+ # 1. Customer Address(Default) <br />
62
+ # 2. New Delivery Address <br />
63
+ # 3. Old Card Address
64
+ # @return [Integer]
65
+ attr_accessor :card_delivery_type
66
+
67
+ # Title of the contact person. <br />
68
+ # Optional<br />
69
+ # Max field length: 10
70
+ # @return [String]
71
+ attr_accessor :delivery_contact_title
72
+
73
+ # Name of the contact person <br />
74
+ # Mandatory - If CardDeliveryType is 2 and OrderCardReplacement is passed
75
+ # as true.<br />
76
+ # Max field length: 50
77
+ # @return [String]
78
+ attr_accessor :delivery_contact_name
79
+
80
+ # Company name <br />
81
+ # Mandatory - If CardDeliveryType is 2 and OrderCardReplacement is passed
82
+ # as true.
83
+ # Max field length: 50
84
+ # @return [String]
85
+ attr_accessor :delivery_company_name
86
+
87
+ # Address line 1 <br />
88
+ # Mandatory - If CardDeliveryType is 2 and OrderCardReplacement is passed
89
+ # as true.<br />
90
+ # Max field length: 40
91
+ # @return [String]
92
+ attr_accessor :delivery_address_line1
93
+
94
+ # Address line 2 <br />
95
+ # Optional <br />
96
+ # Max field length: 40
97
+ # @return [String]
98
+ attr_accessor :delivery_address_line2
99
+
100
+ # Address line 3 <br />
101
+ # Optional<br />
102
+ # Max field length: 40
103
+ # @return [String]
104
+ attr_accessor :delivery_address_line3
105
+
106
+ # ZIP code <br />
107
+ # Mandatory - If CardDeliveryType is 2 and OrderCardReplacement is passed
108
+ # as true.<br />
109
+ # Max field length: 10
110
+ # @return [String]
111
+ attr_accessor :delivery_zip_code
112
+
113
+ # City <br />
114
+ # Mandatory - If CardDeliveryType is 2 and OrderCardReplacement is passed
115
+ # as true.<br />
116
+ # Max field length: 40
117
+ # @return [String]
118
+ attr_accessor :delivery_city
119
+
120
+ # Region Id <br />
121
+ # Optional
122
+ # @return [Integer]
123
+ attr_accessor :delivery_region_id
124
+
125
+ # Region <br />
126
+ # Optional<br />
127
+ # When region is passed
128
+ # @return [String]
129
+ attr_accessor :delivery_region
130
+
131
+ # The ISO code of the country.<br />
132
+ # Mandatory - If CardDeliveryType is 2 and OrderCardReplacement is passed
133
+ # as true
134
+ # @return [String]
135
+ attr_accessor :delivery_country
136
+
137
+ # The countryId of gicen country.<br />
138
+ # @return [Integer]
139
+ attr_accessor :delivery_country_id
140
+
141
+ # Phone number for to send SMS. <br />
142
+ # Optional<br />
143
+ # Max field length: 20
144
+ # @return [String]
145
+ attr_accessor :phone_number
146
+
147
+ # Email address for to send email.<br />
148
+ # Mandatory if PINAdviceType is email else optional.<br />
149
+ # Max field length: 90
150
+ # @return [String]
151
+ attr_accessor :email_address
152
+
153
+ # PIN delivery address type selection.<br />
154
+ # Optional<br />
155
+ # Allowed Values:<br />
156
+ # 1. Customer Address(Default)<br />
157
+ # 2. Card Address<br />
158
+ # 3. New Delivery Address
159
+ # @return [Integer]
160
+ attr_accessor :pin_delivery_address_type
161
+
162
+ # PIN delivery method.<br />
163
+ # Mandatory when OrderReplacement Is true.<br />
164
+ # Allowed Values:<br />
165
+ # 1. Paper<br />
166
+ # 2. Email<br />
167
+ # 3. SMS<br />
168
+ # 4. None
169
+ # @return [Integer]
170
+ attr_accessor :pin_advice_type
171
+
172
+ # Title of the contact person.<br />
173
+ # Optional <br />
174
+ # Max field length: 10
175
+ # @return [String]
176
+ attr_accessor :pin_delivery_contact_title
177
+
178
+ # Name of the contact person.<br />
179
+ # Mandatory - If PINAdviceType is paper else optional.<br />
180
+ # Max field length: 50
181
+ # @return [String]
182
+ attr_accessor :pin_delivery_contact_name
183
+
184
+ # Company name.<br />
185
+ # Mandatory - If PINAdviceType is paper else optional.<br />
186
+ # Max field length: 50
187
+ # @return [String]
188
+ attr_accessor :pin_delivery_company_name
189
+
190
+ # Address line 1.<br />
191
+ # Mandatory - If PINAdviceType is paper else optional.<br />
192
+ # Max field length: 40
193
+ # @return [String]
194
+ attr_accessor :pin_delivery_address_line1
195
+
196
+ # Address line 2.<br />
197
+ # Optional <br />
198
+ # Max field length: 40
199
+ # @return [String]
200
+ attr_accessor :pin_delivery_address_line2
201
+
202
+ # Address line 3.<br />
203
+ # Optional <br />
204
+ # Max field length: 40
205
+ # @return [String]
206
+ attr_accessor :pin_delivery_address_line3
207
+
208
+ # ZIP code.<br />
209
+ # Mandatory - if PINAdviceType is paper else optional. <br />
210
+ # Max field length: 10
211
+ # @return [String]
212
+ attr_accessor :pin_delivery_zip_code
213
+
214
+ # City.<br />
215
+ # Mandatory - If PINAdviceType is paper else optional. <br />
216
+ # Max field length: 40
217
+ # @return [String]
218
+ attr_accessor :pin_delivery_city
219
+
220
+ # Region Id.<br />
221
+ # Optional
222
+ # @return [Integer]
223
+ attr_accessor :pin_delivery_region_id
224
+
225
+ # Region.<br />
226
+ # When region is passed
227
+ # @return [String]
228
+ attr_accessor :pin_delivery_region
229
+
230
+ # The ISO code of the country.<br />
231
+ # Mappings for ISO code <br />
232
+ # Mandatory if PINAdviceType is paper else optional.
233
+ # @return [String]
234
+ attr_accessor :pin_delivery_country
235
+
236
+ # The countryId of the country.<br />
237
+ # Mappings for ISO code<br />
238
+ # This is not an input parameter.
239
+ # @return [Integer]
240
+ attr_accessor :pin_delivery_country_id
241
+
242
+ # Phone number for to send SMS of the PIN in case PINAdviceType is SMS.<br
243
+ # />
244
+ # Mandatory if PINAdviceType is SMS else optional.<br />
245
+ # Max field length: 20
246
+ # @return [String]
247
+ attr_accessor :pin_phone_number
248
+
249
+ # Email address for to send email of the PIN in case PINAdviceType is
250
+ # Email.<br />
251
+ # Mandatory if PINAdviceType is email else optional.<br />
252
+ # Max field length: 90
253
+ # @return [String]
254
+ attr_accessor :pin_email_address
255
+
256
+ # The given address will be used for sending PIN reminders in future when
257
+ # requested.<br />
258
+ # PIN Advice type should be Paper
259
+ # Optional
260
+ # @return [TrueClass | FalseClass]
261
+ attr_accessor :save_for_pin_reminder
262
+
263
+ # If this is specified, the contact address will be saved in cards platform
264
+ # for card reissue processing.<br />
265
+ # Optional
266
+ # @return [TrueClass | FalseClass]
267
+ attr_accessor :save_for_card_reissue
268
+
269
+ # Expiry Date for newly created card to be update in cards plot form.<br />
270
+ # Optional <br />
271
+ # Format: MMyy <br />
272
+ # Eg:1221 <br />
273
+ # If not apply the default Expiry Date.<br />
274
+ # Note:<br />
275
+ # There is a limit to the ExpiryDate which the user can choose for the Card.
276
+ #
277
+ # If the user chooses a later ExpiryDate than the allowed value for the
278
+ # CardType of the OU,
279
+ # the background service logs the respective error code and description
280
+ # @return [String]
281
+ attr_accessor :expiry_date
282
+
283
+ # A mapping from model property names to API property names.
284
+ def self.names
285
+ @_hash = {} if @_hash.nil?
286
+ @_hash['self_selected_encrypted_pin'] = 'SelfSelectedEncryptedPIN'
287
+ @_hash['self_selected_pin_key_id'] = 'SelfSelectedPINKeyID'
288
+ @_hash['self_selected_pin_session_key'] = 'SelfSelectedPINSessionKey'
289
+ @_hash['validate_fleet_id'] = 'ValidateFleetId'
290
+ @_hash['card_group_id'] = 'CardGroupId'
291
+ @_hash['card_delivery_type'] = 'CardDeliveryType'
292
+ @_hash['delivery_contact_title'] = 'DeliveryContactTitle'
293
+ @_hash['delivery_contact_name'] = 'DeliveryContactName'
294
+ @_hash['delivery_company_name'] = 'DeliveryCompanyName'
295
+ @_hash['delivery_address_line1'] = 'DeliveryAddressLine1'
296
+ @_hash['delivery_address_line2'] = 'DeliveryAddressLine2'
297
+ @_hash['delivery_address_line3'] = 'DeliveryAddressLine3'
298
+ @_hash['delivery_zip_code'] = 'DeliveryZipCode'
299
+ @_hash['delivery_city'] = 'DeliveryCity'
300
+ @_hash['delivery_region_id'] = 'DeliveryRegionId'
301
+ @_hash['delivery_region'] = 'DeliveryRegion'
302
+ @_hash['delivery_country'] = 'DeliveryCountry'
303
+ @_hash['delivery_country_id'] = 'DeliveryCountryId'
304
+ @_hash['phone_number'] = 'PhoneNumber'
305
+ @_hash['email_address'] = 'EmailAddress'
306
+ @_hash['pin_delivery_address_type'] = 'PINDeliveryAddressType'
307
+ @_hash['pin_advice_type'] = 'PINAdviceType'
308
+ @_hash['pin_delivery_contact_title'] = 'PINDeliveryContactTitle'
309
+ @_hash['pin_delivery_contact_name'] = 'PINDeliveryContactName'
310
+ @_hash['pin_delivery_company_name'] = 'PINDeliveryCompanyName'
311
+ @_hash['pin_delivery_address_line1'] = 'PINDeliveryAddressLine1'
312
+ @_hash['pin_delivery_address_line2'] = 'PINDeliveryAddressLine2'
313
+ @_hash['pin_delivery_address_line3'] = 'PINDeliveryAddressLine3'
314
+ @_hash['pin_delivery_zip_code'] = 'PINDeliveryZipCode'
315
+ @_hash['pin_delivery_city'] = 'PINDeliveryCity'
316
+ @_hash['pin_delivery_region_id'] = 'PINDeliveryRegionId'
317
+ @_hash['pin_delivery_region'] = 'PINDeliveryRegion'
318
+ @_hash['pin_delivery_country'] = 'PINDeliveryCountry'
319
+ @_hash['pin_delivery_country_id'] = 'PINDeliveryCountryId'
320
+ @_hash['pin_phone_number'] = 'PINPhoneNumber'
321
+ @_hash['pin_email_address'] = 'PINEmailAddress'
322
+ @_hash['save_for_pin_reminder'] = 'SaveForPINReminder'
323
+ @_hash['save_for_card_reissue'] = 'SaveForCardReissue'
324
+ @_hash['expiry_date'] = 'ExpiryDate'
325
+ @_hash
326
+ end
327
+
328
+ # An array for optional fields
329
+ def self.optionals
330
+ %w[
331
+ self_selected_encrypted_pin
332
+ self_selected_pin_key_id
333
+ self_selected_pin_session_key
334
+ validate_fleet_id
335
+ card_group_id
336
+ delivery_contact_title
337
+ delivery_contact_name
338
+ delivery_company_name
339
+ delivery_address_line1
340
+ delivery_address_line2
341
+ delivery_address_line3
342
+ delivery_zip_code
343
+ delivery_city
344
+ delivery_region_id
345
+ delivery_region
346
+ delivery_country
347
+ delivery_country_id
348
+ phone_number
349
+ email_address
350
+ pin_delivery_address_type
351
+ pin_advice_type
352
+ pin_delivery_contact_title
353
+ pin_delivery_contact_name
354
+ pin_delivery_company_name
355
+ pin_delivery_address_line1
356
+ pin_delivery_address_line2
357
+ pin_delivery_address_line3
358
+ pin_delivery_zip_code
359
+ pin_delivery_city
360
+ pin_delivery_region_id
361
+ pin_delivery_region
362
+ pin_delivery_country
363
+ pin_delivery_country_id
364
+ pin_phone_number
365
+ pin_email_address
366
+ save_for_pin_reminder
367
+ save_for_card_reissue
368
+ expiry_date
369
+ ]
370
+ end
371
+
372
+ # An array for nullable fields
373
+ def self.nullables
374
+ %w[
375
+ self_selected_encrypted_pin
376
+ self_selected_pin_key_id
377
+ self_selected_pin_session_key
378
+ card_group_id
379
+ card_delivery_type
380
+ delivery_contact_title
381
+ delivery_contact_name
382
+ delivery_company_name
383
+ delivery_address_line1
384
+ delivery_address_line2
385
+ delivery_address_line3
386
+ delivery_zip_code
387
+ delivery_city
388
+ delivery_region_id
389
+ delivery_region
390
+ delivery_country
391
+ delivery_country_id
392
+ email_address
393
+ pin_delivery_address_type
394
+ pin_advice_type
395
+ pin_delivery_contact_title
396
+ pin_delivery_contact_name
397
+ pin_delivery_company_name
398
+ pin_delivery_address_line1
399
+ pin_delivery_address_line2
400
+ pin_delivery_address_line3
401
+ pin_delivery_zip_code
402
+ pin_delivery_city
403
+ pin_delivery_region_id
404
+ pin_delivery_region
405
+ pin_delivery_country
406
+ pin_delivery_country_id
407
+ pin_phone_number
408
+ pin_email_address
409
+ expiry_date
410
+ ]
411
+ end
412
+
413
+ def initialize(card_delivery_type = nil,
414
+ self_selected_encrypted_pin = SKIP,
415
+ self_selected_pin_key_id = SKIP,
416
+ self_selected_pin_session_key = SKIP,
417
+ validate_fleet_id = SKIP,
418
+ card_group_id = SKIP,
419
+ delivery_contact_title = SKIP,
420
+ delivery_contact_name = SKIP,
421
+ delivery_company_name = SKIP,
422
+ delivery_address_line1 = SKIP,
423
+ delivery_address_line2 = SKIP,
424
+ delivery_address_line3 = SKIP,
425
+ delivery_zip_code = SKIP,
426
+ delivery_city = SKIP,
427
+ delivery_region_id = SKIP,
428
+ delivery_region = SKIP,
429
+ delivery_country = SKIP,
430
+ delivery_country_id = SKIP,
431
+ phone_number = SKIP,
432
+ email_address = SKIP,
433
+ pin_delivery_address_type = SKIP,
434
+ pin_advice_type = SKIP,
435
+ pin_delivery_contact_title = SKIP,
436
+ pin_delivery_contact_name = SKIP,
437
+ pin_delivery_company_name = SKIP,
438
+ pin_delivery_address_line1 = SKIP,
439
+ pin_delivery_address_line2 = SKIP,
440
+ pin_delivery_address_line3 = SKIP,
441
+ pin_delivery_zip_code = SKIP,
442
+ pin_delivery_city = SKIP,
443
+ pin_delivery_region_id = SKIP,
444
+ pin_delivery_region = SKIP,
445
+ pin_delivery_country = SKIP,
446
+ pin_delivery_country_id = SKIP,
447
+ pin_phone_number = SKIP,
448
+ pin_email_address = SKIP,
449
+ save_for_pin_reminder = SKIP,
450
+ save_for_card_reissue = SKIP,
451
+ expiry_date = SKIP)
452
+ unless self_selected_encrypted_pin == SKIP
453
+ @self_selected_encrypted_pin =
454
+ self_selected_encrypted_pin
455
+ end
456
+ @self_selected_pin_key_id = self_selected_pin_key_id unless self_selected_pin_key_id == SKIP
457
+ unless self_selected_pin_session_key == SKIP
458
+ @self_selected_pin_session_key =
459
+ self_selected_pin_session_key
460
+ end
461
+ @validate_fleet_id = validate_fleet_id unless validate_fleet_id == SKIP
462
+ @card_group_id = card_group_id unless card_group_id == SKIP
463
+ @card_delivery_type = card_delivery_type
464
+ @delivery_contact_title = delivery_contact_title unless delivery_contact_title == SKIP
465
+ @delivery_contact_name = delivery_contact_name unless delivery_contact_name == SKIP
466
+ @delivery_company_name = delivery_company_name unless delivery_company_name == SKIP
467
+ @delivery_address_line1 = delivery_address_line1 unless delivery_address_line1 == SKIP
468
+ @delivery_address_line2 = delivery_address_line2 unless delivery_address_line2 == SKIP
469
+ @delivery_address_line3 = delivery_address_line3 unless delivery_address_line3 == SKIP
470
+ @delivery_zip_code = delivery_zip_code unless delivery_zip_code == SKIP
471
+ @delivery_city = delivery_city unless delivery_city == SKIP
472
+ @delivery_region_id = delivery_region_id unless delivery_region_id == SKIP
473
+ @delivery_region = delivery_region unless delivery_region == SKIP
474
+ @delivery_country = delivery_country unless delivery_country == SKIP
475
+ @delivery_country_id = delivery_country_id unless delivery_country_id == SKIP
476
+ @phone_number = phone_number unless phone_number == SKIP
477
+ @email_address = email_address unless email_address == SKIP
478
+ unless pin_delivery_address_type == SKIP
479
+ @pin_delivery_address_type =
480
+ pin_delivery_address_type
481
+ end
482
+ @pin_advice_type = pin_advice_type unless pin_advice_type == SKIP
483
+ unless pin_delivery_contact_title == SKIP
484
+ @pin_delivery_contact_title =
485
+ pin_delivery_contact_title
486
+ end
487
+ unless pin_delivery_contact_name == SKIP
488
+ @pin_delivery_contact_name =
489
+ pin_delivery_contact_name
490
+ end
491
+ unless pin_delivery_company_name == SKIP
492
+ @pin_delivery_company_name =
493
+ pin_delivery_company_name
494
+ end
495
+ unless pin_delivery_address_line1 == SKIP
496
+ @pin_delivery_address_line1 =
497
+ pin_delivery_address_line1
498
+ end
499
+ unless pin_delivery_address_line2 == SKIP
500
+ @pin_delivery_address_line2 =
501
+ pin_delivery_address_line2
502
+ end
503
+ unless pin_delivery_address_line3 == SKIP
504
+ @pin_delivery_address_line3 =
505
+ pin_delivery_address_line3
506
+ end
507
+ @pin_delivery_zip_code = pin_delivery_zip_code unless pin_delivery_zip_code == SKIP
508
+ @pin_delivery_city = pin_delivery_city unless pin_delivery_city == SKIP
509
+ @pin_delivery_region_id = pin_delivery_region_id unless pin_delivery_region_id == SKIP
510
+ @pin_delivery_region = pin_delivery_region unless pin_delivery_region == SKIP
511
+ @pin_delivery_country = pin_delivery_country unless pin_delivery_country == SKIP
512
+ @pin_delivery_country_id = pin_delivery_country_id unless pin_delivery_country_id == SKIP
513
+ @pin_phone_number = pin_phone_number unless pin_phone_number == SKIP
514
+ @pin_email_address = pin_email_address unless pin_email_address == SKIP
515
+ @save_for_pin_reminder = save_for_pin_reminder unless save_for_pin_reminder == SKIP
516
+ @save_for_card_reissue = save_for_card_reissue unless save_for_card_reissue == SKIP
517
+ @expiry_date = expiry_date unless expiry_date == SKIP
518
+ end
519
+
520
+ # Creates an instance of the object from a hash.
521
+ def self.from_hash(hash)
522
+ return nil unless hash
523
+
524
+ # Extract variables from the hash.
525
+ card_delivery_type =
526
+ hash.key?('CardDeliveryType') ? hash['CardDeliveryType'] : nil
527
+ self_selected_encrypted_pin =
528
+ hash.key?('SelfSelectedEncryptedPIN') ? hash['SelfSelectedEncryptedPIN'] : SKIP
529
+ self_selected_pin_key_id =
530
+ hash.key?('SelfSelectedPINKeyID') ? hash['SelfSelectedPINKeyID'] : SKIP
531
+ self_selected_pin_session_key =
532
+ hash.key?('SelfSelectedPINSessionKey') ? hash['SelfSelectedPINSessionKey'] : SKIP
533
+ validate_fleet_id =
534
+ hash.key?('ValidateFleetId') ? hash['ValidateFleetId'] : SKIP
535
+ card_group_id = hash.key?('CardGroupId') ? hash['CardGroupId'] : SKIP
536
+ delivery_contact_title =
537
+ hash.key?('DeliveryContactTitle') ? hash['DeliveryContactTitle'] : SKIP
538
+ delivery_contact_name =
539
+ hash.key?('DeliveryContactName') ? hash['DeliveryContactName'] : SKIP
540
+ delivery_company_name =
541
+ hash.key?('DeliveryCompanyName') ? hash['DeliveryCompanyName'] : SKIP
542
+ delivery_address_line1 =
543
+ hash.key?('DeliveryAddressLine1') ? hash['DeliveryAddressLine1'] : SKIP
544
+ delivery_address_line2 =
545
+ hash.key?('DeliveryAddressLine2') ? hash['DeliveryAddressLine2'] : SKIP
546
+ delivery_address_line3 =
547
+ hash.key?('DeliveryAddressLine3') ? hash['DeliveryAddressLine3'] : SKIP
548
+ delivery_zip_code =
549
+ hash.key?('DeliveryZipCode') ? hash['DeliveryZipCode'] : SKIP
550
+ delivery_city = hash.key?('DeliveryCity') ? hash['DeliveryCity'] : SKIP
551
+ delivery_region_id =
552
+ hash.key?('DeliveryRegionId') ? hash['DeliveryRegionId'] : SKIP
553
+ delivery_region =
554
+ hash.key?('DeliveryRegion') ? hash['DeliveryRegion'] : SKIP
555
+ delivery_country =
556
+ hash.key?('DeliveryCountry') ? hash['DeliveryCountry'] : SKIP
557
+ delivery_country_id =
558
+ hash.key?('DeliveryCountryId') ? hash['DeliveryCountryId'] : SKIP
559
+ phone_number = hash.key?('PhoneNumber') ? hash['PhoneNumber'] : SKIP
560
+ email_address = hash.key?('EmailAddress') ? hash['EmailAddress'] : SKIP
561
+ pin_delivery_address_type =
562
+ hash.key?('PINDeliveryAddressType') ? hash['PINDeliveryAddressType'] : SKIP
563
+ pin_advice_type =
564
+ hash.key?('PINAdviceType') ? hash['PINAdviceType'] : SKIP
565
+ pin_delivery_contact_title =
566
+ hash.key?('PINDeliveryContactTitle') ? hash['PINDeliveryContactTitle'] : SKIP
567
+ pin_delivery_contact_name =
568
+ hash.key?('PINDeliveryContactName') ? hash['PINDeliveryContactName'] : SKIP
569
+ pin_delivery_company_name =
570
+ hash.key?('PINDeliveryCompanyName') ? hash['PINDeliveryCompanyName'] : SKIP
571
+ pin_delivery_address_line1 =
572
+ hash.key?('PINDeliveryAddressLine1') ? hash['PINDeliveryAddressLine1'] : SKIP
573
+ pin_delivery_address_line2 =
574
+ hash.key?('PINDeliveryAddressLine2') ? hash['PINDeliveryAddressLine2'] : SKIP
575
+ pin_delivery_address_line3 =
576
+ hash.key?('PINDeliveryAddressLine3') ? hash['PINDeliveryAddressLine3'] : SKIP
577
+ pin_delivery_zip_code =
578
+ hash.key?('PINDeliveryZipCode') ? hash['PINDeliveryZipCode'] : SKIP
579
+ pin_delivery_city =
580
+ hash.key?('PINDeliveryCity') ? hash['PINDeliveryCity'] : SKIP
581
+ pin_delivery_region_id =
582
+ hash.key?('PINDeliveryRegionId') ? hash['PINDeliveryRegionId'] : SKIP
583
+ pin_delivery_region =
584
+ hash.key?('PINDeliveryRegion') ? hash['PINDeliveryRegion'] : SKIP
585
+ pin_delivery_country =
586
+ hash.key?('PINDeliveryCountry') ? hash['PINDeliveryCountry'] : SKIP
587
+ pin_delivery_country_id =
588
+ hash.key?('PINDeliveryCountryId') ? hash['PINDeliveryCountryId'] : SKIP
589
+ pin_phone_number =
590
+ hash.key?('PINPhoneNumber') ? hash['PINPhoneNumber'] : SKIP
591
+ pin_email_address =
592
+ hash.key?('PINEmailAddress') ? hash['PINEmailAddress'] : SKIP
593
+ save_for_pin_reminder =
594
+ hash.key?('SaveForPINReminder') ? hash['SaveForPINReminder'] : SKIP
595
+ save_for_card_reissue =
596
+ hash.key?('SaveForCardReissue') ? hash['SaveForCardReissue'] : SKIP
597
+ expiry_date = hash.key?('ExpiryDate') ? hash['ExpiryDate'] : SKIP
598
+
599
+ # Create object from extracted values.
600
+ ReplaceCardSettings.new(card_delivery_type,
601
+ self_selected_encrypted_pin,
602
+ self_selected_pin_key_id,
603
+ self_selected_pin_session_key,
604
+ validate_fleet_id,
605
+ card_group_id,
606
+ delivery_contact_title,
607
+ delivery_contact_name,
608
+ delivery_company_name,
609
+ delivery_address_line1,
610
+ delivery_address_line2,
611
+ delivery_address_line3,
612
+ delivery_zip_code,
613
+ delivery_city,
614
+ delivery_region_id,
615
+ delivery_region,
616
+ delivery_country,
617
+ delivery_country_id,
618
+ phone_number,
619
+ email_address,
620
+ pin_delivery_address_type,
621
+ pin_advice_type,
622
+ pin_delivery_contact_title,
623
+ pin_delivery_contact_name,
624
+ pin_delivery_company_name,
625
+ pin_delivery_address_line1,
626
+ pin_delivery_address_line2,
627
+ pin_delivery_address_line3,
628
+ pin_delivery_zip_code,
629
+ pin_delivery_city,
630
+ pin_delivery_region_id,
631
+ pin_delivery_region,
632
+ pin_delivery_country,
633
+ pin_delivery_country_id,
634
+ pin_phone_number,
635
+ pin_email_address,
636
+ save_for_pin_reminder,
637
+ save_for_card_reissue,
638
+ expiry_date)
639
+ end
640
+ end
641
+ end