paypal-apimatic-sdk 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (395) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +35 -0
  3. data/README.md +176 -0
  4. data/bin/console +15 -0
  5. data/lib/paypal_server_sdk/api_helper.rb +10 -0
  6. data/lib/paypal_server_sdk/client.rb +109 -0
  7. data/lib/paypal_server_sdk/configuration.rb +164 -0
  8. data/lib/paypal_server_sdk/controllers/base_controller.rb +65 -0
  9. data/lib/paypal_server_sdk/controllers/o_auth_authorization_controller.rb +42 -0
  10. data/lib/paypal_server_sdk/controllers/orders_controller.rb +551 -0
  11. data/lib/paypal_server_sdk/controllers/payments_controller.rb +462 -0
  12. data/lib/paypal_server_sdk/controllers/subscriptions_controller.rb +843 -0
  13. data/lib/paypal_server_sdk/controllers/transaction_search_controller.rb +178 -0
  14. data/lib/paypal_server_sdk/controllers/vault_controller.rb +224 -0
  15. data/lib/paypal_server_sdk/exceptions/api_exception.rb +21 -0
  16. data/lib/paypal_server_sdk/exceptions/default_error_exception.rb +95 -0
  17. data/lib/paypal_server_sdk/exceptions/error_exception.rb +87 -0
  18. data/lib/paypal_server_sdk/exceptions/o_auth_provider_exception.rb +64 -0
  19. data/lib/paypal_server_sdk/exceptions/search_error_exception.rb +107 -0
  20. data/lib/paypal_server_sdk/exceptions/subscription_error_exception.rb +95 -0
  21. data/lib/paypal_server_sdk/http/api_response.rb +19 -0
  22. data/lib/paypal_server_sdk/http/auth/o_auth2.rb +151 -0
  23. data/lib/paypal_server_sdk/http/http_call_back.rb +10 -0
  24. data/lib/paypal_server_sdk/http/http_method_enum.rb +10 -0
  25. data/lib/paypal_server_sdk/http/http_request.rb +10 -0
  26. data/lib/paypal_server_sdk/http/http_response.rb +10 -0
  27. data/lib/paypal_server_sdk/http/proxy_settings.rb +22 -0
  28. data/lib/paypal_server_sdk/logging/configuration/api_logging_configuration.rb +186 -0
  29. data/lib/paypal_server_sdk/logging/sdk_logger.rb +17 -0
  30. data/lib/paypal_server_sdk/models/activate_subscription_request.rb +63 -0
  31. data/lib/paypal_server_sdk/models/activity_timestamps.rb +79 -0
  32. data/lib/paypal_server_sdk/models/address.rb +131 -0
  33. data/lib/paypal_server_sdk/models/amount_breakdown.rb +132 -0
  34. data/lib/paypal_server_sdk/models/amount_with_breakdown.rb +93 -0
  35. data/lib/paypal_server_sdk/models/app_switch_context.rb +74 -0
  36. data/lib/paypal_server_sdk/models/apple_pay_attributes.rb +73 -0
  37. data/lib/paypal_server_sdk/models/apple_pay_attributes_response.rb +62 -0
  38. data/lib/paypal_server_sdk/models/apple_pay_card.rb +108 -0
  39. data/lib/paypal_server_sdk/models/apple_pay_card_response.rb +209 -0
  40. data/lib/paypal_server_sdk/models/apple_pay_decrypted_token_data.rb +111 -0
  41. data/lib/paypal_server_sdk/models/apple_pay_experience_context.rb +68 -0
  42. data/lib/paypal_server_sdk/models/apple_pay_payment_data.rb +97 -0
  43. data/lib/paypal_server_sdk/models/apple_pay_payment_data_type.rb +41 -0
  44. data/lib/paypal_server_sdk/models/apple_pay_payment_object.rb +150 -0
  45. data/lib/paypal_server_sdk/models/apple_pay_payment_token.rb +63 -0
  46. data/lib/paypal_server_sdk/models/apple_pay_request.rb +165 -0
  47. data/lib/paypal_server_sdk/models/apple_pay_request_card.rb +88 -0
  48. data/lib/paypal_server_sdk/models/apple_pay_tokenized_card.rb +127 -0
  49. data/lib/paypal_server_sdk/models/application_context_user_action.rb +42 -0
  50. data/lib/paypal_server_sdk/models/assurance_details.rb +82 -0
  51. data/lib/paypal_server_sdk/models/auction_information.rb +100 -0
  52. data/lib/paypal_server_sdk/models/authentication_response.rb +74 -0
  53. data/lib/paypal_server_sdk/models/authorization.rb +211 -0
  54. data/lib/paypal_server_sdk/models/authorization_incomplete_reason.rb +36 -0
  55. data/lib/paypal_server_sdk/models/authorization_status.rb +58 -0
  56. data/lib/paypal_server_sdk/models/authorization_status_details.rb +62 -0
  57. data/lib/paypal_server_sdk/models/authorization_status_with_details.rb +72 -0
  58. data/lib/paypal_server_sdk/models/authorization_with_additional_data.rb +225 -0
  59. data/lib/paypal_server_sdk/models/avs_code.rb +156 -0
  60. data/lib/paypal_server_sdk/models/balance_information.rb +106 -0
  61. data/lib/paypal_server_sdk/models/balances_response.rb +111 -0
  62. data/lib/paypal_server_sdk/models/bancontact_payment_object.rb +109 -0
  63. data/lib/paypal_server_sdk/models/bancontact_payment_request.rb +86 -0
  64. data/lib/paypal_server_sdk/models/bank_request.rb +71 -0
  65. data/lib/paypal_server_sdk/models/base_model.rb +110 -0
  66. data/lib/paypal_server_sdk/models/billing_cycle.rb +118 -0
  67. data/lib/paypal_server_sdk/models/billing_cycle_override.rb +91 -0
  68. data/lib/paypal_server_sdk/models/billing_plan.rb +212 -0
  69. data/lib/paypal_server_sdk/models/bin_details.rb +101 -0
  70. data/lib/paypal_server_sdk/models/blik_experience_context.rb +141 -0
  71. data/lib/paypal_server_sdk/models/blik_level0_payment_object.rb +60 -0
  72. data/lib/paypal_server_sdk/models/blik_one_click_payment_object.rb +64 -0
  73. data/lib/paypal_server_sdk/models/blik_one_click_payment_request.rb +97 -0
  74. data/lib/paypal_server_sdk/models/blik_payment_object.rb +98 -0
  75. data/lib/paypal_server_sdk/models/blik_payment_request.rb +119 -0
  76. data/lib/paypal_server_sdk/models/callback_configuration.rb +74 -0
  77. data/lib/paypal_server_sdk/models/callback_events.rb +40 -0
  78. data/lib/paypal_server_sdk/models/cancel_subscription_request.rb +60 -0
  79. data/lib/paypal_server_sdk/models/capture_incomplete_reason.rb +86 -0
  80. data/lib/paypal_server_sdk/models/capture_payment_instruction.rb +104 -0
  81. data/lib/paypal_server_sdk/models/capture_request.rb +126 -0
  82. data/lib/paypal_server_sdk/models/capture_status.rb +56 -0
  83. data/lib/paypal_server_sdk/models/capture_status_details.rb +62 -0
  84. data/lib/paypal_server_sdk/models/capture_status_with_details.rb +72 -0
  85. data/lib/paypal_server_sdk/models/capture_subscription_request.rb +78 -0
  86. data/lib/paypal_server_sdk/models/capture_type.rb +26 -0
  87. data/lib/paypal_server_sdk/models/captured_payment.rb +274 -0
  88. data/lib/paypal_server_sdk/models/card_attributes.rb +83 -0
  89. data/lib/paypal_server_sdk/models/card_attributes_response.rb +62 -0
  90. data/lib/paypal_server_sdk/models/card_authentication_response.rb +63 -0
  91. data/lib/paypal_server_sdk/models/card_brand.rb +153 -0
  92. data/lib/paypal_server_sdk/models/card_customer.rb +98 -0
  93. data/lib/paypal_server_sdk/models/card_customer_information.rb +108 -0
  94. data/lib/paypal_server_sdk/models/card_experience_context.rb +71 -0
  95. data/lib/paypal_server_sdk/models/card_from_request.rb +72 -0
  96. data/lib/paypal_server_sdk/models/card_payment_token_entity.rb +178 -0
  97. data/lib/paypal_server_sdk/models/card_request.rb +191 -0
  98. data/lib/paypal_server_sdk/models/card_response.rb +180 -0
  99. data/lib/paypal_server_sdk/models/card_response_address.rb +136 -0
  100. data/lib/paypal_server_sdk/models/card_response_with_billing_address.rb +100 -0
  101. data/lib/paypal_server_sdk/models/card_stored_credential.rb +111 -0
  102. data/lib/paypal_server_sdk/models/card_supplementary_data.rb +79 -0
  103. data/lib/paypal_server_sdk/models/card_type.rb +48 -0
  104. data/lib/paypal_server_sdk/models/card_vault_response.rb +99 -0
  105. data/lib/paypal_server_sdk/models/card_verification.rb +64 -0
  106. data/lib/paypal_server_sdk/models/card_verification_details.rb +140 -0
  107. data/lib/paypal_server_sdk/models/card_verification_processor_response.rb +74 -0
  108. data/lib/paypal_server_sdk/models/card_verification_status.rb +36 -0
  109. data/lib/paypal_server_sdk/models/cart_information.rb +94 -0
  110. data/lib/paypal_server_sdk/models/checkout_option.rb +77 -0
  111. data/lib/paypal_server_sdk/models/checkout_payment_intent.rb +45 -0
  112. data/lib/paypal_server_sdk/models/cobranded_card.rb +83 -0
  113. data/lib/paypal_server_sdk/models/confirm_order_request.rb +74 -0
  114. data/lib/paypal_server_sdk/models/create_subscription_request.rb +151 -0
  115. data/lib/paypal_server_sdk/models/customer.rb +76 -0
  116. data/lib/paypal_server_sdk/models/customer_information.rb +95 -0
  117. data/lib/paypal_server_sdk/models/customer_response.rb +75 -0
  118. data/lib/paypal_server_sdk/models/customer_vault_payment_tokens_response.rb +122 -0
  119. data/lib/paypal_server_sdk/models/cvv_code.rb +93 -0
  120. data/lib/paypal_server_sdk/models/cycle_execution.rb +124 -0
  121. data/lib/paypal_server_sdk/models/disbursement_mode.rb +39 -0
  122. data/lib/paypal_server_sdk/models/dispute_category.rb +36 -0
  123. data/lib/paypal_server_sdk/models/eci_flag.rb +54 -0
  124. data/lib/paypal_server_sdk/models/enrollment_status.rb +47 -0
  125. data/lib/paypal_server_sdk/models/eps_payment_object.rb +86 -0
  126. data/lib/paypal_server_sdk/models/eps_payment_request.rb +86 -0
  127. data/lib/paypal_server_sdk/models/error_details.rb +125 -0
  128. data/lib/paypal_server_sdk/models/exchange_rate.rb +89 -0
  129. data/lib/paypal_server_sdk/models/experience_context.rb +115 -0
  130. data/lib/paypal_server_sdk/models/experience_context_shipping_preference.rb +46 -0
  131. data/lib/paypal_server_sdk/models/experience_status.rb +48 -0
  132. data/lib/paypal_server_sdk/models/failed_payment_details.rb +98 -0
  133. data/lib/paypal_server_sdk/models/frequency.rb +75 -0
  134. data/lib/paypal_server_sdk/models/fulfillment_type.rb +51 -0
  135. data/lib/paypal_server_sdk/models/giropay_payment_object.rb +86 -0
  136. data/lib/paypal_server_sdk/models/giropay_payment_request.rb +86 -0
  137. data/lib/paypal_server_sdk/models/google_pay_authentication_method.rb +42 -0
  138. data/lib/paypal_server_sdk/models/google_pay_card.rb +128 -0
  139. data/lib/paypal_server_sdk/models/google_pay_card_response.rb +120 -0
  140. data/lib/paypal_server_sdk/models/google_pay_decrypted_token_data.rb +131 -0
  141. data/lib/paypal_server_sdk/models/google_pay_experience_context.rb +68 -0
  142. data/lib/paypal_server_sdk/models/google_pay_payment_method.rb +26 -0
  143. data/lib/paypal_server_sdk/models/google_pay_request.rb +136 -0
  144. data/lib/paypal_server_sdk/models/google_pay_request_card.rb +98 -0
  145. data/lib/paypal_server_sdk/models/google_pay_wallet_response.rb +98 -0
  146. data/lib/paypal_server_sdk/models/ideal_payment_object.rb +98 -0
  147. data/lib/paypal_server_sdk/models/ideal_payment_request.rb +96 -0
  148. data/lib/paypal_server_sdk/models/incentive_details.rb +99 -0
  149. data/lib/paypal_server_sdk/models/incentive_information.rb +71 -0
  150. data/lib/paypal_server_sdk/models/interval_unit.rb +44 -0
  151. data/lib/paypal_server_sdk/models/item.rb +161 -0
  152. data/lib/paypal_server_sdk/models/item_category.rb +43 -0
  153. data/lib/paypal_server_sdk/models/item_details.rb +287 -0
  154. data/lib/paypal_server_sdk/models/item_request.rb +163 -0
  155. data/lib/paypal_server_sdk/models/last_payment_details.rb +75 -0
  156. data/lib/paypal_server_sdk/models/level2_card_processing_data.rb +78 -0
  157. data/lib/paypal_server_sdk/models/level3_card_processing_data.rb +137 -0
  158. data/lib/paypal_server_sdk/models/liability_shift_indicator.rb +40 -0
  159. data/lib/paypal_server_sdk/models/line_item.rb +209 -0
  160. data/lib/paypal_server_sdk/models/link_description.rb +87 -0
  161. data/lib/paypal_server_sdk/models/link_http_method.rb +60 -0
  162. data/lib/paypal_server_sdk/models/merchant_preferences.rb +73 -0
  163. data/lib/paypal_server_sdk/models/mobile_return_flow.rb +41 -0
  164. data/lib/paypal_server_sdk/models/mobile_web_context.rb +76 -0
  165. data/lib/paypal_server_sdk/models/modify_subscription_request.rb +124 -0
  166. data/lib/paypal_server_sdk/models/modify_subscription_response.rb +141 -0
  167. data/lib/paypal_server_sdk/models/money.rb +74 -0
  168. data/lib/paypal_server_sdk/models/mybank_payment_object.rb +98 -0
  169. data/lib/paypal_server_sdk/models/mybank_payment_request.rb +86 -0
  170. data/lib/paypal_server_sdk/models/name.rb +73 -0
  171. data/lib/paypal_server_sdk/models/native_app_context.rb +72 -0
  172. data/lib/paypal_server_sdk/models/net_amount_breakdown_item.rb +87 -0
  173. data/lib/paypal_server_sdk/models/network_token.rb +110 -0
  174. data/lib/paypal_server_sdk/models/network_transaction.rb +107 -0
  175. data/lib/paypal_server_sdk/models/network_transaction_reference_entity.rb +100 -0
  176. data/lib/paypal_server_sdk/models/o_auth_provider_error.rb +62 -0
  177. data/lib/paypal_server_sdk/models/o_auth_token.rb +106 -0
  178. data/lib/paypal_server_sdk/models/one_time_charge.rb +118 -0
  179. data/lib/paypal_server_sdk/models/order.rb +184 -0
  180. data/lib/paypal_server_sdk/models/order_application_context.rb +219 -0
  181. data/lib/paypal_server_sdk/models/order_application_context_landing_page.rb +53 -0
  182. data/lib/paypal_server_sdk/models/order_application_context_shipping_preference.rb +50 -0
  183. data/lib/paypal_server_sdk/models/order_application_context_user_action.rb +47 -0
  184. data/lib/paypal_server_sdk/models/order_authorize_request.rb +63 -0
  185. data/lib/paypal_server_sdk/models/order_authorize_request_payment_source.rb +115 -0
  186. data/lib/paypal_server_sdk/models/order_authorize_response.rb +181 -0
  187. data/lib/paypal_server_sdk/models/order_authorize_response_payment_source.rb +102 -0
  188. data/lib/paypal_server_sdk/models/order_billing_plan.rb +93 -0
  189. data/lib/paypal_server_sdk/models/order_capture_request.rb +63 -0
  190. data/lib/paypal_server_sdk/models/order_capture_request_payment_source.rb +115 -0
  191. data/lib/paypal_server_sdk/models/order_confirm_application_context.rb +122 -0
  192. data/lib/paypal_server_sdk/models/order_request.rb +120 -0
  193. data/lib/paypal_server_sdk/models/order_status.rb +65 -0
  194. data/lib/paypal_server_sdk/models/order_tracker_item.rb +114 -0
  195. data/lib/paypal_server_sdk/models/order_tracker_request.rb +133 -0
  196. data/lib/paypal_server_sdk/models/order_tracker_response.rb +135 -0
  197. data/lib/paypal_server_sdk/models/order_tracker_status.rb +39 -0
  198. data/lib/paypal_server_sdk/models/orders_capture.rb +252 -0
  199. data/lib/paypal_server_sdk/models/orders_card_verification_method.rb +66 -0
  200. data/lib/paypal_server_sdk/models/os_type.rb +40 -0
  201. data/lib/paypal_server_sdk/models/p24_payment_object.rb +122 -0
  202. data/lib/paypal_server_sdk/models/p24_payment_request.rb +97 -0
  203. data/lib/paypal_server_sdk/models/pa_res_status.rb +61 -0
  204. data/lib/paypal_server_sdk/models/participant_metadata.rb +64 -0
  205. data/lib/paypal_server_sdk/models/patch.rb +93 -0
  206. data/lib/paypal_server_sdk/models/patch_op.rb +89 -0
  207. data/lib/paypal_server_sdk/models/payee_base.rb +76 -0
  208. data/lib/paypal_server_sdk/models/payee_payment_method_preference.rb +38 -0
  209. data/lib/paypal_server_sdk/models/payer.rb +136 -0
  210. data/lib/paypal_server_sdk/models/payer_base.rb +75 -0
  211. data/lib/paypal_server_sdk/models/payer_information.rb +146 -0
  212. data/lib/paypal_server_sdk/models/payer_name.rb +128 -0
  213. data/lib/paypal_server_sdk/models/payment_advice_code.rb +101 -0
  214. data/lib/paypal_server_sdk/models/payment_authorization.rb +233 -0
  215. data/lib/paypal_server_sdk/models/payment_collection.rb +113 -0
  216. data/lib/paypal_server_sdk/models/payment_initiator.rb +39 -0
  217. data/lib/paypal_server_sdk/models/payment_instruction.rb +121 -0
  218. data/lib/paypal_server_sdk/models/payment_method.rb +63 -0
  219. data/lib/paypal_server_sdk/models/payment_method_preference.rb +86 -0
  220. data/lib/paypal_server_sdk/models/payment_preferences.rb +105 -0
  221. data/lib/paypal_server_sdk/models/payment_preferences_override.rb +107 -0
  222. data/lib/paypal_server_sdk/models/payment_source.rb +203 -0
  223. data/lib/paypal_server_sdk/models/payment_source_response.rb +190 -0
  224. data/lib/paypal_server_sdk/models/payment_supplementary_data.rb +62 -0
  225. data/lib/paypal_server_sdk/models/payment_token_request.rb +74 -0
  226. data/lib/paypal_server_sdk/models/payment_token_request_card.rb +120 -0
  227. data/lib/paypal_server_sdk/models/payment_token_request_payment_source.rb +71 -0
  228. data/lib/paypal_server_sdk/models/payment_token_response.rb +103 -0
  229. data/lib/paypal_server_sdk/models/payment_token_response_payment_source.rb +91 -0
  230. data/lib/paypal_server_sdk/models/payment_token_status.rb +52 -0
  231. data/lib/paypal_server_sdk/models/payments_capture.rb +252 -0
  232. data/lib/paypal_server_sdk/models/paypal_experience_landing_page.rb +56 -0
  233. data/lib/paypal_server_sdk/models/paypal_experience_user_action.rb +42 -0
  234. data/lib/paypal_server_sdk/models/paypal_payment_token.rb +211 -0
  235. data/lib/paypal_server_sdk/models/paypal_payment_token_customer_type.rb +42 -0
  236. data/lib/paypal_server_sdk/models/paypal_payment_token_usage_type.rb +40 -0
  237. data/lib/paypal_server_sdk/models/paypal_reference_id_type.rb +44 -0
  238. data/lib/paypal_server_sdk/models/paypal_wallet.rb +188 -0
  239. data/lib/paypal_server_sdk/models/paypal_wallet_account_verification_status.rb +41 -0
  240. data/lib/paypal_server_sdk/models/paypal_wallet_attributes.rb +72 -0
  241. data/lib/paypal_server_sdk/models/paypal_wallet_attributes_response.rb +82 -0
  242. data/lib/paypal_server_sdk/models/paypal_wallet_contact_preference.rb +48 -0
  243. data/lib/paypal_server_sdk/models/paypal_wallet_context_shipping_preference.rb +45 -0
  244. data/lib/paypal_server_sdk/models/paypal_wallet_customer.rb +108 -0
  245. data/lib/paypal_server_sdk/models/paypal_wallet_customer_request.rb +108 -0
  246. data/lib/paypal_server_sdk/models/paypal_wallet_experience_context.rb +200 -0
  247. data/lib/paypal_server_sdk/models/paypal_wallet_response.rb +213 -0
  248. data/lib/paypal_server_sdk/models/paypal_wallet_stored_credential.rb +99 -0
  249. data/lib/paypal_server_sdk/models/paypal_wallet_vault_instruction.rb +122 -0
  250. data/lib/paypal_server_sdk/models/paypal_wallet_vault_response.rb +99 -0
  251. data/lib/paypal_server_sdk/models/paypal_wallet_vault_status.rb +45 -0
  252. data/lib/paypal_server_sdk/models/phone.rb +91 -0
  253. data/lib/paypal_server_sdk/models/phone_number.rb +68 -0
  254. data/lib/paypal_server_sdk/models/phone_number_with_country_code.rb +83 -0
  255. data/lib/paypal_server_sdk/models/phone_number_with_optional_country_code.rb +81 -0
  256. data/lib/paypal_server_sdk/models/phone_type.rb +48 -0
  257. data/lib/paypal_server_sdk/models/phone_with_type.rb +72 -0
  258. data/lib/paypal_server_sdk/models/plan.rb +92 -0
  259. data/lib/paypal_server_sdk/models/plan_collection.rb +111 -0
  260. data/lib/paypal_server_sdk/models/plan_details.rb +147 -0
  261. data/lib/paypal_server_sdk/models/plan_override.rb +96 -0
  262. data/lib/paypal_server_sdk/models/plan_request.rb +154 -0
  263. data/lib/paypal_server_sdk/models/plan_request_status.rb +42 -0
  264. data/lib/paypal_server_sdk/models/platform_fee.rb +75 -0
  265. data/lib/paypal_server_sdk/models/pricing_model.rb +42 -0
  266. data/lib/paypal_server_sdk/models/pricing_scheme.rb +84 -0
  267. data/lib/paypal_server_sdk/models/pricing_tier.rb +83 -0
  268. data/lib/paypal_server_sdk/models/processor_response.rb +98 -0
  269. data/lib/paypal_server_sdk/models/processor_response_code.rb +648 -0
  270. data/lib/paypal_server_sdk/models/purchase_unit.rb +245 -0
  271. data/lib/paypal_server_sdk/models/purchase_unit_request.rb +219 -0
  272. data/lib/paypal_server_sdk/models/reason_code.rb +60 -0
  273. data/lib/paypal_server_sdk/models/reauthorize_request.rb +72 -0
  274. data/lib/paypal_server_sdk/models/refund.rb +214 -0
  275. data/lib/paypal_server_sdk/models/refund_incomplete_reason.rb +27 -0
  276. data/lib/paypal_server_sdk/models/refund_payment_instruction.rb +80 -0
  277. data/lib/paypal_server_sdk/models/refund_platform_fee.rb +64 -0
  278. data/lib/paypal_server_sdk/models/refund_request.rb +115 -0
  279. data/lib/paypal_server_sdk/models/refund_status.rb +44 -0
  280. data/lib/paypal_server_sdk/models/refund_status_details.rb +62 -0
  281. data/lib/paypal_server_sdk/models/refund_status_with_details.rb +72 -0
  282. data/lib/paypal_server_sdk/models/related_identifiers.rb +83 -0
  283. data/lib/paypal_server_sdk/models/return_flow.rb +41 -0
  284. data/lib/paypal_server_sdk/models/risk_supplementary_data.rb +63 -0
  285. data/lib/paypal_server_sdk/models/search_response.rb +176 -0
  286. data/lib/paypal_server_sdk/models/seller_payable_breakdown.rb +177 -0
  287. data/lib/paypal_server_sdk/models/seller_protection.rb +78 -0
  288. data/lib/paypal_server_sdk/models/seller_protection_status.rb +46 -0
  289. data/lib/paypal_server_sdk/models/seller_receivable_breakdown.rb +147 -0
  290. data/lib/paypal_server_sdk/models/sepa_debit_experience_context.rb +88 -0
  291. data/lib/paypal_server_sdk/models/sepa_debit_request.rb +64 -0
  292. data/lib/paypal_server_sdk/models/setup_fee_failure_action.rb +37 -0
  293. data/lib/paypal_server_sdk/models/setup_token_request.rb +74 -0
  294. data/lib/paypal_server_sdk/models/setup_token_request_card.rb +143 -0
  295. data/lib/paypal_server_sdk/models/setup_token_request_payment_source.rb +111 -0
  296. data/lib/paypal_server_sdk/models/setup_token_response.rb +115 -0
  297. data/lib/paypal_server_sdk/models/setup_token_response_card.rb +178 -0
  298. data/lib/paypal_server_sdk/models/setup_token_response_payment_source.rb +81 -0
  299. data/lib/paypal_server_sdk/models/shipment_carrier.rb +5682 -0
  300. data/lib/paypal_server_sdk/models/shipping_details.rb +133 -0
  301. data/lib/paypal_server_sdk/models/shipping_information.rb +101 -0
  302. data/lib/paypal_server_sdk/models/shipping_name.rb +62 -0
  303. data/lib/paypal_server_sdk/models/shipping_option.rb +108 -0
  304. data/lib/paypal_server_sdk/models/shipping_type.rb +52 -0
  305. data/lib/paypal_server_sdk/models/shipping_with_tracking_details.rb +152 -0
  306. data/lib/paypal_server_sdk/models/simple_postal_address_coarse_grained.rb +130 -0
  307. data/lib/paypal_server_sdk/models/sofort_payment_object.rb +98 -0
  308. data/lib/paypal_server_sdk/models/sofort_payment_request.rb +86 -0
  309. data/lib/paypal_server_sdk/models/standard_entry_class_code.rb +59 -0
  310. data/lib/paypal_server_sdk/models/store_in_vault_instruction.rb +27 -0
  311. data/lib/paypal_server_sdk/models/store_information.rb +71 -0
  312. data/lib/paypal_server_sdk/models/stored_payment_source.rb +111 -0
  313. data/lib/paypal_server_sdk/models/stored_payment_source_payment_type.rb +43 -0
  314. data/lib/paypal_server_sdk/models/stored_payment_source_usage_type.rb +44 -0
  315. data/lib/paypal_server_sdk/models/subscriber.rb +84 -0
  316. data/lib/paypal_server_sdk/models/subscriber_request.rb +97 -0
  317. data/lib/paypal_server_sdk/models/subscription.rb +205 -0
  318. data/lib/paypal_server_sdk/models/subscription_amount_with_breakdown.rb +119 -0
  319. data/lib/paypal_server_sdk/models/subscription_application_context.rb +134 -0
  320. data/lib/paypal_server_sdk/models/subscription_billing_cycle.rb +108 -0
  321. data/lib/paypal_server_sdk/models/subscription_billing_information.rb +148 -0
  322. data/lib/paypal_server_sdk/models/subscription_card_request.rb +141 -0
  323. data/lib/paypal_server_sdk/models/subscription_collection.rb +90 -0
  324. data/lib/paypal_server_sdk/models/subscription_customer_information.rb +84 -0
  325. data/lib/paypal_server_sdk/models/subscription_patch_application_context.rb +122 -0
  326. data/lib/paypal_server_sdk/models/subscription_payer_name.rb +114 -0
  327. data/lib/paypal_server_sdk/models/subscription_payment_source.rb +65 -0
  328. data/lib/paypal_server_sdk/models/subscription_payment_source_response.rb +63 -0
  329. data/lib/paypal_server_sdk/models/subscription_plan_status.rb +42 -0
  330. data/lib/paypal_server_sdk/models/subscription_pricing_model.rb +36 -0
  331. data/lib/paypal_server_sdk/models/subscription_pricing_scheme.rb +129 -0
  332. data/lib/paypal_server_sdk/models/subscription_transaction_details.rb +118 -0
  333. data/lib/paypal_server_sdk/models/subscriptions_card_attributes.rb +83 -0
  334. data/lib/paypal_server_sdk/models/subscriptions_card_brand.rb +133 -0
  335. data/lib/paypal_server_sdk/models/supplementary_data.rb +76 -0
  336. data/lib/paypal_server_sdk/models/suspend_subscription.rb +60 -0
  337. data/lib/paypal_server_sdk/models/tax_amount.rb +63 -0
  338. data/lib/paypal_server_sdk/models/tax_id_type.rb +36 -0
  339. data/lib/paypal_server_sdk/models/tax_info.rb +69 -0
  340. data/lib/paypal_server_sdk/models/taxes.rb +71 -0
  341. data/lib/paypal_server_sdk/models/taxes_override.rb +72 -0
  342. data/lib/paypal_server_sdk/models/tenure_type.rb +43 -0
  343. data/lib/paypal_server_sdk/models/three_d_secure_authentication_response.rb +76 -0
  344. data/lib/paypal_server_sdk/models/three_d_secure_card_authentication_response.rb +89 -0
  345. data/lib/paypal_server_sdk/models/token.rb +68 -0
  346. data/lib/paypal_server_sdk/models/token_type.rb +27 -0
  347. data/lib/paypal_server_sdk/models/transaction_details.rb +126 -0
  348. data/lib/paypal_server_sdk/models/transaction_information.rb +494 -0
  349. data/lib/paypal_server_sdk/models/transaction_search_error_details.rb +103 -0
  350. data/lib/paypal_server_sdk/models/transactions_list.rb +111 -0
  351. data/lib/paypal_server_sdk/models/trustly_payment_object.rb +110 -0
  352. data/lib/paypal_server_sdk/models/trustly_payment_request.rb +97 -0
  353. data/lib/paypal_server_sdk/models/universal_product_code.rb +68 -0
  354. data/lib/paypal_server_sdk/models/upc_type.rb +56 -0
  355. data/lib/paypal_server_sdk/models/update_pricing_scheme.rb +72 -0
  356. data/lib/paypal_server_sdk/models/update_pricing_schemes_request.rb +69 -0
  357. data/lib/paypal_server_sdk/models/usage_pattern.rb +95 -0
  358. data/lib/paypal_server_sdk/models/vault_apple_pay_request.rb +73 -0
  359. data/lib/paypal_server_sdk/models/vault_card_experience_context.rb +128 -0
  360. data/lib/paypal_server_sdk/models/vault_card_verification_method.rb +52 -0
  361. data/lib/paypal_server_sdk/models/vault_customer.rb +72 -0
  362. data/lib/paypal_server_sdk/models/vault_experience_context.rb +154 -0
  363. data/lib/paypal_server_sdk/models/vault_instruction.rb +62 -0
  364. data/lib/paypal_server_sdk/models/vault_instruction_action.rb +39 -0
  365. data/lib/paypal_server_sdk/models/vault_instruction_base.rb +64 -0
  366. data/lib/paypal_server_sdk/models/vault_paypal_wallet_request.rb +154 -0
  367. data/lib/paypal_server_sdk/models/vault_response.rb +100 -0
  368. data/lib/paypal_server_sdk/models/vault_response_customer.rb +86 -0
  369. data/lib/paypal_server_sdk/models/vault_status.rb +45 -0
  370. data/lib/paypal_server_sdk/models/vault_token_request.rb +68 -0
  371. data/lib/paypal_server_sdk/models/vault_token_request_type.rb +26 -0
  372. data/lib/paypal_server_sdk/models/vault_user_action.rb +42 -0
  373. data/lib/paypal_server_sdk/models/vault_venmo_request.rb +143 -0
  374. data/lib/paypal_server_sdk/models/vaulted_digital_wallet.rb +132 -0
  375. data/lib/paypal_server_sdk/models/vaulted_digital_wallet_shipping_details.rb +114 -0
  376. data/lib/paypal_server_sdk/models/venmo_experience_context.rb +101 -0
  377. data/lib/paypal_server_sdk/models/venmo_payment_token.rb +199 -0
  378. data/lib/paypal_server_sdk/models/venmo_payment_token_customer_type.rb +40 -0
  379. data/lib/paypal_server_sdk/models/venmo_payment_token_usage_pattern.rb +58 -0
  380. data/lib/paypal_server_sdk/models/venmo_payment_token_usage_type.rb +39 -0
  381. data/lib/paypal_server_sdk/models/venmo_vault_response.rb +100 -0
  382. data/lib/paypal_server_sdk/models/venmo_vault_response_status.rb +45 -0
  383. data/lib/paypal_server_sdk/models/venmo_wallet_additional_attributes.rb +72 -0
  384. data/lib/paypal_server_sdk/models/venmo_wallet_attributes_response.rb +62 -0
  385. data/lib/paypal_server_sdk/models/venmo_wallet_customer_information.rb +94 -0
  386. data/lib/paypal_server_sdk/models/venmo_wallet_experience_context.rb +108 -0
  387. data/lib/paypal_server_sdk/models/venmo_wallet_experience_context_shipping_preference.rb +43 -0
  388. data/lib/paypal_server_sdk/models/venmo_wallet_experience_context_user_action.rb +42 -0
  389. data/lib/paypal_server_sdk/models/venmo_wallet_request.rb +102 -0
  390. data/lib/paypal_server_sdk/models/venmo_wallet_response.rb +146 -0
  391. data/lib/paypal_server_sdk/models/venmo_wallet_vault_attributes.rb +131 -0
  392. data/lib/paypal_server_sdk/utilities/date_time_helper.rb +11 -0
  393. data/lib/paypal_server_sdk/utilities/file_wrapper.rb +28 -0
  394. data/lib/paypal_server_sdk.rb +433 -0
  395. metadata +478 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: c2913c2a1923487acf72ced7844e48f26bb3baba18903fd9ff45e89c0b4402b7
4
+ data.tar.gz: 87bcf08ba95b9520a178b791768e5d649b55888449b036318986f011563a51fc
5
+ SHA512:
6
+ metadata.gz: 8e1534a750f012ad87ece12b66834e6d3cfc71451e83988041701541eb4911a21e034b6090e81337dbe71aea4d1d3020c1ecfe9946ee6d2de31db19c772482d0
7
+ data.tar.gz: fb30d33bfddaecf71dcaa6c1dc892d0f19b9486c690eca28c3f5fe3469e812882255baadda90d23775d368f5ccc7fd9d13b44375994e62dcf59326ef7a46de5a
data/LICENSE ADDED
@@ -0,0 +1,35 @@
1
+ The PayPal Server SDK is released under the following license:
2
+
3
+ Copyright (c) 2024 PAYPAL, INC.
4
+
5
+ SDK LICENSE
6
+
7
+ NOTICE TO USER: PayPal, Inc. is providing the Software and Documentation for use under the terms of this Agreement. Any use, reproduction, modification or distribution of the Software or Documentation, or any derivatives or portions hereof, constitutes your acceptance of this Agreement.
8
+ As used in this Agreement, "PayPal" means PayPal, Inc. "Software" means the software code accompanying this agreement. "Documentation" means the documents, specifications and all other items accompanying this Agreement other than the Software.
9
+
10
+ 1. LICENSE GRANT
11
+ Subject to the terms of this Agreement, PayPal hereby grants you a non-exclusive, worldwide, royalty free license to use, reproduce, prepare derivative works from, publicly display, publicly perform, distribute and sublicense the Software for any purpose, other than perpetration of any fraud or violation of any law, statute, ordinance, or regulation (for example, those governing financial services, consumer protections, unfair competition, anti-discrimination or false advertising), provided the copyright notice below appears in a conspicuous location within the source code of the distributed Software and this license is distributed in the supporting documentation of the Software you distribute. Furthermore, you must comply with all third party licenses in order to use the third party software contained in the Software.
12
+ Subject to the terms of this Agreement, PayPal hereby grants you a non-exclusive, worldwide, royalty free license to use, reproduce, publicly display, publicly perform, distribute and sublicense the Documentation for any purpose, other than perpetration of any fraud or violation of any law, statute, ordinance, or regulation (for example, those governing financial services, consumer protections, unfair competition, anti-discrimination or false advertising). You may not modify the Documentation.
13
+ No title to the intellectual property in the Software or Documentation is transferred to you under the terms of this Agreement. You do not acquire any rights to the Software or the Documentation except as expressly set forth in this Agreement.
14
+ Nothing in this Agreement provides you with any right, title, or license to use PayPal’s or any third party’s copyright, patent, trademark, trade secret, or other intellectual property rights, or rights of publicity or privacy, beyond the rights specifically granted herein. You may not infringe PayPal’s or any third party’s copyright, patent, trademark, trade secret, or other intellectual property rights, or rights of publicity or privacy.
15
+ If you choose to distribute the Software in a commercial product, you do so with the understanding that you agree to defend, indemnify and hold harmless PayPal and its suppliers against any losses, damages and costs arising from the claims, lawsuits or other legal actions arising out of such distribution. You may distribute the Software in object code form under your own license, provided that your license agreement:
16
+ (a) complies with the terms and conditions of this license agreement;
17
+ (b) effectively disclaims all warranties and conditions, express or implied, on behalf of PayPal;
18
+ (c) effectively excludes all liability for damages on behalf of PayPal;
19
+ (d) states that any provisions that differ from this Agreement are offered by you alone and not PayPal; and
20
+ (e) states that the Software is available from you or PayPal and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
21
+
22
+ 2. DISCLAIMER OF WARRANTY
23
+ PAYPAL LICENSES THE SOFTWARE AND DOCUMENTATION TO YOU ONLY ON AN "AS IS" BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. PAYPAL MAKES NO WARRANTY THAT THE SOFTWARE OR DOCUMENTATION WILL BE ERROR-FREE. Each user of the Software or Documentation is solely responsible for determining the appropriateness of using and distributing the Software and Documentation and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs, or equipment, and unavailability or interruption of operations. Use of the Software and Documentation is made with the understanding that PayPal will not provide you with any technical or customer support or maintenance. Some states or jurisdictions do not allow the exclusion of implied warranties or limitations on how long an implied warranty may last, so the above limitations may not apply to you. To the extent permissible, any implied warranties are limited to ninety (90) days.
24
+
25
+ 3. LIMITATION OF LIABILITY
26
+ PAYPAL AND ITS SUPPLIERS SHALL NOT BE LIABLE FOR LOSS OR DAMAGE ARISING OUT OF THIS AGREEMENT OR FROM THE USE OF THE SOFTWARE OR DOCUMENTATION. IN NO EVENT WILL PAYPAL OR ITS SUPPLIERS BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, INCIDENTAL, OR SPECIAL DAMAGES INCLUDING LOST PROFITS, LOST SAVINGS, COSTS, FEES, OR EXPENSES OF ANY KIND ARISING OUT OF ANY PROVISION OF THIS AGREEMENT OR THE USE OR THE INABILITY TO USE THE SOFTWARE OR DOCUMENTATION, HOWEVER CAUSED AND UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR TORT INCLUDING NEGLIGENCE (OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. PAYPAL'S AGGREGATE LIABILITY AND THAT OF ITS SUPPLIERS UNDER OR IN CONNECTION WITH THIS AGREEMENT SHALL BE LIMITED TO THE AMOUNT PAID BY YOU FOR THE SOFTWARE AND DOCUMENTATION.
27
+
28
+ 4. TRADEMARK USAGE
29
+ PayPal is a trademark PayPal, Inc. in the United States and other countries. Such trademarks may not be used to endorse or promote any product unless expressly permitted under separate agreement with PayPal.
30
+
31
+ 5. TERM
32
+ Your rights under this Agreement shall terminate if you fail to comply with any of the material terms or conditions of this Agreement and do not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all your rights under this Agreement terminate, you agree to cease use and distribution of the Software and Documentation as soon as reasonably practicable.
33
+
34
+ 6. GOVERNING LAW AND JURISDICTION.
35
+ This Agreement is governed by the statutes and laws of the State of California, without regard to the conflicts of law principles thereof. If any part of this Agreement is found void and unenforceable, it will not affect the validity of the balance of the Agreement, which shall remain valid and enforceable according to its terms. Any dispute arising out of or related to this Agreement shall be brought in the courts of Santa Clara County, California, USA.
data/README.md ADDED
@@ -0,0 +1,176 @@
1
+
2
+ # Getting Started with PayPal Server SDK
3
+
4
+ ## Introduction
5
+
6
+ ### Important Notes
7
+
8
+ - **Available Features:** This SDK currently contains only 5 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future.
9
+
10
+ ### Information
11
+
12
+ The PayPal Server SDK provides integration access to the PayPal REST APIs. The API endpoints are divided into distinct controllers:
13
+
14
+ - Orders Controller: [Orders API v2](https://developer.paypal.com/docs/api/orders/v2/)
15
+ - Payments Controller: [Payments API v2](https://developer.paypal.com/docs/api/payments/v2)
16
+ - Vault Controller: [Payment Method Tokens API v3](https://developer.paypal.com/docs/api/payment-tokens/v3/) *Available in the US only.*
17
+ - Transaction Search Controller: [Transaction Search API v1](https://developer.paypal.com/docs/api/transaction-search/v1/)
18
+ - Subscriptions Controller: [Subscriptions API v1](https://developer.paypal.com/docs/api/subscriptions/v1/)
19
+
20
+ ## Install the Package
21
+
22
+ Install the gem from the command line:
23
+
24
+ ```bash
25
+ gem install paypal-apimatic-sdk -v 1.0.0
26
+ ```
27
+
28
+ Or add the gem to your Gemfile and run `bundle`:
29
+
30
+ ```ruby
31
+ gem 'paypal-apimatic-sdk', '1.0.0'
32
+ ```
33
+
34
+ For additional gem details, see the [RubyGems page for the paypal-apimatic-sdk gem](https://rubygems.org/gems/paypal-apimatic-sdk/versions/1.0.0).
35
+
36
+ ## IRB Console Usage
37
+
38
+ You can explore the SDK interactively using IRB in two ways
39
+
40
+ ### 1. Use IRB with Installed Gem
41
+
42
+ Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
43
+
44
+ ```bash
45
+ irb
46
+ ```
47
+
48
+ Now you can load the SDK in the IRB
49
+
50
+ ```ruby
51
+ require 'paypal_server_sdk'
52
+ include PaypalServerSdk
53
+ ```
54
+
55
+ ### 2. Use IRB within SDK
56
+
57
+ Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
58
+
59
+ ```
60
+ cd path/to/paypal_server_sdk
61
+ ```
62
+
63
+ Now you can start the preconfigured irb console by running the following command
64
+
65
+ ```bash
66
+ ruby bin/console
67
+ ```
68
+
69
+ **_Note:_** This automatically loads the SDK from lib/
70
+
71
+ ## Initialize the API Client
72
+
73
+ **_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/client.md)
74
+
75
+ The following parameters are configurable for the API Client:
76
+
77
+ | Parameter | Type | Description |
78
+ | --- | --- | --- |
79
+ | environment | [`Environment`](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.SANDBOX`** |
80
+ | connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
81
+ | adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
82
+ | timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
83
+ | max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
84
+ | retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
85
+ | backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
86
+ | retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
87
+ | retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
88
+ | http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
89
+ | proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
90
+ | logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
91
+ | client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
92
+
93
+ The API client can be initialized as follows:
94
+
95
+ ### Code-Based Client Initialization
96
+
97
+ ```ruby
98
+ require 'paypal_server_sdk'
99
+ include PaypalServerSdk
100
+
101
+ client = Client.new(
102
+ client_credentials_auth_credentials: ClientCredentialsAuthCredentials.new(
103
+ o_auth_client_id: 'OAuthClientId',
104
+ o_auth_client_secret: 'OAuthClientSecret'
105
+ ),
106
+ environment: Environment::SANDBOX,
107
+ logging_configuration: LoggingConfiguration.new(
108
+ log_level: Logger::INFO,
109
+ request_logging_config: RequestLoggingConfiguration.new(
110
+ log_body: true
111
+ ),
112
+ response_logging_config: ResponseLoggingConfiguration.new(
113
+ log_headers: true
114
+ )
115
+ )
116
+ )
117
+ ```
118
+
119
+ ### Environment-Based Client Initialization
120
+
121
+ ```ruby
122
+ require 'paypal_server_sdk'
123
+ include PaypalServerSdk
124
+
125
+ # Create client from environment
126
+ client = Client.from_env
127
+ ```
128
+
129
+ See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md) section for details.
130
+
131
+ ## Environments
132
+
133
+ The SDK can be configured to use a different environment for making API calls. Available environments are:
134
+
135
+ ### Fields
136
+
137
+ | Name | Description |
138
+ | --- | --- |
139
+ | SANDBOX | **Default** PayPal Sandbox Environment |
140
+
141
+ ## Authorization
142
+
143
+ This API uses the following authentication schemes.
144
+
145
+ * [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md)
146
+
147
+ ## List of APIs
148
+
149
+ * [Transactionsearch](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/transactionsearch.md)
150
+ * [Orders](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/orders.md)
151
+ * [Payments](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/payments.md)
152
+ * [Vault](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/vault.md)
153
+ * [Subscriptions](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/subscriptions.md)
154
+
155
+ ## SDK Infrastructure
156
+
157
+ ### Configuration
158
+
159
+ * [ProxySettings](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/proxy-settings.md)
160
+ * [Environment-Based Client Initialization](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
161
+ * [AbstractLogger](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/abstract-logger.md)
162
+ * [LoggingConfiguration](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/logging-configuration.md)
163
+ * [RequestLoggingConfiguration](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/request-logging-configuration.md)
164
+ * [ResponseLoggingConfiguration](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/response-logging-configuration.md)
165
+
166
+ ### HTTP
167
+
168
+ * [HttpResponse](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/http-response.md)
169
+ * [HttpRequest](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/http-request.md)
170
+
171
+ ### Utilities
172
+
173
+ * [ApiResponse](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/api-response.md)
174
+ * [ApiHelper](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/api-helper.md)
175
+ * [DateTimeHelper](https://www.github.com/sdks-io/paypal-apimatic-ruby-sdk/tree/1.0.0/doc/date-time-helper.md)
176
+
data/bin/console ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ # Load the lib folder into Ruby's load path
4
+ $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
5
+
6
+ # Require the gem
7
+ require 'paypal_server_sdk'
8
+
9
+ puts 'PaypalServerSdk SDK loaded!'
10
+ puts 'You can now create a client with: client = PaypalServerSdk::Client.new'
11
+ puts 'Or use from_env: client = PaypalServerSdk::Client.from_env'
12
+
13
+ # Start an interactive IRB session
14
+ require 'irb'
15
+ IRB.start
@@ -0,0 +1,10 @@
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
+ # API utility class
8
+ class APIHelper < CoreLibrary::ApiHelper
9
+ end
10
+ end
@@ -0,0 +1,109 @@
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
+ # paypal_server_sdk client class.
8
+ class Client
9
+ include CoreLibrary
10
+ attr_reader :config, :auth_managers
11
+
12
+ def user_agent_detail
13
+ config.user_agent_detail
14
+ end
15
+
16
+ # Returns the configured authentication Oauth2 instance.
17
+ def oauth2
18
+ @auth_managers['Oauth2']
19
+ end
20
+
21
+ # Access to orders controller.
22
+ # @return [OrdersController] Returns the controller instance.
23
+ def orders
24
+ @orders ||= OrdersController.new @global_configuration
25
+ end
26
+
27
+ # Access to payments controller.
28
+ # @return [PaymentsController] Returns the controller instance.
29
+ def payments
30
+ @payments ||= PaymentsController.new @global_configuration
31
+ end
32
+
33
+ # Access to vault controller.
34
+ # @return [VaultController] Returns the controller instance.
35
+ def vault
36
+ @vault ||= VaultController.new @global_configuration
37
+ end
38
+
39
+ # Access to transaction_search controller.
40
+ # @return [TransactionSearchController] Returns the controller instance.
41
+ def transaction_search
42
+ @transaction_search ||= TransactionSearchController.new @global_configuration
43
+ end
44
+
45
+ # Access to subscriptions controller.
46
+ # @return [SubscriptionsController] Returns the controller instance.
47
+ def subscriptions
48
+ @subscriptions ||= SubscriptionsController.new @global_configuration
49
+ end
50
+
51
+ # Access to o_auth_authorization controller.
52
+ # @return [OAuthAuthorizationController] Returns the controller instance.
53
+ def o_auth_authorization
54
+ @o_auth_authorization ||= OAuthAuthorizationController.new @global_configuration
55
+ end
56
+
57
+ def initialize(
58
+ connection: nil, adapter: :net_http_persistent, timeout: 60,
59
+ max_retries: 0, retry_interval: 1, backoff_factor: 2,
60
+ retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
61
+ retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
62
+ logging_configuration: nil, environment: Environment::SANDBOX,
63
+ client_credentials_auth_credentials: nil, config: nil
64
+ )
65
+ @config = if config.nil?
66
+ Configuration.new(
67
+ connection: connection, adapter: adapter, timeout: timeout,
68
+ max_retries: max_retries, retry_interval: retry_interval,
69
+ backoff_factor: backoff_factor,
70
+ retry_statuses: retry_statuses,
71
+ retry_methods: retry_methods, http_callback: http_callback,
72
+ proxy_settings: proxy_settings,
73
+ logging_configuration: logging_configuration,
74
+ environment: environment,
75
+ client_credentials_auth_credentials: client_credentials_auth_credentials
76
+ )
77
+ else
78
+ config
79
+ end
80
+ user_agent_params = BaseController.user_agent_parameters
81
+
82
+ @global_configuration = GlobalConfiguration.new(client_configuration: @config)
83
+ .base_uri_executor(@config.method(:get_base_uri))
84
+ .global_errors(BaseController::GLOBAL_ERRORS)
85
+ .user_agent(BaseController.user_agent,
86
+ agent_parameters: user_agent_params)
87
+
88
+ initialize_auth_managers(@global_configuration)
89
+ @global_configuration = @global_configuration.auth_managers(@auth_managers)
90
+ end
91
+
92
+ # Initializes the auth managers hash used for authenticating API calls.
93
+ # @param [GlobalConfiguration] global_config The global configuration of the SDK)
94
+ def initialize_auth_managers(global_config)
95
+ @auth_managers = {}
96
+ http_client_config = global_config.client_configuration
97
+ %w[Oauth2].each { |auth| @auth_managers[auth] = nil }
98
+ @auth_managers['Oauth2'] = OAuth2.new(http_client_config.client_credentials_auth_credentials,
99
+ global_config)
100
+ end
101
+
102
+ # Creates a client directly from environment variables.
103
+ def self.from_env(**overrides)
104
+ default_config = Configuration.build_default_config_from_env
105
+ new_config = default_config.clone_with(**overrides)
106
+ new(config: new_config)
107
+ end
108
+ end
109
+ end
@@ -0,0 +1,164 @@
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
+ # An enum for SDK environments.
8
+ class Environment
9
+ # SANDBOX: PayPal Sandbox Environment
10
+ ENVIRONMENT = [
11
+ SANDBOX = 'Sandbox'.freeze
12
+ ].freeze
13
+
14
+ # Converts a string or symbol into a valid Environment constant.
15
+ def self.from_value(value, default_value = SANDBOX)
16
+ return default_value if value.nil?
17
+
18
+ default_value
19
+ end
20
+ end
21
+
22
+ # An enum for API servers.
23
+ class Server
24
+ SERVER = [
25
+ DEFAULT = 'default'.freeze
26
+ ].freeze
27
+
28
+ # Converts a string or symbol into a valid Server constant.
29
+ def self.from_value(value, default_value = DEFAULT)
30
+ return default_value if value.nil?
31
+
32
+ default_value
33
+ end
34
+ end
35
+
36
+ # All configuration including auth info and base URI for the API access
37
+ # are configured in this class.
38
+ class Configuration < CoreLibrary::HttpClientConfiguration
39
+ # The attribute readers for properties.
40
+ attr_reader :environment, :client_credentials_auth_credentials
41
+
42
+ class << self
43
+ attr_reader :environments
44
+ end
45
+
46
+ def initialize(
47
+ connection: nil, adapter: :net_http_persistent, timeout: 60,
48
+ max_retries: 0, retry_interval: 1, backoff_factor: 2,
49
+ retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
50
+ retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
51
+ logging_configuration: nil, environment: Environment::SANDBOX,
52
+ client_credentials_auth_credentials: nil
53
+ )
54
+ super connection: connection, adapter: adapter, timeout: timeout,
55
+ max_retries: max_retries, retry_interval: retry_interval,
56
+ backoff_factor: backoff_factor, retry_statuses: retry_statuses,
57
+ retry_methods: retry_methods, http_callback: http_callback,
58
+ proxy_settings: proxy_settings,
59
+ logging_configuration: logging_configuration
60
+
61
+ # Current API environment
62
+ @environment = String(environment)
63
+
64
+ # The object holding OAuth 2 Client Credentials Grant credentials
65
+ @client_credentials_auth_credentials = client_credentials_auth_credentials
66
+
67
+ # Initializing OAuth 2 Client Credentials Grant credentials with the provided auth parameters
68
+ @client_credentials_auth_credentials = client_credentials_auth_credentials
69
+
70
+ # The Http Client to use for making requests.
71
+ set_http_client CoreLibrary::FaradayClient.new(self)
72
+ end
73
+
74
+ def clone_with(connection: nil, adapter: nil, timeout: nil,
75
+ max_retries: nil, retry_interval: nil, backoff_factor: nil,
76
+ retry_statuses: nil, retry_methods: nil, http_callback: nil,
77
+ proxy_settings: nil, logging_configuration: nil,
78
+ environment: nil, client_credentials_auth_credentials: nil)
79
+ connection ||= self.connection
80
+ adapter ||= self.adapter
81
+ timeout ||= self.timeout
82
+ max_retries ||= self.max_retries
83
+ retry_interval ||= self.retry_interval
84
+ backoff_factor ||= self.backoff_factor
85
+ retry_statuses ||= self.retry_statuses
86
+ retry_methods ||= self.retry_methods
87
+ http_callback ||= self.http_callback
88
+ proxy_settings ||= self.proxy_settings
89
+ logging_configuration ||= self.logging_configuration
90
+ environment ||= self.environment
91
+ client_credentials_auth_credentials ||= self.client_credentials_auth_credentials
92
+
93
+ Configuration.new(
94
+ connection: connection, adapter: adapter, timeout: timeout,
95
+ max_retries: max_retries, retry_interval: retry_interval,
96
+ backoff_factor: backoff_factor, retry_statuses: retry_statuses,
97
+ retry_methods: retry_methods, http_callback: http_callback,
98
+ proxy_settings: proxy_settings,
99
+ logging_configuration: logging_configuration, environment: environment,
100
+ client_credentials_auth_credentials: client_credentials_auth_credentials
101
+ )
102
+ end
103
+
104
+
105
+ # All the environments the SDK can run in.
106
+ ENVIRONMENTS = {
107
+ Environment::SANDBOX => {
108
+ Server::DEFAULT => 'https://api-m.sandbox.paypal.com'
109
+ }
110
+ }.freeze
111
+
112
+ # Generates the appropriate base URI for the environment and the server.
113
+ # @param [Configuration::Server] server The server enum for which the base URI is
114
+ # required.
115
+ # @return [String] The base URI.
116
+ def get_base_uri(server = Server::DEFAULT)
117
+ ENVIRONMENTS[environment][server].clone
118
+ end
119
+
120
+ # Builds a Configuration instance using environment variables.
121
+ def self.build_default_config_from_env
122
+ # === Core environment ===
123
+ environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'sandbox'))
124
+ timeout = (ENV['TIMEOUT'] || 60).to_f
125
+ max_retries = (ENV['MAX_RETRIES'] || 0).to_i
126
+ retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
127
+ backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
128
+ retry_statuses = ENV.fetch('RETRY_STATUSES',
129
+ '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
130
+ .split(',')
131
+ .map(&:strip)
132
+ .map do |item|
133
+ item.match?(/\A\d+\z/) ? item.to_i : item.downcase
134
+ end
135
+ retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
136
+ .split(',')
137
+ .map(&:strip)
138
+ .map do |item|
139
+ item.match?(/\A\d+\z/) ? item.to_i : item.downcase
140
+ end
141
+
142
+ # === Authentication credentials ===
143
+ client_credentials_auth_credentials = ClientCredentialsAuthCredentials.from_env
144
+
145
+ # === Proxy settings ===
146
+ proxy_settings = ProxySettings.from_env
147
+ # === Logging Configuration ===
148
+ logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
149
+
150
+ Configuration.new(
151
+ environment: environment,
152
+ timeout: timeout,
153
+ max_retries: max_retries,
154
+ retry_interval: retry_interval,
155
+ backoff_factor: backoff_factor,
156
+ retry_statuses: retry_statuses,
157
+ retry_methods: retry_methods,
158
+ client_credentials_auth_credentials: client_credentials_auth_credentials,
159
+ proxy_settings: proxy_settings,
160
+ logging_configuration: logging_configuration
161
+ )
162
+ end
163
+ end
164
+ end
@@ -0,0 +1,65 @@
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
+ # BaseController.
8
+ class BaseController
9
+ include CoreLibrary
10
+ attr_accessor :config, :http_call_back
11
+
12
+ def self.user_agent
13
+ 'PayPal REST API Ruby SDK, Version: 1.0.0, on OS {os-info}'
14
+ end
15
+
16
+ def self.user_agent_parameters
17
+ {
18
+ '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
19
+ }
20
+ end
21
+
22
+ GLOBAL_ERRORS = {
23
+ 'default' => ErrorCase.new
24
+ .error_message('HTTP response not OK.')
25
+ .exception_type(APIException)
26
+ }.freeze
27
+
28
+ # Initialization constructor.
29
+ # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
30
+ def initialize(global_configuration)
31
+ @global_configuration = global_configuration
32
+ @config = @global_configuration.client_configuration
33
+ @http_call_back = @config.http_callback
34
+ @api_call = ApiCall.new(@global_configuration)
35
+ end
36
+
37
+ # Creates a new instance of the request builder.
38
+ # @param [String] http_method The HTTP method to use in the request.
39
+ # @param [String] path The endpoint path to use in the request.
40
+ # @param [String] server The server to extract the base uri for the request.
41
+ # @return [RequestBuilder] The instance of RequestBuilder.
42
+ def new_request_builder(http_method, path, server)
43
+ RequestBuilder.new
44
+ .http_method(http_method)
45
+ .path(path)
46
+ .server(server)
47
+ end
48
+
49
+ # Creates a new instance of the response handler.
50
+ # @return [ResponseHandler] The instance of ResponseHandler.
51
+ def new_response_handler
52
+ ResponseHandler.new
53
+ end
54
+
55
+ # Creates a new instance of the parameter.
56
+ # @param [String|optional] key The key of the parameter.
57
+ # @param [Object] value The value of the parameter.
58
+ # @return [Parameter] The instance of Parameter.
59
+ def new_parameter(value, key: nil)
60
+ Parameter.new
61
+ .key(key)
62
+ .value(value)
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,42 @@
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
+ # OAuthAuthorizationController
8
+ class OAuthAuthorizationController < BaseController
9
+ # Create a new OAuth 2 token.
10
+ # @param [String] authorization Required parameter: Authorization header in
11
+ # Basic auth format
12
+ # @param [String] scope Optional parameter: Requested scopes as a
13
+ # space-delimited list.
14
+ # @param [Hash] _field_parameters Additional optional form parameters are
15
+ # supported by this endpoint.
16
+ # @return [ApiResponse] Complete http response with raw body and status code.
17
+ def request_token(options = {},
18
+ _field_parameters: nil)
19
+ @api_call
20
+ .request(new_request_builder(HttpMethodEnum::POST,
21
+ '/v1/oauth2/token',
22
+ Server::DEFAULT)
23
+ .form_param(new_parameter('client_credentials', key: 'grant_type'))
24
+ .header_param(new_parameter(options['authorization'], key: 'Authorization'))
25
+ .form_param(new_parameter(options['scope'], key: 'scope'))
26
+ .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
27
+ .header_param(new_parameter('application/json', key: 'accept'))
28
+ .additional_form_params(_field_parameters))
29
+ .response(new_response_handler
30
+ .deserializer(APIHelper.method(:custom_type_deserializer))
31
+ .deserialize_into(OAuthToken.method(:from_hash))
32
+ .is_api_response(true)
33
+ .local_error('400',
34
+ 'OAuth 2 provider returned an error.',
35
+ OAuthProviderException)
36
+ .local_error('401',
37
+ 'OAuth 2 provider says client authentication failed.',
38
+ OAuthProviderException))
39
+ .execute
40
+ end
41
+ end
42
+ end