first_data_gateway 1.1.0 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (481) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +79 -0
  3. data/README.md +69 -39
  4. data/docs/AVSResponse.md +2 -2
  5. data/docs/AccessTokenResponse.md +2 -2
  6. data/docs/AccountUpdaterResponse.md +12 -0
  7. data/docs/AdditionalAmountRate.md +2 -2
  8. data/docs/AdditionalDetails.md +10 -0
  9. data/docs/AdditionalTransactionDetails.md +3 -3
  10. data/docs/Address.md +7 -7
  11. data/docs/Airline.md +12 -12
  12. data/docs/AirlineAncillaryServiceCategory.md +1 -1
  13. data/docs/AirlineTravelRoute.md +4 -4
  14. data/docs/AliPay.md +2 -2
  15. data/docs/{SecondaryTransactionAdditionalDetails.md → AliPayPaymentMethod.md} +2 -2
  16. data/docs/AliPaySaleTransaction.md +14 -0
  17. data/docs/Amount.md +2 -2
  18. data/docs/AmountComponents.md +6 -7
  19. data/docs/Authentication.md +8 -0
  20. data/docs/AuthenticationApi.md +12 -12
  21. data/docs/AuthenticationRedirect.md +10 -0
  22. data/docs/AuthenticationRedirectParams.md +10 -0
  23. data/docs/AuthenticationVerificationRequest.md +11 -0
  24. data/docs/BasicResponse.md +1 -1
  25. data/docs/Billing.md +3 -5
  26. data/docs/BillingAddress.md +4 -4
  27. data/docs/BillingAddressPhone.md +1 -1
  28. data/docs/CarRental.md +6 -6
  29. data/docs/CarRentalExtraCharges.md +1 -1
  30. data/docs/Card.md +6 -6
  31. data/docs/CardFunction.md +7 -0
  32. data/docs/CardInfo.md +2 -2
  33. data/docs/CardInfoLookupApi.md +14 -14
  34. data/docs/CardInfoLookupResponse.md +1 -1
  35. data/docs/CardVerificationApi.md +12 -12
  36. data/docs/CardVerificationRequest.md +1 -0
  37. data/docs/ChinaDomesticPaymentMethod.md +9 -0
  38. data/docs/ChinaPnRSaleTransaction.md +14 -0
  39. data/docs/ClientLocale.md +2 -2
  40. data/docs/Contact.md +4 -4
  41. data/docs/CreatePaymentToken.md +10 -0
  42. data/docs/CurrencyConversion.md +9 -0
  43. data/docs/CurrencyConversionApi.md +15 -15
  44. data/docs/Customer.md +6 -6
  45. data/docs/CustomerAddress.md +3 -3
  46. data/docs/CustomerAddressPhone.md +1 -1
  47. data/docs/DCCExchangeRateRequest.md +11 -0
  48. data/docs/Dcc.md +2 -1
  49. data/docs/Device.md +2 -2
  50. data/docs/DeviceNetworks.md +1 -1
  51. data/docs/Document.md +2 -2
  52. data/docs/DynamicPricing.md +11 -0
  53. data/docs/DynamicPricingExchangeRateRequest.md +11 -0
  54. data/docs/ErrorResponse.md +1 -1
  55. data/docs/ExchangeRateRequest.md +2 -4
  56. data/docs/ExchangeRateResponse.md +11 -11
  57. data/docs/Expiration.md +2 -2
  58. data/docs/FraudDetectApi.md +12 -12
  59. data/docs/FraudOrderItems.md +1 -1
  60. data/docs/FraudOrderShipToAddress.md +6 -6
  61. data/docs/Frequency.md +2 -2
  62. data/docs/InstallmentOptions.md +5 -3
  63. data/docs/Lodging.md +5 -5
  64. data/docs/MerchantLocationMerchantAddress.md +6 -6
  65. data/docs/Order.md +5 -0
  66. data/docs/OrderApi.md +36 -102
  67. data/docs/OrderErrorResponse.md +4 -5
  68. data/docs/OrderResponse.md +4 -5
  69. data/docs/PayPal.md +1 -1
  70. data/docs/PayPalPaymentMethod.md +8 -0
  71. data/docs/PaymentApi.md +67 -193
  72. data/docs/PaymentCard.md +8 -11
  73. data/docs/PaymentCardCreditTransaction.md +15 -0
  74. data/docs/PaymentCardForcedTicketTransaction.md +15 -0
  75. data/docs/PaymentCardPayerAuthTransaction.md +15 -0
  76. data/docs/PaymentCardPaymentMethod.md +9 -0
  77. data/docs/PaymentCardPaymentTokenizationRequest.md +13 -0
  78. data/docs/PaymentCardPreAuthTransaction.md +18 -0
  79. data/docs/PaymentCardSaleTransaction.md +18 -0
  80. data/docs/PaymentFacilitator.md +4 -4
  81. data/docs/PaymentMethod.md +0 -7
  82. data/docs/PaymentMethodDetails.md +9 -0
  83. data/docs/PaymentMethodPaymentSchedulesRequest.md +24 -0
  84. data/docs/PaymentMethodType.md +7 -0
  85. data/docs/PaymentPayMethod.md +1 -1
  86. data/docs/PaymentSchedulesApi.md +58 -58
  87. data/docs/PaymentSchedulesErrorResponse.md +1 -1
  88. data/docs/PaymentSchedulesRequest.md +5 -6
  89. data/docs/PaymentSchedulesResponse.md +1 -1
  90. data/docs/PaymentTokenApi.md +23 -23
  91. data/docs/PaymentTokenCreditTransaction.md +15 -0
  92. data/docs/PaymentTokenDetails.md +14 -0
  93. data/docs/PaymentTokenPaymentMethod.md +9 -0
  94. data/docs/PaymentTokenPreAuthTransaction.md +17 -0
  95. data/docs/PaymentTokenSaleTransaction.md +17 -0
  96. data/docs/PaymentTokenizationErrorResponse.md +8 -8
  97. data/docs/PaymentTokenizationRequest.md +4 -3
  98. data/docs/PaymentTokenizationResponse.md +8 -8
  99. data/docs/PaymentURLApi.md +12 -12
  100. data/docs/PaymentUrlErrorResponse.md +3 -3
  101. data/docs/PaymentUrlRequest.md +3 -3
  102. data/docs/PaymentUrlResponse.md +3 -3
  103. data/docs/PaymentVerification3ds.md +3 -3
  104. data/docs/PaymentVerificationAvs.md +3 -3
  105. data/docs/PaymentVerificationCvv.md +3 -3
  106. data/docs/PaypalCreditTransaction.md +14 -0
  107. data/docs/PostAuthTransaction.md +14 -0
  108. data/docs/PrimaryTransaction.md +3 -12
  109. data/docs/ProcessorData.md +8 -6
  110. data/docs/PurchaseCardsLevel2.md +3 -3
  111. data/docs/PurchaseCardsLevel3.md +1 -1
  112. data/docs/PurchaseCardsLevel3LineItems.md +8 -8
  113. data/docs/RecurringPaymentDetails.md +2 -2
  114. data/docs/RecurringPaymentDetailsResponse.md +4 -5
  115. data/docs/ReferencedOrderPaymentSchedulesRequest.md +24 -0
  116. data/docs/ReferencedOrderPaymentTokenizationRequest.md +13 -0
  117. data/docs/ResponseAmountComponents.md +14 -0
  118. data/docs/ReturnTransaction.md +13 -0
  119. data/docs/ScoreOnlyRequest.md +1 -1
  120. data/docs/ScoreOnlyResponse.md +3 -3
  121. data/docs/ScoreOnlyResponseFraudScore.md +1 -1
  122. data/docs/ScoreOnlyResponseFraudScoreExplanations.md +3 -3
  123. data/docs/SecondaryTransaction.md +3 -5
  124. data/docs/Secure3dAuthenticationRequest.md +8 -0
  125. data/docs/Secure3dAuthenticationResult.md +12 -0
  126. data/docs/Secure3dAuthenticationVerificationRequest.md +13 -0
  127. data/docs/Secure3dResponse.md +1 -1
  128. data/docs/Sepa.md +4 -4
  129. data/docs/SepaMandate.md +2 -2
  130. data/docs/SepaPaymentMethod.md +8 -0
  131. data/docs/SepaSaleTransaction.md +14 -0
  132. data/docs/Shipping.md +1 -1
  133. data/docs/SoftDescriptor.md +2 -2
  134. data/docs/SplitShipment.md +1 -1
  135. data/docs/StoredCredential.md +4 -4
  136. data/docs/SubMerchantData.md +4 -4
  137. data/docs/SubMerchantSplit.md +9 -0
  138. data/docs/Transaction.md +4 -4
  139. data/docs/TransactionErrorResponse.md +11 -10
  140. data/docs/TransactionResponse.md +11 -10
  141. data/docs/UnionPayAuthenticationRequest.md +9 -0
  142. data/docs/UnionPayAuthenticationVerificationRequest.md +12 -0
  143. data/docs/UsePaymentToken.md +10 -0
  144. data/docs/VoidTransaction.md +10 -0
  145. data/first_data_gateway.gemspec +3 -2
  146. data/lib/openapi_client/api/authentication_api.rb +18 -18
  147. data/lib/openapi_client/api/card_info_lookup_api.rb +15 -15
  148. data/lib/openapi_client/api/card_verification_api.rb +13 -13
  149. data/lib/openapi_client/api/currency_conversion_api.rb +17 -17
  150. data/lib/openapi_client/api/fraud_detect_api.rb +13 -17
  151. data/lib/openapi_client/api/order_api.rb +45 -153
  152. data/lib/openapi_client/api/payment_api.rb +88 -287
  153. data/lib/openapi_client/api/payment_schedules_api.rb +61 -63
  154. data/lib/openapi_client/api/payment_token_api.rb +24 -24
  155. data/lib/openapi_client/api/payment_url_api.rb +13 -13
  156. data/lib/openapi_client/api_client.rb +2 -2
  157. data/lib/openapi_client/api_error.rb +2 -2
  158. data/lib/openapi_client/configuration.rb +4 -4
  159. data/lib/openapi_client/models/access_token_response.rb +5 -5
  160. data/lib/openapi_client/models/account_updater_response.rb +225 -0
  161. data/lib/openapi_client/models/additional_amount_rate.rb +15 -4
  162. data/lib/openapi_client/models/{primary_transaction_additional_details.rb → additional_details.rb} +11 -113
  163. data/lib/openapi_client/models/additional_transaction_details.rb +6 -6
  164. data/lib/openapi_client/models/address.rb +9 -9
  165. data/lib/openapi_client/models/airline.rb +15 -15
  166. data/lib/openapi_client/models/airline_ancillary_service_category.rb +7 -2
  167. data/lib/openapi_client/models/airline_travel_route.rb +7 -6
  168. data/lib/openapi_client/models/ali_pay.rb +4 -4
  169. data/lib/openapi_client/models/{referenced_order.rb → ali_pay_payment_method.rb} +16 -20
  170. data/lib/openapi_client/models/ali_pay_sale_transaction.rb +286 -0
  171. data/lib/openapi_client/models/amount.rb +5 -5
  172. data/lib/openapi_client/models/amount_components.rb +13 -23
  173. data/lib/openapi_client/models/authentication.rb +190 -0
  174. data/lib/openapi_client/models/{authentication_request.rb → authentication_redirect.rb} +24 -20
  175. data/lib/openapi_client/models/authentication_redirect_params.rb +205 -0
  176. data/lib/openapi_client/models/authentication_verification_request.rb +234 -0
  177. data/lib/openapi_client/models/avs_response.rb +4 -2
  178. data/lib/openapi_client/models/basic_response.rb +2 -7
  179. data/lib/openapi_client/models/billing.rb +7 -76
  180. data/lib/openapi_client/models/billing_address.rb +7 -7
  181. data/lib/openapi_client/models/billing_address_phone.rb +4 -4
  182. data/lib/openapi_client/models/car_rental.rb +9 -9
  183. data/lib/openapi_client/models/car_rental_extra_charges.rb +3 -3
  184. data/lib/openapi_client/models/card.rb +9 -8
  185. data/lib/openapi_client/models/card_function.rb +33 -0
  186. data/lib/openapi_client/models/card_info.rb +4 -17
  187. data/lib/openapi_client/models/card_info_lookup_request.rb +3 -3
  188. data/lib/openapi_client/models/card_info_lookup_response.rb +2 -7
  189. data/lib/openapi_client/models/card_verification_request.rb +32 -7
  190. data/lib/openapi_client/models/china_domestic.rb +2 -2
  191. data/lib/openapi_client/models/{authentication_response_verification.rb → china_domestic_payment_method.rb} +33 -48
  192. data/lib/openapi_client/models/china_pn_r_sale_transaction.rb +286 -0
  193. data/lib/openapi_client/models/client_locale.rb +5 -5
  194. data/lib/openapi_client/models/contact.rb +7 -6
  195. data/lib/openapi_client/models/create_payment_token.rb +209 -0
  196. data/lib/openapi_client/models/{authentication_response_verification_request.rb → currency_conversion.rb} +29 -35
  197. data/lib/openapi_client/models/customer.rb +9 -9
  198. data/lib/openapi_client/models/customer_address.rb +6 -6
  199. data/lib/openapi_client/models/customer_address_phone.rb +4 -4
  200. data/lib/openapi_client/models/dcc.rb +24 -4
  201. data/lib/openapi_client/models/dcc_exchange_rate_request.rb +273 -0
  202. data/lib/openapi_client/models/device.rb +4 -3
  203. data/lib/openapi_client/models/device_networks.rb +4 -3
  204. data/lib/openapi_client/models/document.rb +4 -4
  205. data/lib/openapi_client/models/dynamic_pricing.rb +235 -0
  206. data/lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb +273 -0
  207. data/lib/openapi_client/models/error.rb +2 -2
  208. data/lib/openapi_client/models/error_details.rb +2 -2
  209. data/lib/openapi_client/models/error_response.rb +2 -7
  210. data/lib/openapi_client/models/exchange_rate_request.rb +26 -103
  211. data/lib/openapi_client/models/exchange_rate_response.rb +20 -25
  212. data/lib/openapi_client/models/expiration.rb +5 -5
  213. data/lib/openapi_client/models/fraud_order.rb +2 -2
  214. data/lib/openapi_client/models/fraud_order_items.rb +4 -2
  215. data/lib/openapi_client/models/fraud_order_ship_to_address.rb +8 -8
  216. data/lib/openapi_client/models/frequency.rb +5 -5
  217. data/lib/openapi_client/models/industry_specific_extensions.rb +3 -3
  218. data/lib/openapi_client/models/installment_options.rb +63 -9
  219. data/lib/openapi_client/models/lodging.rb +8 -8
  220. data/lib/openapi_client/models/lodging_extra_charges.rb +2 -2
  221. data/lib/openapi_client/models/loyalty.rb +2 -2
  222. data/lib/openapi_client/models/merchant.rb +2 -2
  223. data/lib/openapi_client/models/merchant_location.rb +2 -2
  224. data/lib/openapi_client/models/merchant_location_merchant_address.rb +9 -9
  225. data/lib/openapi_client/models/order.rb +52 -7
  226. data/lib/openapi_client/models/order_error_response.rb +6 -21
  227. data/lib/openapi_client/models/order_response.rb +7 -22
  228. data/lib/openapi_client/models/pay_pal.rb +3 -3
  229. data/lib/openapi_client/models/pay_pal_payment_method.rb +189 -0
  230. data/lib/openapi_client/models/payment.rb +2 -2
  231. data/lib/openapi_client/models/payment_card.rb +38 -58
  232. data/lib/openapi_client/models/payment_card_credit_transaction.rb +295 -0
  233. data/lib/openapi_client/models/payment_card_forced_ticket_transaction.rb +320 -0
  234. data/lib/openapi_client/models/payment_card_payer_auth_transaction.rb +295 -0
  235. data/lib/openapi_client/models/payment_card_payment_method.rb +198 -0
  236. data/lib/openapi_client/models/payment_card_payment_tokenization_request.rb +264 -0
  237. data/lib/openapi_client/models/payment_card_pre_auth_transaction.rb +325 -0
  238. data/lib/openapi_client/models/payment_card_sale_transaction.rb +325 -0
  239. data/lib/openapi_client/models/payment_facilitator.rb +7 -7
  240. data/lib/openapi_client/models/payment_issuer_response.rb +2 -2
  241. data/lib/openapi_client/models/payment_method.rb +5 -108
  242. data/lib/openapi_client/models/{basket_item.rb → payment_method_details.rb} +17 -38
  243. data/lib/openapi_client/models/payment_method_payment_schedules_request.rb +426 -0
  244. data/lib/openapi_client/models/payment_method_type.rb +47 -0
  245. data/lib/openapi_client/models/payment_pay_method.rb +4 -4
  246. data/lib/openapi_client/models/payment_schedules_error_response.rb +2 -7
  247. data/lib/openapi_client/models/payment_schedules_request.rb +41 -30
  248. data/lib/openapi_client/models/payment_schedules_response.rb +2 -7
  249. data/lib/openapi_client/models/payment_token_credit_transaction.rb +295 -0
  250. data/lib/openapi_client/models/{payment_tokenization.rb → payment_token_details.rb} +18 -96
  251. data/lib/openapi_client/models/payment_token_payment_method.rb +198 -0
  252. data/lib/openapi_client/models/payment_token_pre_auth_transaction.rb +316 -0
  253. data/lib/openapi_client/models/payment_token_sale_transaction.rb +316 -0
  254. data/lib/openapi_client/models/payment_tokenization_error_response.rb +10 -15
  255. data/lib/openapi_client/models/payment_tokenization_request.rb +60 -61
  256. data/lib/openapi_client/models/payment_tokenization_response.rb +10 -15
  257. data/lib/openapi_client/models/payment_url_error_response.rb +4 -9
  258. data/lib/openapi_client/models/payment_url_request.rb +11 -16
  259. data/lib/openapi_client/models/payment_url_response.rb +4 -9
  260. data/lib/openapi_client/models/payment_verification3ds.rb +5 -5
  261. data/lib/openapi_client/models/payment_verification_avs.rb +5 -5
  262. data/lib/openapi_client/models/payment_verification_cvv.rb +5 -5
  263. data/lib/openapi_client/models/paypal_credit_transaction.rb +286 -0
  264. data/lib/openapi_client/models/post_auth_transaction.rb +266 -0
  265. data/lib/openapi_client/models/primary_transaction.rb +30 -118
  266. data/lib/openapi_client/models/processor_data.rb +48 -7
  267. data/lib/openapi_client/models/purchase_cards.rb +3 -2
  268. data/lib/openapi_client/models/purchase_cards_level2.rb +6 -5
  269. data/lib/openapi_client/models/purchase_cards_level3.rb +9 -3
  270. data/lib/openapi_client/models/purchase_cards_level3_line_items.rb +16 -16
  271. data/lib/openapi_client/models/recurring_payment_details.rb +15 -15
  272. data/lib/openapi_client/models/recurring_payment_details_response.rb +6 -21
  273. data/lib/openapi_client/models/referenced_order_payment_schedules_request.rb +427 -0
  274. data/lib/openapi_client/models/referenced_order_payment_tokenization_request.rb +265 -0
  275. data/lib/openapi_client/models/response_amount_components.rb +245 -0
  276. data/lib/openapi_client/models/response_type.rb +2 -2
  277. data/lib/openapi_client/models/return_transaction.rb +257 -0
  278. data/lib/openapi_client/models/score_only_request.rb +4 -4
  279. data/lib/openapi_client/models/score_only_response.rb +6 -5
  280. data/lib/openapi_client/models/score_only_response_fraud_score.rb +4 -3
  281. data/lib/openapi_client/models/score_only_response_fraud_score_explanations.rb +5 -2
  282. data/lib/openapi_client/models/secondary_transaction.rb +45 -40
  283. data/lib/openapi_client/models/secure3d_authentication_request.rb +190 -0
  284. data/lib/openapi_client/models/{payment_card_authentication_result.rb → secure3d_authentication_result.rb} +34 -41
  285. data/lib/openapi_client/models/secure3d_authentication_verification_request.rb +264 -0
  286. data/lib/openapi_client/models/secure3d_response.rb +4 -3
  287. data/lib/openapi_client/models/sepa.rb +6 -6
  288. data/lib/openapi_client/models/sepa_mandate.rb +5 -5
  289. data/lib/openapi_client/models/{secondary_transaction_additional_details.rb → sepa_payment_method.rb} +16 -10
  290. data/lib/openapi_client/models/sepa_sale_transaction.rb +286 -0
  291. data/lib/openapi_client/models/shipping.rb +4 -3
  292. data/lib/openapi_client/models/soft_descriptor.rb +15 -15
  293. data/lib/openapi_client/models/split_shipment.rb +4 -4
  294. data/lib/openapi_client/models/stored_credential.rb +7 -7
  295. data/lib/openapi_client/models/sub_merchant_data.rb +7 -7
  296. data/lib/openapi_client/models/sub_merchant_split.rb +233 -0
  297. data/lib/openapi_client/models/transaction.rb +18 -18
  298. data/lib/openapi_client/models/transaction_error_response.rb +28 -24
  299. data/lib/openapi_client/models/transaction_origin.rb +2 -2
  300. data/lib/openapi_client/models/transaction_response.rb +32 -28
  301. data/lib/openapi_client/models/transaction_type.rb +2 -2
  302. data/lib/openapi_client/models/union_pay_authentication_request.rb +224 -0
  303. data/lib/openapi_client/models/union_pay_authentication_verification_request.rb +249 -0
  304. data/lib/openapi_client/models/use_payment_token.rb +233 -0
  305. data/lib/openapi_client/models/{card_verifications_transaction.rb → void_transaction.rb} +28 -17
  306. data/lib/openapi_client/version.rb +3 -3
  307. data/lib/openapi_client.rb +50 -12
  308. data/lib/simple/gateway.rb +8 -59
  309. data/lib/simple_client.rb +4 -4
  310. data/spec/api/authentication_api_spec.rb +7 -7
  311. data/spec/api/card_info_lookup_api_spec.rb +8 -8
  312. data/spec/api/card_verification_api_spec.rb +7 -7
  313. data/spec/api/currency_conversion_api_spec.rb +9 -9
  314. data/spec/api/fraud_detect_api_spec.rb +7 -7
  315. data/spec/api/order_api_spec.rb +19 -40
  316. data/spec/api/payment_api_spec.rb +33 -72
  317. data/spec/api/payment_schedules_api_spec.rb +29 -29
  318. data/spec/api/payment_token_api_spec.rb +12 -12
  319. data/spec/api/payment_url_api_spec.rb +7 -7
  320. data/spec/api_client_spec.rb +2 -2
  321. data/spec/configuration_spec.rb +5 -5
  322. data/spec/models/access_token_response_spec.rb +2 -2
  323. data/spec/models/account_updater_response_spec.rb +65 -0
  324. data/spec/models/additional_amount_rate_spec.rb +2 -2
  325. data/spec/models/additional_details_spec.rb +53 -0
  326. data/spec/models/additional_transaction_details_spec.rb +2 -2
  327. data/spec/models/address_spec.rb +2 -2
  328. data/spec/models/airline_ancillary_service_category_spec.rb +2 -2
  329. data/spec/models/airline_spec.rb +2 -2
  330. data/spec/models/airline_travel_route_spec.rb +2 -2
  331. data/spec/models/ali_pay_payment_method_spec.rb +41 -0
  332. data/spec/models/ali_pay_sale_transaction_spec.rb +77 -0
  333. data/spec/models/ali_pay_spec.rb +2 -2
  334. data/spec/models/amount_components_spec.rb +2 -8
  335. data/spec/models/amount_spec.rb +2 -2
  336. data/spec/models/authentication_redirect_params_spec.rb +53 -0
  337. data/spec/models/{authentication_response_verification_spec.rb → authentication_redirect_spec.rb} +11 -17
  338. data/spec/models/authentication_spec.rb +41 -0
  339. data/spec/models/{authentication_response_verification_request_spec.rb → authentication_verification_request_spec.rb} +11 -11
  340. data/spec/models/avs_response_spec.rb +2 -2
  341. data/spec/models/basic_response_spec.rb +2 -2
  342. data/spec/models/billing_address_phone_spec.rb +2 -2
  343. data/spec/models/billing_address_spec.rb +2 -2
  344. data/spec/models/billing_spec.rb +2 -18
  345. data/spec/models/car_rental_extra_charges_spec.rb +2 -2
  346. data/spec/models/car_rental_spec.rb +2 -2
  347. data/spec/models/card_function_spec.rb +35 -0
  348. data/spec/models/card_info_lookup_request_spec.rb +2 -2
  349. data/spec/models/card_info_lookup_response_spec.rb +2 -2
  350. data/spec/models/card_info_spec.rb +2 -6
  351. data/spec/models/card_spec.rb +2 -2
  352. data/spec/models/card_verification_request_spec.rb +8 -2
  353. data/spec/models/china_domestic_payment_method_spec.rb +51 -0
  354. data/spec/models/china_domestic_spec.rb +2 -2
  355. data/spec/models/china_pn_r_sale_transaction_spec.rb +77 -0
  356. data/spec/models/client_locale_spec.rb +2 -2
  357. data/spec/models/contact_spec.rb +2 -2
  358. data/spec/models/create_payment_token_spec.rb +53 -0
  359. data/spec/models/currency_conversion_spec.rb +47 -0
  360. data/spec/models/customer_address_phone_spec.rb +2 -2
  361. data/spec/models/customer_address_spec.rb +2 -2
  362. data/spec/models/customer_spec.rb +2 -2
  363. data/spec/models/dcc_exchange_rate_request_spec.rb +59 -0
  364. data/spec/models/dcc_spec.rb +8 -2
  365. data/spec/models/device_networks_spec.rb +2 -2
  366. data/spec/models/device_spec.rb +2 -2
  367. data/spec/models/document_spec.rb +2 -2
  368. data/spec/models/dynamic_pricing_exchange_rate_request_spec.rb +59 -0
  369. data/spec/models/{basket_item_spec.rb → dynamic_pricing_spec.rb} +12 -12
  370. data/spec/models/error_details_spec.rb +2 -2
  371. data/spec/models/error_response_spec.rb +2 -2
  372. data/spec/models/error_spec.rb +2 -2
  373. data/spec/models/exchange_rate_request_spec.rb +4 -20
  374. data/spec/models/exchange_rate_response_spec.rb +3 -3
  375. data/spec/models/expiration_spec.rb +2 -2
  376. data/spec/models/fraud_order_items_spec.rb +2 -2
  377. data/spec/models/fraud_order_ship_to_address_spec.rb +2 -2
  378. data/spec/models/fraud_order_spec.rb +2 -2
  379. data/spec/models/frequency_spec.rb +2 -2
  380. data/spec/models/industry_specific_extensions_spec.rb +2 -2
  381. data/spec/models/installment_options_spec.rb +18 -2
  382. data/spec/models/lodging_extra_charges_spec.rb +2 -2
  383. data/spec/models/lodging_spec.rb +2 -2
  384. data/spec/models/loyalty_spec.rb +2 -2
  385. data/spec/models/merchant_location_merchant_address_spec.rb +2 -2
  386. data/spec/models/merchant_location_spec.rb +2 -2
  387. data/spec/models/merchant_spec.rb +2 -2
  388. data/spec/models/order_error_response_spec.rb +2 -8
  389. data/spec/models/order_response_spec.rb +2 -8
  390. data/spec/models/order_spec.rb +32 -2
  391. data/spec/models/pay_pal_payment_method_spec.rb +41 -0
  392. data/spec/models/pay_pal_spec.rb +2 -2
  393. data/spec/models/payment_card_credit_transaction_spec.rb +83 -0
  394. data/spec/models/{primary_transaction_additional_details_spec.rb → payment_card_forced_ticket_transaction_spec.rb} +16 -22
  395. data/spec/models/payment_card_payer_auth_transaction_spec.rb +83 -0
  396. data/spec/models/payment_card_payment_method_spec.rb +47 -0
  397. data/spec/models/payment_card_payment_tokenization_request_spec.rb +71 -0
  398. data/spec/models/payment_card_pre_auth_transaction_spec.rb +101 -0
  399. data/spec/models/payment_card_sale_transaction_spec.rb +101 -0
  400. data/spec/models/payment_card_spec.rb +3 -21
  401. data/spec/models/payment_facilitator_spec.rb +2 -2
  402. data/spec/models/payment_issuer_response_spec.rb +2 -2
  403. data/spec/models/payment_method_details_spec.rb +47 -0
  404. data/spec/models/payment_method_payment_schedules_request_spec.rb +137 -0
  405. data/spec/models/payment_method_spec.rb +2 -48
  406. data/spec/models/payment_method_type_spec.rb +35 -0
  407. data/spec/models/payment_pay_method_spec.rb +2 -2
  408. data/spec/models/payment_schedules_error_response_spec.rb +2 -2
  409. data/spec/models/payment_schedules_request_spec.rb +5 -11
  410. data/spec/models/payment_schedules_response_spec.rb +2 -2
  411. data/spec/models/payment_spec.rb +2 -2
  412. data/spec/models/payment_token_credit_transaction_spec.rb +83 -0
  413. data/spec/models/{payment_tokenization_spec.rb → payment_token_details_spec.rb} +9 -25
  414. data/spec/models/payment_token_payment_method_spec.rb +47 -0
  415. data/spec/models/payment_token_pre_auth_transaction_spec.rb +95 -0
  416. data/spec/models/payment_token_sale_transaction_spec.rb +95 -0
  417. data/spec/models/payment_tokenization_error_response_spec.rb +2 -2
  418. data/spec/models/payment_tokenization_request_spec.rb +12 -10
  419. data/spec/models/payment_tokenization_response_spec.rb +2 -2
  420. data/spec/models/payment_url_error_response_spec.rb +2 -2
  421. data/spec/models/payment_url_request_spec.rb +3 -3
  422. data/spec/models/payment_url_response_spec.rb +2 -2
  423. data/spec/models/payment_verification3ds_spec.rb +2 -2
  424. data/spec/models/payment_verification_avs_spec.rb +2 -2
  425. data/spec/models/payment_verification_cvv_spec.rb +2 -2
  426. data/spec/models/paypal_credit_transaction_spec.rb +77 -0
  427. data/spec/models/post_auth_transaction_spec.rb +77 -0
  428. data/spec/models/primary_transaction_spec.rb +5 -59
  429. data/spec/models/processor_data_spec.rb +14 -2
  430. data/spec/models/purchase_cards_level2_spec.rb +2 -2
  431. data/spec/models/purchase_cards_level3_line_items_spec.rb +3 -3
  432. data/spec/models/purchase_cards_level3_spec.rb +2 -2
  433. data/spec/models/purchase_cards_spec.rb +2 -2
  434. data/spec/models/recurring_payment_details_response_spec.rb +2 -8
  435. data/spec/models/recurring_payment_details_spec.rb +4 -4
  436. data/spec/models/referenced_order_payment_schedules_request_spec.rb +137 -0
  437. data/spec/models/referenced_order_payment_tokenization_request_spec.rb +71 -0
  438. data/spec/models/response_amount_components_spec.rb +77 -0
  439. data/spec/models/response_type_spec.rb +2 -2
  440. data/spec/models/return_transaction_spec.rb +71 -0
  441. data/spec/models/score_only_request_spec.rb +2 -2
  442. data/spec/models/score_only_response_fraud_score_explanations_spec.rb +2 -2
  443. data/spec/models/score_only_response_fraud_score_spec.rb +2 -2
  444. data/spec/models/score_only_response_spec.rb +2 -2
  445. data/spec/models/secondary_transaction_spec.rb +5 -17
  446. data/spec/models/secure3d_authentication_request_spec.rb +41 -0
  447. data/spec/models/{payment_card_authentication_result_spec.rb → secure3d_authentication_result_spec.rb} +11 -15
  448. data/spec/models/secure3d_authentication_verification_request_spec.rb +71 -0
  449. data/spec/models/secure3d_response_spec.rb +2 -2
  450. data/spec/models/sepa_mandate_spec.rb +2 -2
  451. data/spec/models/sepa_payment_method_spec.rb +41 -0
  452. data/spec/models/sepa_sale_transaction_spec.rb +77 -0
  453. data/spec/models/sepa_spec.rb +2 -2
  454. data/spec/models/shipping_spec.rb +2 -2
  455. data/spec/models/soft_descriptor_spec.rb +3 -3
  456. data/spec/models/split_shipment_spec.rb +2 -2
  457. data/spec/models/stored_credential_spec.rb +2 -2
  458. data/spec/models/sub_merchant_data_spec.rb +2 -2
  459. data/spec/models/{card_verifications_transaction_spec.rb → sub_merchant_split_spec.rb} +10 -10
  460. data/spec/models/transaction_error_response_spec.rb +10 -4
  461. data/spec/models/transaction_origin_spec.rb +2 -2
  462. data/spec/models/transaction_response_spec.rb +10 -4
  463. data/spec/models/transaction_spec.rb +4 -4
  464. data/spec/models/transaction_type_spec.rb +2 -2
  465. data/spec/models/{authentication_request_spec.rb → union_pay_authentication_request_spec.rb} +9 -13
  466. data/spec/models/union_pay_authentication_verification_request_spec.rb +65 -0
  467. data/spec/models/use_payment_token_spec.rb +53 -0
  468. data/spec/models/void_transaction_spec.rb +53 -0
  469. data/spec/spec_helper.rb +2 -2
  470. metadata +195 -42
  471. data/docs/AuthenticationRequest.md +0 -9
  472. data/docs/AuthenticationResponseVerification.md +0 -11
  473. data/docs/AuthenticationResponseVerificationRequest.md +0 -11
  474. data/docs/BasketItem.md +0 -11
  475. data/docs/CardVerificationsTransaction.md +0 -9
  476. data/docs/PaymentCardAuthenticationResult.md +0 -12
  477. data/docs/PaymentTokenization.md +0 -16
  478. data/docs/PrimaryTransactionAdditionalDetails.md +0 -16
  479. data/docs/ReferencedOrder.md +0 -9
  480. data/spec/models/referenced_order_spec.rb +0 -47
  481. data/spec/models/secondary_transaction_additional_details_spec.rb +0 -41
data/docs/ExchangeRateResponse.md CHANGED
@@ -3,19 +3,19 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **client_request_id** | **String** | Echoes back the value in the request header | [optional]
7
- **api_trace_id** | **String** | Echoes back the value in the request header | [optional]
8
- **response_type** | [**ResponseType**](ResponseType.md) | |
9
- **ipg_transaction_id** | **String** | The response transaction ID | [optional]
10
- **request_time** | **String** | Time of the request | [optional]
6
+ **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional]
7
+ **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional]
8
+ **response_type** | [**ResponseType**](ResponseType.md) | | [optional]
9
+ **ipg_transaction_id** | **String** | The response transaction ID. | [optional]
10
+ **request_time** | **String** | Time of the request. | [optional]
11
11
  **inquiry_rate_id** | **String** | Inquiry rate ID. | [optional]
12
- **foreign_currency_code** | **String** | Foreign currency code | [optional]
13
- **foreign_amount** | **String** | Foreign amount | [optional]
14
- **exchange_rate** | **String** | Exchange rate | [optional]
12
+ **foreign_currency** | **String** | Foreign currency in alphabetic ISO 4217 currency code format. | [optional]
13
+ **foreign_amount** | **String** | Foreign amount. | [optional]
14
+ **exchange_rate** | **String** | Exchange rate. | [optional]
15
15
  **dcc_offered** | **String** | Dcc offered. | [optional]
16
- **exchange_rate_source_timestamp** | **String** | Exchange rate source timestamp | [optional]
17
- **expiration_timestamp** | **String** | Expiration timestamp | [optional]
16
+ **exchange_rate_source_timestamp** | **String** | Exchange rate source timestamp. | [optional]
17
+ **expiration_timestamp** | **String** | Expiration timestamp. | [optional]
18
18
  **margin_rate_percentage** | **String** | Margin rate percentage. | [optional]
19
- **exchange_rate_source_name** | **String** | Exchange rate source name | [optional]
19
+ **exchange_rate_source_name** | **String** | Exchange rate source name. | [optional]
20
20
 
21
21
 
data/docs/Expiration.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **month** | **String** | Month of the card expiration date |
7
- **year** | **String** | Year of the card expiration date |
6
+ **month** | **String** | Month of the card expiration date. |
7
+ **year** | **String** | Year of the card expiration date. |
8
8
 
9
9
 
data/docs/FraudDetectApi.md CHANGED
@@ -1,10 +1,10 @@
1
1
  # OpenapiClient::FraudDetectApi
2
2
 
3
- All URIs are relative to *https://cert.api.firstdata.com/gateway*
3
+ All URIs are relative to *https://cert.api.firstdata.com/gateway/v2*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**score_only**](FraudDetectApi.md#score_only) | **POST** /v1/fraud/score-only | Score a transaction for fraud.
7
+ [**score_only**](FraudDetectApi.md#score_only) | **POST** /fraud/score-only | Score a transaction for fraud.
8
8
 
9
9
 
10
10
  # **score_only**
@@ -20,14 +20,14 @@ Use this to obtain a fraud score for a transaction.
20
20
  require 'openapi_client'
21
21
 
22
22
  api_instance = OpenapiClient::FraudDetectApi.new
23
- content_type = 'application/json' # String | content type
23
+ content_type = 'application/json' # String | Content type.
24
24
  client_request_id = 'client_request_id_example' # String | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
25
- api_key = 'api_key_example' # String |
25
+ api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
26
26
  timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
27
- score_only_request = OpenapiClient::ScoreOnlyRequest.new # ScoreOnlyRequest |
27
+ score_only_request = OpenapiClient::ScoreOnlyRequest.new # ScoreOnlyRequest | Accepted request type: ScoreOnlyRequest.
28
28
  opts = {
29
- message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
30
- region: 'region_example' # String | The region where client wants to process the transaction
29
+ message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
30
+ region: 'region_example' # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
31
31
  }
32
32
 
33
33
  begin
@@ -43,13 +43,13 @@ end
43
43
 
44
44
  Name | Type | Description | Notes
45
45
  ------------- | ------------- | ------------- | -------------
46
- **content_type** | **String**| content type | [default to 'application/json']
46
+ **content_type** | **String**| Content type. | [default to 'application/json']
47
47
  **client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
48
- **api_key** | **String**| |
48
+ **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. |
49
49
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
50
- **score_only_request** | [**ScoreOnlyRequest**](ScoreOnlyRequest.md)| |
51
- **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
52
- **region** | **String**| The region where client wants to process the transaction | [optional]
50
+ **score_only_request** | [**ScoreOnlyRequest**](ScoreOnlyRequest.md)| Accepted request type: ScoreOnlyRequest. |
51
+ **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
52
+ **region** | **String**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional]
53
53
 
54
54
  ### Return type
55
55
 
data/docs/FraudOrderItems.md CHANGED
@@ -10,6 +10,6 @@ Name | Type | Description | Notes
10
10
  **unit_price** | **String** | The price per unit. | [optional]
11
11
  **categories** | **String** | The categories that this product belongs to. | [optional]
12
12
  **details_url** | **String** | The URL to the merchant's management system, for reporting and analysis. | [optional]
13
- **user_defined** | [**Object**](.md) | | [optional]
13
+ **user_defined** | [**Object**](.md) | A JSON object that can carry any additional information about the order that might be helpful for fraud detection. | [optional]
14
14
 
15
15
 
data/docs/FraudOrderShipToAddress.md CHANGED
@@ -4,11 +4,11 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **phone** | **String** | Free-form phone number associated with the ship-to address. | [optional]
7
- **address1** | **String** | Street Address 1. This field is required if the parent object is present. | [optional]
8
- **address2** | **String** | Street Address 2. | [optional]
9
- **city** | **String** | City | [optional]
10
- **state** | **String** | State or Province | [optional]
11
- **zip** | **String** | Postal Code, free form. This field is required if the parent object is present. | [optional]
12
- **country** | **String** | Country. This field is required if the parent object is present. | [optional]
7
+ **address1** | **String** | First line of street address. | [optional]
8
+ **address2** | **String** | Second line of street address. | [optional]
9
+ **city** | **String** | City. | [optional]
10
+ **state** | **String** | State or province. | [optional]
11
+ **zip** | **String** | Postal Code, free form. | [optional]
12
+ **country** | **String** | Country. | [optional]
13
13
 
14
14
 
data/docs/Frequency.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **every** | **Integer** | Rate of frequency |
7
- **unit** | **String** | Unit which defines the frequency |
6
+ **every** | **Integer** | Rate of frequency. |
7
+ **unit** | **String** | Unit which defines the frequency. |
8
8
 
9
9
 
data/docs/InstallmentOptions.md CHANGED
@@ -3,8 +3,10 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **number_of_installments** | **Integer** | Number of installments for a Sale transaction if the customer pays the total amount in multiple transactions | [optional]
7
- **installments_interest** | **BOOLEAN** | Indicates whether the installment interest amount has been applied. Possible values are \"yes\" or \"no\". | [optional]
8
- **installment_delay_months** | **Integer** | The number of months the first installment payment will be delayed | [optional]
6
+ **number_of_installments** | **Integer** | Number of installments for a sale transaction if the customer pays the total amount in multiple transactions. | [optional]
7
+ **installments_interest** | **BOOLEAN** | Indicates whether the installment interest amount has been applied. | [optional]
8
+ **installment_delay_months** | **Integer** | The number of months the first installment payment will be delayed. | [optional]
9
+ **recurring_type** | **String** | The type of recurring payment. | [optional]
10
+ **merchant_advice_code_supported** | **BOOLEAN** | Indicates if the merchant supports merchant advice code (MAC) in order to receive table 55 code for a declined recurring transaction. | [optional]
9
11
 
10
12
 
data/docs/Lodging.md CHANGED
@@ -3,10 +3,10 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **arrival_date** | **Date** | Date of arrival | [optional]
7
- **departure_date** | **Date** | Date of departure | [optional]
8
- **folio_number** | **String** | Portfolio number | [optional]
9
- **extra_charges** | [**Array<LodgingExtraCharges>**](LodgingExtraCharges.md) | Information about charges other than base lodging | [optional]
10
- **no_show_indicator** | **BOOLEAN** | Indicates if the transaction is associated with a delayed or no-show penalty | [optional]
6
+ **arrival_date** | **Date** | Date of arrival. | [optional]
7
+ **departure_date** | **Date** | Date of departure. | [optional]
8
+ **folio_number** | **String** | Portfolio number. | [optional]
9
+ **extra_charges** | [**Array<LodgingExtraCharges>**](LodgingExtraCharges.md) | Information about charges other than base lodging. | [optional]
10
+ **no_show_indicator** | **BOOLEAN** | Indicates if the transaction is associated with a delayed or no-show penalty. | [optional]
11
11
 
12
12
 
data/docs/MerchantLocationMerchantAddress.md CHANGED
@@ -3,11 +3,11 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **street** | **String** | Merchant Street Address 1. This field is required if the parent object is present. |
7
- **street2** | **String** | Merchant Street Address 2 | [optional]
8
- **state_province** | **String** | Merchant State | [optional]
9
- **city** | **String** | Merchant City | [optional]
10
- **country** | **String** | Merchant Country. |
11
- **zip_postal_code** | **String** | Merchant Zip Code. |
6
+ **street** | **String** | First line of street address. |
7
+ **street2** | **String** | Second line of street address. | [optional]
8
+ **state_province** | **String** | Merchant state or provinceu. | [optional]
9
+ **city** | **String** | Merchant city. | [optional]
10
+ **country** | **String** | Merchant country. |
11
+ **zip_postal_code** | **String** | Merchant ZIP code. |
12
12
 
13
13
 
data/docs/Order.md CHANGED
@@ -6,5 +6,10 @@ Name | Type | Description | Notes
6
6
  **order_id** | **String** | Client Order ID if supplied by client. | [optional]
7
7
  **billing** | [**Billing**](Billing.md) | | [optional]
8
8
  **shipping** | [**Shipping**](Shipping.md) | | [optional]
9
+ **industry_specific_extensions** | [**IndustrySpecificExtensions**](IndustrySpecificExtensions.md) | | [optional]
10
+ **purchase_card** | [**PurchaseCards**](PurchaseCards.md) | | [optional]
11
+ **installment_options** | [**InstallmentOptions**](InstallmentOptions.md) | | [optional]
12
+ **soft_descriptor** | [**SoftDescriptor**](SoftDescriptor.md) | | [optional]
13
+ **additional_details** | [**AdditionalDetails**](AdditionalDetails.md) | | [optional]
9
14
 
10
15
 
data/docs/OrderApi.md CHANGED
@@ -1,18 +1,17 @@
1
1
  # OpenapiClient::OrderApi
2
2
 
3
- All URIs are relative to *https://cert.api.firstdata.com/gateway*
3
+ All URIs are relative to *https://cert.api.firstdata.com/gateway/v2*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**order_inquiry**](OrderApi.md#order_inquiry) | **GET** /v1/orders/{order-id} | Retrieve the state of an order
8
- [**order_post_auth**](OrderApi.md#order_post_auth) | **POST** /v1/orders/{order-id}/postauth | Capture/complete an already existing order.
9
- [**order_return_transaction**](OrderApi.md#order_return_transaction) | **POST** /v1/orders/{order-id}/return | Return/refund an order.
7
+ [**order_inquiry**](OrderApi.md#order_inquiry) | **GET** /orders/{order-id} | Retrieve the state of an order.
8
+ [**submit_secondary_transaction_from_order**](OrderApi.md#submit_secondary_transaction_from_order) | **POST** /orders/{order-id} | Perform return or postAuth secondary transactions.
10
9
 
11
10
 
12
11
  # **order_inquiry**
13
12
  > OrderResponse order_inquiry(content_type, client_request_id, api_key, timestamp, order_id, opts)
14
13
 
15
- Retrieve the state of an order
14
+ Retrieve the state of an order.
16
15
 
17
16
  Use this query to get the current state of an existing order.
18
17
 
@@ -22,19 +21,19 @@ Use this query to get the current state of an existing order.
22
21
  require 'openapi_client'
23
22
 
24
23
  api_instance = OpenapiClient::OrderApi.new
25
- content_type = 'application/json' # String | content type
24
+ content_type = 'application/json' # String | Content type.
26
25
  client_request_id = 'client_request_id_example' # String | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
27
- api_key = 'api_key_example' # String |
26
+ api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
28
27
  timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
29
- order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId
28
+ order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId.
30
29
  opts = {
31
- message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
32
- region: 'region_example', # String | The region where client wants to process the transaction
33
- store_id: 'store_id_example' # String | An optional outlet ID for clients that support multiple stores in the same developer app
30
+ message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
31
+ region: 'region_example', # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
32
+ store_id: 'store_id_example' # String | An optional outlet ID for clients that support multiple stores in the same developer app.
34
33
  }
35
34
 
36
35
  begin
37
- #Retrieve the state of an order
36
+ #Retrieve the state of an order.
38
37
  result = api_instance.order_inquiry(content_type, client_request_id, api_key, timestamp, order_id, opts)
39
38
  p result
40
39
  rescue OpenapiClient::ApiError => e
@@ -46,14 +45,14 @@ end
46
45
 
47
46
  Name | Type | Description | Notes
48
47
  ------------- | ------------- | ------------- | -------------
49
- **content_type** | **String**| content type | [default to 'application/json']
48
+ **content_type** | **String**| Content type. | [default to 'application/json']
50
49
  **client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
51
- **api_key** | **String**| |
50
+ **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. |
52
51
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
53
- **order_id** | **String**| Gateway order identifier as returned in the parameter orderId |
54
- **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
55
- **region** | **String**| The region where client wants to process the transaction | [optional]
56
- **store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app | [optional]
52
+ **order_id** | **String**| Gateway order identifier as returned in the parameter orderId. |
53
+ **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
54
+ **region** | **String**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional]
55
+ **store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app. | [optional]
57
56
 
58
57
  ### Return type
59
58
 
@@ -70,12 +69,12 @@ No authorization required
70
69
 
71
70
 
72
71
 
73
- # **order_post_auth**
74
- > TransactionResponse order_post_auth(content_type, client_request_id, api_key, timestamp, order_id, secondary_transaction, opts)
72
+ # **submit_secondary_transaction_from_order**
73
+ > TransactionResponse submit_secondary_transaction_from_order(content_type, client_request_id, api_key, timestamp, order_id, secondary_transaction, opts)
75
74
 
76
- Capture/complete an already existing order.
75
+ Perform return or postAuth secondary transactions.
77
76
 
78
- Use this to capture/complete an order. Postauths and partial postauths are allowed.
77
+ Use this to perform a postAuth or return secondary transaction using order ID. Partial postAuths and returns are allowed.
79
78
 
80
79
  ### Example
81
80
  ```ruby
@@ -83,24 +82,23 @@ Use this to capture/complete an order. Postauths and partial postauths are allow
83
82
  require 'openapi_client'
84
83
 
85
84
  api_instance = OpenapiClient::OrderApi.new
86
- content_type = 'application/json' # String | content type
85
+ content_type = 'application/json' # String | Content type.
87
86
  client_request_id = 'client_request_id_example' # String | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
88
- api_key = 'api_key_example' # String |
87
+ api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
89
88
  timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
90
- order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId
91
- secondary_transaction = OpenapiClient::SecondaryTransaction.new # SecondaryTransaction |
89
+ order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId.
90
+ secondary_transaction = OpenapiClient::SecondaryTransaction.new # SecondaryTransaction | Accepted request types: PostAuthTransaction, VoidTransaction, and ReturnTransaction.
92
91
  opts = {
93
- message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
94
- region: 'region_example', # String | The region where client wants to process the transaction
95
- store_id: 'store_id_example' # String | An optional outlet ID for clients that support multiple stores in the same developer app
92
+ message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
93
+ region: 'region_example' # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
96
94
  }
97
95
 
98
96
  begin
99
- #Capture/complete an already existing order.
100
- result = api_instance.order_post_auth(content_type, client_request_id, api_key, timestamp, order_id, secondary_transaction, opts)
97
+ #Perform return or postAuth secondary transactions.
98
+ result = api_instance.submit_secondary_transaction_from_order(content_type, client_request_id, api_key, timestamp, order_id, secondary_transaction, opts)
101
99
  p result
102
100
  rescue OpenapiClient::ApiError => e
103
- puts "Exception when calling OrderApi->order_post_auth: #{e}"
101
+ puts "Exception when calling OrderApi->submit_secondary_transaction_from_order: #{e}"
104
102
  end
105
103
  ```
106
104
 
@@ -108,78 +106,14 @@ end
108
106
 
109
107
  Name | Type | Description | Notes
110
108
  ------------- | ------------- | ------------- | -------------
111
- **content_type** | **String**| content type | [default to 'application/json']
109
+ **content_type** | **String**| Content type. | [default to 'application/json']
112
110
  **client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
113
- **api_key** | **String**| |
111
+ **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. |
114
112
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
115
- **order_id** | **String**| Gateway order identifier as returned in the parameter orderId |
116
- **secondary_transaction** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
117
- **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
118
- **region** | **String**| The region where client wants to process the transaction | [optional]
119
- **store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app | [optional]
120
-
121
- ### Return type
122
-
123
- [**TransactionResponse**](TransactionResponse.md)
124
-
125
- ### Authorization
126
-
127
- No authorization required
128
-
129
- ### HTTP request headers
130
-
131
- - **Content-Type**: application/json
132
- - **Accept**: application/json
133
-
134
-
135
-
136
- # **order_return_transaction**
137
- > TransactionResponse order_return_transaction(content_type, client_request_id, api_key, timestamp, order_id, secondary_transaction, opts)
138
-
139
- Return/refund an order.
140
-
141
- Use this for Returns of an existing order. Partial Returns are allowed.
142
-
143
- ### Example
144
- ```ruby
145
- # load the gem
146
- require 'openapi_client'
147
-
148
- api_instance = OpenapiClient::OrderApi.new
149
- content_type = 'application/json' # String | content type
150
- client_request_id = 'client_request_id_example' # String | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
151
- api_key = 'api_key_example' # String |
152
- timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
153
- order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId
154
- secondary_transaction = OpenapiClient::SecondaryTransaction.new # SecondaryTransaction |
155
- opts = {
156
- message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
157
- region: 'region_example', # String | The region where client wants to process the transaction
158
- store_id: 'store_id_example' # String | An optional outlet ID for clients that support multiple stores in the same developer app
159
- }
160
-
161
- begin
162
- #Return/refund an order.
163
- result = api_instance.order_return_transaction(content_type, client_request_id, api_key, timestamp, order_id, secondary_transaction, opts)
164
- p result
165
- rescue OpenapiClient::ApiError => e
166
- puts "Exception when calling OrderApi->order_return_transaction: #{e}"
167
- end
168
- ```
169
-
170
- ### Parameters
171
-
172
- Name | Type | Description | Notes
173
- ------------- | ------------- | ------------- | -------------
174
- **content_type** | **String**| content type | [default to 'application/json']
175
- **client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
176
- **api_key** | **String**| |
177
- **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
178
- **order_id** | **String**| Gateway order identifier as returned in the parameter orderId |
179
- **secondary_transaction** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
180
- **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
181
- **region** | **String**| The region where client wants to process the transaction | [optional]
182
- **store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app | [optional]
113
+ **order_id** | **String**| Gateway order identifier as returned in the parameter orderId. |
114
+ **secondary_transaction** | [**SecondaryTransaction**](SecondaryTransaction.md)| Accepted request types: PostAuthTransaction, VoidTransaction, and ReturnTransaction. |
115
+ **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
116
+ **region** | **String**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional]
183
117
 
184
118
  ### Return type
185
119
 
data/docs/OrderErrorResponse.md CHANGED
@@ -5,14 +5,13 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional]
7
7
  **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional]
8
- **response_type** | [**ResponseType**](ResponseType.md) | |
9
- **ipg_transaction_id** | **String** | The response transaction ID | [optional]
10
- **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID | [optional]
11
- **transaction_time** | **Integer** | The transaction time in seconds since Epoch | [optional]
8
+ **response_type** | [**ResponseType**](ResponseType.md) | | [optional]
9
+ **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional]
10
+ **transaction_time** | **Integer** | The transaction time in seconds since epoch. | [optional]
12
11
  **billing** | [**Billing**](Billing.md) | | [optional]
13
12
  **shipping** | [**Shipping**](Shipping.md) | | [optional]
14
13
  **mandate** | [**SepaMandate**](SepaMandate.md) | | [optional]
15
- **transactions** | [**Array<Transaction>**](Transaction.md) | Required for some payment methods (for example, Klarna) | [optional]
14
+ **transactions** | [**Array<Transaction>**](Transaction.md) | Required for some payment methods (for example, Klarna). | [optional]
16
15
  **processor** | [**ProcessorData**](ProcessorData.md) | | [optional]
17
16
  **error** | [**Error**](Error.md) | | [optional]
18
17
 
data/docs/OrderResponse.md CHANGED
@@ -5,14 +5,13 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional]
7
7
  **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional]
8
- **response_type** | [**ResponseType**](ResponseType.md) | |
9
- **ipg_transaction_id** | **String** | The response transaction ID | [optional]
10
- **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID | [optional]
11
- **transaction_time** | **Integer** | The transaction time in seconds since Epoch | [optional]
8
+ **response_type** | [**ResponseType**](ResponseType.md) | | [optional]
9
+ **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional]
10
+ **transaction_time** | **Integer** | The transaction time in seconds since epoch. | [optional]
12
11
  **billing** | [**Billing**](Billing.md) | | [optional]
13
12
  **shipping** | [**Shipping**](Shipping.md) | | [optional]
14
13
  **mandate** | [**SepaMandate**](SepaMandate.md) | | [optional]
15
- **transactions** | [**Array<Transaction>**](Transaction.md) | Required for some payment methods (for example, Klarna) | [optional]
14
+ **transactions** | [**Array<Transaction>**](Transaction.md) | Required for some payment methods (for example, Klarna). | [optional]
16
15
  **processor** | [**ProcessorData**](ProcessorData.md) | | [optional]
17
16
 
18
17
 
data/docs/PayPal.md CHANGED
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **recipient_email** | **String** | Email address of the recipient |
6
+ **recipient_email** | **String** | Email address of the recipient. |
7
7
 
8
8
 
data/docs/PayPalPaymentMethod.md ADDED
@@ -0,0 +1,8 @@
1
+ # OpenapiClient::PayPalPaymentMethod
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **pay_pal** | [**PayPal**](PayPal.md) | |
7
+
8
+