velopayments 2.14.90.pre.1 → 2.17.8.beta1
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.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/Makefile +41 -9
- data/README.md +61 -23
- data/docs/AuthApi.md +8 -9
- data/docs/AuthResponse.md +3 -1
- data/docs/CompanyResponse.md +19 -0
- data/docs/{Company.md → CompanyV1.md} +2 -2
- data/docs/CreateIndividual.md +1 -1
- data/docs/CreateIndividual2.md +21 -0
- data/docs/CreatePayee.md +3 -3
- data/docs/CreatePayee2.md +37 -0
- data/docs/CreatePayeeAddress.md +1 -1
- data/docs/CreatePayeeAddress2.md +31 -0
- data/docs/CreatePayeesCSVRequest.md +1 -1
- data/docs/CreatePayeesCSVRequest2.md +73 -0
- data/docs/CreatePayeesCSVResponse2.md +19 -0
- data/docs/CreatePayeesRequest2.md +19 -0
- data/docs/CreatePaymentChannel2.md +29 -0
- data/docs/CreatePayoutRequest.md +6 -2
- data/docs/Error.md +23 -0
- data/docs/ErrorResponse.md +19 -0
- data/docs/FundingAudit.md +3 -1
- data/docs/FundingDelta.md +23 -0
- data/docs/FundingDeltaResponse.md +21 -0
- data/docs/FundingDeltaResponseLinks.md +19 -0
- data/docs/FundingEvent.md +3 -1
- data/docs/FundingManagerApi.md +33 -26
- data/docs/GetFundingsResponse.md +1 -1
- data/docs/GetFundingsResponseAllOf.md +1 -1
- data/docs/GetPaymentsForPayoutResponseV4.md +2 -2
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +16 -0
- data/docs/GetPayoutsResponseV4.md +3 -3
- data/docs/IndividualResponse.md +17 -0
- data/docs/{Individual.md → IndividualV1.md} +5 -5
- data/docs/{IndividualName.md → IndividualV1Name.md} +2 -2
- data/docs/PagedPayeeInvitationStatusResponse.md +2 -2
- data/docs/PagedPayeeResponse.md +23 -0
- data/docs/PagedPayeeResponse2.md +23 -0
- data/docs/PagedPayeeResponse2Summary.md +25 -0
- data/docs/{PayeeResponseLinks.md → PagedPayeeResponseLinks.md} +2 -2
- data/docs/{PayeeResponsePage.md → PagedPayeeResponsePage.md} +2 -2
- data/docs/{PayeeResponseSummary.md → PagedPayeeResponseSummary.md} +2 -2
- data/docs/Payee.md +9 -9
- data/docs/{Address.md → PayeeAddress.md} +2 -2
- data/docs/PayeeDelta.md +1 -1
- data/docs/PayeeInvitationApi.md +109 -3
- data/docs/{PaymentChannel.md → PayeePaymentChannel.md} +2 -2
- data/docs/{PayorRef.md → PayeePayorRef.md} +2 -2
- data/docs/PayeePayorRef2.md +21 -0
- data/docs/PayeeResponse.md +40 -8
- data/docs/PayeeResponse2.md +55 -0
- data/docs/PayeesApi.md +133 -4
- data/docs/PaymentAuditServiceApi.md +70 -7
- data/docs/PaymentDelta.md +31 -0
- data/docs/PaymentDeltaResponse.md +21 -0
- data/docs/PaymentResponseV4.md +4 -2
- data/docs/PaymentResponseV4Payout.md +19 -0
- data/docs/PaymentStatus.md +16 -0
- data/docs/PayorAddress.md +31 -0
- data/docs/PayorAddressV2.md +31 -0
- data/docs/PayorV1.md +9 -7
- data/docs/PayorV2.md +9 -7
- data/docs/PayorsApi.md +8 -6
- data/docs/PayoutPayorV4.md +25 -0
- data/docs/PayoutPrincipalV4.md +19 -0
- data/docs/PayoutSummaryAuditV4.md +5 -3
- data/docs/PayoutTypeV4.md +16 -0
- data/docs/QuoteFxSummary.md +2 -2
- data/docs/UpdateRemoteIdRequest.md +19 -0
- data/docs/WatchlistStatus.md +16 -0
- data/lib/velopayments.rb +41 -12
- data/lib/velopayments/api/auth_api.rb +9 -16
- data/lib/velopayments/api/countries_api.rb +2 -2
- data/lib/velopayments/api/currencies_api.rb +2 -2
- data/lib/velopayments/api/funding_manager_api.rb +63 -55
- data/lib/velopayments/api/get_payout_api.rb +3 -3
- data/lib/velopayments/api/instruct_payout_api.rb +3 -3
- data/lib/velopayments/api/payee_invitation_api.rb +134 -8
- data/lib/velopayments/api/payees_api.rb +177 -9
- data/lib/velopayments/api/payment_audit_service_api.rb +95 -12
- data/lib/velopayments/api/payor_applications_api.rb +4 -4
- data/lib/velopayments/api/payors_api.rb +18 -19
- data/lib/velopayments/api/payout_history_api.rb +4 -4
- data/lib/velopayments/api/quote_payout_api.rb +3 -3
- data/lib/velopayments/api/submit_payout_api.rb +2 -2
- data/lib/velopayments/api/withdraw_payout_api.rb +3 -3
- data/lib/velopayments/api_client.rb +30 -30
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +9 -2
- data/lib/velopayments/models/auth_response.rb +28 -7
- data/lib/velopayments/models/auto_top_up_config.rb +15 -3
- data/lib/velopayments/models/challenge.rb +13 -3
- data/lib/velopayments/models/company_response.rb +273 -0
- data/lib/velopayments/models/{company.rb → company_v1.rb} +18 -6
- data/lib/velopayments/models/create_individual.rb +14 -4
- data/lib/velopayments/models/create_individual2.rb +259 -0
- data/lib/velopayments/models/create_payee.rb +17 -5
- data/lib/velopayments/models/{payor_funding_bank_details_update.rb → create_payee2.rb} +153 -93
- data/lib/velopayments/models/create_payee_address.rb +19 -3
- data/lib/velopayments/models/create_payee_address2.rb +510 -0
- data/lib/velopayments/models/create_payees_csv_request.rb +14 -3
- data/lib/velopayments/models/create_payees_csv_request2.rb +1142 -0
- data/lib/velopayments/models/create_payees_csv_response.rb +13 -3
- data/lib/velopayments/models/create_payees_csv_response2.rb +217 -0
- data/lib/velopayments/models/create_payees_request.rb +13 -3
- data/lib/velopayments/models/create_payees_request2.rb +227 -0
- data/lib/velopayments/models/create_payment_channel.rb +13 -3
- data/lib/velopayments/models/create_payment_channel2.rb +418 -0
- data/lib/velopayments/models/create_payout_request.rb +36 -9
- data/lib/velopayments/models/error.rb +271 -0
- data/lib/velopayments/models/error_response.rb +222 -0
- data/lib/velopayments/models/failed_submission.rb +13 -3
- data/lib/velopayments/models/funding_audit.rb +38 -7
- data/lib/velopayments/models/funding_delta.rb +298 -0
- data/lib/velopayments/models/funding_delta_response.rb +229 -0
- data/lib/velopayments/models/funding_delta_response_links.rb +215 -0
- data/lib/velopayments/models/funding_event.rb +26 -7
- data/lib/velopayments/models/funding_event_type.rb +2 -2
- data/lib/velopayments/models/funding_request_v1.rb +13 -3
- data/lib/velopayments/models/funding_request_v2.rb +13 -3
- data/lib/velopayments/models/fx_summary_v3.rb +13 -3
- data/lib/velopayments/models/fx_summary_v4.rb +13 -3
- data/lib/velopayments/models/get_fundings_response.rb +17 -5
- data/lib/velopayments/models/get_fundings_response_all_of.rb +17 -5
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +13 -3
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +13 -3
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -3
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +15 -5
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +87 -4
- data/lib/velopayments/models/get_payout_statistics.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v3.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v3_summary.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v4.rb +16 -6
- data/lib/velopayments/models/individual_response.rb +211 -0
- data/lib/velopayments/models/{individual.rb → individual_v1.rb} +17 -7
- data/lib/velopayments/models/{individual_name.rb → individual_v1_name.rb} +16 -6
- data/lib/velopayments/models/invitation_status.rb +2 -2
- data/lib/velopayments/models/invitation_status_response.rb +13 -3
- data/lib/velopayments/models/invite_payee_request.rb +13 -3
- data/lib/velopayments/models/language.rb +2 -2
- data/lib/velopayments/models/list_payments_response.rb +13 -3
- data/lib/velopayments/models/list_payments_response_page.rb +13 -3
- data/lib/velopayments/models/list_payments_response_summary.rb +13 -3
- data/lib/velopayments/models/list_source_account_response.rb +13 -3
- data/lib/velopayments/models/list_source_account_response_links.rb +13 -3
- data/lib/velopayments/models/list_source_account_response_page.rb +13 -3
- data/lib/velopayments/models/list_source_account_response_v2.rb +13 -3
- data/lib/velopayments/models/list_source_account_response_v2_page.rb +13 -3
- data/lib/velopayments/models/marketing_opt_in.rb +13 -3
- data/lib/velopayments/models/notifications.rb +13 -3
- data/lib/velopayments/models/ofac_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status.rb +2 -2
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +15 -5
- data/lib/velopayments/models/paged_payee_response.rb +238 -0
- data/lib/velopayments/models/paged_payee_response2.rb +238 -0
- data/lib/velopayments/models/paged_payee_response2_summary.rb +242 -0
- data/lib/velopayments/models/{payee_response_links.rb → paged_payee_response_links.rb} +16 -6
- data/lib/velopayments/models/{payee_response_page.rb → paged_payee_response_page.rb} +16 -6
- data/lib/velopayments/models/{payee_response_summary.rb → paged_payee_response_summary.rb} +16 -6
- data/lib/velopayments/models/paged_response.rb +13 -3
- data/lib/velopayments/models/paged_response_page.rb +13 -3
- data/lib/velopayments/models/payee.rb +24 -8
- data/lib/velopayments/models/{address.rb → payee_address.rb} +21 -6
- data/lib/velopayments/models/payee_delta.rb +14 -3
- data/lib/velopayments/models/payee_delta_response.rb +13 -3
- data/lib/velopayments/models/payee_delta_response_links.rb +13 -3
- data/lib/velopayments/models/payee_delta_response_page.rb +13 -3
- data/lib/velopayments/models/payee_invitation_status.rb +13 -3
- data/lib/velopayments/models/payee_invitation_status_response.rb +13 -3
- data/lib/velopayments/models/{payment_channel.rb → payee_payment_channel.rb} +16 -6
- data/lib/velopayments/models/{payor_ref.rb → payee_payor_ref.rb} +16 -6
- data/lib/velopayments/models/payee_payor_ref2.rb +224 -0
- data/lib/velopayments/models/payee_response.rb +192 -32
- data/lib/velopayments/models/payee_response2.rb +388 -0
- data/lib/velopayments/models/payee_type.rb +2 -2
- data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
- data/lib/velopayments/models/payment_audit_currency_v4.rb +2 -2
- data/lib/velopayments/models/payment_channel_country.rb +13 -3
- data/lib/velopayments/models/payment_channel_rule.rb +13 -3
- data/lib/velopayments/models/payment_channel_rules_response.rb +13 -3
- data/lib/velopayments/models/payment_delta.rb +285 -0
- data/lib/velopayments/models/payment_delta_response.rb +229 -0
- data/lib/velopayments/models/payment_event_response_v3.rb +13 -3
- data/lib/velopayments/models/payment_event_response_v4.rb +13 -3
- data/lib/velopayments/models/payment_instruction.rb +13 -3
- data/lib/velopayments/models/payment_response_v3.rb +13 -3
- data/lib/velopayments/models/payment_response_v4.rb +27 -7
- data/lib/velopayments/models/payment_response_v4_payout.rb +215 -0
- data/lib/velopayments/models/payment_status.rb +42 -0
- data/lib/velopayments/models/payor_address.rb +493 -0
- data/lib/velopayments/models/payor_address_v2.rb +493 -0
- data/lib/velopayments/models/payor_branding_response.rb +16 -3
- data/lib/velopayments/models/payor_create_api_key_request.rb +14 -3
- data/lib/velopayments/models/payor_create_api_key_response.rb +13 -3
- data/lib/velopayments/models/payor_create_application_request.rb +14 -3
- data/lib/velopayments/models/payor_email_opt_out_request.rb +13 -3
- data/lib/velopayments/models/payor_links_response.rb +13 -3
- data/lib/velopayments/models/payor_links_response_links.rb +13 -3
- data/lib/velopayments/models/payor_links_response_payors.rb +13 -3
- data/lib/velopayments/models/payor_logo_request.rb +13 -3
- data/lib/velopayments/models/payor_v1.rb +27 -8
- data/lib/velopayments/models/payor_v2.rb +27 -8
- data/lib/velopayments/models/payout_payor_v4.rb +273 -0
- data/lib/velopayments/models/payout_principal_v4.rb +228 -0
- data/lib/velopayments/models/payout_status_v3.rb +2 -2
- data/lib/velopayments/models/payout_status_v4.rb +2 -2
- data/lib/velopayments/models/payout_summary_audit_v3.rb +13 -3
- data/lib/velopayments/models/payout_summary_audit_v4.rb +33 -8
- data/lib/velopayments/models/payout_summary_response.rb +13 -3
- data/lib/velopayments/models/payout_type_v4.rb +37 -0
- data/lib/velopayments/models/query_batch_response.rb +13 -3
- data/lib/velopayments/models/quote_fx_summary.rb +69 -3
- data/lib/velopayments/models/quote_response.rb +13 -3
- data/lib/velopayments/models/rejected_payment.rb +13 -3
- data/lib/velopayments/models/set_notifications_request.rb +13 -3
- data/lib/velopayments/models/source_account.rb +13 -3
- data/lib/velopayments/models/source_account_response.rb +15 -3
- data/lib/velopayments/models/source_account_response_v2.rb +15 -3
- data/lib/velopayments/models/source_account_summary_v3.rb +13 -3
- data/lib/velopayments/models/source_account_summary_v4.rb +13 -3
- data/lib/velopayments/models/supported_countries_response.rb +13 -3
- data/lib/velopayments/models/supported_country.rb +13 -3
- data/lib/velopayments/models/supported_currency.rb +13 -3
- data/lib/velopayments/models/supported_currency_response.rb +13 -3
- data/lib/velopayments/models/update_remote_id_request.rb +253 -0
- data/lib/velopayments/models/watchlist_status.rb +39 -0
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +2 -2
- data/spec/api/auth_api_spec.rb +3 -4
- data/spec/api/countries_api_spec.rb +2 -2
- data/spec/api/currencies_api_spec.rb +2 -2
- data/spec/api/funding_manager_api_spec.rb +17 -15
- data/spec/api/get_payout_api_spec.rb +2 -2
- data/spec/api/instruct_payout_api_spec.rb +2 -2
- data/spec/api/payee_invitation_api_spec.rb +27 -3
- data/spec/api/payees_api_spec.rb +39 -4
- data/spec/api/payment_audit_service_api_spec.rb +21 -5
- data/spec/api/payor_applications_api_spec.rb +2 -2
- data/spec/api/payors_api_spec.rb +5 -4
- data/spec/api/payout_history_api_spec.rb +2 -2
- data/spec/api/quote_payout_api_spec.rb +2 -2
- data/spec/api/submit_payout_api_spec.rb +2 -2
- data/spec/api/withdraw_payout_api_spec.rb +2 -2
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/auth_response_spec.rb +8 -2
- data/spec/models/auto_top_up_config_spec.rb +2 -2
- data/spec/models/challenge_spec.rb +2 -2
- data/spec/models/company_response_spec.rb +47 -0
- data/spec/models/{company_spec.rb → company_v1_spec.rb} +8 -8
- data/spec/models/{payor_funding_bank_details_update_spec.rb → create_individual2_spec.rb} +11 -11
- data/spec/models/create_individual_spec.rb +2 -2
- data/spec/models/create_payee2_spec.rb +101 -0
- data/spec/models/create_payee_address2_spec.rb +87 -0
- data/spec/models/create_payee_address_spec.rb +2 -2
- data/spec/models/create_payee_spec.rb +2 -2
- data/spec/models/create_payees_csv_request2_spec.rb +225 -0
- data/spec/models/create_payees_csv_request_spec.rb +2 -2
- data/spec/models/create_payees_csv_response2_spec.rb +47 -0
- data/spec/models/create_payees_csv_response_spec.rb +2 -2
- data/spec/models/create_payees_request2_spec.rb +47 -0
- data/spec/models/create_payees_request_spec.rb +2 -2
- data/spec/models/create_payment_channel2_spec.rb +85 -0
- data/spec/models/create_payment_channel_spec.rb +2 -2
- data/spec/models/create_payout_request_spec.rb +14 -2
- data/spec/models/error_response_spec.rb +47 -0
- data/spec/models/error_spec.rb +63 -0
- data/spec/models/failed_submission_spec.rb +2 -2
- data/spec/models/funding_audit_spec.rb +12 -2
- data/spec/models/funding_delta_response_links_spec.rb +47 -0
- data/spec/models/funding_delta_response_spec.rb +53 -0
- data/spec/models/funding_delta_spec.rb +59 -0
- data/spec/models/funding_event_spec.rb +8 -2
- data/spec/models/funding_event_type_spec.rb +2 -2
- data/spec/models/funding_request_v1_spec.rb +2 -2
- data/spec/models/funding_request_v2_spec.rb +2 -2
- data/spec/models/fx_summary_v3_spec.rb +2 -2
- data/spec/models/fx_summary_v4_spec.rb +2 -2
- data/spec/models/get_fundings_response_all_of_spec.rb +2 -2
- data/spec/models/get_fundings_response_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +50 -2
- data/spec/models/get_payout_statistics_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_summary_spec.rb +2 -2
- data/spec/models/get_payouts_response_v4_spec.rb +2 -2
- data/spec/models/individual_response_spec.rb +41 -0
- data/spec/models/{individual_name_spec.rb → individual_v1_name_spec.rb} +8 -8
- data/spec/models/{individual_spec.rb → individual_v1_spec.rb} +8 -8
- data/spec/models/invitation_status_response_spec.rb +2 -2
- data/spec/models/invitation_status_spec.rb +2 -2
- data/spec/models/invite_payee_request_spec.rb +2 -2
- data/spec/models/language_spec.rb +2 -2
- data/spec/models/list_payments_response_page_spec.rb +2 -2
- data/spec/models/list_payments_response_spec.rb +2 -2
- data/spec/models/list_payments_response_summary_spec.rb +2 -2
- data/spec/models/list_source_account_response_links_spec.rb +2 -2
- data/spec/models/list_source_account_response_page_spec.rb +2 -2
- data/spec/models/list_source_account_response_spec.rb +2 -2
- data/spec/models/list_source_account_response_v2_page_spec.rb +2 -2
- data/spec/models/list_source_account_response_v2_spec.rb +2 -2
- data/spec/models/marketing_opt_in_spec.rb +2 -2
- data/spec/models/notifications_spec.rb +2 -2
- data/spec/models/ofac_status_spec.rb +2 -2
- data/spec/models/onboarded_status_spec.rb +2 -2
- data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
- data/spec/models/paged_payee_response2_spec.rb +59 -0
- data/spec/models/paged_payee_response2_summary_spec.rb +65 -0
- data/spec/models/{payee_response_links_spec.rb → paged_payee_response_links_spec.rb} +8 -8
- data/spec/models/{payee_response_page_spec.rb → paged_payee_response_page_spec.rb} +8 -8
- data/spec/models/paged_payee_response_spec.rb +59 -0
- data/spec/models/{payee_response_summary_spec.rb → paged_payee_response_summary_spec.rb} +8 -8
- data/spec/models/paged_response_page_spec.rb +2 -2
- data/spec/models/paged_response_spec.rb +2 -2
- data/spec/models/{address_spec.rb → payee_address_spec.rb} +8 -8
- data/spec/models/payee_delta_response_links_spec.rb +2 -2
- data/spec/models/payee_delta_response_page_spec.rb +2 -2
- data/spec/models/payee_delta_response_spec.rb +2 -2
- data/spec/models/payee_delta_spec.rb +2 -2
- data/spec/models/payee_invitation_status_response_spec.rb +2 -2
- data/spec/models/payee_invitation_status_spec.rb +2 -2
- data/spec/models/{payment_channel_spec.rb → payee_payment_channel_spec.rb} +8 -8
- data/spec/models/payee_payor_ref2_spec.rb +53 -0
- data/spec/models/{payor_ref_spec.rb → payee_payor_ref_spec.rb} +8 -8
- data/spec/models/payee_response2_spec.rb +155 -0
- data/spec/models/payee_response_spec.rb +102 -6
- data/spec/models/payee_spec.rb +2 -2
- data/spec/models/payee_type_spec.rb +2 -2
- data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
- data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
- data/spec/models/payment_channel_country_spec.rb +2 -2
- data/spec/models/payment_channel_rule_spec.rb +2 -2
- data/spec/models/payment_channel_rules_response_spec.rb +2 -2
- data/spec/models/payment_delta_response_spec.rb +53 -0
- data/spec/models/payment_delta_spec.rb +83 -0
- data/spec/models/payment_event_response_v3_spec.rb +2 -2
- data/spec/models/payment_event_response_v4_spec.rb +2 -2
- data/spec/models/payment_instruction_spec.rb +2 -2
- data/spec/models/payment_response_v3_spec.rb +2 -2
- data/spec/models/payment_response_v4_payout_spec.rb +47 -0
- data/spec/models/payment_response_v4_spec.rb +8 -2
- data/spec/models/payment_status_spec.rb +35 -0
- data/spec/models/payor_address_spec.rb +83 -0
- data/spec/models/payor_address_v2_spec.rb +83 -0
- data/spec/models/payor_branding_response_spec.rb +2 -2
- data/spec/models/payor_create_api_key_request_spec.rb +2 -2
- data/spec/models/payor_create_api_key_response_spec.rb +2 -2
- data/spec/models/payor_create_application_request_spec.rb +2 -2
- data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
- data/spec/models/payor_links_response_links_spec.rb +2 -2
- data/spec/models/payor_links_response_payors_spec.rb +2 -2
- data/spec/models/payor_links_response_spec.rb +2 -2
- data/spec/models/payor_logo_request_spec.rb +2 -2
- data/spec/models/payor_v1_spec.rb +8 -2
- data/spec/models/payor_v2_spec.rb +8 -2
- data/spec/models/payout_payor_v4_spec.rb +65 -0
- data/spec/models/payout_principal_v4_spec.rb +47 -0
- data/spec/models/payout_status_v3_spec.rb +2 -2
- data/spec/models/payout_status_v4_spec.rb +2 -2
- data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
- data/spec/models/payout_summary_audit_v4_spec.rb +8 -2
- data/spec/models/payout_summary_response_spec.rb +2 -2
- data/spec/models/payout_type_v4_spec.rb +35 -0
- data/spec/models/query_batch_response_spec.rb +2 -2
- data/spec/models/quote_fx_summary_spec.rb +10 -2
- data/spec/models/quote_response_spec.rb +2 -2
- data/spec/models/rejected_payment_spec.rb +2 -2
- data/spec/models/set_notifications_request_spec.rb +2 -2
- data/spec/models/source_account_response_spec.rb +2 -2
- data/spec/models/source_account_response_v2_spec.rb +2 -2
- data/spec/models/source_account_spec.rb +2 -2
- data/spec/models/source_account_summary_v3_spec.rb +2 -2
- data/spec/models/source_account_summary_v4_spec.rb +2 -2
- data/spec/models/supported_countries_response_spec.rb +2 -2
- data/spec/models/supported_country_spec.rb +2 -2
- data/spec/models/supported_currency_response_spec.rb +2 -2
- data/spec/models/supported_currency_spec.rb +2 -2
- data/spec/models/update_remote_id_request_spec.rb +47 -0
- data/spec/models/watchlist_status_spec.rb +35 -0
- data/spec/spec_helper.rb +2 -2
- data/velopayments.gemspec +2 -8
- metadata +252 -259
- data/Gemfile.lock +0 -79
- data/docs/PayorFundingBankDetailsUpdate.md +0 -21
- data/velopayments-2.11.73.gem +0 -0
- data/velopayments-2.14.90.gem +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e410cc43fbb6d39309c5c2c7e6978a67b8be4c8a
|
4
|
+
data.tar.gz: d0f76361e45fc26406ec4ca3d8e7fab83347c64f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 25cd758bf502f6d082b5b926d73925fabe2f47b290915ed20208fb36a7f5e884ba0fe70d3b8334e39ce24503fac8f02d67199a03328779312feb05c47563dadd
|
7
|
+
data.tar.gz: 903d2ef3c35ec88e4e218b86e695f8900b2bde852898c954d19d1140959ae49b8a674a88300db808490dbc05e043552d8a37c9e0f9216c3e585ceff47026ca16
|
data/LICENSE
CHANGED
@@ -186,7 +186,7 @@
|
|
186
186
|
same "printed page" as the copyright notice for easier
|
187
187
|
identification within third-party archives.
|
188
188
|
|
189
|
-
Copyright
|
189
|
+
Copyright 2019 Velo Holdings Ltd.
|
190
190
|
|
191
191
|
Licensed under the Apache License, Version 2.0 (the "License");
|
192
192
|
you may not use this file except in compliance with the License.
|
data/Makefile
CHANGED
@@ -8,6 +8,12 @@ help:
|
|
8
8
|
@echo "\033[92m make WORKING_SPEC=https://raw.githubusercontent.com/velopaymentsapi/VeloOpenApi/master/spec/openapi.yaml client \033[0m"
|
9
9
|
@echo ""
|
10
10
|
|
11
|
+
version:
|
12
|
+
@docker run -i --rm mikefarah/yq sh -c "apk -q add curl && curl -s $$WORKING_SPEC -o /tmp/oa3.yaml; yq r /tmp/oa3.yaml info.version" 2>&1
|
13
|
+
|
14
|
+
oa3config:
|
15
|
+
sed -i.bak 's/"gemVersion": ".*"/"gemVersion": "${VERSION}"/g' oa3-config.json && rm oa3-config.json.bak
|
16
|
+
|
11
17
|
clean:
|
12
18
|
rm -Rf lib
|
13
19
|
rm -Rf docs
|
@@ -19,8 +25,9 @@ clean:
|
|
19
25
|
rm -f Gemfile.lock
|
20
26
|
rm -f Rakefile
|
21
27
|
rm -f *.gemspec
|
28
|
+
rm -f velopayments-*.gem
|
22
29
|
|
23
|
-
|
30
|
+
generate:
|
24
31
|
docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate \
|
25
32
|
-i $$WORKING_SPEC \
|
26
33
|
-g ruby \
|
@@ -28,18 +35,43 @@ ruby-client:
|
|
28
35
|
-c /local/oa3-config.json
|
29
36
|
|
30
37
|
trim:
|
31
|
-
rm -Rf .openapi-generator
|
32
|
-
rm .openapi-generator-ignore
|
33
|
-
rm .travis.yml
|
34
|
-
rm git_push.sh
|
38
|
+
- rm -Rf .openapi-generator
|
39
|
+
- rm .openapi-generator-ignore
|
40
|
+
- rm .travis.yml
|
41
|
+
- rm git_push.sh
|
35
42
|
|
36
43
|
info:
|
37
44
|
sed -i.bak '1s/.*/# Ruby client for Velo/' README.md && rm README.md.bak
|
45
|
+
sed -i.bak '2s/.*/[](https:\/\/opensource.org\/licenses\/Apache-2.0) [](https:\/\/badge.fury.io\/rb\/velopayments) [](https:\/\/circleci.com\/gh\/velopaymentsapi\/velo-ruby)\\/' README.md && rm README.md.bak
|
38
46
|
|
39
|
-
|
47
|
+
build_client:
|
48
|
+
#
|
49
|
+
|
50
|
+
client: clean generate trim info build_client
|
51
|
+
|
52
|
+
tests:
|
53
|
+
# language: ruby
|
54
|
+
# cache: bundler
|
55
|
+
# rvm:
|
56
|
+
# - 2.3
|
57
|
+
# - 2.4
|
58
|
+
# - 2.5
|
59
|
+
# script:
|
60
|
+
# - bundle install --path vendor/bundle
|
61
|
+
# - bundle exec rspec
|
62
|
+
# - gem build velopayments.gemspec
|
63
|
+
# - gem install ./velopayments-1.0.3.gem
|
64
|
+
|
65
|
+
commit:
|
66
|
+
git add --all
|
67
|
+
git commit -am 'bump version to ${VERSION}'
|
68
|
+
git push --set-upstream origin master
|
40
69
|
|
41
|
-
|
70
|
+
build:
|
71
|
+
sed -i.bak "s/VERSION = '.*'/VERSION = '${VERSION}'/g" lib/velopayments/version.rb && rm lib/velopayments/version.rb.bak
|
42
72
|
gem build velopayments.gemspec
|
43
73
|
|
44
|
-
|
45
|
-
|
74
|
+
publish:
|
75
|
+
git tag $(VERSION)
|
76
|
+
git push origin tag $(VERSION)
|
77
|
+
gem push velopayments-$(VERSION).gem
|
data/README.md
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
# Ruby client for Velo
|
2
|
-
|
2
|
+
[](https://opensource.org/licenses/Apache-2.0) [](https://badge.fury.io/rb/velopayments) [](https://circleci.com/gh/velopaymentsapi/velo-ruby)\
|
3
3
|
VeloPayments - the Ruby gem for the Velo Payments APIs
|
4
4
|
|
5
5
|
## Terms and Definitions
|
@@ -79,8 +79,8 @@ If you make other Velo API calls which require authorization but the Authorizati
|
|
79
79
|
|
80
80
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
81
81
|
|
82
|
-
- API version: 2.
|
83
|
-
- Package version: 2.
|
82
|
+
- API version: 2.17.8
|
83
|
+
- Package version: 2.17.8
|
84
84
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
85
85
|
|
86
86
|
## Installation
|
@@ -96,16 +96,16 @@ gem build velopayments.gemspec
|
|
96
96
|
Then either install the gem locally:
|
97
97
|
|
98
98
|
```shell
|
99
|
-
gem install ./velopayments-2.
|
99
|
+
gem install ./velopayments-2.17.8.gem
|
100
100
|
```
|
101
101
|
|
102
|
-
(for development, run `gem install --dev ./velopayments-2.
|
102
|
+
(for development, run `gem install --dev ./velopayments-2.17.8.gem` to install the development dependencies)
|
103
103
|
|
104
104
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
105
105
|
|
106
106
|
Finally add this to the Gemfile:
|
107
107
|
|
108
|
-
gem 'velopayments', '~> 2.
|
108
|
+
gem 'velopayments', '~> 2.17.8'
|
109
109
|
|
110
110
|
### Install from Git
|
111
111
|
|
@@ -131,19 +131,19 @@ require 'velopayments'
|
|
131
131
|
|
132
132
|
# Setup authorization
|
133
133
|
VeloPayments.configure do |config|
|
134
|
-
# Configure
|
135
|
-
config.
|
134
|
+
# Configure HTTP basic authorization: basicAuth
|
135
|
+
config.username = 'YOUR_USERNAME'
|
136
|
+
config.password = 'YOUR_PASSWORD'
|
136
137
|
end
|
137
138
|
|
138
139
|
api_instance = VeloPayments::AuthApi.new
|
139
|
-
authorization = 'authorization_example' # String | String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529
|
140
140
|
opts = {
|
141
141
|
grant_type: 'client_credentials' # String | OAuth grant type. Should use 'client_credentials'
|
142
142
|
}
|
143
143
|
|
144
144
|
begin
|
145
145
|
#Authentication endpoint
|
146
|
-
result = api_instance.velo_auth(
|
146
|
+
result = api_instance.velo_auth(opts)
|
147
147
|
p result
|
148
148
|
rescue VeloPayments::ApiError => e
|
149
149
|
puts "Exception when calling AuthApi->velo_auth: #{e}"
|
@@ -157,7 +157,7 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
|
|
157
157
|
|
158
158
|
Class | Method | HTTP request | Description
|
159
159
|
------------ | ------------- | ------------- | -------------
|
160
|
-
*VeloPayments::AuthApi* | [**velo_auth**](docs/AuthApi.md#velo_auth) | **POST** /v1/authenticate
|
160
|
+
*VeloPayments::AuthApi* | [**velo_auth**](docs/AuthApi.md#velo_auth) | **POST** /v1/authenticate | Authentication endpoint
|
161
161
|
*VeloPayments::CountriesApi* | [**list_supported_countries**](docs/CountriesApi.md#list_supported_countries) | **GET** /v1/supportedCountries | List Supported Countries
|
162
162
|
*VeloPayments::CountriesApi* | [**v1_payment_channel_rules_get**](docs/CountriesApi.md#v1_payment_channel_rules_get) | **GET** /v1/paymentChannelRules | List Payment Channel Country Rules
|
163
163
|
*VeloPayments::CurrenciesApi* | [**list_supported_currencies**](docs/CurrenciesApi.md#list_supported_currencies) | **GET** /v2/currencies | List Supported Currencies
|
@@ -168,19 +168,23 @@ Class | Method | HTTP request | Description
|
|
168
168
|
*VeloPayments::FundingManagerApi* | [**get_source_account_v2**](docs/FundingManagerApi.md#get_source_account_v2) | **GET** /v2/sourceAccounts/{sourceAccountId} | Get details about given source account.
|
169
169
|
*VeloPayments::FundingManagerApi* | [**get_source_accounts**](docs/FundingManagerApi.md#get_source_accounts) | **GET** /v1/sourceAccounts | Get list of source accounts
|
170
170
|
*VeloPayments::FundingManagerApi* | [**get_source_accounts_v2**](docs/FundingManagerApi.md#get_source_accounts_v2) | **GET** /v2/sourceAccounts | Get list of source accounts
|
171
|
+
*VeloPayments::FundingManagerApi* | [**list_funding_audit_deltas**](docs/FundingManagerApi.md#list_funding_audit_deltas) | **GET** /v1/deltas/fundings | List Funding changes
|
171
172
|
*VeloPayments::FundingManagerApi* | [**set_notifications_request**](docs/FundingManagerApi.md#set_notifications_request) | **POST** /v1/sourceAccounts/{sourceAccountId}/notifications | Set notifications
|
172
|
-
*VeloPayments::FundingManagerApi* | [**set_payor_funding_bank_details**](docs/FundingManagerApi.md#set_payor_funding_bank_details) | **POST** /v1/payors/{payorId}/payorFundingBankDetailsUpdate | Set Funding Bank Details
|
173
173
|
*VeloPayments::GetPayoutApi* | [**v3_payouts_payout_id_get**](docs/GetPayoutApi.md#v3_payouts_payout_id_get) | **GET** /v3/payouts/{payoutId} | Get Payout Summary
|
174
174
|
*VeloPayments::InstructPayoutApi* | [**v3_payouts_payout_id_post**](docs/InstructPayoutApi.md#v3_payouts_payout_id_post) | **POST** /v3/payouts/{payoutId} | Instruct Payout
|
175
175
|
*VeloPayments::PayeeInvitationApi* | [**get_payees_invitation_status**](docs/PayeeInvitationApi.md#get_payees_invitation_status) | **GET** /v1/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
|
176
176
|
*VeloPayments::PayeeInvitationApi* | [**get_payees_invitation_status_v2**](docs/PayeeInvitationApi.md#get_payees_invitation_status_v2) | **GET** /v2/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
|
177
177
|
*VeloPayments::PayeeInvitationApi* | [**resend_payee_invite**](docs/PayeeInvitationApi.md#resend_payee_invite) | **POST** /v1/payees/{payeeId}/invite | Resend Payee Invite
|
178
|
-
*VeloPayments::PayeeInvitationApi* | [**v2_create_payee**](docs/PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Intiate Payee Creation
|
178
|
+
*VeloPayments::PayeeInvitationApi* | [**v2_create_payee**](docs/PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Intiate Payee Creation V2
|
179
179
|
*VeloPayments::PayeeInvitationApi* | [**v2_query_batch_status**](docs/PayeeInvitationApi.md#v2_query_batch_status) | **GET** /v2/payees/batch/{batchId} | Query Batch Status
|
180
|
+
*VeloPayments::PayeeInvitationApi* | [**v3_create_payee**](docs/PayeeInvitationApi.md#v3_create_payee) | **POST** /v3/payees | Intiate Payee Creation V3
|
181
|
+
*VeloPayments::PayeeInvitationApi* | [**v3_query_batch_status**](docs/PayeeInvitationApi.md#v3_query_batch_status) | **GET** /v3/payees/batch/{batchId} | Query Batch Status
|
180
182
|
*VeloPayments::PayeesApi* | [**delete_payee_by_id**](docs/PayeesApi.md#delete_payee_by_id) | **DELETE** /v1/payees/{payeeId} | Delete Payee by Id
|
181
183
|
*VeloPayments::PayeesApi* | [**get_payee_by_id**](docs/PayeesApi.md#get_payee_by_id) | **GET** /v1/payees/{payeeId} | Get Payee by Id
|
182
184
|
*VeloPayments::PayeesApi* | [**list_payee_changes**](docs/PayeesApi.md#list_payee_changes) | **GET** /v1/deltas/payees | List Payee Changes
|
183
185
|
*VeloPayments::PayeesApi* | [**list_payees**](docs/PayeesApi.md#list_payees) | **GET** /v1/payees | List Payees
|
186
|
+
*VeloPayments::PayeesApi* | [**list_payees_v3**](docs/PayeesApi.md#list_payees_v3) | **GET** /v3/payees | List Payees
|
187
|
+
*VeloPayments::PayeesApi* | [**v1_payees_payee_id_remote_id_update_post**](docs/PayeesApi.md#v1_payees_payee_id_remote_id_update_post) | **POST** /v1/payees/{payeeId}/remoteIdUpdate | Update Payee Remote Id
|
184
188
|
*VeloPayments::PaymentAuditServiceApi* | [**export_transactions_csv**](docs/PaymentAuditServiceApi.md#export_transactions_csv) | **GET** /v4/paymentaudit/transactions | Export Transactions
|
185
189
|
*VeloPayments::PaymentAuditServiceApi* | [**get_fundings**](docs/PaymentAuditServiceApi.md#get_fundings) | **GET** /v1/paymentaudit/fundings | Get Fundings for Payor
|
186
190
|
*VeloPayments::PaymentAuditServiceApi* | [**get_payment_details**](docs/PaymentAuditServiceApi.md#get_payment_details) | **GET** /v3/paymentaudit/payments/{paymentId} | Get Payment
|
@@ -189,6 +193,7 @@ Class | Method | HTTP request | Description
|
|
189
193
|
*VeloPayments::PaymentAuditServiceApi* | [**get_payments_for_payout_v4**](docs/PaymentAuditServiceApi.md#get_payments_for_payout_v4) | **GET** /v4/paymentaudit/payouts/{payoutId} | Get Payments for Payout
|
190
194
|
*VeloPayments::PaymentAuditServiceApi* | [**get_payouts_for_payor**](docs/PaymentAuditServiceApi.md#get_payouts_for_payor) | **GET** /v3/paymentaudit/payouts | Get Payouts for Payor
|
191
195
|
*VeloPayments::PaymentAuditServiceApi* | [**get_payouts_for_payor_v4**](docs/PaymentAuditServiceApi.md#get_payouts_for_payor_v4) | **GET** /v4/paymentaudit/payouts | Get Payouts for Payor
|
196
|
+
*VeloPayments::PaymentAuditServiceApi* | [**list_payment_changes**](docs/PaymentAuditServiceApi.md#list_payment_changes) | **GET** /v1/deltas/payments | List Payment Changes
|
192
197
|
*VeloPayments::PaymentAuditServiceApi* | [**list_payments_audit**](docs/PaymentAuditServiceApi.md#list_payments_audit) | **GET** /v3/paymentaudit/payments | Get List of Payments
|
193
198
|
*VeloPayments::PaymentAuditServiceApi* | [**list_payments_audit_v4**](docs/PaymentAuditServiceApi.md#list_payments_audit_v4) | **GET** /v4/paymentaudit/payments | Get List of Payments
|
194
199
|
*VeloPayments::PayorApplicationsApi* | [**payor_create_api_key_request**](docs/PayorApplicationsApi.md#payor_create_api_key_request) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key
|
@@ -209,21 +214,33 @@ Class | Method | HTTP request | Description
|
|
209
214
|
|
210
215
|
## Documentation for Models
|
211
216
|
|
212
|
-
- [VeloPayments::Address](docs/Address.md)
|
213
217
|
- [VeloPayments::AuthResponse](docs/AuthResponse.md)
|
214
218
|
- [VeloPayments::AutoTopUpConfig](docs/AutoTopUpConfig.md)
|
215
219
|
- [VeloPayments::Challenge](docs/Challenge.md)
|
216
|
-
- [VeloPayments::
|
220
|
+
- [VeloPayments::CompanyResponse](docs/CompanyResponse.md)
|
221
|
+
- [VeloPayments::CompanyV1](docs/CompanyV1.md)
|
217
222
|
- [VeloPayments::CreateIndividual](docs/CreateIndividual.md)
|
223
|
+
- [VeloPayments::CreateIndividual2](docs/CreateIndividual2.md)
|
218
224
|
- [VeloPayments::CreatePayee](docs/CreatePayee.md)
|
225
|
+
- [VeloPayments::CreatePayee2](docs/CreatePayee2.md)
|
219
226
|
- [VeloPayments::CreatePayeeAddress](docs/CreatePayeeAddress.md)
|
227
|
+
- [VeloPayments::CreatePayeeAddress2](docs/CreatePayeeAddress2.md)
|
220
228
|
- [VeloPayments::CreatePayeesCSVRequest](docs/CreatePayeesCSVRequest.md)
|
229
|
+
- [VeloPayments::CreatePayeesCSVRequest2](docs/CreatePayeesCSVRequest2.md)
|
221
230
|
- [VeloPayments::CreatePayeesCSVResponse](docs/CreatePayeesCSVResponse.md)
|
231
|
+
- [VeloPayments::CreatePayeesCSVResponse2](docs/CreatePayeesCSVResponse2.md)
|
222
232
|
- [VeloPayments::CreatePayeesRequest](docs/CreatePayeesRequest.md)
|
233
|
+
- [VeloPayments::CreatePayeesRequest2](docs/CreatePayeesRequest2.md)
|
223
234
|
- [VeloPayments::CreatePaymentChannel](docs/CreatePaymentChannel.md)
|
235
|
+
- [VeloPayments::CreatePaymentChannel2](docs/CreatePaymentChannel2.md)
|
224
236
|
- [VeloPayments::CreatePayoutRequest](docs/CreatePayoutRequest.md)
|
237
|
+
- [VeloPayments::Error](docs/Error.md)
|
238
|
+
- [VeloPayments::ErrorResponse](docs/ErrorResponse.md)
|
225
239
|
- [VeloPayments::FailedSubmission](docs/FailedSubmission.md)
|
226
240
|
- [VeloPayments::FundingAudit](docs/FundingAudit.md)
|
241
|
+
- [VeloPayments::FundingDelta](docs/FundingDelta.md)
|
242
|
+
- [VeloPayments::FundingDeltaResponse](docs/FundingDeltaResponse.md)
|
243
|
+
- [VeloPayments::FundingDeltaResponseLinks](docs/FundingDeltaResponseLinks.md)
|
227
244
|
- [VeloPayments::FundingEvent](docs/FundingEvent.md)
|
228
245
|
- [VeloPayments::FundingEventType](docs/FundingEventType.md)
|
229
246
|
- [VeloPayments::FundingRequestV1](docs/FundingRequestV1.md)
|
@@ -243,8 +260,9 @@ Class | Method | HTTP request | Description
|
|
243
260
|
- [VeloPayments::GetPayoutsResponseV3Page](docs/GetPayoutsResponseV3Page.md)
|
244
261
|
- [VeloPayments::GetPayoutsResponseV3Summary](docs/GetPayoutsResponseV3Summary.md)
|
245
262
|
- [VeloPayments::GetPayoutsResponseV4](docs/GetPayoutsResponseV4.md)
|
246
|
-
- [VeloPayments::
|
247
|
-
- [VeloPayments::
|
263
|
+
- [VeloPayments::IndividualResponse](docs/IndividualResponse.md)
|
264
|
+
- [VeloPayments::IndividualV1](docs/IndividualV1.md)
|
265
|
+
- [VeloPayments::IndividualV1Name](docs/IndividualV1Name.md)
|
248
266
|
- [VeloPayments::InvitationStatus](docs/InvitationStatus.md)
|
249
267
|
- [VeloPayments::InvitationStatusResponse](docs/InvitationStatusResponse.md)
|
250
268
|
- [VeloPayments::InvitePayeeRequest](docs/InvitePayeeRequest.md)
|
@@ -262,49 +280,63 @@ Class | Method | HTTP request | Description
|
|
262
280
|
- [VeloPayments::OfacStatus](docs/OfacStatus.md)
|
263
281
|
- [VeloPayments::OnboardedStatus](docs/OnboardedStatus.md)
|
264
282
|
- [VeloPayments::PagedPayeeInvitationStatusResponse](docs/PagedPayeeInvitationStatusResponse.md)
|
283
|
+
- [VeloPayments::PagedPayeeResponse](docs/PagedPayeeResponse.md)
|
284
|
+
- [VeloPayments::PagedPayeeResponse2](docs/PagedPayeeResponse2.md)
|
285
|
+
- [VeloPayments::PagedPayeeResponse2Summary](docs/PagedPayeeResponse2Summary.md)
|
286
|
+
- [VeloPayments::PagedPayeeResponseLinks](docs/PagedPayeeResponseLinks.md)
|
287
|
+
- [VeloPayments::PagedPayeeResponsePage](docs/PagedPayeeResponsePage.md)
|
288
|
+
- [VeloPayments::PagedPayeeResponseSummary](docs/PagedPayeeResponseSummary.md)
|
265
289
|
- [VeloPayments::PagedResponse](docs/PagedResponse.md)
|
266
290
|
- [VeloPayments::PagedResponsePage](docs/PagedResponsePage.md)
|
267
291
|
- [VeloPayments::Payee](docs/Payee.md)
|
292
|
+
- [VeloPayments::PayeeAddress](docs/PayeeAddress.md)
|
268
293
|
- [VeloPayments::PayeeDelta](docs/PayeeDelta.md)
|
269
294
|
- [VeloPayments::PayeeDeltaResponse](docs/PayeeDeltaResponse.md)
|
270
295
|
- [VeloPayments::PayeeDeltaResponseLinks](docs/PayeeDeltaResponseLinks.md)
|
271
296
|
- [VeloPayments::PayeeDeltaResponsePage](docs/PayeeDeltaResponsePage.md)
|
272
297
|
- [VeloPayments::PayeeInvitationStatus](docs/PayeeInvitationStatus.md)
|
273
298
|
- [VeloPayments::PayeeInvitationStatusResponse](docs/PayeeInvitationStatusResponse.md)
|
299
|
+
- [VeloPayments::PayeePaymentChannel](docs/PayeePaymentChannel.md)
|
300
|
+
- [VeloPayments::PayeePayorRef](docs/PayeePayorRef.md)
|
301
|
+
- [VeloPayments::PayeePayorRef2](docs/PayeePayorRef2.md)
|
274
302
|
- [VeloPayments::PayeeResponse](docs/PayeeResponse.md)
|
275
|
-
- [VeloPayments::
|
276
|
-
- [VeloPayments::PayeeResponsePage](docs/PayeeResponsePage.md)
|
277
|
-
- [VeloPayments::PayeeResponseSummary](docs/PayeeResponseSummary.md)
|
303
|
+
- [VeloPayments::PayeeResponse2](docs/PayeeResponse2.md)
|
278
304
|
- [VeloPayments::PayeeType](docs/PayeeType.md)
|
279
305
|
- [VeloPayments::PaymentAuditCurrencyV3](docs/PaymentAuditCurrencyV3.md)
|
280
306
|
- [VeloPayments::PaymentAuditCurrencyV4](docs/PaymentAuditCurrencyV4.md)
|
281
|
-
- [VeloPayments::PaymentChannel](docs/PaymentChannel.md)
|
282
307
|
- [VeloPayments::PaymentChannelCountry](docs/PaymentChannelCountry.md)
|
283
308
|
- [VeloPayments::PaymentChannelRule](docs/PaymentChannelRule.md)
|
284
309
|
- [VeloPayments::PaymentChannelRulesResponse](docs/PaymentChannelRulesResponse.md)
|
310
|
+
- [VeloPayments::PaymentDelta](docs/PaymentDelta.md)
|
311
|
+
- [VeloPayments::PaymentDeltaResponse](docs/PaymentDeltaResponse.md)
|
285
312
|
- [VeloPayments::PaymentEventResponseV3](docs/PaymentEventResponseV3.md)
|
286
313
|
- [VeloPayments::PaymentEventResponseV4](docs/PaymentEventResponseV4.md)
|
287
314
|
- [VeloPayments::PaymentInstruction](docs/PaymentInstruction.md)
|
288
315
|
- [VeloPayments::PaymentResponseV3](docs/PaymentResponseV3.md)
|
289
316
|
- [VeloPayments::PaymentResponseV4](docs/PaymentResponseV4.md)
|
317
|
+
- [VeloPayments::PaymentResponseV4Payout](docs/PaymentResponseV4Payout.md)
|
318
|
+
- [VeloPayments::PaymentStatus](docs/PaymentStatus.md)
|
319
|
+
- [VeloPayments::PayorAddress](docs/PayorAddress.md)
|
320
|
+
- [VeloPayments::PayorAddressV2](docs/PayorAddressV2.md)
|
290
321
|
- [VeloPayments::PayorBrandingResponse](docs/PayorBrandingResponse.md)
|
291
322
|
- [VeloPayments::PayorCreateApiKeyRequest](docs/PayorCreateApiKeyRequest.md)
|
292
323
|
- [VeloPayments::PayorCreateApiKeyResponse](docs/PayorCreateApiKeyResponse.md)
|
293
324
|
- [VeloPayments::PayorCreateApplicationRequest](docs/PayorCreateApplicationRequest.md)
|
294
325
|
- [VeloPayments::PayorEmailOptOutRequest](docs/PayorEmailOptOutRequest.md)
|
295
|
-
- [VeloPayments::PayorFundingBankDetailsUpdate](docs/PayorFundingBankDetailsUpdate.md)
|
296
326
|
- [VeloPayments::PayorLinksResponse](docs/PayorLinksResponse.md)
|
297
327
|
- [VeloPayments::PayorLinksResponseLinks](docs/PayorLinksResponseLinks.md)
|
298
328
|
- [VeloPayments::PayorLinksResponsePayors](docs/PayorLinksResponsePayors.md)
|
299
329
|
- [VeloPayments::PayorLogoRequest](docs/PayorLogoRequest.md)
|
300
|
-
- [VeloPayments::PayorRef](docs/PayorRef.md)
|
301
330
|
- [VeloPayments::PayorV1](docs/PayorV1.md)
|
302
331
|
- [VeloPayments::PayorV2](docs/PayorV2.md)
|
332
|
+
- [VeloPayments::PayoutPayorV4](docs/PayoutPayorV4.md)
|
333
|
+
- [VeloPayments::PayoutPrincipalV4](docs/PayoutPrincipalV4.md)
|
303
334
|
- [VeloPayments::PayoutStatusV3](docs/PayoutStatusV3.md)
|
304
335
|
- [VeloPayments::PayoutStatusV4](docs/PayoutStatusV4.md)
|
305
336
|
- [VeloPayments::PayoutSummaryAuditV3](docs/PayoutSummaryAuditV3.md)
|
306
337
|
- [VeloPayments::PayoutSummaryAuditV4](docs/PayoutSummaryAuditV4.md)
|
307
338
|
- [VeloPayments::PayoutSummaryResponse](docs/PayoutSummaryResponse.md)
|
339
|
+
- [VeloPayments::PayoutTypeV4](docs/PayoutTypeV4.md)
|
308
340
|
- [VeloPayments::QueryBatchResponse](docs/QueryBatchResponse.md)
|
309
341
|
- [VeloPayments::QuoteFxSummary](docs/QuoteFxSummary.md)
|
310
342
|
- [VeloPayments::QuoteResponse](docs/QuoteResponse.md)
|
@@ -319,6 +351,8 @@ Class | Method | HTTP request | Description
|
|
319
351
|
- [VeloPayments::SupportedCountry](docs/SupportedCountry.md)
|
320
352
|
- [VeloPayments::SupportedCurrency](docs/SupportedCurrency.md)
|
321
353
|
- [VeloPayments::SupportedCurrencyResponse](docs/SupportedCurrencyResponse.md)
|
354
|
+
- [VeloPayments::UpdateRemoteIdRequest](docs/UpdateRemoteIdRequest.md)
|
355
|
+
- [VeloPayments::WatchlistStatus](docs/WatchlistStatus.md)
|
322
356
|
|
323
357
|
|
324
358
|
## Documentation for Authorization
|
@@ -333,3 +367,7 @@ Class | Method | HTTP request | Description
|
|
333
367
|
- **Scopes**:
|
334
368
|
- : Scopes not required
|
335
369
|
|
370
|
+
### basicAuth
|
371
|
+
|
372
|
+
- **Type**: HTTP basic authentication
|
373
|
+
|
data/docs/AuthApi.md
CHANGED
@@ -4,17 +4,17 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**velo_auth**](AuthApi.md#velo_auth) | **POST** /v1/authenticate
|
7
|
+
[**velo_auth**](AuthApi.md#velo_auth) | **POST** /v1/authenticate | Authentication endpoint
|
8
8
|
|
9
9
|
|
10
10
|
|
11
11
|
## velo_auth
|
12
12
|
|
13
|
-
> AuthResponse velo_auth(
|
13
|
+
> AuthResponse velo_auth(opts)
|
14
14
|
|
15
15
|
Authentication endpoint
|
16
16
|
|
17
|
-
Use this endpoint to obtain an access token for calling Velo Payments APIs.
|
17
|
+
Use this endpoint to obtain an access token for calling Velo Payments APIs. Use HTTP Basic Auth. String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529
|
18
18
|
|
19
19
|
### Example
|
20
20
|
|
@@ -23,19 +23,19 @@ Use this endpoint to obtain an access token for calling Velo Payments APIs.
|
|
23
23
|
require 'velopayments'
|
24
24
|
# setup authorization
|
25
25
|
VeloPayments.configure do |config|
|
26
|
-
# Configure
|
27
|
-
config.
|
26
|
+
# Configure HTTP basic authorization: basicAuth
|
27
|
+
config.username = 'YOUR USERNAME'
|
28
|
+
config.password = 'YOUR PASSWORD'
|
28
29
|
end
|
29
30
|
|
30
31
|
api_instance = VeloPayments::AuthApi.new
|
31
|
-
authorization = 'authorization_example' # String | String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529
|
32
32
|
opts = {
|
33
33
|
grant_type: 'client_credentials' # String | OAuth grant type. Should use 'client_credentials'
|
34
34
|
}
|
35
35
|
|
36
36
|
begin
|
37
37
|
#Authentication endpoint
|
38
|
-
result = api_instance.velo_auth(
|
38
|
+
result = api_instance.velo_auth(opts)
|
39
39
|
p result
|
40
40
|
rescue VeloPayments::ApiError => e
|
41
41
|
puts "Exception when calling AuthApi->velo_auth: #{e}"
|
@@ -47,7 +47,6 @@ end
|
|
47
47
|
|
48
48
|
Name | Type | Description | Notes
|
49
49
|
------------- | ------------- | ------------- | -------------
|
50
|
-
**authorization** | **String**| String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 |
|
51
50
|
**grant_type** | **String**| OAuth grant type. Should use 'client_credentials' | [optional] [default to 'client_credentials']
|
52
51
|
|
53
52
|
### Return type
|
@@ -56,7 +55,7 @@ Name | Type | Description | Notes
|
|
56
55
|
|
57
56
|
### Authorization
|
58
57
|
|
59
|
-
[
|
58
|
+
[basicAuth](../README.md#basicAuth)
|
60
59
|
|
61
60
|
### HTTP request headers
|
62
61
|
|
data/docs/AuthResponse.md
CHANGED
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**expires_in** | **Float** | | [optional]
|
10
10
|
**refresh_token** | **String** | | [optional]
|
11
11
|
**scope** | **String** | | [optional]
|
12
|
+
**entity_ids** | **Array<String>** | | [optional]
|
12
13
|
|
13
14
|
## Code Sample
|
14
15
|
|
@@ -19,7 +20,8 @@ instance = VeloPayments::AuthResponse.new(access_token: null,
|
|
19
20
|
token_type: bearer,
|
20
21
|
expires_in: 1799,
|
21
22
|
refresh_token: IwOGYzYTlmM2YxOTQ5MGE3YmNmMDFkNTVk,
|
22
|
-
scope: example_scope
|
23
|
+
scope: example_scope,
|
24
|
+
entity_ids: null)
|
23
25
|
```
|
24
26
|
|
25
27
|
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# VeloPayments::CompanyResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | |
|
8
|
+
**operating_name** | **String** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'VeloPayments'
|
14
|
+
|
15
|
+
instance = VeloPayments::CompanyResponse.new(name: null,
|
16
|
+
operating_name: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# VeloPayments::
|
1
|
+
# VeloPayments::CompanyV1
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
```ruby
|
14
14
|
require 'VeloPayments'
|
15
15
|
|
16
|
-
instance = VeloPayments::
|
16
|
+
instance = VeloPayments::CompanyV1.new(name: null,
|
17
17
|
tax_id: null,
|
18
18
|
operating_name: null)
|
19
19
|
```
|