velopayments 2.19.40.beta1 → 2.26.124.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/Dockerfile +7 -0
- data/Gemfile +1 -1
- data/Makefile +7 -12
- data/README.md +164 -101
- data/docs/AcceptedPaymentV3.md +32 -0
- data/docs/AccessTokenResponse.md +20 -19
- data/docs/AccessTokenValidationRequest.md +8 -7
- data/docs/AuthResponse.md +18 -17
- data/docs/AutoTopUpConfig.md +12 -11
- data/docs/AutoTopUpConfig2.md +24 -0
- data/docs/Category.md +15 -0
- data/docs/Challenge.md +10 -9
- data/docs/Challenge2.md +20 -0
- data/docs/Company.md +12 -11
- data/docs/Company2.md +12 -11
- data/docs/CountriesApi.md +91 -38
- data/docs/CreateFundingAccountRequestV2.md +30 -0
- data/docs/CreateIndividual.md +12 -11
- data/docs/CreateIndividual2.md +12 -11
- data/docs/CreateIndividualName.md +24 -0
- data/docs/CreatePayee.md +28 -27
- data/docs/CreatePayee2.md +28 -27
- data/docs/CreatePayeeAddress.md +22 -21
- data/docs/CreatePayeeAddress2.md +22 -21
- data/docs/CreatePayeesCSVResponse.md +10 -9
- data/docs/CreatePayeesCSVResponse2.md +10 -9
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +12 -11
- data/docs/CreatePayeesRequest.md +10 -9
- data/docs/CreatePayeesRequest2.md +10 -9
- data/docs/CreatePaymentChannel.md +20 -19
- data/docs/CreatePaymentChannel2.md +20 -19
- data/docs/CreatePayorLinkRequest.md +12 -11
- data/docs/CreatePayoutRequestV3.md +24 -0
- data/docs/CreateWebhookRequest.md +26 -0
- data/docs/CurrenciesApi.md +29 -12
- data/docs/DebitEvent.md +24 -0
- data/docs/DebitEventAllOf.md +18 -0
- data/docs/DebitStatusChanged.md +26 -0
- data/docs/DebitStatusChangedAllOf.md +18 -0
- data/docs/Error.md +20 -13
- data/docs/ErrorData.md +20 -0
- data/docs/ErrorResponse.md +12 -9
- data/docs/FailedPayee.md +38 -0
- data/docs/FailedPayee2.md +38 -0
- data/docs/FailedSubmission.md +10 -9
- data/docs/FailedSubmission2.md +10 -9
- data/docs/FundingAccountResponse.md +26 -17
- data/docs/FundingAccountResponse2.md +36 -0
- data/docs/FundingAccountType.md +15 -0
- data/docs/FundingAudit.md +24 -23
- data/docs/FundingEvent.md +14 -13
- data/docs/FundingEventType.md +4 -5
- data/docs/FundingManagerApi.md +772 -185
- data/docs/FundingManagerPrivateApi.md +101 -16
- data/docs/FundingPayorStatusAuditResponse.md +14 -13
- data/docs/FundingRequestV1.md +8 -7
- data/docs/FundingRequestV2.md +8 -7
- data/docs/FundingRequestV3.md +20 -0
- data/docs/FxSummary.md +36 -0
- data/docs/FxSummaryV3.md +26 -25
- data/docs/GetFundingsResponse.md +12 -11
- data/docs/GetFundingsResponseLinks.md +20 -0
- data/docs/GetPayeeListResponse.md +50 -0
- data/docs/GetPayeeListResponse2.md +50 -0
- data/docs/GetPayeeListResponseCompany.md +20 -0
- data/docs/GetPayeeListResponseCompany2.md +20 -0
- data/docs/GetPayeeListResponseIndividual.md +18 -0
- data/docs/GetPayeeListResponseIndividual2.md +18 -0
- data/docs/GetPaymentsForPayoutResponseV3.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV3Page.md +16 -15
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +26 -25
- data/docs/GetPaymentsForPayoutResponseV4.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +44 -41
- data/docs/GetPayoutStatistics.md +10 -9
- data/docs/GetPayoutsResponse.md +22 -0
- data/docs/GetPayoutsResponseV3.md +12 -11
- data/docs/GetPayoutsResponseV3Links.md +10 -9
- data/docs/GetPayoutsResponseV3Page.md +16 -15
- data/docs/Individual.md +12 -11
- data/docs/Individual2.md +12 -11
- data/docs/IndividualName.md +24 -0
- data/docs/InlineResponse400.md +12 -9
- data/docs/InlineResponse401.md +12 -9
- data/docs/InlineResponse403.md +12 -9
- data/docs/InlineResponse404.md +22 -0
- data/docs/InlineResponse409.md +22 -0
- data/docs/InlineResponse412.md +22 -0
- data/docs/InvitationStatus.md +4 -5
- data/docs/InvitationStatus2.md +15 -0
- data/docs/InvitePayeeRequest.md +8 -7
- data/docs/InvitePayeeRequest2.md +8 -7
- data/docs/InviteUserRequest.md +26 -25
- data/docs/KycState.md +4 -5
- data/docs/LinkForResponse.md +10 -9
- data/docs/ListFundingAccountsResponse.md +12 -11
- data/docs/ListFundingAccountsResponse2.md +22 -0
- data/docs/ListPaymentsResponseV3.md +22 -0
- data/docs/ListPaymentsResponseV3Page.md +26 -0
- data/docs/ListPaymentsResponseV4.md +12 -11
- data/docs/ListSourceAccountResponse.md +12 -11
- data/docs/ListSourceAccountResponseLinks.md +10 -9
- data/docs/ListSourceAccountResponsePage.md +16 -15
- data/docs/ListSourceAccountResponseV2.md +12 -11
- data/docs/ListSourceAccountResponseV2Links.md +20 -0
- data/docs/ListSourceAccountResponseV3.md +22 -0
- data/docs/ListSourceAccountResponseV3Links.md +20 -0
- data/docs/LocalisationDetails.md +20 -0
- data/docs/LoginApi.md +113 -41
- data/docs/MFADetails.md +10 -9
- data/docs/MFAType.md +4 -5
- data/docs/Name.md +24 -0
- data/docs/Name2.md +24 -0
- data/docs/Notification.md +26 -0
- data/docs/Notifications.md +8 -7
- data/docs/Notifications2.md +18 -0
- data/docs/OfacStatus.md +4 -5
- data/docs/OnboardedStatus.md +4 -5
- data/docs/OnboardedStatus2.md +4 -5
- data/docs/OnboardingStatusChanged.md +26 -0
- data/docs/PageForResponse.md +16 -15
- data/docs/PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse2.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponsePage.md +16 -15
- data/docs/PagedPayeeResponse.md +14 -13
- data/docs/PagedPayeeResponse2.md +14 -13
- data/docs/PagedPayeeResponseLinks.md +10 -9
- data/docs/PagedPayeeResponsePage.md +16 -15
- data/docs/PagedPayeeResponseSummary.md +16 -15
- data/docs/PagedPaymentsResponseV3.md +22 -0
- data/docs/PagedUserResponse.md +12 -11
- data/docs/PagedUserResponseLinks.md +10 -9
- data/docs/PagedUserResponsePage.md +16 -15
- data/docs/PasswordRequest.md +8 -7
- data/docs/PayableIssue.md +20 -0
- data/docs/PayableIssue2.md +20 -0
- data/docs/PayableStatusChanged.md +26 -0
- data/docs/PayeeAddress.md +22 -21
- data/docs/PayeeAddress2.md +22 -21
- data/docs/PayeeDelta.md +20 -19
- data/docs/PayeeDelta2.md +20 -19
- data/docs/PayeeDeltaResponse.md +12 -11
- data/docs/PayeeDeltaResponse2.md +12 -11
- data/docs/PayeeDeltaResponse2Links.md +10 -9
- data/docs/PayeeDeltaResponseLinks.md +10 -9
- data/docs/PayeeDeltaResponsePage.md +16 -15
- data/docs/PayeeDetailResponse.md +74 -0
- data/docs/PayeeDetailResponse2.md +74 -0
- data/docs/PayeeDetailsChanged.md +26 -0
- data/docs/PayeeEvent.md +26 -0
- data/docs/PayeeEventAllOf.md +20 -0
- data/docs/PayeeEventAllOfReasons.md +20 -0
- data/docs/PayeeInvitationApi.md +258 -176
- data/docs/PayeeInvitationStatusResponse.md +12 -11
- data/docs/PayeeInvitationStatusResponse2.md +12 -11
- data/docs/PayeePayorRef.md +20 -11
- data/docs/PayeePayorRefV3.md +20 -15
- data/docs/PayeeType.md +4 -5
- data/docs/PayeeUserSelfUpdateRequest.md +28 -0
- data/docs/PayeesApi.md +479 -219
- data/docs/PaymentAuditCurrency.md +15 -0
- data/docs/PaymentAuditCurrencyV3.md +4 -5
- data/docs/PaymentAuditServiceApi.md +280 -437
- data/docs/PaymentAuditServiceDeprecatedApi.md +675 -0
- data/docs/PaymentChannelCountry.md +10 -9
- data/docs/PaymentChannelRule.md +20 -19
- data/docs/PaymentChannelRulesResponse.md +8 -7
- data/docs/PaymentDelta.md +22 -21
- data/docs/PaymentDeltaResponse.md +12 -11
- data/docs/PaymentDeltaResponseV1.md +22 -0
- data/docs/PaymentDeltaV1.md +32 -0
- data/docs/PaymentEvent.md +28 -0
- data/docs/PaymentEventAllOf.md +22 -0
- data/docs/PaymentEventResponse.md +40 -0
- data/docs/PaymentEventResponseV3.md +30 -29
- data/docs/PaymentInstructionV3.md +34 -0
- data/docs/PaymentRails.md +4 -5
- data/docs/PaymentRejectedOrReturned.md +34 -0
- data/docs/PaymentRejectedOrReturnedAllOf.md +20 -0
- data/docs/PaymentResponseV3.md +78 -77
- data/docs/PaymentResponseV4.md +96 -79
- data/docs/PaymentResponseV4Payout.md +12 -11
- data/docs/PaymentStatusChanged.md +30 -0
- data/docs/PaymentStatusChangedAllOf.md +18 -0
- data/docs/PaymentV3.md +42 -0
- data/docs/PayorAddress.md +22 -21
- data/docs/PayorAddressV2.md +22 -21
- data/docs/PayorAmlTransaction.md +70 -0
- data/docs/PayorAmlTransactionV3.md +56 -61
- data/docs/PayorBrandingResponse.md +16 -15
- data/docs/PayorCreateApiKeyRequest.md +12 -11
- data/docs/PayorCreateApiKeyResponse.md +10 -9
- data/docs/PayorCreateApplicationRequest.md +10 -9
- data/docs/PayorEmailOptOutRequest.md +8 -7
- data/docs/PayorLinksResponse.md +10 -9
- data/docs/PayorLinksResponseLinks.md +14 -13
- data/docs/PayorLinksResponsePayors.md +14 -13
- data/docs/PayorV1.md +50 -47
- data/docs/PayorV2.md +52 -45
- data/docs/PayorsApi.md +236 -101
- data/docs/PayorsPrivateApi.md +29 -13
- data/docs/PayoutCompanyV3.md +18 -0
- data/docs/PayoutIndividualV3.md +18 -0
- data/docs/PayoutNameV3.md +20 -0
- data/docs/PayoutPayeeV3.md +22 -0
- data/docs/PayoutPayor.md +26 -0
- data/docs/PayoutPayorIds.md +22 -0
- data/docs/PayoutPrincipal.md +20 -0
- data/docs/PayoutServiceApi.md +513 -0
- data/docs/PayoutStatus.md +15 -0
- data/docs/PayoutStatusV3.md +4 -5
- data/docs/PayoutSummaryAudit.md +48 -0
- data/docs/PayoutSummaryAuditV3.md +30 -29
- data/docs/PayoutSummaryResponseV3.md +36 -0
- data/docs/PayoutType.md +15 -0
- data/docs/Ping.md +22 -0
- data/docs/QueryBatchResponse.md +14 -13
- data/docs/QueryBatchResponse2.md +14 -13
- data/docs/QuoteFxSummaryV3.md +38 -0
- data/docs/QuoteResponseV3.md +18 -0
- data/docs/RegionV2.md +20 -0
- data/docs/RegisterSmsRequest.md +8 -7
- data/docs/RejectedPaymentV3.md +38 -0
- data/docs/ResendTokenRequest.md +10 -9
- data/docs/ResetPasswordRequest.md +8 -7
- data/docs/Role.md +8 -7
- data/docs/RoleUpdateRequest.md +10 -9
- data/docs/SelfMFATypeUnregisterRequest.md +8 -7
- data/docs/SelfUpdatePasswordRequest.md +10 -9
- data/docs/SetNotificationsRequest.md +8 -7
- data/docs/SourceAccountResponse.md +34 -31
- data/docs/SourceAccountResponseV2.md +38 -35
- data/docs/SourceAccountResponseV3.md +52 -0
- data/docs/SourceAccountSummary.md +22 -0
- data/docs/SourceAccountSummaryV3.md +12 -11
- data/docs/SourceAccountType.md +15 -0
- data/docs/SourceAccountV3.md +24 -0
- data/docs/SourceEvent.md +22 -0
- data/docs/SupportedCountriesResponse.md +8 -7
- data/docs/SupportedCountriesResponseV2.md +18 -0
- data/docs/SupportedCountry.md +10 -9
- data/docs/SupportedCountryV2.md +22 -0
- data/docs/SupportedCurrencyResponseV2.md +18 -0
- data/docs/SupportedCurrencyV2.md +20 -0
- data/docs/TokensApi.md +31 -15
- data/docs/TransferRequest.md +12 -11
- data/docs/TransferRequest2.md +22 -0
- data/docs/TransmissionType.md +15 -0
- data/docs/TransmissionTypes.md +22 -0
- data/docs/TransmissionTypes2.md +22 -0
- data/docs/UnregisterMFARequest.md +10 -9
- data/docs/UpdatePayeeDetailsRequest.md +30 -0
- data/docs/UpdatePayeeDetailsRequest2.md +30 -0
- data/docs/UpdateRemoteIdRequest.md +10 -9
- data/docs/UpdateRemoteIdRequest2.md +20 -0
- data/docs/UpdateWebhookRequest.md +24 -0
- data/docs/UserDetailsUpdateRequest.md +22 -21
- data/docs/UserInfo.md +12 -11
- data/docs/UserResponse.md +34 -33
- data/docs/UserStatus.md +4 -5
- data/docs/UserType.md +4 -5
- data/docs/UserType2.md +4 -5
- data/docs/UsersApi.md +526 -181
- data/docs/ValidatePasswordResponse.md +14 -13
- data/docs/WatchlistStatus.md +4 -5
- data/docs/WatchlistStatus2.md +15 -0
- data/docs/WebhookResponse.md +28 -0
- data/docs/WebhooksApi.md +297 -0
- data/docs/WebhooksResponse.md +22 -0
- data/docs/WithdrawPaymentRequest.md +18 -0
- data/lib/velopayments.rb +110 -70
- data/lib/velopayments/api/countries_api.rb +38 -35
- data/lib/velopayments/api/currencies_api.rb +13 -12
- data/lib/velopayments/api/funding_manager_api.rb +519 -74
- data/lib/velopayments/api/funding_manager_private_api.rb +77 -13
- data/lib/velopayments/api/login_api.rb +21 -14
- data/lib/velopayments/api/payee_invitation_api.rb +100 -154
- data/lib/velopayments/api/payees_api.rb +299 -203
- data/lib/velopayments/api/payment_audit_service_api.rb +153 -459
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
- data/lib/velopayments/api/payors_api.rb +48 -40
- data/lib/velopayments/api/payors_private_api.rb +6 -5
- data/lib/velopayments/api/payout_service_api.rb +513 -0
- data/lib/velopayments/api/tokens_api.rb +6 -5
- data/lib/velopayments/api/users_api.rb +146 -54
- data/lib/velopayments/api/webhooks_api.rb +291 -0
- data/lib/velopayments/api_client.rb +51 -47
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +40 -11
- data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +57 -15
- data/lib/velopayments/models/access_token_response.rb +20 -8
- data/lib/velopayments/models/access_token_validation_request.rb +20 -8
- data/lib/velopayments/models/auth_response.rb +20 -8
- data/lib/velopayments/models/auto_top_up_config.rb +20 -8
- data/lib/velopayments/models/auto_top_up_config2.rb +256 -0
- data/lib/velopayments/models/{language.rb → category.rb} +9 -16
- data/lib/velopayments/models/challenge.rb +20 -8
- data/lib/velopayments/models/challenge2.rb +293 -0
- data/lib/velopayments/models/company.rb +25 -13
- data/lib/velopayments/models/company2.rb +25 -13
- data/lib/velopayments/models/{payee_payment_channel.rb → create_funding_account_request_v2.rb} +146 -148
- data/lib/velopayments/models/create_individual.rb +21 -9
- data/lib/velopayments/models/create_individual2.rb +21 -9
- data/lib/velopayments/models/{create_individual2_name.rb → create_individual_name.rb} +23 -11
- data/lib/velopayments/models/create_payee.rb +24 -11
- data/lib/velopayments/models/create_payee2.rb +25 -12
- data/lib/velopayments/models/create_payee_address.rb +53 -25
- data/lib/velopayments/models/create_payee_address2.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response2.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +20 -8
- data/lib/velopayments/models/create_payees_request.rb +20 -8
- data/lib/velopayments/models/create_payees_request2.rb +20 -8
- data/lib/velopayments/models/create_payment_channel.rb +20 -8
- data/lib/velopayments/models/create_payment_channel2.rb +20 -8
- data/lib/velopayments/models/create_payor_link_request.rb +20 -8
- data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +56 -26
- data/lib/velopayments/models/create_webhook_request.rb +338 -0
- data/lib/velopayments/models/debit_event.rb +278 -0
- data/lib/velopayments/models/debit_event_all_of.rb +224 -0
- data/lib/velopayments/models/debit_status_changed.rb +293 -0
- data/lib/velopayments/models/debit_status_changed_all_of.rb +224 -0
- data/lib/velopayments/models/error.rb +54 -14
- data/lib/velopayments/models/error_data.rb +229 -0
- data/lib/velopayments/models/error_response.rb +49 -14
- data/lib/velopayments/models/{payee_payor_ref_v2.rb → failed_payee.rb} +104 -69
- data/lib/velopayments/models/failed_payee2.rb +313 -0
- data/lib/velopayments/models/failed_submission.rb +21 -9
- data/lib/velopayments/models/failed_submission2.rb +21 -9
- data/lib/velopayments/models/funding_account_response.rb +115 -12
- data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +116 -97
- data/lib/velopayments/models/{location_type.rb → funding_account_type.rb} +8 -10
- data/lib/velopayments/models/funding_audit.rb +33 -19
- data/lib/velopayments/models/funding_event.rb +21 -9
- data/lib/velopayments/models/funding_event_type.rb +3 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +57 -9
- data/lib/velopayments/models/funding_request_v1.rb +20 -8
- data/lib/velopayments/models/funding_request_v2.rb +20 -8
- data/lib/velopayments/models/{payor_logo_request.rb → funding_request_v3.rb} +79 -18
- data/lib/velopayments/models/{fx_summary_v4.rb → fx_summary.rb} +26 -14
- data/lib/velopayments/models/fx_summary_v3.rb +21 -9
- data/lib/velopayments/models/get_fundings_response.rb +23 -18
- data/lib/velopayments/models/{get_fundings_response_all_of.rb → get_fundings_response_links.rb} +39 -20
- data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +96 -115
- data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +97 -116
- data/lib/velopayments/models/{company_response.rb → get_payee_list_response_company.rb} +29 -26
- data/lib/velopayments/models/{company_v1.rb → get_payee_list_response_company2.rb} +30 -55
- data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +24 -12
- data/lib/velopayments/models/{paged_response.rb → get_payee_list_response_individual2.rb} +30 -29
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +23 -11
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +43 -56
- data/lib/velopayments/models/get_payout_statistics.rb +20 -8
- data/lib/velopayments/models/{get_payouts_response_v4.rb → get_payouts_response.rb} +24 -12
- data/lib/velopayments/models/get_payouts_response_v3.rb +20 -8
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +20 -8
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +20 -8
- data/lib/velopayments/models/individual.rb +21 -9
- data/lib/velopayments/models/individual2.rb +21 -9
- data/lib/velopayments/models/{individual_v1_name.rb → individual_name.rb} +23 -11
- data/lib/velopayments/models/inline_response400.rb +51 -14
- data/lib/velopayments/models/inline_response401.rb +51 -14
- data/lib/velopayments/models/inline_response403.rb +51 -14
- data/lib/velopayments/models/inline_response404.rb +258 -0
- data/lib/velopayments/models/inline_response409.rb +258 -0
- data/lib/velopayments/models/inline_response412.rb +258 -0
- data/lib/velopayments/models/invitation_status.rb +3 -2
- data/lib/velopayments/models/invitation_status2.rb +38 -0
- data/lib/velopayments/models/invite_payee_request.rb +20 -8
- data/lib/velopayments/models/invite_payee_request2.rb +20 -8
- data/lib/velopayments/models/invite_user_request.rb +29 -17
- data/lib/velopayments/models/kyc_state.rb +3 -2
- data/lib/velopayments/models/link_for_response.rb +20 -8
- data/lib/velopayments/models/list_funding_accounts_response.rb +20 -8
- data/lib/velopayments/models/list_funding_accounts_response2.rb +241 -0
- data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +24 -12
- data/lib/velopayments/models/{list_payments_response_page.rb → list_payments_response_v3_page.rb} +23 -11
- data/lib/velopayments/models/list_payments_response_v4.rb +21 -9
- data/lib/velopayments/models/list_source_account_response.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_links.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_page.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_v2.rb +21 -9
- data/lib/velopayments/models/{invitation_status_response.rb → list_source_account_response_v2_links.rb} +39 -25
- data/lib/velopayments/models/list_source_account_response_v3.rb +241 -0
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +227 -0
- data/lib/velopayments/models/localisation_details.rb +231 -0
- data/lib/velopayments/models/mfa_details.rb +20 -8
- data/lib/velopayments/models/mfa_type.rb +3 -2
- data/lib/velopayments/models/name.rb +341 -0
- data/lib/velopayments/models/name2.rb +341 -0
- data/lib/velopayments/models/{individual_v1.rb → notification.rb} +77 -58
- data/lib/velopayments/models/notifications.rb +20 -8
- data/lib/velopayments/models/{marketing_opt_in.rb → notifications2.rb} +30 -27
- data/lib/velopayments/models/ofac_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status2.rb +3 -2
- data/lib/velopayments/models/{inline_response400_errors.rb → onboarding_status_changed.rb} +92 -39
- data/lib/velopayments/models/page_for_response.rb +20 -8
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +20 -8
- data/lib/velopayments/models/paged_payee_response.rb +21 -9
- data/lib/velopayments/models/paged_payee_response2.rb +22 -10
- data/lib/velopayments/models/paged_payee_response_links.rb +20 -8
- data/lib/velopayments/models/paged_payee_response_page.rb +20 -8
- data/lib/velopayments/models/paged_payee_response_summary.rb +27 -15
- data/lib/velopayments/models/paged_payments_response_v3.rb +241 -0
- data/lib/velopayments/models/paged_user_response.rb +20 -8
- data/lib/velopayments/models/paged_user_response_links.rb +20 -8
- data/lib/velopayments/models/paged_user_response_page.rb +20 -8
- data/lib/velopayments/models/password_request.rb +20 -8
- data/lib/velopayments/models/payable_issue.rb +238 -0
- data/lib/velopayments/models/payable_issue2.rb +238 -0
- data/lib/velopayments/models/payable_status_changed.rb +289 -0
- data/lib/velopayments/models/payee_address.rb +20 -8
- data/lib/velopayments/models/payee_address2.rb +20 -8
- data/lib/velopayments/models/payee_delta.rb +21 -9
- data/lib/velopayments/models/payee_delta2.rb +20 -8
- data/lib/velopayments/models/payee_delta_response.rb +20 -8
- data/lib/velopayments/models/payee_delta_response2.rb +20 -8
- data/lib/velopayments/models/payee_delta_response2_links.rb +20 -8
- data/lib/velopayments/models/payee_delta_response_links.rb +20 -8
- data/lib/velopayments/models/payee_delta_response_page.rb +20 -8
- data/lib/velopayments/models/{payee_response_v3.rb → payee_detail_response.rb} +45 -23
- data/lib/velopayments/models/{payee_response_v2.rb → payee_detail_response2.rb} +77 -64
- data/lib/velopayments/models/payee_details_changed.rb +289 -0
- data/lib/velopayments/models/{payee_invitation_status.rb → payee_event.rb} +86 -64
- data/lib/velopayments/models/payee_event_all_of.rb +236 -0
- data/lib/velopayments/models/payee_event_all_of_reasons.rb +237 -0
- data/lib/velopayments/models/payee_invitation_status_response.rb +20 -8
- data/lib/velopayments/models/payee_invitation_status_response2.rb +20 -8
- data/lib/velopayments/models/payee_payor_ref.rb +66 -12
- data/lib/velopayments/models/payee_payor_ref_v3.rb +46 -46
- data/lib/velopayments/models/payee_type.rb +3 -2
- data/lib/velopayments/models/{user_response2.rb → payee_user_self_update_request.rb} +64 -196
- data/lib/velopayments/models/{payment_audit_currency_v4.rb → payment_audit_currency.rb} +6 -5
- data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
- data/lib/velopayments/models/payment_channel_country.rb +20 -8
- data/lib/velopayments/models/payment_channel_rule.rb +20 -8
- data/lib/velopayments/models/payment_channel_rules_response.rb +20 -8
- data/lib/velopayments/models/payment_delta.rb +20 -8
- data/lib/velopayments/models/payment_delta_response.rb +20 -8
- data/lib/velopayments/models/payment_delta_response_v1.rb +241 -0
- data/lib/velopayments/models/payment_delta_v1.rb +297 -0
- data/lib/velopayments/models/payment_event.rb +297 -0
- data/lib/velopayments/models/{paged_response_page.rb → payment_event_all_of.rb} +49 -48
- data/lib/velopayments/models/{payment_event_response_v4.rb → payment_event_response.rb} +28 -16
- data/lib/velopayments/models/payment_event_response_v3.rb +21 -9
- data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +148 -16
- data/lib/velopayments/models/payment_rails.rb +3 -2
- data/lib/velopayments/models/payment_rejected_or_returned.rb +342 -0
- data/lib/velopayments/models/{inline_response403_errors.rb → payment_rejected_or_returned_all_of.rb} +48 -45
- data/lib/velopayments/models/payment_response_v3.rb +21 -9
- data/lib/velopayments/models/payment_response_v4.rb +101 -13
- data/lib/velopayments/models/payment_response_v4_payout.rb +22 -10
- data/lib/velopayments/models/payment_status_changed.rb +312 -0
- data/lib/velopayments/models/payment_status_changed_all_of.rb +224 -0
- data/lib/velopayments/models/payment_v3.rb +389 -0
- data/lib/velopayments/models/payor_address.rb +20 -8
- data/lib/velopayments/models/payor_address_v2.rb +20 -8
- data/lib/velopayments/models/{payor_aml_transaction_v4.rb → payor_aml_transaction.rb} +24 -21
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +21 -36
- data/lib/velopayments/models/payor_branding_response.rb +20 -8
- data/lib/velopayments/models/payor_create_api_key_request.rb +30 -8
- data/lib/velopayments/models/payor_create_api_key_response.rb +20 -8
- data/lib/velopayments/models/payor_create_application_request.rb +20 -8
- data/lib/velopayments/models/payor_email_opt_out_request.rb +20 -8
- data/lib/velopayments/models/payor_links_response.rb +20 -8
- data/lib/velopayments/models/payor_links_response_links.rb +20 -8
- data/lib/velopayments/models/payor_links_response_payors.rb +20 -8
- data/lib/velopayments/models/payor_v1.rb +33 -12
- data/lib/velopayments/models/payor_v2.rb +55 -12
- data/lib/velopayments/models/payout_company_v3.rb +223 -0
- data/lib/velopayments/models/{individual_response.rb → payout_individual_v3.rb} +24 -12
- data/lib/velopayments/models/payout_name_v3.rb +237 -0
- data/lib/velopayments/models/payout_payee_v3.rb +242 -0
- data/lib/velopayments/models/{payout_payor_v4.rb → payout_payor.rb} +23 -11
- data/lib/velopayments/models/payout_payor_ids.rb +255 -0
- data/lib/velopayments/models/{payout_principal_v4.rb → payout_principal.rb} +23 -11
- data/lib/velopayments/models/{payout_status_v4.rb → payout_status.rb} +6 -5
- data/lib/velopayments/models/payout_status_v3.rb +3 -2
- data/lib/velopayments/models/{payout_summary_audit_v4.rb → payout_summary_audit.rb} +39 -18
- data/lib/velopayments/models/payout_summary_audit_v3.rb +20 -8
- data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +42 -16
- data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +6 -5
- data/lib/velopayments/models/ping.rb +262 -0
- data/lib/velopayments/models/query_batch_response.rb +20 -8
- data/lib/velopayments/models/query_batch_response2.rb +20 -8
- data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +49 -13
- data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +24 -12
- data/lib/velopayments/models/{region.rb → region_v2.rb} +23 -11
- data/lib/velopayments/models/register_sms_request.rb +23 -11
- data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +54 -12
- data/lib/velopayments/models/resend_token_request.rb +20 -8
- data/lib/velopayments/models/reset_password_request.rb +20 -8
- data/lib/velopayments/models/role.rb +20 -8
- data/lib/velopayments/models/role_update_request.rb +20 -8
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +20 -8
- data/lib/velopayments/models/self_update_password_request.rb +20 -8
- data/lib/velopayments/models/set_notifications_request.rb +20 -8
- data/lib/velopayments/models/source_account_response.rb +34 -13
- data/lib/velopayments/models/source_account_response_v2.rb +36 -15
- data/lib/velopayments/models/{payee_payment_channel2.rb → source_account_response_v3.rb} +196 -182
- data/lib/velopayments/models/{source_account_summary_v4.rb → source_account_summary.rb} +24 -12
- data/lib/velopayments/models/source_account_summary_v3.rb +20 -8
- data/lib/velopayments/models/source_account_type.rb +37 -0
- data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +63 -11
- data/lib/velopayments/models/source_event.rb +255 -0
- data/lib/velopayments/models/supported_countries_response.rb +20 -8
- data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +24 -12
- data/lib/velopayments/models/supported_country.rb +51 -37
- data/lib/velopayments/models/{supported_country2.rb → supported_country_v2.rb} +55 -41
- data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +24 -12
- data/lib/velopayments/models/supported_currency_v2.rb +264 -0
- data/lib/velopayments/models/transfer_request.rb +20 -8
- data/lib/velopayments/models/transfer_request2.rb +309 -0
- data/lib/velopayments/models/transmission_type.rb +38 -0
- data/lib/velopayments/models/{supported_currency.rb → transmission_types.rb} +63 -26
- data/lib/velopayments/models/{currency_type.rb → transmission_types2.rb} +60 -45
- data/lib/velopayments/models/unregister_mfa_request.rb +20 -8
- data/lib/velopayments/models/update_payee_details_request.rb +275 -0
- data/lib/velopayments/models/{paged_payee_response2_summary.rb → update_payee_details_request2.rb} +75 -42
- data/lib/velopayments/models/update_remote_id_request.rb +20 -8
- data/lib/velopayments/models/update_remote_id_request2.rb +265 -0
- data/lib/velopayments/models/update_webhook_request.rb +312 -0
- data/lib/velopayments/models/user_details_update_request.rb +29 -17
- data/lib/velopayments/models/user_info.rb +20 -8
- data/lib/velopayments/models/user_response.rb +45 -18
- data/lib/velopayments/models/user_status.rb +3 -2
- data/lib/velopayments/models/user_type.rb +3 -2
- data/lib/velopayments/models/user_type2.rb +3 -2
- data/lib/velopayments/models/validate_password_response.rb +20 -8
- data/lib/velopayments/models/watchlist_status.rb +3 -2
- data/lib/velopayments/models/{ofac_status2.rb → watchlist_status2.rb} +8 -5
- data/lib/velopayments/models/webhook_response.rb +265 -0
- data/lib/velopayments/models/webhooks_response.rb +241 -0
- data/lib/velopayments/models/withdraw_payment_request.rb +252 -0
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +12 -12
- data/spec/api/currencies_api_spec.rb +5 -5
- data/spec/api/funding_manager_api_spec.rb +94 -18
- data/spec/api/funding_manager_private_api_spec.rb +17 -5
- data/spec/api/login_api_spec.rb +3 -2
- data/spec/api/payee_invitation_api_spec.rb +23 -35
- data/spec/api/payees_api_spec.rb +63 -47
- data/spec/api/payment_audit_service_api_spec.rb +28 -112
- data/spec/api/{payout_history_api_spec.rb → payment_audit_service_deprecated_api_spec.rb} +115 -33
- data/spec/api/payors_api_spec.rb +9 -9
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/{models/payee2_spec.rb → api/payout_service_api_spec.rb} +66 -103
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +17 -4
- data/spec/api/webhooks_api_spec.rb +86 -0
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/accepted_payment_v3_spec.rb +76 -0
- data/spec/models/access_token_response_spec.rb +5 -12
- data/spec/models/access_token_validation_request_spec.rb +5 -12
- data/spec/models/auth_response_spec.rb +5 -12
- data/spec/models/{inline_response401_errors_spec.rb → auto_top_up_config2_spec.rb} +12 -19
- data/spec/models/auto_top_up_config_spec.rb +5 -12
- data/spec/models/{language_spec.rb → category_spec.rb} +8 -15
- data/spec/models/{paged_response_spec.rb → challenge2_spec.rb} +10 -17
- data/spec/models/challenge_spec.rb +5 -12
- data/spec/models/company2_spec.rb +5 -12
- data/spec/models/company_spec.rb +5 -12
- data/spec/models/{payee_payment_channel_spec.rb → create_funding_account_request_v2_spec.rb} +19 -26
- data/spec/models/create_individual2_spec.rb +5 -12
- data/spec/models/{individual_v1_name_spec.rb → create_individual_name_spec.rb} +8 -15
- data/spec/models/create_individual_spec.rb +5 -12
- data/spec/models/create_payee2_spec.rb +5 -12
- data/spec/models/create_payee_address2_spec.rb +6 -13
- data/spec/models/create_payee_address_spec.rb +9 -12
- data/spec/models/create_payee_spec.rb +5 -12
- data/spec/models/create_payees_csv_response2_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_spec.rb +5 -12
- data/spec/models/create_payees_request2_spec.rb +5 -12
- data/spec/models/create_payees_request_spec.rb +5 -12
- data/spec/models/create_payment_channel2_spec.rb +7 -14
- data/spec/models/create_payment_channel_spec.rb +7 -14
- data/spec/models/create_payor_link_request_spec.rb +6 -13
- data/spec/models/{create_payout_request_spec.rb → create_payout_request_v3_spec.rb} +8 -21
- data/spec/models/create_webhook_request_spec.rb +58 -0
- data/spec/models/debit_event_all_of_spec.rb +34 -0
- data/spec/models/debit_event_spec.rb +52 -0
- data/spec/models/{currency_type_spec.rb → debit_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/debit_status_changed_spec.rb +58 -0
- data/spec/models/{marketing_opt_in_spec.rb → error_data_spec.rb} +10 -17
- data/spec/models/error_response_spec.rb +11 -12
- data/spec/models/error_spec.rb +24 -13
- data/spec/models/failed_payee2_spec.rb +94 -0
- data/spec/models/failed_payee_spec.rb +94 -0
- data/spec/models/failed_submission2_spec.rb +5 -12
- data/spec/models/failed_submission_spec.rb +5 -12
- data/spec/models/funding_account_response2_spec.rb +88 -0
- data/spec/models/funding_account_response_spec.rb +29 -12
- data/spec/models/{language2_spec.rb → funding_account_type_spec.rb} +8 -15
- data/spec/models/funding_audit_spec.rb +14 -21
- data/spec/models/funding_event_spec.rb +5 -12
- data/spec/models/funding_event_type_spec.rb +5 -12
- data/spec/models/funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/funding_request_v1_spec.rb +5 -12
- data/spec/models/funding_request_v2_spec.rb +5 -12
- data/spec/models/funding_request_v3_spec.rb +40 -0
- data/spec/models/{fx_summary_v4_spec.rb → fx_summary_spec.rb} +10 -17
- data/spec/models/fx_summary_v3_spec.rb +7 -14
- data/spec/models/get_fundings_response_links_spec.rb +40 -0
- data/spec/models/get_fundings_response_spec.rb +5 -12
- data/spec/models/{payee_response2_spec.rb → get_payee_list_response2_spec.rb} +21 -46
- data/spec/models/get_payee_list_response_company2_spec.rb +40 -0
- data/spec/models/{company_response_spec.rb → get_payee_list_response_company_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_individual2_spec.rb +34 -0
- data/spec/models/{user_response2_roles_spec.rb → get_payee_list_response_individual_spec.rb} +8 -15
- data/spec/models/{payee_spec.rb → get_payee_list_response_spec.rb} +21 -46
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +6 -13
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +11 -16
- data/spec/models/get_payout_statistics_spec.rb +5 -12
- data/spec/models/{company_v1_spec.rb → get_payouts_response_spec.rb} +11 -18
- data/spec/models/get_payouts_response_v3_links_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_spec.rb +5 -12
- data/spec/models/individual2_spec.rb +5 -12
- data/spec/models/{create_individual2_name_spec.rb → individual_name_spec.rb} +8 -15
- data/spec/models/individual_spec.rb +5 -12
- data/spec/models/inline_response400_spec.rb +11 -12
- data/spec/models/inline_response401_spec.rb +11 -12
- data/spec/models/inline_response403_spec.rb +11 -12
- data/spec/models/{individual_v1_spec.rb → inline_response404_spec.rb} +11 -18
- data/spec/models/inline_response409_spec.rb +46 -0
- data/spec/models/inline_response412_spec.rb +46 -0
- data/spec/models/{ofac_status2_spec.rb → invitation_status2_spec.rb} +8 -15
- data/spec/models/invitation_status_spec.rb +5 -12
- data/spec/models/invite_payee_request2_spec.rb +5 -12
- data/spec/models/invite_payee_request_spec.rb +5 -12
- data/spec/models/invite_user_request_spec.rb +6 -13
- data/spec/models/kyc_state_spec.rb +5 -12
- data/spec/models/link_for_response_spec.rb +5 -12
- data/spec/models/{list_payments_response_spec.rb → list_funding_accounts_response2_spec.rb} +8 -15
- data/spec/models/list_funding_accounts_response_spec.rb +5 -12
- data/spec/models/{paged_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -15
- data/spec/models/list_payments_response_v3_spec.rb +46 -0
- data/spec/models/list_payments_response_v4_spec.rb +5 -12
- data/spec/models/list_source_account_response_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_page_spec.rb +5 -12
- data/spec/models/list_source_account_response_spec.rb +5 -12
- data/spec/models/list_source_account_response_v2_links_spec.rb +40 -0
- data/spec/models/list_source_account_response_v2_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_links_spec.rb +40 -0
- data/spec/models/list_source_account_response_v3_spec.rb +46 -0
- data/spec/models/localisation_details_spec.rb +40 -0
- data/spec/models/mfa_details_spec.rb +5 -12
- data/spec/models/mfa_type_spec.rb +5 -12
- data/spec/models/name2_spec.rb +52 -0
- data/spec/models/name_spec.rb +52 -0
- data/spec/models/notification_spec.rb +58 -0
- data/spec/models/notifications2_spec.rb +34 -0
- data/spec/models/notifications_spec.rb +5 -12
- data/spec/models/ofac_status_spec.rb +5 -12
- data/spec/models/onboarded_status2_spec.rb +5 -12
- data/spec/models/onboarded_status_spec.rb +5 -12
- data/spec/models/{list_payments_response_page_spec.rb → onboarding_status_changed_spec.rb} +13 -20
- data/spec/models/page_for_response_spec.rb +5 -12
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_spec.rb +5 -12
- data/spec/models/paged_payee_response2_spec.rb +5 -12
- data/spec/models/paged_payee_response_links_spec.rb +5 -12
- data/spec/models/paged_payee_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_response_spec.rb +5 -12
- data/spec/models/paged_payee_response_summary_spec.rb +6 -13
- data/spec/models/{get_payouts_response_v4_spec.rb → paged_payments_response_v3_spec.rb} +8 -15
- data/spec/models/paged_user_response_links_spec.rb +5 -12
- data/spec/models/paged_user_response_page_spec.rb +5 -12
- data/spec/models/paged_user_response_spec.rb +5 -12
- data/spec/models/password_request_spec.rb +5 -12
- data/spec/models/payable_issue2_spec.rb +40 -0
- data/spec/models/payable_issue_spec.rb +40 -0
- data/spec/models/payable_status_changed_spec.rb +58 -0
- data/spec/models/payee_address2_spec.rb +5 -12
- data/spec/models/payee_address_spec.rb +5 -12
- data/spec/models/payee_delta2_spec.rb +5 -12
- data/spec/models/payee_delta_response2_links_spec.rb +5 -12
- data/spec/models/payee_delta_response2_spec.rb +5 -12
- data/spec/models/payee_delta_response_links_spec.rb +5 -12
- data/spec/models/payee_delta_response_page_spec.rb +5 -12
- data/spec/models/payee_delta_response_spec.rb +5 -12
- data/spec/models/payee_delta_spec.rb +5 -12
- data/spec/models/{payee_response_v2_spec.rb → payee_detail_response2_spec.rb} +28 -35
- data/spec/models/{payee_response_v3_spec.rb → payee_detail_response_spec.rb} +14 -15
- data/spec/models/payee_details_changed_spec.rb +58 -0
- data/spec/models/payee_event_all_of_reasons_spec.rb +40 -0
- data/spec/models/payee_event_all_of_spec.rb +40 -0
- data/spec/models/{inline_response400_errors_spec.rb → payee_event_spec.rb} +17 -18
- data/spec/models/payee_invitation_status_response2_spec.rb +6 -13
- data/spec/models/payee_invitation_status_response_spec.rb +6 -13
- data/spec/models/payee_payor_ref_spec.rb +29 -12
- data/spec/models/payee_payor_ref_v3_spec.rb +17 -16
- data/spec/models/payee_type_spec.rb +5 -12
- data/spec/models/{payment_instruction_spec.rb → payee_user_self_update_request_spec.rb} +14 -21
- data/spec/models/{location_type_spec.rb → payment_audit_currency_spec.rb} +8 -15
- data/spec/models/payment_audit_currency_v3_spec.rb +5 -12
- data/spec/models/payment_channel_country_spec.rb +5 -12
- data/spec/models/payment_channel_rule_spec.rb +5 -12
- data/spec/models/payment_channel_rules_response_spec.rb +5 -12
- data/spec/models/payment_delta_response_spec.rb +5 -12
- data/spec/models/payment_delta_response_v1_spec.rb +46 -0
- data/spec/models/payment_delta_spec.rb +5 -12
- data/spec/models/payment_delta_v1_spec.rb +76 -0
- data/spec/models/payment_event_all_of_spec.rb +46 -0
- data/spec/models/{payment_event_response_v4_spec.rb → payment_event_response_spec.rb} +10 -17
- data/spec/models/payment_event_response_v3_spec.rb +6 -13
- data/spec/models/{accepted_payment_spec.rb → payment_event_spec.rb} +14 -21
- data/spec/models/{rejected_payment_spec.rb → payment_instruction_v3_spec.rb} +15 -22
- data/spec/models/payment_rails_spec.rb +5 -12
- data/spec/models/payment_rejected_or_returned_all_of_spec.rb +40 -0
- data/spec/models/payment_rejected_or_returned_spec.rb +82 -0
- data/spec/models/payment_response_v3_spec.rb +7 -14
- data/spec/models/payment_response_v4_payout_spec.rb +5 -12
- data/spec/models/payment_response_v4_spec.rb +55 -14
- data/spec/models/{payor_logo_request_spec.rb → payment_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/payment_status_changed_spec.rb +70 -0
- data/spec/models/payment_v3_spec.rb +110 -0
- data/spec/models/payor_address_spec.rb +5 -12
- data/spec/models/payor_address_v2_spec.rb +5 -12
- data/spec/models/{payor_aml_transaction_v4_spec.rb → payor_aml_transaction_spec.rb} +8 -21
- data/spec/models/payor_aml_transaction_v3_spec.rb +5 -30
- data/spec/models/payor_branding_response_spec.rb +5 -12
- data/spec/models/payor_create_api_key_request_spec.rb +6 -13
- data/spec/models/payor_create_api_key_response_spec.rb +5 -12
- data/spec/models/payor_create_application_request_spec.rb +5 -12
- data/spec/models/payor_email_opt_out_request_spec.rb +5 -12
- data/spec/models/payor_links_response_links_spec.rb +6 -13
- data/spec/models/payor_links_response_payors_spec.rb +6 -13
- data/spec/models/payor_links_response_spec.rb +5 -12
- data/spec/models/payor_v1_spec.rb +12 -13
- data/spec/models/payor_v2_spec.rb +24 -13
- data/spec/models/payout_company_v3_spec.rb +34 -0
- data/spec/models/{individual_response_spec.rb → payout_individual_v3_spec.rb} +8 -15
- data/spec/models/payout_name_v3_spec.rb +40 -0
- data/spec/models/payout_payee_v3_spec.rb +46 -0
- data/spec/models/payout_payor_ids_spec.rb +46 -0
- data/spec/models/{payout_payor_v4_spec.rb → payout_payor_spec.rb} +8 -15
- data/spec/models/{payout_principal_v4_spec.rb → payout_principal_spec.rb} +8 -15
- data/spec/models/payout_status_spec.rb +28 -0
- data/spec/models/payout_status_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_audit_v4_spec.rb → payout_summary_audit_spec.rb} +14 -15
- data/spec/models/payout_summary_audit_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +14 -15
- data/spec/models/payout_type_spec.rb +28 -0
- data/spec/models/ping_spec.rb +46 -0
- data/spec/models/query_batch_response2_spec.rb +6 -13
- data/spec/models/query_batch_response_spec.rb +6 -13
- data/spec/models/{quote_fx_summary_spec.rb → quote_fx_summary_v3_spec.rb} +10 -17
- data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -15
- data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -15
- data/spec/models/register_sms_request_spec.rb +5 -12
- data/spec/models/rejected_payment_v3_spec.rb +94 -0
- data/spec/models/resend_token_request_spec.rb +6 -13
- data/spec/models/reset_password_request_spec.rb +5 -12
- data/spec/models/role_spec.rb +5 -12
- data/spec/models/role_update_request_spec.rb +5 -12
- data/spec/models/self_mfa_type_unregister_request_spec.rb +6 -13
- data/spec/models/self_update_password_request_spec.rb +5 -12
- data/spec/models/set_notifications_request_spec.rb +5 -12
- data/spec/models/source_account_response_spec.rb +12 -13
- data/spec/models/source_account_response_v2_spec.rb +12 -13
- data/spec/models/{payee_response_spec.rb → source_account_response_v3_spec.rb} +30 -45
- data/spec/models/{source_account_summary_v4_spec.rb → source_account_summary_spec.rb} +8 -15
- data/spec/models/source_account_summary_v3_spec.rb +5 -12
- data/spec/models/source_account_type_spec.rb +28 -0
- data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -15
- data/spec/models/source_event_spec.rb +46 -0
- data/spec/models/supported_countries_response_spec.rb +5 -12
- data/spec/models/supported_countries_response_v2_spec.rb +34 -0
- data/spec/models/supported_country_spec.rb +5 -20
- data/spec/models/supported_country_v2_spec.rb +46 -0
- data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -15
- data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -15
- data/spec/models/transfer_request2_spec.rb +46 -0
- data/spec/models/transfer_request_spec.rb +5 -12
- data/spec/models/transmission_type_spec.rb +28 -0
- data/spec/models/transmission_types2_spec.rb +46 -0
- data/spec/models/transmission_types_spec.rb +46 -0
- data/spec/models/unregister_mfa_request_spec.rb +6 -13
- data/spec/models/update_payee_details_request2_spec.rb +70 -0
- data/spec/models/{payee_payment_channel2_spec.rb → update_payee_details_request_spec.rb} +15 -26
- data/spec/models/update_remote_id_request2_spec.rb +40 -0
- data/spec/models/update_remote_id_request_spec.rb +5 -12
- data/spec/models/update_webhook_request_spec.rb +52 -0
- data/spec/models/user_details_update_request_spec.rb +5 -12
- data/spec/models/user_info_spec.rb +5 -12
- data/spec/models/user_response_spec.rb +8 -15
- data/spec/models/user_status_spec.rb +5 -12
- data/spec/models/user_type2_spec.rb +5 -12
- data/spec/models/user_type_spec.rb +5 -12
- data/spec/models/validate_password_response_spec.rb +5 -12
- data/spec/models/watchlist_status2_spec.rb +28 -0
- data/spec/models/watchlist_status_spec.rb +5 -12
- data/spec/models/webhook_response_spec.rb +64 -0
- data/spec/models/webhooks_response_spec.rb +46 -0
- data/spec/models/withdraw_payment_request_spec.rb +34 -0
- data/spec/spec_helper.rb +2 -2
- data/specs/api/countries_api_spec.rb +103 -0
- data/{spec/api/quote_payout_api_spec.rb → specs/api/currencies_api_spec.rb} +16 -15
- data/specs/api/funding_manager_api_spec.rb +372 -0
- data/{spec/api/get_payout_api_spec.rb → specs/api/funding_manager_private_api_spec.rb} +15 -15
- data/specs/api/login_api_spec.rb +82 -0
- data/specs/api/payee_invitation_api_spec.rb +161 -0
- data/specs/api/payees_api_spec.rb +186 -0
- data/specs/api/payment_audit_service_api_spec.rb +318 -0
- data/specs/api/payors_api_spec.rb +171 -0
- data/{spec/api/instruct_payout_api_spec.rb → specs/api/payors_private_api_spec.rb} +14 -14
- data/specs/api/payout_service_api_spec.rb +127 -0
- data/{spec/api/withdraw_payout_api_spec.rb → specs/api/tokens_api_spec.rb} +15 -14
- data/specs/api/users_api_spec.rb +284 -0
- data/velopayments.gemspec +3 -4
- metadata +449 -295
- data/docs/AcceptedPayment.md +0 -27
- data/docs/CompanyResponse.md +0 -19
- data/docs/CompanyV1.md +0 -21
- data/docs/CreateFundingAccountRequest.md +0 -23
- data/docs/CreateIndividual2Name.md +0 -23
- data/docs/CreatePayeesCSVRequest.md +0 -73
- data/docs/CreatePayeesCSVRequest2.md +0 -73
- data/docs/CreatePayoutRequest.md +0 -25
- data/docs/CurrencyType.md +0 -17
- data/docs/FxSummaryV4.md +0 -35
- data/docs/GetFundingsResponseAllOf.md +0 -17
- data/docs/GetPayoutApi.md +0 -61
- data/docs/GetPayoutsResponseV4.md +0 -21
- data/docs/IndividualResponse.md +0 -17
- data/docs/IndividualV1.md +0 -21
- data/docs/IndividualV1Name.md +0 -23
- data/docs/InlineResponse400Errors.md +0 -23
- data/docs/InlineResponse401Errors.md +0 -23
- data/docs/InlineResponse403Errors.md +0 -23
- data/docs/InstructPayoutApi.md +0 -60
- data/docs/InvitationStatusResponse.md +0 -17
- data/docs/Language.md +0 -16
- data/docs/Language2.md +0 -16
- data/docs/ListPaymentsResponse.md +0 -21
- data/docs/ListPaymentsResponsePage.md +0 -25
- data/docs/LocationType.md +0 -16
- data/docs/MarketingOptIn.md +0 -19
- data/docs/OfacStatus2.md +0 -16
- data/docs/PagedPayeeResponse2Summary.md +0 -25
- data/docs/PagedResponse.md +0 -19
- data/docs/PagedResponsePage.md +0 -25
- data/docs/Payee.md +0 -55
- data/docs/Payee2.md +0 -57
- data/docs/PayeeInvitationStatus.md +0 -21
- data/docs/PayeePaymentChannel.md +0 -29
- data/docs/PayeePaymentChannel2.md +0 -29
- data/docs/PayeePayorRefV2.md +0 -25
- data/docs/PayeeResponse.md +0 -55
- data/docs/PayeeResponse2.md +0 -55
- data/docs/PayeeResponseV2.md +0 -73
- data/docs/PayeeResponseV3.md +0 -71
- data/docs/PaymentAuditCurrencyV4.md +0 -16
- data/docs/PaymentEventResponseV4.md +0 -39
- data/docs/PaymentInstruction.md +0 -27
- data/docs/PayorAmlTransactionV4.md +0 -71
- data/docs/PayorLogoRequest.md +0 -17
- data/docs/PayoutHistoryApi.md +0 -221
- data/docs/PayoutPayorV4.md +0 -25
- data/docs/PayoutPrincipalV4.md +0 -19
- data/docs/PayoutStatusV4.md +0 -16
- data/docs/PayoutSummaryAuditV4.md +0 -45
- data/docs/PayoutSummaryResponse.md +0 -33
- data/docs/PayoutTypeV4.md +0 -16
- data/docs/QuoteFxSummary.md +0 -37
- data/docs/QuotePayoutApi.md +0 -61
- data/docs/QuoteResponse.md +0 -17
- data/docs/Region.md +0 -19
- data/docs/RejectedPayment.md +0 -33
- data/docs/SourceAccount.md +0 -23
- data/docs/SourceAccountSummaryV4.md +0 -21
- data/docs/SubmitPayoutApi.md +0 -60
- data/docs/SupportedCountriesResponse2.md +0 -17
- data/docs/SupportedCountry2.md +0 -21
- data/docs/SupportedCurrency.md +0 -19
- data/docs/SupportedCurrencyResponse.md +0 -17
- data/docs/UserResponse2.md +0 -45
- data/docs/UserResponse2Roles.md +0 -17
- data/docs/WithdrawPayoutApi.md +0 -60
- data/lib/velopayments/api/get_payout_api.rb +0 -84
- data/lib/velopayments/api/instruct_payout_api.rb +0 -84
- data/lib/velopayments/api/payout_history_api.rb +0 -285
- data/lib/velopayments/api/quote_payout_api.rb +0 -84
- data/lib/velopayments/api/submit_payout_api.rb +0 -86
- data/lib/velopayments/api/withdraw_payout_api.rb +0 -84
- data/lib/velopayments/models/create_payees_csv_request.rb +0 -1148
- data/lib/velopayments/models/create_payees_csv_request2.rb +0 -1148
- data/lib/velopayments/models/inline_response401_errors.rb +0 -236
- data/lib/velopayments/models/language2.rb +0 -45
- data/lib/velopayments/models/payee2.rb +0 -456
- data/lib/velopayments/models/payee_response.rb +0 -388
- data/spec/api/submit_payout_api_spec.rb +0 -47
- data/spec/models/create_funding_account_request_spec.rb +0 -59
- data/spec/models/create_payees_csv_request2_spec.rb +0 -225
- data/spec/models/create_payees_csv_request_spec.rb +0 -221
- data/spec/models/get_fundings_response_all_of_spec.rb +0 -41
- data/spec/models/inline_response403_errors_spec.rb +0 -59
- data/spec/models/invitation_status_response_spec.rb +0 -41
- data/spec/models/paged_payee_response2_summary_spec.rb +0 -65
- data/spec/models/payee_invitation_status_spec.rb +0 -57
- data/spec/models/payee_payor_ref_v2_spec.rb +0 -69
- data/spec/models/payment_audit_currency_v4_spec.rb +0 -35
- data/spec/models/payout_status_v4_spec.rb +0 -35
- data/spec/models/payout_type_v4_spec.rb +0 -35
- data/spec/models/supported_countries_response2_spec.rb +0 -41
- data/spec/models/supported_country2_spec.rb +0 -61
- data/spec/models/user_response2_spec.rb +0 -137
|
@@ -3,17 +3,18 @@
|
|
|
3
3
|
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a 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. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.
|
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version:
|
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module VeloPayments
|
|
16
|
-
class
|
|
17
|
+
class PayeeDetailResponse2
|
|
17
18
|
attr_accessor :payee_id
|
|
18
19
|
|
|
19
20
|
attr_accessor :payor_refs
|
|
@@ -22,8 +23,13 @@ module VeloPayments
|
|
|
22
23
|
|
|
23
24
|
attr_accessor :onboarded_status
|
|
24
25
|
|
|
25
|
-
attr_accessor :
|
|
26
|
+
attr_accessor :watchlist_status
|
|
26
27
|
|
|
28
|
+
attr_accessor :watchlist_override_expires_at_timestamp
|
|
29
|
+
|
|
30
|
+
attr_accessor :watchlist_override_comment
|
|
31
|
+
|
|
32
|
+
# An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR> See the /v1/supportedLanguages endpoint to list the available codes for an environment.
|
|
27
33
|
attr_accessor :language
|
|
28
34
|
|
|
29
35
|
attr_accessor :created
|
|
@@ -48,13 +54,7 @@ module VeloPayments
|
|
|
48
54
|
|
|
49
55
|
attr_accessor :cellphone_number
|
|
50
56
|
|
|
51
|
-
attr_accessor :
|
|
52
|
-
|
|
53
|
-
attr_accessor :ofac_override
|
|
54
|
-
|
|
55
|
-
attr_accessor :ofac_override_reason
|
|
56
|
-
|
|
57
|
-
attr_accessor :ofac_override_timestamp
|
|
57
|
+
attr_accessor :watchlist_status_updated_timestamp
|
|
58
58
|
|
|
59
59
|
attr_accessor :grace_period_end_date
|
|
60
60
|
|
|
@@ -73,6 +73,8 @@ module VeloPayments
|
|
|
73
73
|
# The timestamp when the payee last accepted T&Cs
|
|
74
74
|
attr_accessor :accept_terms_and_conditions_timestamp
|
|
75
75
|
|
|
76
|
+
attr_accessor :challenge
|
|
77
|
+
|
|
76
78
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
77
79
|
def self.attribute_map
|
|
78
80
|
{
|
|
@@ -80,7 +82,9 @@ module VeloPayments
|
|
|
80
82
|
:'payor_refs' => :'payorRefs',
|
|
81
83
|
:'email' => :'email',
|
|
82
84
|
:'onboarded_status' => :'onboardedStatus',
|
|
83
|
-
:'
|
|
85
|
+
:'watchlist_status' => :'watchlistStatus',
|
|
86
|
+
:'watchlist_override_expires_at_timestamp' => :'watchlistOverrideExpiresAtTimestamp',
|
|
87
|
+
:'watchlist_override_comment' => :'watchlistOverrideComment',
|
|
84
88
|
:'language' => :'language',
|
|
85
89
|
:'created' => :'created',
|
|
86
90
|
:'country' => :'country',
|
|
@@ -93,10 +97,7 @@ module VeloPayments
|
|
|
93
97
|
:'individual' => :'individual',
|
|
94
98
|
:'company' => :'company',
|
|
95
99
|
:'cellphone_number' => :'cellphoneNumber',
|
|
96
|
-
:'
|
|
97
|
-
:'ofac_override' => :'ofacOverride',
|
|
98
|
-
:'ofac_override_reason' => :'ofacOverrideReason',
|
|
99
|
-
:'ofac_override_timestamp' => :'ofacOverrideTimestamp',
|
|
100
|
+
:'watchlist_status_updated_timestamp' => :'watchlistStatusUpdatedTimestamp',
|
|
100
101
|
:'grace_period_end_date' => :'gracePeriodEndDate',
|
|
101
102
|
:'enhanced_kyc_completed' => :'enhancedKycCompleted',
|
|
102
103
|
:'kyc_completed_timestamp' => :'kycCompletedTimestamp',
|
|
@@ -104,34 +105,39 @@ module VeloPayments
|
|
|
104
105
|
:'pause_payment_timestamp' => :'pausePaymentTimestamp',
|
|
105
106
|
:'marketing_opt_in_decision' => :'marketingOptInDecision',
|
|
106
107
|
:'marketing_opt_in_timestamp' => :'marketingOptInTimestamp',
|
|
107
|
-
:'accept_terms_and_conditions_timestamp' => :'acceptTermsAndConditionsTimestamp'
|
|
108
|
+
:'accept_terms_and_conditions_timestamp' => :'acceptTermsAndConditionsTimestamp',
|
|
109
|
+
:'challenge' => :'challenge'
|
|
108
110
|
}
|
|
109
111
|
end
|
|
110
112
|
|
|
113
|
+
# Returns all the JSON keys this model knows about
|
|
114
|
+
def self.acceptable_attributes
|
|
115
|
+
attribute_map.values
|
|
116
|
+
end
|
|
117
|
+
|
|
111
118
|
# Attribute type mapping.
|
|
112
119
|
def self.openapi_types
|
|
113
120
|
{
|
|
114
121
|
:'payee_id' => :'String',
|
|
115
|
-
:'payor_refs' => :'Array<
|
|
122
|
+
:'payor_refs' => :'Array<PayeePayorRef>',
|
|
116
123
|
:'email' => :'String',
|
|
117
|
-
:'onboarded_status' => :'
|
|
118
|
-
:'
|
|
119
|
-
:'
|
|
120
|
-
:'
|
|
124
|
+
:'onboarded_status' => :'OnboardedStatus',
|
|
125
|
+
:'watchlist_status' => :'WatchlistStatus2',
|
|
126
|
+
:'watchlist_override_expires_at_timestamp' => :'Time',
|
|
127
|
+
:'watchlist_override_comment' => :'String',
|
|
128
|
+
:'language' => :'String',
|
|
129
|
+
:'created' => :'Time',
|
|
121
130
|
:'country' => :'String',
|
|
122
131
|
:'display_name' => :'String',
|
|
123
132
|
:'payee_type' => :'PayeeType',
|
|
124
133
|
:'disabled' => :'Boolean',
|
|
125
134
|
:'disabled_comment' => :'String',
|
|
126
|
-
:'disabled_updated_timestamp' => :'
|
|
135
|
+
:'disabled_updated_timestamp' => :'Time',
|
|
127
136
|
:'address' => :'PayeeAddress2',
|
|
128
|
-
:'individual' => :'
|
|
129
|
-
:'company' => :'
|
|
137
|
+
:'individual' => :'Individual2',
|
|
138
|
+
:'company' => :'Company2',
|
|
130
139
|
:'cellphone_number' => :'String',
|
|
131
|
-
:'
|
|
132
|
-
:'ofac_override' => :'Boolean',
|
|
133
|
-
:'ofac_override_reason' => :'String',
|
|
134
|
-
:'ofac_override_timestamp' => :'String',
|
|
140
|
+
:'watchlist_status_updated_timestamp' => :'String',
|
|
135
141
|
:'grace_period_end_date' => :'Date',
|
|
136
142
|
:'enhanced_kyc_completed' => :'Boolean',
|
|
137
143
|
:'kyc_completed_timestamp' => :'String',
|
|
@@ -139,7 +145,8 @@ module VeloPayments
|
|
|
139
145
|
:'pause_payment_timestamp' => :'String',
|
|
140
146
|
:'marketing_opt_in_decision' => :'Boolean',
|
|
141
147
|
:'marketing_opt_in_timestamp' => :'String',
|
|
142
|
-
:'accept_terms_and_conditions_timestamp' => :'
|
|
148
|
+
:'accept_terms_and_conditions_timestamp' => :'Time',
|
|
149
|
+
:'challenge' => :'Challenge2'
|
|
143
150
|
}
|
|
144
151
|
end
|
|
145
152
|
|
|
@@ -148,14 +155,14 @@ module VeloPayments
|
|
|
148
155
|
Set.new([
|
|
149
156
|
:'payor_refs',
|
|
150
157
|
:'email',
|
|
158
|
+
:'watchlist_override_expires_at_timestamp',
|
|
151
159
|
:'company',
|
|
152
|
-
:'
|
|
153
|
-
:'ofac_override_timestamp',
|
|
160
|
+
:'watchlist_status_updated_timestamp',
|
|
154
161
|
:'grace_period_end_date',
|
|
155
162
|
:'kyc_completed_timestamp',
|
|
156
163
|
:'pause_payment_timestamp',
|
|
157
164
|
:'marketing_opt_in_timestamp',
|
|
158
|
-
:'accept_terms_and_conditions_timestamp'
|
|
165
|
+
:'accept_terms_and_conditions_timestamp',
|
|
159
166
|
])
|
|
160
167
|
end
|
|
161
168
|
|
|
@@ -163,13 +170,13 @@ module VeloPayments
|
|
|
163
170
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
164
171
|
def initialize(attributes = {})
|
|
165
172
|
if (!attributes.is_a?(Hash))
|
|
166
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::
|
|
173
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::PayeeDetailResponse2` initialize method"
|
|
167
174
|
end
|
|
168
175
|
|
|
169
176
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
170
177
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
171
178
|
if (!self.class.attribute_map.key?(k.to_sym))
|
|
172
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::
|
|
179
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::PayeeDetailResponse2`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
173
180
|
end
|
|
174
181
|
h[k.to_sym] = v
|
|
175
182
|
}
|
|
@@ -192,8 +199,16 @@ module VeloPayments
|
|
|
192
199
|
self.onboarded_status = attributes[:'onboarded_status']
|
|
193
200
|
end
|
|
194
201
|
|
|
195
|
-
if attributes.key?(:'
|
|
196
|
-
self.
|
|
202
|
+
if attributes.key?(:'watchlist_status')
|
|
203
|
+
self.watchlist_status = attributes[:'watchlist_status']
|
|
204
|
+
end
|
|
205
|
+
|
|
206
|
+
if attributes.key?(:'watchlist_override_expires_at_timestamp')
|
|
207
|
+
self.watchlist_override_expires_at_timestamp = attributes[:'watchlist_override_expires_at_timestamp']
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
if attributes.key?(:'watchlist_override_comment')
|
|
211
|
+
self.watchlist_override_comment = attributes[:'watchlist_override_comment']
|
|
197
212
|
end
|
|
198
213
|
|
|
199
214
|
if attributes.key?(:'language')
|
|
@@ -244,20 +259,8 @@ module VeloPayments
|
|
|
244
259
|
self.cellphone_number = attributes[:'cellphone_number']
|
|
245
260
|
end
|
|
246
261
|
|
|
247
|
-
if attributes.key?(:'
|
|
248
|
-
self.
|
|
249
|
-
end
|
|
250
|
-
|
|
251
|
-
if attributes.key?(:'ofac_override')
|
|
252
|
-
self.ofac_override = attributes[:'ofac_override']
|
|
253
|
-
end
|
|
254
|
-
|
|
255
|
-
if attributes.key?(:'ofac_override_reason')
|
|
256
|
-
self.ofac_override_reason = attributes[:'ofac_override_reason']
|
|
257
|
-
end
|
|
258
|
-
|
|
259
|
-
if attributes.key?(:'ofac_override_timestamp')
|
|
260
|
-
self.ofac_override_timestamp = attributes[:'ofac_override_timestamp']
|
|
262
|
+
if attributes.key?(:'watchlist_status_updated_timestamp')
|
|
263
|
+
self.watchlist_status_updated_timestamp = attributes[:'watchlist_status_updated_timestamp']
|
|
261
264
|
end
|
|
262
265
|
|
|
263
266
|
if attributes.key?(:'grace_period_end_date')
|
|
@@ -291,6 +294,10 @@ module VeloPayments
|
|
|
291
294
|
if attributes.key?(:'accept_terms_and_conditions_timestamp')
|
|
292
295
|
self.accept_terms_and_conditions_timestamp = attributes[:'accept_terms_and_conditions_timestamp']
|
|
293
296
|
end
|
|
297
|
+
|
|
298
|
+
if attributes.key?(:'challenge')
|
|
299
|
+
self.challenge = attributes[:'challenge']
|
|
300
|
+
end
|
|
294
301
|
end
|
|
295
302
|
|
|
296
303
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -315,7 +322,9 @@ module VeloPayments
|
|
|
315
322
|
payor_refs == o.payor_refs &&
|
|
316
323
|
email == o.email &&
|
|
317
324
|
onboarded_status == o.onboarded_status &&
|
|
318
|
-
|
|
325
|
+
watchlist_status == o.watchlist_status &&
|
|
326
|
+
watchlist_override_expires_at_timestamp == o.watchlist_override_expires_at_timestamp &&
|
|
327
|
+
watchlist_override_comment == o.watchlist_override_comment &&
|
|
319
328
|
language == o.language &&
|
|
320
329
|
created == o.created &&
|
|
321
330
|
country == o.country &&
|
|
@@ -328,10 +337,7 @@ module VeloPayments
|
|
|
328
337
|
individual == o.individual &&
|
|
329
338
|
company == o.company &&
|
|
330
339
|
cellphone_number == o.cellphone_number &&
|
|
331
|
-
|
|
332
|
-
ofac_override == o.ofac_override &&
|
|
333
|
-
ofac_override_reason == o.ofac_override_reason &&
|
|
334
|
-
ofac_override_timestamp == o.ofac_override_timestamp &&
|
|
340
|
+
watchlist_status_updated_timestamp == o.watchlist_status_updated_timestamp &&
|
|
335
341
|
grace_period_end_date == o.grace_period_end_date &&
|
|
336
342
|
enhanced_kyc_completed == o.enhanced_kyc_completed &&
|
|
337
343
|
kyc_completed_timestamp == o.kyc_completed_timestamp &&
|
|
@@ -339,7 +345,8 @@ module VeloPayments
|
|
|
339
345
|
pause_payment_timestamp == o.pause_payment_timestamp &&
|
|
340
346
|
marketing_opt_in_decision == o.marketing_opt_in_decision &&
|
|
341
347
|
marketing_opt_in_timestamp == o.marketing_opt_in_timestamp &&
|
|
342
|
-
accept_terms_and_conditions_timestamp == o.accept_terms_and_conditions_timestamp
|
|
348
|
+
accept_terms_and_conditions_timestamp == o.accept_terms_and_conditions_timestamp &&
|
|
349
|
+
challenge == o.challenge
|
|
343
350
|
end
|
|
344
351
|
|
|
345
352
|
# @see the `==` method
|
|
@@ -351,7 +358,7 @@ module VeloPayments
|
|
|
351
358
|
# Calculates hash code according to all attributes.
|
|
352
359
|
# @return [Integer] Hash code
|
|
353
360
|
def hash
|
|
354
|
-
[payee_id, payor_refs, email, onboarded_status,
|
|
361
|
+
[payee_id, payor_refs, email, onboarded_status, watchlist_status, watchlist_override_expires_at_timestamp, watchlist_override_comment, language, created, country, display_name, payee_type, disabled, disabled_comment, disabled_updated_timestamp, address, individual, company, cellphone_number, watchlist_status_updated_timestamp, grace_period_end_date, enhanced_kyc_completed, kyc_completed_timestamp, pause_payment, pause_payment_timestamp, marketing_opt_in_decision, marketing_opt_in_timestamp, accept_terms_and_conditions_timestamp, challenge].hash
|
|
355
362
|
end
|
|
356
363
|
|
|
357
364
|
# Builds the object from hash
|
|
@@ -367,7 +374,9 @@ module VeloPayments
|
|
|
367
374
|
def build_from_hash(attributes)
|
|
368
375
|
return nil unless attributes.is_a?(Hash)
|
|
369
376
|
self.class.openapi_types.each_pair do |key, type|
|
|
370
|
-
if
|
|
377
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
378
|
+
self.send("#{key}=", nil)
|
|
379
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
371
380
|
# check to ensure the input is an array given that the attribute
|
|
372
381
|
# is documented as an array but the input is not
|
|
373
382
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
@@ -375,7 +384,7 @@ module VeloPayments
|
|
|
375
384
|
end
|
|
376
385
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
377
386
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
378
|
-
end
|
|
387
|
+
end
|
|
379
388
|
end
|
|
380
389
|
|
|
381
390
|
self
|
|
@@ -387,8 +396,8 @@ module VeloPayments
|
|
|
387
396
|
# @return [Object] Deserialized data
|
|
388
397
|
def _deserialize(type, value)
|
|
389
398
|
case type.to_sym
|
|
390
|
-
when :
|
|
391
|
-
|
|
399
|
+
when :Time
|
|
400
|
+
Time.parse(value)
|
|
392
401
|
when :Date
|
|
393
402
|
Date.parse(value)
|
|
394
403
|
when :String
|
|
@@ -418,7 +427,9 @@ module VeloPayments
|
|
|
418
427
|
end
|
|
419
428
|
end
|
|
420
429
|
else # model
|
|
421
|
-
|
|
430
|
+
# models (e.g. Pet) or oneOf
|
|
431
|
+
klass = VeloPayments.const_get(type)
|
|
432
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
422
433
|
end
|
|
423
434
|
end
|
|
424
435
|
|
|
@@ -444,7 +455,7 @@ module VeloPayments
|
|
|
444
455
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
445
456
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
446
457
|
end
|
|
447
|
-
|
|
458
|
+
|
|
448
459
|
hash[param] = _to_hash(value)
|
|
449
460
|
end
|
|
450
461
|
hash
|
|
@@ -467,5 +478,7 @@ module VeloPayments
|
|
|
467
478
|
value
|
|
468
479
|
end
|
|
469
480
|
end
|
|
481
|
+
|
|
470
482
|
end
|
|
483
|
+
|
|
471
484
|
end
|
|
@@ -0,0 +1,289 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Velo Payments APIs
|
|
3
|
+
|
|
4
|
+
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a 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. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module VeloPayments
|
|
17
|
+
# Base type for all payee details changed events
|
|
18
|
+
class PayeeDetailsChanged
|
|
19
|
+
# OA3 Schema type name for the source info which is used as the discriminator value to ensure that data binding works correctly
|
|
20
|
+
attr_accessor :source_type
|
|
21
|
+
|
|
22
|
+
# UUID id of the source event in the Velo platform
|
|
23
|
+
attr_accessor :event_id
|
|
24
|
+
|
|
25
|
+
# ISO8601 timestamp indicating when the source event was created
|
|
26
|
+
attr_accessor :created_at
|
|
27
|
+
|
|
28
|
+
# ID of this payee within the Velo platform
|
|
29
|
+
attr_accessor :payee_id
|
|
30
|
+
|
|
31
|
+
# The reasons for the event notification.
|
|
32
|
+
attr_accessor :reasons
|
|
33
|
+
|
|
34
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
35
|
+
def self.attribute_map
|
|
36
|
+
{
|
|
37
|
+
:'source_type' => :'sourceType',
|
|
38
|
+
:'event_id' => :'eventId',
|
|
39
|
+
:'created_at' => :'createdAt',
|
|
40
|
+
:'payee_id' => :'payeeId',
|
|
41
|
+
:'reasons' => :'reasons'
|
|
42
|
+
}
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# Returns all the JSON keys this model knows about
|
|
46
|
+
def self.acceptable_attributes
|
|
47
|
+
attribute_map.values
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Attribute type mapping.
|
|
51
|
+
def self.openapi_types
|
|
52
|
+
{
|
|
53
|
+
:'source_type' => :'String',
|
|
54
|
+
:'event_id' => :'String',
|
|
55
|
+
:'created_at' => :'Time',
|
|
56
|
+
:'payee_id' => :'String',
|
|
57
|
+
:'reasons' => :'Array<PayeeEventAllOfReasons>'
|
|
58
|
+
}
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# List of attributes with nullable: true
|
|
62
|
+
def self.openapi_nullable
|
|
63
|
+
Set.new([
|
|
64
|
+
])
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# List of class defined in allOf (OpenAPI v3)
|
|
68
|
+
def self.openapi_all_of
|
|
69
|
+
[
|
|
70
|
+
:'PayeeEvent'
|
|
71
|
+
]
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# Initializes the object
|
|
75
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
76
|
+
def initialize(attributes = {})
|
|
77
|
+
if (!attributes.is_a?(Hash))
|
|
78
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::PayeeDetailsChanged` initialize method"
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
82
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
83
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
84
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::PayeeDetailsChanged`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
85
|
+
end
|
|
86
|
+
h[k.to_sym] = v
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
if attributes.key?(:'source_type')
|
|
90
|
+
self.source_type = attributes[:'source_type']
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
if attributes.key?(:'event_id')
|
|
94
|
+
self.event_id = attributes[:'event_id']
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
if attributes.key?(:'created_at')
|
|
98
|
+
self.created_at = attributes[:'created_at']
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
if attributes.key?(:'payee_id')
|
|
102
|
+
self.payee_id = attributes[:'payee_id']
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
if attributes.key?(:'reasons')
|
|
106
|
+
if (value = attributes[:'reasons']).is_a?(Array)
|
|
107
|
+
self.reasons = value
|
|
108
|
+
end
|
|
109
|
+
end
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
113
|
+
# @return Array for valid properties with the reasons
|
|
114
|
+
def list_invalid_properties
|
|
115
|
+
invalid_properties = Array.new
|
|
116
|
+
if @source_type.nil?
|
|
117
|
+
invalid_properties.push('invalid value for "source_type", source_type cannot be nil.')
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
if @event_id.nil?
|
|
121
|
+
invalid_properties.push('invalid value for "event_id", event_id cannot be nil.')
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
if @created_at.nil?
|
|
125
|
+
invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
if @payee_id.nil?
|
|
129
|
+
invalid_properties.push('invalid value for "payee_id", payee_id cannot be nil.')
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
invalid_properties
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# Check to see if the all the properties in the model are valid
|
|
136
|
+
# @return true if the model is valid
|
|
137
|
+
def valid?
|
|
138
|
+
return false if @source_type.nil?
|
|
139
|
+
return false if @event_id.nil?
|
|
140
|
+
return false if @created_at.nil?
|
|
141
|
+
return false if @payee_id.nil?
|
|
142
|
+
true
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# Checks equality by comparing each attribute.
|
|
146
|
+
# @param [Object] Object to be compared
|
|
147
|
+
def ==(o)
|
|
148
|
+
return true if self.equal?(o)
|
|
149
|
+
self.class == o.class &&
|
|
150
|
+
source_type == o.source_type &&
|
|
151
|
+
event_id == o.event_id &&
|
|
152
|
+
created_at == o.created_at &&
|
|
153
|
+
payee_id == o.payee_id &&
|
|
154
|
+
reasons == o.reasons
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
# @see the `==` method
|
|
158
|
+
# @param [Object] Object to be compared
|
|
159
|
+
def eql?(o)
|
|
160
|
+
self == o
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
# Calculates hash code according to all attributes.
|
|
164
|
+
# @return [Integer] Hash code
|
|
165
|
+
def hash
|
|
166
|
+
[source_type, event_id, created_at, payee_id, reasons].hash
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
# Builds the object from hash
|
|
170
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
171
|
+
# @return [Object] Returns the model itself
|
|
172
|
+
def self.build_from_hash(attributes)
|
|
173
|
+
new.build_from_hash(attributes)
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
# Builds the object from hash
|
|
177
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
178
|
+
# @return [Object] Returns the model itself
|
|
179
|
+
def build_from_hash(attributes)
|
|
180
|
+
return nil unless attributes.is_a?(Hash)
|
|
181
|
+
self.class.openapi_types.each_pair do |key, type|
|
|
182
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
183
|
+
self.send("#{key}=", nil)
|
|
184
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
185
|
+
# check to ensure the input is an array given that the attribute
|
|
186
|
+
# is documented as an array but the input is not
|
|
187
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
188
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
189
|
+
end
|
|
190
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
191
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
192
|
+
end
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
self
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
# Deserializes the data based on type
|
|
199
|
+
# @param string type Data type
|
|
200
|
+
# @param string value Value to be deserialized
|
|
201
|
+
# @return [Object] Deserialized data
|
|
202
|
+
def _deserialize(type, value)
|
|
203
|
+
case type.to_sym
|
|
204
|
+
when :Time
|
|
205
|
+
Time.parse(value)
|
|
206
|
+
when :Date
|
|
207
|
+
Date.parse(value)
|
|
208
|
+
when :String
|
|
209
|
+
value.to_s
|
|
210
|
+
when :Integer
|
|
211
|
+
value.to_i
|
|
212
|
+
when :Float
|
|
213
|
+
value.to_f
|
|
214
|
+
when :Boolean
|
|
215
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
216
|
+
true
|
|
217
|
+
else
|
|
218
|
+
false
|
|
219
|
+
end
|
|
220
|
+
when :Object
|
|
221
|
+
# generic object (usually a Hash), return directly
|
|
222
|
+
value
|
|
223
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
224
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
225
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
226
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
227
|
+
k_type = Regexp.last_match[:k_type]
|
|
228
|
+
v_type = Regexp.last_match[:v_type]
|
|
229
|
+
{}.tap do |hash|
|
|
230
|
+
value.each do |k, v|
|
|
231
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
232
|
+
end
|
|
233
|
+
end
|
|
234
|
+
else # model
|
|
235
|
+
# models (e.g. Pet) or oneOf
|
|
236
|
+
klass = VeloPayments.const_get(type)
|
|
237
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
238
|
+
end
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
# Returns the string representation of the object
|
|
242
|
+
# @return [String] String presentation of the object
|
|
243
|
+
def to_s
|
|
244
|
+
to_hash.to_s
|
|
245
|
+
end
|
|
246
|
+
|
|
247
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
248
|
+
# @return [Hash] Returns the object in the form of hash
|
|
249
|
+
def to_body
|
|
250
|
+
to_hash
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
# Returns the object in the form of hash
|
|
254
|
+
# @return [Hash] Returns the object in the form of hash
|
|
255
|
+
def to_hash
|
|
256
|
+
hash = {}
|
|
257
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
258
|
+
value = self.send(attr)
|
|
259
|
+
if value.nil?
|
|
260
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
261
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
262
|
+
end
|
|
263
|
+
|
|
264
|
+
hash[param] = _to_hash(value)
|
|
265
|
+
end
|
|
266
|
+
hash
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
# Outputs non-array value in the form of hash
|
|
270
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
271
|
+
# @param [Object] value Any valid value
|
|
272
|
+
# @return [Hash] Returns the value in the form of hash
|
|
273
|
+
def _to_hash(value)
|
|
274
|
+
if value.is_a?(Array)
|
|
275
|
+
value.compact.map { |v| _to_hash(v) }
|
|
276
|
+
elsif value.is_a?(Hash)
|
|
277
|
+
{}.tap do |hash|
|
|
278
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
279
|
+
end
|
|
280
|
+
elsif value.respond_to? :to_hash
|
|
281
|
+
value.to_hash
|
|
282
|
+
else
|
|
283
|
+
value
|
|
284
|
+
end
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
end
|