paypal-server-sdk 2.2.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (400) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +148 -148
  3. data/lib/paypal_server_sdk/api_helper.rb +10 -10
  4. data/lib/paypal_server_sdk/client.rb +102 -102
  5. data/lib/paypal_server_sdk/configuration.rb +135 -135
  6. data/lib/paypal_server_sdk/controllers/base_controller.rb +58 -58
  7. data/lib/paypal_server_sdk/controllers/o_auth_authorization_controller.rb +42 -42
  8. data/lib/paypal_server_sdk/controllers/orders_controller.rb +551 -551
  9. data/lib/paypal_server_sdk/controllers/payments_controller.rb +462 -462
  10. data/lib/paypal_server_sdk/controllers/subscriptions_controller.rb +843 -843
  11. data/lib/paypal_server_sdk/controllers/transaction_search_controller.rb +178 -178
  12. data/lib/paypal_server_sdk/controllers/vault_controller.rb +224 -224
  13. data/lib/paypal_server_sdk/exceptions/api_exception.rb +21 -21
  14. data/lib/paypal_server_sdk/exceptions/default_error_exception.rb +78 -78
  15. data/lib/paypal_server_sdk/exceptions/error_exception.rb +70 -70
  16. data/lib/paypal_server_sdk/exceptions/o_auth_provider_exception.rb +47 -47
  17. data/lib/paypal_server_sdk/exceptions/search_error_exception.rb +90 -90
  18. data/lib/paypal_server_sdk/exceptions/subscription_error_exception.rb +78 -78
  19. data/lib/paypal_server_sdk/http/api_response.rb +7 -7
  20. data/lib/paypal_server_sdk/http/auth/o_auth2.rb +144 -144
  21. data/lib/paypal_server_sdk/http/http_call_back.rb +10 -10
  22. data/lib/paypal_server_sdk/http/http_method_enum.rb +10 -10
  23. data/lib/paypal_server_sdk/http/http_request.rb +10 -10
  24. data/lib/paypal_server_sdk/http/http_response.rb +10 -10
  25. data/lib/paypal_server_sdk/http/proxy_settings.rb +5 -5
  26. data/lib/paypal_server_sdk/logging/configuration/api_logging_configuration.rb +5 -5
  27. data/lib/paypal_server_sdk/logging/sdk_logger.rb +5 -5
  28. data/lib/paypal_server_sdk/models/activate_subscription_request.rb +63 -63
  29. data/lib/paypal_server_sdk/models/activity_timestamps.rb +79 -79
  30. data/lib/paypal_server_sdk/models/address.rb +132 -131
  31. data/lib/paypal_server_sdk/models/amount_breakdown.rb +132 -132
  32. data/lib/paypal_server_sdk/models/amount_with_breakdown.rb +94 -93
  33. data/lib/paypal_server_sdk/models/app_switch_context.rb +74 -74
  34. data/lib/paypal_server_sdk/models/apple_pay_attributes.rb +73 -73
  35. data/lib/paypal_server_sdk/models/apple_pay_attributes_response.rb +62 -62
  36. data/lib/paypal_server_sdk/models/apple_pay_card.rb +108 -108
  37. data/lib/paypal_server_sdk/models/apple_pay_card_response.rb +210 -209
  38. data/lib/paypal_server_sdk/models/apple_pay_decrypted_token_data.rb +111 -111
  39. data/lib/paypal_server_sdk/models/apple_pay_experience_context.rb +68 -68
  40. data/lib/paypal_server_sdk/models/apple_pay_payment_data.rb +97 -97
  41. data/lib/paypal_server_sdk/models/apple_pay_payment_data_type.rb +36 -36
  42. data/lib/paypal_server_sdk/models/apple_pay_payment_object.rb +150 -150
  43. data/lib/paypal_server_sdk/models/apple_pay_payment_token.rb +63 -63
  44. data/lib/paypal_server_sdk/models/apple_pay_request.rb +165 -165
  45. data/lib/paypal_server_sdk/models/apple_pay_request_card.rb +88 -88
  46. data/lib/paypal_server_sdk/models/apple_pay_tokenized_card.rb +127 -127
  47. data/lib/paypal_server_sdk/models/application_context_user_action.rb +37 -37
  48. data/lib/paypal_server_sdk/models/assurance_details.rb +82 -82
  49. data/lib/paypal_server_sdk/models/auction_information.rb +100 -100
  50. data/lib/paypal_server_sdk/models/authentication_response.rb +74 -74
  51. data/lib/paypal_server_sdk/models/authorization.rb +211 -211
  52. data/lib/paypal_server_sdk/models/authorization_incomplete_reason.rb +31 -31
  53. data/lib/paypal_server_sdk/models/authorization_status.rb +54 -54
  54. data/lib/paypal_server_sdk/models/authorization_status_details.rb +62 -62
  55. data/lib/paypal_server_sdk/models/authorization_status_with_details.rb +72 -72
  56. data/lib/paypal_server_sdk/models/authorization_with_additional_data.rb +225 -225
  57. data/lib/paypal_server_sdk/models/avs_code.rb +152 -152
  58. data/lib/paypal_server_sdk/models/balance_information.rb +106 -106
  59. data/lib/paypal_server_sdk/models/balances_response.rb +111 -111
  60. data/lib/paypal_server_sdk/models/bancontact_payment_object.rb +110 -109
  61. data/lib/paypal_server_sdk/models/bancontact_payment_request.rb +87 -86
  62. data/lib/paypal_server_sdk/models/bank_request.rb +71 -71
  63. data/lib/paypal_server_sdk/models/base_model.rb +110 -110
  64. data/lib/paypal_server_sdk/models/billing_cycle.rb +129 -118
  65. data/lib/paypal_server_sdk/models/billing_cycle_override.rb +91 -91
  66. data/lib/paypal_server_sdk/models/billing_plan.rb +212 -212
  67. data/lib/paypal_server_sdk/models/bin_details.rb +102 -101
  68. data/lib/paypal_server_sdk/models/blik_experience_context.rb +142 -141
  69. data/lib/paypal_server_sdk/models/blik_level0_payment_object.rb +60 -60
  70. data/lib/paypal_server_sdk/models/blik_one_click_payment_object.rb +64 -64
  71. data/lib/paypal_server_sdk/models/blik_one_click_payment_request.rb +97 -97
  72. data/lib/paypal_server_sdk/models/blik_payment_object.rb +99 -98
  73. data/lib/paypal_server_sdk/models/blik_payment_request.rb +120 -119
  74. data/lib/paypal_server_sdk/models/callback_configuration.rb +74 -74
  75. data/lib/paypal_server_sdk/models/callback_events.rb +35 -35
  76. data/lib/paypal_server_sdk/models/cancel_subscription_request.rb +60 -60
  77. data/lib/paypal_server_sdk/models/capture_incomplete_reason.rb +82 -82
  78. data/lib/paypal_server_sdk/models/capture_payment_instruction.rb +104 -104
  79. data/lib/paypal_server_sdk/models/capture_request.rb +126 -126
  80. data/lib/paypal_server_sdk/models/capture_status.rb +52 -52
  81. data/lib/paypal_server_sdk/models/capture_status_details.rb +62 -62
  82. data/lib/paypal_server_sdk/models/capture_status_with_details.rb +72 -72
  83. data/lib/paypal_server_sdk/models/capture_subscription_request.rb +78 -78
  84. data/lib/paypal_server_sdk/models/capture_type.rb +24 -24
  85. data/lib/paypal_server_sdk/models/captured_payment.rb +274 -274
  86. data/lib/paypal_server_sdk/models/card_attributes.rb +83 -83
  87. data/lib/paypal_server_sdk/models/card_attributes_response.rb +62 -62
  88. data/lib/paypal_server_sdk/models/card_authentication_response.rb +63 -63
  89. data/lib/paypal_server_sdk/models/card_brand.rb +149 -149
  90. data/lib/paypal_server_sdk/models/card_customer.rb +98 -98
  91. data/lib/paypal_server_sdk/models/card_customer_information.rb +108 -108
  92. data/lib/paypal_server_sdk/models/card_experience_context.rb +71 -71
  93. data/lib/paypal_server_sdk/models/card_from_request.rb +72 -72
  94. data/lib/paypal_server_sdk/models/card_payment_token_entity.rb +178 -178
  95. data/lib/paypal_server_sdk/models/card_request.rb +191 -191
  96. data/lib/paypal_server_sdk/models/card_response.rb +180 -180
  97. data/lib/paypal_server_sdk/models/card_response_address.rb +137 -136
  98. data/lib/paypal_server_sdk/models/card_response_with_billing_address.rb +101 -100
  99. data/lib/paypal_server_sdk/models/card_stored_credential.rb +111 -111
  100. data/lib/paypal_server_sdk/models/card_supplementary_data.rb +79 -79
  101. data/lib/paypal_server_sdk/models/card_type.rb +44 -44
  102. data/lib/paypal_server_sdk/models/card_vault_response.rb +99 -99
  103. data/lib/paypal_server_sdk/models/card_verification.rb +64 -64
  104. data/lib/paypal_server_sdk/models/card_verification_details.rb +140 -140
  105. data/lib/paypal_server_sdk/models/card_verification_processor_response.rb +74 -74
  106. data/lib/paypal_server_sdk/models/card_verification_status.rb +31 -31
  107. data/lib/paypal_server_sdk/models/cart_information.rb +94 -94
  108. data/lib/paypal_server_sdk/models/checkout_option.rb +77 -77
  109. data/lib/paypal_server_sdk/models/checkout_payment_intent.rb +40 -40
  110. data/lib/paypal_server_sdk/models/cobranded_card.rb +83 -83
  111. data/lib/paypal_server_sdk/models/confirm_order_request.rb +85 -74
  112. data/lib/paypal_server_sdk/models/create_subscription_request.rb +151 -151
  113. data/lib/paypal_server_sdk/models/customer.rb +76 -76
  114. data/lib/paypal_server_sdk/models/customer_information.rb +95 -95
  115. data/lib/paypal_server_sdk/models/customer_response.rb +75 -75
  116. data/lib/paypal_server_sdk/models/customer_vault_payment_tokens_response.rb +123 -122
  117. data/lib/paypal_server_sdk/models/cvv_code.rb +89 -89
  118. data/lib/paypal_server_sdk/models/cycle_execution.rb +124 -124
  119. data/lib/paypal_server_sdk/models/cycle_frequency.rb +72 -0
  120. data/lib/paypal_server_sdk/models/disbursement_mode.rb +34 -34
  121. data/lib/paypal_server_sdk/models/dispute_category.rb +31 -31
  122. data/lib/paypal_server_sdk/models/eci_flag.rb +50 -50
  123. data/lib/paypal_server_sdk/models/enrollment_status.rb +43 -43
  124. data/lib/paypal_server_sdk/models/eps_payment_object.rb +87 -86
  125. data/lib/paypal_server_sdk/models/eps_payment_request.rb +87 -86
  126. data/lib/paypal_server_sdk/models/error_details.rb +125 -125
  127. data/lib/paypal_server_sdk/models/exchange_rate.rb +91 -89
  128. data/lib/paypal_server_sdk/models/experience_context.rb +116 -115
  129. data/lib/paypal_server_sdk/models/experience_context_shipping_preference.rb +41 -41
  130. data/lib/paypal_server_sdk/models/experience_status.rb +44 -44
  131. data/lib/paypal_server_sdk/models/failed_payment_details.rb +98 -98
  132. data/lib/paypal_server_sdk/models/frequency.rb +75 -75
  133. data/lib/paypal_server_sdk/models/frequency_interval_unit.rb +48 -0
  134. data/lib/paypal_server_sdk/models/fulfillment_type.rb +47 -47
  135. data/lib/paypal_server_sdk/models/giropay_payment_object.rb +87 -86
  136. data/lib/paypal_server_sdk/models/giropay_payment_request.rb +87 -86
  137. data/lib/paypal_server_sdk/models/google_pay_authentication_method.rb +37 -37
  138. data/lib/paypal_server_sdk/models/google_pay_card.rb +128 -128
  139. data/lib/paypal_server_sdk/models/google_pay_card_response.rb +120 -120
  140. data/lib/paypal_server_sdk/models/google_pay_decrypted_token_data.rb +131 -131
  141. data/lib/paypal_server_sdk/models/google_pay_experience_context.rb +68 -68
  142. data/lib/paypal_server_sdk/models/google_pay_payment_method.rb +24 -24
  143. data/lib/paypal_server_sdk/models/google_pay_request.rb +136 -136
  144. data/lib/paypal_server_sdk/models/google_pay_request_card.rb +98 -98
  145. data/lib/paypal_server_sdk/models/google_pay_wallet_response.rb +98 -98
  146. data/lib/paypal_server_sdk/models/ideal_payment_object.rb +99 -98
  147. data/lib/paypal_server_sdk/models/ideal_payment_request.rb +97 -96
  148. data/lib/paypal_server_sdk/models/incentive_details.rb +99 -99
  149. data/lib/paypal_server_sdk/models/incentive_information.rb +71 -71
  150. data/lib/paypal_server_sdk/models/interval_unit.rb +40 -40
  151. data/lib/paypal_server_sdk/models/item.rb +161 -161
  152. data/lib/paypal_server_sdk/models/item_category.rb +38 -38
  153. data/lib/paypal_server_sdk/models/item_details.rb +287 -287
  154. data/lib/paypal_server_sdk/models/item_request.rb +163 -163
  155. data/lib/paypal_server_sdk/models/last_payment_details.rb +75 -75
  156. data/lib/paypal_server_sdk/models/level2_card_processing_data.rb +78 -78
  157. data/lib/paypal_server_sdk/models/level3_card_processing_data.rb +137 -137
  158. data/lib/paypal_server_sdk/models/liability_shift_indicator.rb +35 -35
  159. data/lib/paypal_server_sdk/models/line_item.rb +209 -209
  160. data/lib/paypal_server_sdk/models/link_description.rb +92 -87
  161. data/lib/paypal_server_sdk/models/link_http_method.rb +56 -56
  162. data/lib/paypal_server_sdk/models/merchant_preferences.rb +73 -73
  163. data/lib/paypal_server_sdk/models/mobile_return_flow.rb +36 -36
  164. data/lib/paypal_server_sdk/models/mobile_web_context.rb +76 -76
  165. data/lib/paypal_server_sdk/models/modify_subscription_request.rb +124 -124
  166. data/lib/paypal_server_sdk/models/modify_subscription_response.rb +141 -141
  167. data/lib/paypal_server_sdk/models/money.rb +75 -74
  168. data/lib/paypal_server_sdk/models/mybank_payment_object.rb +99 -98
  169. data/lib/paypal_server_sdk/models/mybank_payment_request.rb +87 -86
  170. data/lib/paypal_server_sdk/models/name.rb +73 -73
  171. data/lib/paypal_server_sdk/models/native_app_context.rb +72 -72
  172. data/lib/paypal_server_sdk/models/net_amount_breakdown_item.rb +87 -87
  173. data/lib/paypal_server_sdk/models/network_token.rb +110 -110
  174. data/lib/paypal_server_sdk/models/network_transaction.rb +107 -107
  175. data/lib/paypal_server_sdk/models/network_transaction_reference_entity.rb +100 -100
  176. data/lib/paypal_server_sdk/models/o_auth_provider_error.rb +58 -58
  177. data/lib/paypal_server_sdk/models/o_auth_token.rb +106 -106
  178. data/lib/paypal_server_sdk/models/one_time_charge.rb +118 -118
  179. data/lib/paypal_server_sdk/models/order.rb +197 -184
  180. data/lib/paypal_server_sdk/models/order_application_context.rb +219 -219
  181. data/lib/paypal_server_sdk/models/order_application_context_landing_page.rb +48 -48
  182. data/lib/paypal_server_sdk/models/order_application_context_shipping_preference.rb +45 -45
  183. data/lib/paypal_server_sdk/models/order_application_context_user_action.rb +42 -42
  184. data/lib/paypal_server_sdk/models/order_authorize_request.rb +63 -63
  185. data/lib/paypal_server_sdk/models/order_authorize_request_payment_source.rb +115 -115
  186. data/lib/paypal_server_sdk/models/order_authorize_response.rb +194 -181
  187. data/lib/paypal_server_sdk/models/order_authorize_response_payment_source.rb +102 -102
  188. data/lib/paypal_server_sdk/models/order_billing_plan.rb +93 -93
  189. data/lib/paypal_server_sdk/models/order_capture_request.rb +63 -63
  190. data/lib/paypal_server_sdk/models/order_capture_request_payment_source.rb +115 -115
  191. data/lib/paypal_server_sdk/models/order_confirm_application_context.rb +123 -122
  192. data/lib/paypal_server_sdk/models/order_request.rb +132 -120
  193. data/lib/paypal_server_sdk/models/order_status.rb +60 -60
  194. data/lib/paypal_server_sdk/models/order_tracker_item.rb +114 -114
  195. data/lib/paypal_server_sdk/models/order_tracker_request.rb +133 -133
  196. data/lib/paypal_server_sdk/models/order_tracker_response.rb +135 -135
  197. data/lib/paypal_server_sdk/models/order_tracker_status.rb +34 -34
  198. data/lib/paypal_server_sdk/models/orders_capture.rb +252 -252
  199. data/lib/paypal_server_sdk/models/orders_card_verification_method.rb +61 -61
  200. data/lib/paypal_server_sdk/models/os_type.rb +35 -35
  201. data/lib/paypal_server_sdk/models/p24_payment_object.rb +123 -122
  202. data/lib/paypal_server_sdk/models/p24_payment_request.rb +98 -97
  203. data/lib/paypal_server_sdk/models/pa_res_status.rb +57 -57
  204. data/lib/paypal_server_sdk/models/participant_metadata.rb +64 -64
  205. data/lib/paypal_server_sdk/models/patch.rb +93 -93
  206. data/lib/paypal_server_sdk/models/patch_op.rb +84 -84
  207. data/lib/paypal_server_sdk/models/payee_base.rb +76 -76
  208. data/lib/paypal_server_sdk/models/payee_payment_method_preference.rb +33 -33
  209. data/lib/paypal_server_sdk/models/payer.rb +136 -136
  210. data/lib/paypal_server_sdk/models/payer_base.rb +75 -75
  211. data/lib/paypal_server_sdk/models/payer_information.rb +146 -146
  212. data/lib/paypal_server_sdk/models/payer_name.rb +128 -128
  213. data/lib/paypal_server_sdk/models/payment_advice_code.rb +97 -97
  214. data/lib/paypal_server_sdk/models/payment_authorization.rb +233 -233
  215. data/lib/paypal_server_sdk/models/payment_collection.rb +113 -113
  216. data/lib/paypal_server_sdk/models/payment_initiator.rb +34 -34
  217. data/lib/paypal_server_sdk/models/payment_instruction.rb +121 -121
  218. data/lib/paypal_server_sdk/models/payment_method.rb +63 -63
  219. data/lib/paypal_server_sdk/models/payment_method_preference.rb +86 -86
  220. data/lib/paypal_server_sdk/models/payment_preferences.rb +105 -105
  221. data/lib/paypal_server_sdk/models/payment_preferences_override.rb +107 -107
  222. data/lib/paypal_server_sdk/models/payment_source.rb +203 -203
  223. data/lib/paypal_server_sdk/models/payment_source_response.rb +190 -190
  224. data/lib/paypal_server_sdk/models/payment_supplementary_data.rb +62 -62
  225. data/lib/paypal_server_sdk/models/payment_token_request.rb +74 -74
  226. data/lib/paypal_server_sdk/models/payment_token_request_card.rb +120 -120
  227. data/lib/paypal_server_sdk/models/payment_token_request_payment_source.rb +71 -71
  228. data/lib/paypal_server_sdk/models/payment_token_response.rb +104 -103
  229. data/lib/paypal_server_sdk/models/payment_token_response_payment_source.rb +91 -91
  230. data/lib/paypal_server_sdk/models/payment_token_status.rb +48 -48
  231. data/lib/paypal_server_sdk/models/payments_capture.rb +252 -252
  232. data/lib/paypal_server_sdk/models/paypal_experience_landing_page.rb +52 -52
  233. data/lib/paypal_server_sdk/models/paypal_experience_user_action.rb +37 -37
  234. data/lib/paypal_server_sdk/models/paypal_payment_token.rb +211 -211
  235. data/lib/paypal_server_sdk/models/paypal_payment_token_customer_type.rb +37 -37
  236. data/lib/paypal_server_sdk/models/paypal_payment_token_usage_type.rb +35 -35
  237. data/lib/paypal_server_sdk/models/paypal_reference_id_type.rb +40 -40
  238. data/lib/paypal_server_sdk/models/paypal_wallet.rb +188 -188
  239. data/lib/paypal_server_sdk/models/paypal_wallet_account_verification_status.rb +36 -36
  240. data/lib/paypal_server_sdk/models/paypal_wallet_attributes.rb +71 -71
  241. data/lib/paypal_server_sdk/models/paypal_wallet_attributes_response.rb +82 -82
  242. data/lib/paypal_server_sdk/models/paypal_wallet_contact_preference.rb +43 -43
  243. data/lib/paypal_server_sdk/models/paypal_wallet_context_shipping_preference.rb +40 -40
  244. data/lib/paypal_server_sdk/models/paypal_wallet_customer.rb +108 -108
  245. data/lib/paypal_server_sdk/models/paypal_wallet_customer_request.rb +108 -108
  246. data/lib/paypal_server_sdk/models/paypal_wallet_experience_context.rb +201 -200
  247. data/lib/paypal_server_sdk/models/paypal_wallet_response.rb +213 -213
  248. data/lib/paypal_server_sdk/models/paypal_wallet_stored_credential.rb +99 -99
  249. data/lib/paypal_server_sdk/models/paypal_wallet_vault_base.rb +134 -134
  250. data/lib/paypal_server_sdk/models/paypal_wallet_vault_instruction.rb +132 -132
  251. data/lib/paypal_server_sdk/models/paypal_wallet_vault_response.rb +99 -99
  252. data/lib/paypal_server_sdk/models/paypal_wallet_vault_status.rb +40 -40
  253. data/lib/paypal_server_sdk/models/phone.rb +91 -91
  254. data/lib/paypal_server_sdk/models/phone_number.rb +68 -68
  255. data/lib/paypal_server_sdk/models/phone_number_with_country_code.rb +83 -83
  256. data/lib/paypal_server_sdk/models/phone_number_with_optional_country_code.rb +81 -81
  257. data/lib/paypal_server_sdk/models/phone_type.rb +44 -44
  258. data/lib/paypal_server_sdk/models/phone_with_type.rb +72 -72
  259. data/lib/paypal_server_sdk/models/plan.rb +92 -92
  260. data/lib/paypal_server_sdk/models/plan_collection.rb +111 -111
  261. data/lib/paypal_server_sdk/models/plan_details.rb +147 -147
  262. data/lib/paypal_server_sdk/models/plan_override.rb +96 -96
  263. data/lib/paypal_server_sdk/models/plan_request.rb +154 -154
  264. data/lib/paypal_server_sdk/models/plan_request_status.rb +37 -37
  265. data/lib/paypal_server_sdk/models/platform_fee.rb +75 -75
  266. data/lib/paypal_server_sdk/models/pricing_model.rb +37 -37
  267. data/lib/paypal_server_sdk/models/pricing_scheme.rb +84 -84
  268. data/lib/paypal_server_sdk/models/pricing_tier.rb +83 -83
  269. data/lib/paypal_server_sdk/models/processing_instruction.rb +33 -0
  270. data/lib/paypal_server_sdk/models/processor_response.rb +98 -98
  271. data/lib/paypal_server_sdk/models/processor_response_code.rb +644 -644
  272. data/lib/paypal_server_sdk/models/purchase_unit.rb +245 -245
  273. data/lib/paypal_server_sdk/models/purchase_unit_request.rb +219 -219
  274. data/lib/paypal_server_sdk/models/reason_code.rb +56 -56
  275. data/lib/paypal_server_sdk/models/reauthorize_request.rb +72 -72
  276. data/lib/paypal_server_sdk/models/refund.rb +214 -214
  277. data/lib/paypal_server_sdk/models/refund_incomplete_reason.rb +25 -25
  278. data/lib/paypal_server_sdk/models/refund_payment_instruction.rb +80 -80
  279. data/lib/paypal_server_sdk/models/refund_platform_fee.rb +64 -64
  280. data/lib/paypal_server_sdk/models/refund_request.rb +115 -115
  281. data/lib/paypal_server_sdk/models/refund_status.rb +40 -40
  282. data/lib/paypal_server_sdk/models/refund_status_details.rb +62 -62
  283. data/lib/paypal_server_sdk/models/refund_status_with_details.rb +72 -72
  284. data/lib/paypal_server_sdk/models/related_identifiers.rb +83 -83
  285. data/lib/paypal_server_sdk/models/return_flow.rb +36 -36
  286. data/lib/paypal_server_sdk/models/risk_supplementary_data.rb +63 -63
  287. data/lib/paypal_server_sdk/models/search_response.rb +176 -176
  288. data/lib/paypal_server_sdk/models/seller_payable_breakdown.rb +177 -177
  289. data/lib/paypal_server_sdk/models/seller_protection.rb +78 -78
  290. data/lib/paypal_server_sdk/models/seller_protection_status.rb +41 -41
  291. data/lib/paypal_server_sdk/models/seller_receivable_breakdown.rb +147 -147
  292. data/lib/paypal_server_sdk/models/sepa_debit_experience_context.rb +89 -88
  293. data/lib/paypal_server_sdk/models/sepa_debit_request.rb +64 -64
  294. data/lib/paypal_server_sdk/models/setup_fee_failure_action.rb +32 -32
  295. data/lib/paypal_server_sdk/models/setup_token_request.rb +74 -74
  296. data/lib/paypal_server_sdk/models/setup_token_request_card.rb +143 -143
  297. data/lib/paypal_server_sdk/models/setup_token_request_payment_source.rb +111 -111
  298. data/lib/paypal_server_sdk/models/setup_token_response.rb +116 -115
  299. data/lib/paypal_server_sdk/models/setup_token_response_card.rb +178 -178
  300. data/lib/paypal_server_sdk/models/setup_token_response_payment_source.rb +81 -81
  301. data/lib/paypal_server_sdk/models/shipment_carrier.rb +5682 -5682
  302. data/lib/paypal_server_sdk/models/shipping_details.rb +133 -133
  303. data/lib/paypal_server_sdk/models/shipping_information.rb +101 -101
  304. data/lib/paypal_server_sdk/models/shipping_name.rb +62 -62
  305. data/lib/paypal_server_sdk/models/shipping_option.rb +108 -108
  306. data/lib/paypal_server_sdk/models/shipping_type.rb +48 -48
  307. data/lib/paypal_server_sdk/models/shipping_with_tracking_details.rb +152 -152
  308. data/lib/paypal_server_sdk/models/simple_postal_address_coarse_grained.rb +130 -130
  309. data/lib/paypal_server_sdk/models/sofort_payment_object.rb +99 -98
  310. data/lib/paypal_server_sdk/models/sofort_payment_request.rb +87 -86
  311. data/lib/paypal_server_sdk/models/standard_entry_class_code.rb +55 -55
  312. data/lib/paypal_server_sdk/models/store_in_vault_instruction.rb +25 -25
  313. data/lib/paypal_server_sdk/models/store_information.rb +71 -71
  314. data/lib/paypal_server_sdk/models/stored_payment_source.rb +111 -111
  315. data/lib/paypal_server_sdk/models/stored_payment_source_payment_type.rb +38 -38
  316. data/lib/paypal_server_sdk/models/stored_payment_source_usage_type.rb +39 -39
  317. data/lib/paypal_server_sdk/models/subscriber.rb +107 -107
  318. data/lib/paypal_server_sdk/models/subscriber_request.rb +120 -120
  319. data/lib/paypal_server_sdk/models/subscription.rb +241 -205
  320. data/lib/paypal_server_sdk/models/subscription_amount_with_breakdown.rb +119 -119
  321. data/lib/paypal_server_sdk/models/subscription_application_context.rb +134 -134
  322. data/lib/paypal_server_sdk/models/subscription_billing_cycle.rb +108 -108
  323. data/lib/paypal_server_sdk/models/subscription_billing_information.rb +148 -148
  324. data/lib/paypal_server_sdk/models/subscription_card_request.rb +141 -141
  325. data/lib/paypal_server_sdk/models/subscription_collection.rb +90 -90
  326. data/lib/paypal_server_sdk/models/subscription_customer_information.rb +84 -84
  327. data/lib/paypal_server_sdk/models/subscription_patch_application_context.rb +122 -122
  328. data/lib/paypal_server_sdk/models/subscription_payer.rb +85 -85
  329. data/lib/paypal_server_sdk/models/subscription_payer_name.rb +114 -114
  330. data/lib/paypal_server_sdk/models/subscription_payment_source.rb +65 -65
  331. data/lib/paypal_server_sdk/models/subscription_payment_source_response.rb +63 -63
  332. data/lib/paypal_server_sdk/models/subscription_plan_status.rb +37 -37
  333. data/lib/paypal_server_sdk/models/subscription_pricing_model.rb +31 -31
  334. data/lib/paypal_server_sdk/models/subscription_pricing_scheme.rb +129 -129
  335. data/lib/paypal_server_sdk/models/subscription_status.rb +52 -0
  336. data/lib/paypal_server_sdk/models/subscription_transaction_details.rb +118 -118
  337. data/lib/paypal_server_sdk/models/subscriptions_card_attributes.rb +83 -83
  338. data/lib/paypal_server_sdk/models/subscriptions_card_brand.rb +129 -129
  339. data/lib/paypal_server_sdk/models/supplementary_data.rb +76 -76
  340. data/lib/paypal_server_sdk/models/suspend_subscription.rb +60 -60
  341. data/lib/paypal_server_sdk/models/tax_amount.rb +63 -63
  342. data/lib/paypal_server_sdk/models/tax_id_type.rb +31 -31
  343. data/lib/paypal_server_sdk/models/tax_info.rb +69 -69
  344. data/lib/paypal_server_sdk/models/taxes.rb +71 -71
  345. data/lib/paypal_server_sdk/models/taxes_override.rb +72 -72
  346. data/lib/paypal_server_sdk/models/tenure_type.rb +38 -38
  347. data/lib/paypal_server_sdk/models/three_d_secure_authentication_response.rb +76 -76
  348. data/lib/paypal_server_sdk/models/three_d_secure_card_authentication_response.rb +89 -89
  349. data/lib/paypal_server_sdk/models/token.rb +68 -68
  350. data/lib/paypal_server_sdk/models/token_type.rb +25 -25
  351. data/lib/paypal_server_sdk/models/transaction_details.rb +126 -126
  352. data/lib/paypal_server_sdk/models/transaction_information.rb +494 -494
  353. data/lib/paypal_server_sdk/models/transaction_search_error_details.rb +103 -103
  354. data/lib/paypal_server_sdk/models/transactions_list.rb +111 -111
  355. data/lib/paypal_server_sdk/models/trustly_payment_object.rb +111 -110
  356. data/lib/paypal_server_sdk/models/trustly_payment_request.rb +98 -97
  357. data/lib/paypal_server_sdk/models/universal_product_code.rb +68 -68
  358. data/lib/paypal_server_sdk/models/upc_type.rb +52 -52
  359. data/lib/paypal_server_sdk/models/update_pricing_scheme.rb +72 -72
  360. data/lib/paypal_server_sdk/models/update_pricing_schemes_request.rb +69 -69
  361. data/lib/paypal_server_sdk/models/usage_pattern.rb +91 -91
  362. data/lib/paypal_server_sdk/models/usage_type.rb +34 -34
  363. data/lib/paypal_server_sdk/models/vault_apple_pay_request.rb +73 -73
  364. data/lib/paypal_server_sdk/models/vault_card_experience_context.rb +129 -128
  365. data/lib/paypal_server_sdk/models/vault_card_verification_method.rb +47 -47
  366. data/lib/paypal_server_sdk/models/vault_customer.rb +72 -72
  367. data/lib/paypal_server_sdk/models/vault_experience_context.rb +155 -154
  368. data/lib/paypal_server_sdk/models/vault_instruction.rb +62 -62
  369. data/lib/paypal_server_sdk/models/vault_instruction_action.rb +34 -34
  370. data/lib/paypal_server_sdk/models/vault_instruction_base.rb +64 -64
  371. data/lib/paypal_server_sdk/models/vault_paypal_wallet_request.rb +154 -154
  372. data/lib/paypal_server_sdk/models/vault_response.rb +100 -100
  373. data/lib/paypal_server_sdk/models/vault_response_customer.rb +86 -86
  374. data/lib/paypal_server_sdk/models/vault_status.rb +40 -40
  375. data/lib/paypal_server_sdk/models/vault_token_request.rb +68 -68
  376. data/lib/paypal_server_sdk/models/vault_token_request_type.rb +24 -24
  377. data/lib/paypal_server_sdk/models/vault_user_action.rb +37 -37
  378. data/lib/paypal_server_sdk/models/vault_venmo_request.rb +143 -143
  379. data/lib/paypal_server_sdk/models/vaulted_digital_wallet.rb +132 -132
  380. data/lib/paypal_server_sdk/models/vaulted_digital_wallet_shipping_details.rb +114 -114
  381. data/lib/paypal_server_sdk/models/venmo_experience_context.rb +101 -101
  382. data/lib/paypal_server_sdk/models/venmo_payment_token.rb +199 -199
  383. data/lib/paypal_server_sdk/models/venmo_payment_token_customer_type.rb +35 -35
  384. data/lib/paypal_server_sdk/models/venmo_payment_token_usage_pattern.rb +54 -54
  385. data/lib/paypal_server_sdk/models/venmo_payment_token_usage_type.rb +34 -34
  386. data/lib/paypal_server_sdk/models/venmo_vault_response.rb +100 -100
  387. data/lib/paypal_server_sdk/models/venmo_vault_response_status.rb +40 -40
  388. data/lib/paypal_server_sdk/models/venmo_wallet_additional_attributes.rb +72 -72
  389. data/lib/paypal_server_sdk/models/venmo_wallet_attributes_response.rb +62 -62
  390. data/lib/paypal_server_sdk/models/venmo_wallet_customer_information.rb +94 -94
  391. data/lib/paypal_server_sdk/models/venmo_wallet_experience_context.rb +108 -108
  392. data/lib/paypal_server_sdk/models/venmo_wallet_experience_context_shipping_preference.rb +38 -38
  393. data/lib/paypal_server_sdk/models/venmo_wallet_experience_context_user_action.rb +37 -37
  394. data/lib/paypal_server_sdk/models/venmo_wallet_request.rb +102 -102
  395. data/lib/paypal_server_sdk/models/venmo_wallet_response.rb +146 -146
  396. data/lib/paypal_server_sdk/models/venmo_wallet_vault_attributes.rb +131 -131
  397. data/lib/paypal_server_sdk/utilities/date_time_helper.rb +11 -11
  398. data/lib/paypal_server_sdk/utilities/file_wrapper.rb +17 -17
  399. data/lib/paypal_server_sdk.rb +440 -436
  400. metadata +6 -2
@@ -1,113 +1,113 @@
1
- # paypal_server_sdk
2
- #
3
- # This file was automatically generated by APIMATIC v3.0
4
- # ( https://www.apimatic.io ).
5
-
6
- module PaypalServerSdk
7
- # The collection of payments, or transactions, for a purchase unit in an
8
- # order. For example, authorized payments, captured payments, and refunds.
9
- class PaymentCollection < BaseModel
10
- SKIP = Object.new
11
- private_constant :SKIP
12
-
13
- # An array of authorized payments for a purchase unit. A purchase unit can
14
- # have zero or more authorized payments.
15
- # @return [Array[AuthorizationWithAdditionalData]]
16
- attr_accessor :authorizations
17
-
18
- # An array of captured payments for a purchase unit. A purchase unit can
19
- # have zero or more captured payments.
20
- # @return [Array[OrdersCapture]]
21
- attr_accessor :captures
22
-
23
- # An array of refunds for a purchase unit. A purchase unit can have zero or
24
- # more refunds.
25
- # @return [Array[Refund]]
26
- attr_accessor :refunds
27
-
28
- # A mapping from model property names to API property names.
29
- def self.names
30
- @_hash = {} if @_hash.nil?
31
- @_hash['authorizations'] = 'authorizations'
32
- @_hash['captures'] = 'captures'
33
- @_hash['refunds'] = 'refunds'
34
- @_hash
35
- end
36
-
37
- # An array for optional fields
38
- def self.optionals
39
- %w[
40
- authorizations
41
- captures
42
- refunds
43
- ]
44
- end
45
-
46
- # An array for nullable fields
47
- def self.nullables
48
- []
49
- end
50
-
51
- def initialize(authorizations: SKIP, captures: SKIP, refunds: SKIP)
52
- @authorizations = authorizations unless authorizations == SKIP
53
- @captures = captures unless captures == SKIP
54
- @refunds = refunds unless refunds == SKIP
55
- end
56
-
57
- # Creates an instance of the object from a hash.
58
- def self.from_hash(hash)
59
- return nil unless hash
60
-
61
- # Extract variables from the hash.
62
- # Parameter is an array, so we need to iterate through it
63
- authorizations = nil
64
- unless hash['authorizations'].nil?
65
- authorizations = []
66
- hash['authorizations'].each do |structure|
67
- authorizations << (AuthorizationWithAdditionalData.from_hash(structure) if structure)
68
- end
69
- end
70
-
71
- authorizations = SKIP unless hash.key?('authorizations')
72
- # Parameter is an array, so we need to iterate through it
73
- captures = nil
74
- unless hash['captures'].nil?
75
- captures = []
76
- hash['captures'].each do |structure|
77
- captures << (OrdersCapture.from_hash(structure) if structure)
78
- end
79
- end
80
-
81
- captures = SKIP unless hash.key?('captures')
82
- # Parameter is an array, so we need to iterate through it
83
- refunds = nil
84
- unless hash['refunds'].nil?
85
- refunds = []
86
- hash['refunds'].each do |structure|
87
- refunds << (Refund.from_hash(structure) if structure)
88
- end
89
- end
90
-
91
- refunds = SKIP unless hash.key?('refunds')
92
-
93
- # Create object from extracted values.
94
- PaymentCollection.new(authorizations: authorizations,
95
- captures: captures,
96
- refunds: refunds)
97
- end
98
-
99
- # Provides a human-readable string representation of the object.
100
- def to_s
101
- class_name = self.class.name.split('::').last
102
- "<#{class_name} authorizations: #{@authorizations}, captures: #{@captures}, refunds:"\
103
- " #{@refunds}>"
104
- end
105
-
106
- # Provides a debugging-friendly string with detailed object information.
107
- def inspect
108
- class_name = self.class.name.split('::').last
109
- "<#{class_name} authorizations: #{@authorizations.inspect}, captures: #{@captures.inspect},"\
110
- " refunds: #{@refunds.inspect}>"
111
- end
112
- end
113
- end
1
+ # paypal_server_sdk
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0
4
+ # ( https://www.apimatic.io ).
5
+
6
+ module PaypalServerSdk
7
+ # The collection of payments, or transactions, for a purchase unit in an
8
+ # order. For example, authorized payments, captured payments, and refunds.
9
+ class PaymentCollection < BaseModel
10
+ SKIP = Object.new
11
+ private_constant :SKIP
12
+
13
+ # An array of authorized payments for a purchase unit. A purchase unit can
14
+ # have zero or more authorized payments.
15
+ # @return [Array[AuthorizationWithAdditionalData]]
16
+ attr_accessor :authorizations
17
+
18
+ # An array of captured payments for a purchase unit. A purchase unit can
19
+ # have zero or more captured payments.
20
+ # @return [Array[OrdersCapture]]
21
+ attr_accessor :captures
22
+
23
+ # An array of refunds for a purchase unit. A purchase unit can have zero or
24
+ # more refunds.
25
+ # @return [Array[Refund]]
26
+ attr_accessor :refunds
27
+
28
+ # A mapping from model property names to API property names.
29
+ def self.names
30
+ @_hash = {} if @_hash.nil?
31
+ @_hash['authorizations'] = 'authorizations'
32
+ @_hash['captures'] = 'captures'
33
+ @_hash['refunds'] = 'refunds'
34
+ @_hash
35
+ end
36
+
37
+ # An array for optional fields
38
+ def self.optionals
39
+ %w[
40
+ authorizations
41
+ captures
42
+ refunds
43
+ ]
44
+ end
45
+
46
+ # An array for nullable fields
47
+ def self.nullables
48
+ []
49
+ end
50
+
51
+ def initialize(authorizations: SKIP, captures: SKIP, refunds: SKIP)
52
+ @authorizations = authorizations unless authorizations == SKIP
53
+ @captures = captures unless captures == SKIP
54
+ @refunds = refunds unless refunds == SKIP
55
+ end
56
+
57
+ # Creates an instance of the object from a hash.
58
+ def self.from_hash(hash)
59
+ return nil unless hash
60
+
61
+ # Extract variables from the hash.
62
+ # Parameter is an array, so we need to iterate through it
63
+ authorizations = nil
64
+ unless hash['authorizations'].nil?
65
+ authorizations = []
66
+ hash['authorizations'].each do |structure|
67
+ authorizations << (AuthorizationWithAdditionalData.from_hash(structure) if structure)
68
+ end
69
+ end
70
+
71
+ authorizations = SKIP unless hash.key?('authorizations')
72
+ # Parameter is an array, so we need to iterate through it
73
+ captures = nil
74
+ unless hash['captures'].nil?
75
+ captures = []
76
+ hash['captures'].each do |structure|
77
+ captures << (OrdersCapture.from_hash(structure) if structure)
78
+ end
79
+ end
80
+
81
+ captures = SKIP unless hash.key?('captures')
82
+ # Parameter is an array, so we need to iterate through it
83
+ refunds = nil
84
+ unless hash['refunds'].nil?
85
+ refunds = []
86
+ hash['refunds'].each do |structure|
87
+ refunds << (Refund.from_hash(structure) if structure)
88
+ end
89
+ end
90
+
91
+ refunds = SKIP unless hash.key?('refunds')
92
+
93
+ # Create object from extracted values.
94
+ PaymentCollection.new(authorizations: authorizations,
95
+ captures: captures,
96
+ refunds: refunds)
97
+ end
98
+
99
+ # Provides a human-readable string representation of the object.
100
+ def to_s
101
+ class_name = self.class.name.split('::').last
102
+ "<#{class_name} authorizations: #{@authorizations}, captures: #{@captures}, refunds:"\
103
+ " #{@refunds}>"
104
+ end
105
+
106
+ # Provides a debugging-friendly string with detailed object information.
107
+ def inspect
108
+ class_name = self.class.name.split('::').last
109
+ "<#{class_name} authorizations: #{@authorizations.inspect}, captures: #{@captures.inspect},"\
110
+ " refunds: #{@refunds.inspect}>"
111
+ end
112
+ end
113
+ end
@@ -1,39 +1,39 @@
1
- # paypal_server_sdk
2
- #
3
- # This file was automatically generated by APIMATIC v3.0
4
- # ( https://www.apimatic.io ).
5
-
6
- module PaypalServerSdk
7
- # The person or party who initiated or triggered the payment.
8
- class PaymentInitiator
9
- PAYMENT_INITIATOR = [
10
- # Payment is initiated with the active engagement of the customer. e.g. a
11
- # customer checking out on a merchant website.
12
- CUSTOMER = 'CUSTOMER'.freeze,
13
-
14
- # Payment is initiated by merchant on behalf of the customer without the
15
- # active engagement of customer. e.g. a merchant charging the monthly
16
- # payment of a subscription to the customer.
17
- MERCHANT = 'MERCHANT'.freeze
18
- ].freeze
19
-
20
- def self.validate(value)
21
- return false if value.nil?
22
-
23
- true
24
- end
25
-
26
- def self.from_value(value, default_value = CUSTOMER)
1
+ # paypal_server_sdk
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0
4
+ # ( https://www.apimatic.io ).
5
+
6
+ module PaypalServerSdk
7
+ # The person or party who initiated or triggered the payment.
8
+ class PaymentInitiator
9
+ PAYMENT_INITIATOR = [
10
+ # Payment is initiated with the active engagement of the customer. e.g. a
11
+ # customer checking out on a merchant website.
12
+ CUSTOMER = 'CUSTOMER'.freeze,
13
+
14
+ # Payment is initiated by merchant on behalf of the customer without the
15
+ # active engagement of customer. e.g. a merchant charging the monthly
16
+ # payment of a subscription to the customer.
17
+ MERCHANT = 'MERCHANT'.freeze
18
+ ].freeze
19
+
20
+ def self.validate(value)
21
+ return false if value.nil?
22
+
23
+ true
24
+ end
25
+
26
+ def self.from_value(value, default_value = CUSTOMER)
27
27
  return default_value if value.nil?
28
-
29
- str = value.to_s.strip
30
28
 
31
- case str.downcase
32
- when 'customer' then CUSTOMER
33
- when 'merchant' then MERCHANT
29
+ str = value.to_s.strip
30
+
31
+ case str.downcase
32
+ when 'customer' then CUSTOMER
33
+ when 'merchant' then MERCHANT
34
34
  else
35
35
  default_value
36
36
  end
37
- end
38
- end
39
- end
37
+ end
38
+ end
39
+ end
@@ -1,121 +1,121 @@
1
- # paypal_server_sdk
2
- #
3
- # This file was automatically generated by APIMATIC v3.0
4
- # ( https://www.apimatic.io ).
5
-
6
- module PaypalServerSdk
7
- # Any additional payment instructions to be consider during payment
8
- # processing. This processing instruction is applicable for Capturing an order
9
- # or Authorizing an Order.
10
- class PaymentInstruction < BaseModel
11
- SKIP = Object.new
12
- private_constant :SKIP
13
-
14
- # An array of various fees, commissions, tips, or donations. This field is
15
- # only applicable to merchants that been enabled for PayPal Complete
16
- # Payments Platform for Marketplaces and Platforms capability.
17
- # @return [Array[PlatformFee]]
18
- attr_accessor :platform_fees
19
-
20
- # The funds that are held on behalf of the merchant.
21
- # @return [DisbursementMode]
22
- attr_accessor :disbursement_mode
23
-
24
- # This field is only enabled for selected merchants/partners to use and
25
- # provides the ability to trigger a specific pricing rate/plan for a payment
26
- # transaction. The list of eligible 'payee_pricing_tier_id' would be
27
- # provided to you by your Account Manager. Specifying values other than the
28
- # one provided to you by your account manager would result in an error.
29
- # @return [String]
30
- attr_accessor :payee_pricing_tier_id
31
-
32
- # FX identifier generated returned by PayPal to be used for payment
33
- # processing in order to honor FX rate (for eligible integrations) to be
34
- # used when amount is settled/received into the payee account.
35
- # @return [String]
36
- attr_accessor :payee_receivable_fx_rate_id
37
-
38
- # A mapping from model property names to API property names.
39
- def self.names
40
- @_hash = {} if @_hash.nil?
41
- @_hash['platform_fees'] = 'platform_fees'
42
- @_hash['disbursement_mode'] = 'disbursement_mode'
43
- @_hash['payee_pricing_tier_id'] = 'payee_pricing_tier_id'
44
- @_hash['payee_receivable_fx_rate_id'] = 'payee_receivable_fx_rate_id'
45
- @_hash
46
- end
47
-
48
- # An array for optional fields
49
- def self.optionals
50
- %w[
51
- platform_fees
52
- disbursement_mode
53
- payee_pricing_tier_id
54
- payee_receivable_fx_rate_id
55
- ]
56
- end
57
-
58
- # An array for nullable fields
59
- def self.nullables
60
- []
61
- end
62
-
63
- def initialize(platform_fees: SKIP,
64
- disbursement_mode: DisbursementMode::INSTANT,
65
- payee_pricing_tier_id: SKIP,
66
- payee_receivable_fx_rate_id: SKIP)
67
- @platform_fees = platform_fees unless platform_fees == SKIP
68
- @disbursement_mode = disbursement_mode unless disbursement_mode == SKIP
69
- @payee_pricing_tier_id = payee_pricing_tier_id unless payee_pricing_tier_id == SKIP
70
- unless payee_receivable_fx_rate_id == SKIP
71
- @payee_receivable_fx_rate_id =
72
- payee_receivable_fx_rate_id
73
- end
74
- end
75
-
76
- # Creates an instance of the object from a hash.
77
- def self.from_hash(hash)
78
- return nil unless hash
79
-
80
- # Extract variables from the hash.
81
- # Parameter is an array, so we need to iterate through it
82
- platform_fees = nil
83
- unless hash['platform_fees'].nil?
84
- platform_fees = []
85
- hash['platform_fees'].each do |structure|
86
- platform_fees << (PlatformFee.from_hash(structure) if structure)
87
- end
88
- end
89
-
90
- platform_fees = SKIP unless hash.key?('platform_fees')
91
- disbursement_mode =
92
- hash['disbursement_mode'] ||= DisbursementMode::INSTANT
93
- payee_pricing_tier_id =
94
- hash.key?('payee_pricing_tier_id') ? hash['payee_pricing_tier_id'] : SKIP
95
- payee_receivable_fx_rate_id =
96
- hash.key?('payee_receivable_fx_rate_id') ? hash['payee_receivable_fx_rate_id'] : SKIP
97
-
98
- # Create object from extracted values.
99
- PaymentInstruction.new(platform_fees: platform_fees,
100
- disbursement_mode: disbursement_mode,
101
- payee_pricing_tier_id: payee_pricing_tier_id,
102
- payee_receivable_fx_rate_id: payee_receivable_fx_rate_id)
103
- end
104
-
105
- # Provides a human-readable string representation of the object.
106
- def to_s
107
- class_name = self.class.name.split('::').last
108
- "<#{class_name} platform_fees: #{@platform_fees}, disbursement_mode: #{@disbursement_mode},"\
109
- " payee_pricing_tier_id: #{@payee_pricing_tier_id}, payee_receivable_fx_rate_id:"\
110
- " #{@payee_receivable_fx_rate_id}>"
111
- end
112
-
113
- # Provides a debugging-friendly string with detailed object information.
114
- def inspect
115
- class_name = self.class.name.split('::').last
116
- "<#{class_name} platform_fees: #{@platform_fees.inspect}, disbursement_mode:"\
117
- " #{@disbursement_mode.inspect}, payee_pricing_tier_id: #{@payee_pricing_tier_id.inspect},"\
118
- " payee_receivable_fx_rate_id: #{@payee_receivable_fx_rate_id.inspect}>"
119
- end
120
- end
121
- end
1
+ # paypal_server_sdk
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0
4
+ # ( https://www.apimatic.io ).
5
+
6
+ module PaypalServerSdk
7
+ # Any additional payment instructions to be consider during payment
8
+ # processing. This processing instruction is applicable for Capturing an order
9
+ # or Authorizing an Order.
10
+ class PaymentInstruction < BaseModel
11
+ SKIP = Object.new
12
+ private_constant :SKIP
13
+
14
+ # An array of various fees, commissions, tips, or donations. This field is
15
+ # only applicable to merchants that been enabled for PayPal Complete
16
+ # Payments Platform for Marketplaces and Platforms capability.
17
+ # @return [Array[PlatformFee]]
18
+ attr_accessor :platform_fees
19
+
20
+ # The funds that are held on behalf of the merchant.
21
+ # @return [DisbursementMode]
22
+ attr_accessor :disbursement_mode
23
+
24
+ # This field is only enabled for selected merchants/partners to use and
25
+ # provides the ability to trigger a specific pricing rate/plan for a payment
26
+ # transaction. The list of eligible 'payee_pricing_tier_id' would be
27
+ # provided to you by your Account Manager. Specifying values other than the
28
+ # one provided to you by your account manager would result in an error.
29
+ # @return [String]
30
+ attr_accessor :payee_pricing_tier_id
31
+
32
+ # FX identifier generated returned by PayPal to be used for payment
33
+ # processing in order to honor FX rate (for eligible integrations) to be
34
+ # used when amount is settled/received into the payee account.
35
+ # @return [String]
36
+ attr_accessor :payee_receivable_fx_rate_id
37
+
38
+ # A mapping from model property names to API property names.
39
+ def self.names
40
+ @_hash = {} if @_hash.nil?
41
+ @_hash['platform_fees'] = 'platform_fees'
42
+ @_hash['disbursement_mode'] = 'disbursement_mode'
43
+ @_hash['payee_pricing_tier_id'] = 'payee_pricing_tier_id'
44
+ @_hash['payee_receivable_fx_rate_id'] = 'payee_receivable_fx_rate_id'
45
+ @_hash
46
+ end
47
+
48
+ # An array for optional fields
49
+ def self.optionals
50
+ %w[
51
+ platform_fees
52
+ disbursement_mode
53
+ payee_pricing_tier_id
54
+ payee_receivable_fx_rate_id
55
+ ]
56
+ end
57
+
58
+ # An array for nullable fields
59
+ def self.nullables
60
+ []
61
+ end
62
+
63
+ def initialize(platform_fees: SKIP,
64
+ disbursement_mode: DisbursementMode::INSTANT,
65
+ payee_pricing_tier_id: SKIP,
66
+ payee_receivable_fx_rate_id: SKIP)
67
+ @platform_fees = platform_fees unless platform_fees == SKIP
68
+ @disbursement_mode = disbursement_mode unless disbursement_mode == SKIP
69
+ @payee_pricing_tier_id = payee_pricing_tier_id unless payee_pricing_tier_id == SKIP
70
+ unless payee_receivable_fx_rate_id == SKIP
71
+ @payee_receivable_fx_rate_id =
72
+ payee_receivable_fx_rate_id
73
+ end
74
+ end
75
+
76
+ # Creates an instance of the object from a hash.
77
+ def self.from_hash(hash)
78
+ return nil unless hash
79
+
80
+ # Extract variables from the hash.
81
+ # Parameter is an array, so we need to iterate through it
82
+ platform_fees = nil
83
+ unless hash['platform_fees'].nil?
84
+ platform_fees = []
85
+ hash['platform_fees'].each do |structure|
86
+ platform_fees << (PlatformFee.from_hash(structure) if structure)
87
+ end
88
+ end
89
+
90
+ platform_fees = SKIP unless hash.key?('platform_fees')
91
+ disbursement_mode =
92
+ hash['disbursement_mode'] ||= DisbursementMode::INSTANT
93
+ payee_pricing_tier_id =
94
+ hash.key?('payee_pricing_tier_id') ? hash['payee_pricing_tier_id'] : SKIP
95
+ payee_receivable_fx_rate_id =
96
+ hash.key?('payee_receivable_fx_rate_id') ? hash['payee_receivable_fx_rate_id'] : SKIP
97
+
98
+ # Create object from extracted values.
99
+ PaymentInstruction.new(platform_fees: platform_fees,
100
+ disbursement_mode: disbursement_mode,
101
+ payee_pricing_tier_id: payee_pricing_tier_id,
102
+ payee_receivable_fx_rate_id: payee_receivable_fx_rate_id)
103
+ end
104
+
105
+ # Provides a human-readable string representation of the object.
106
+ def to_s
107
+ class_name = self.class.name.split('::').last
108
+ "<#{class_name} platform_fees: #{@platform_fees}, disbursement_mode: #{@disbursement_mode},"\
109
+ " payee_pricing_tier_id: #{@payee_pricing_tier_id}, payee_receivable_fx_rate_id:"\
110
+ " #{@payee_receivable_fx_rate_id}>"
111
+ end
112
+
113
+ # Provides a debugging-friendly string with detailed object information.
114
+ def inspect
115
+ class_name = self.class.name.split('::').last
116
+ "<#{class_name} platform_fees: #{@platform_fees.inspect}, disbursement_mode:"\
117
+ " #{@disbursement_mode.inspect}, payee_pricing_tier_id: #{@payee_pricing_tier_id.inspect},"\
118
+ " payee_receivable_fx_rate_id: #{@payee_receivable_fx_rate_id.inspect}>"
119
+ end
120
+ end
121
+ end
@@ -1,63 +1,63 @@
1
- # paypal_server_sdk
2
- #
3
- # This file was automatically generated by APIMATIC v3.0
4
- # ( https://www.apimatic.io ).
5
-
6
- module PaypalServerSdk
7
- # The customer and merchant payment preferences.
8
- class PaymentMethod < BaseModel
9
- SKIP = Object.new
10
- private_constant :SKIP
11
-
12
- # The merchant-preferred payment methods.
13
- # @return [PayeePaymentMethodPreference]
14
- attr_accessor :payee_preferred
15
-
16
- # A mapping from model property names to API property names.
17
- def self.names
18
- @_hash = {} if @_hash.nil?
19
- @_hash['payee_preferred'] = 'payee_preferred'
20
- @_hash
21
- end
22
-
23
- # An array for optional fields
24
- def self.optionals
25
- %w[
26
- payee_preferred
27
- ]
28
- end
29
-
30
- # An array for nullable fields
31
- def self.nullables
32
- []
33
- end
34
-
35
- def initialize(payee_preferred: PayeePaymentMethodPreference::UNRESTRICTED)
36
- @payee_preferred = payee_preferred unless payee_preferred == SKIP
37
- end
38
-
39
- # Creates an instance of the object from a hash.
40
- def self.from_hash(hash)
41
- return nil unless hash
42
-
43
- # Extract variables from the hash.
44
- payee_preferred =
45
- hash['payee_preferred'] ||= PayeePaymentMethodPreference::UNRESTRICTED
46
-
47
- # Create object from extracted values.
48
- PaymentMethod.new(payee_preferred: payee_preferred)
49
- end
50
-
51
- # Provides a human-readable string representation of the object.
52
- def to_s
53
- class_name = self.class.name.split('::').last
54
- "<#{class_name} payee_preferred: #{@payee_preferred}>"
55
- end
56
-
57
- # Provides a debugging-friendly string with detailed object information.
58
- def inspect
59
- class_name = self.class.name.split('::').last
60
- "<#{class_name} payee_preferred: #{@payee_preferred.inspect}>"
61
- end
62
- end
63
- end
1
+ # paypal_server_sdk
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0
4
+ # ( https://www.apimatic.io ).
5
+
6
+ module PaypalServerSdk
7
+ # The customer and merchant payment preferences.
8
+ class PaymentMethod < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # The merchant-preferred payment methods.
13
+ # @return [PayeePaymentMethodPreference]
14
+ attr_accessor :payee_preferred
15
+
16
+ # A mapping from model property names to API property names.
17
+ def self.names
18
+ @_hash = {} if @_hash.nil?
19
+ @_hash['payee_preferred'] = 'payee_preferred'
20
+ @_hash
21
+ end
22
+
23
+ # An array for optional fields
24
+ def self.optionals
25
+ %w[
26
+ payee_preferred
27
+ ]
28
+ end
29
+
30
+ # An array for nullable fields
31
+ def self.nullables
32
+ []
33
+ end
34
+
35
+ def initialize(payee_preferred: PayeePaymentMethodPreference::UNRESTRICTED)
36
+ @payee_preferred = payee_preferred unless payee_preferred == SKIP
37
+ end
38
+
39
+ # Creates an instance of the object from a hash.
40
+ def self.from_hash(hash)
41
+ return nil unless hash
42
+
43
+ # Extract variables from the hash.
44
+ payee_preferred =
45
+ hash['payee_preferred'] ||= PayeePaymentMethodPreference::UNRESTRICTED
46
+
47
+ # Create object from extracted values.
48
+ PaymentMethod.new(payee_preferred: payee_preferred)
49
+ end
50
+
51
+ # Provides a human-readable string representation of the object.
52
+ def to_s
53
+ class_name = self.class.name.split('::').last
54
+ "<#{class_name} payee_preferred: #{@payee_preferred}>"
55
+ end
56
+
57
+ # Provides a debugging-friendly string with detailed object information.
58
+ def inspect
59
+ class_name = self.class.name.split('::').last
60
+ "<#{class_name} payee_preferred: #{@payee_preferred.inspect}>"
61
+ end
62
+ end
63
+ end