velopayments 2.20.29.beta1 → 2.29.128.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 +2 -2
- data/Makefile +27 -18
- data/README.md +174 -99
- 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/CreatePayeesCSVRequest.md +64 -63
- data/docs/CreatePayeesCSVRequest2.md +64 -63
- 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 +46 -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 +12 -9
- data/docs/InlineResponse412.md +22 -0
- data/docs/InstructPayoutRequest.md +18 -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 +28 -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 +253 -171
- 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/PayeeType2.md +15 -0
- data/docs/PayeeUserSelfUpdateRequest.md +28 -0
- data/docs/PayeesApi.md +472 -212
- data/docs/PaymentAuditCurrency.md +15 -0
- data/docs/PaymentAuditCurrencyV3.md +4 -5
- data/docs/PaymentAuditServiceApi.md +293 -438
- 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 +100 -79
- data/docs/PaymentResponseV4Payout.md +12 -11
- data/docs/PaymentStatusChanged.md +30 -0
- data/docs/PaymentStatusChangedAllOf.md +18 -0
- data/docs/PaymentV3.md +44 -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/PayorLogoRequest.md +8 -7
- data/docs/PayorV1.md +50 -47
- data/docs/PayorV2.md +56 -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/PayoutSchedule.md +28 -0
- data/docs/PayoutSchedule2.md +26 -0
- data/docs/PayoutServiceApi.md +659 -0
- data/docs/PayoutStatus.md +15 -0
- data/docs/PayoutStatusV3.md +4 -5
- data/docs/PayoutSummaryAudit.md +50 -0
- data/docs/PayoutSummaryAuditV3.md +30 -29
- data/docs/PayoutSummaryResponseV3.md +38 -0
- data/docs/PayoutType.md +15 -0
- data/docs/Ping.md +22 -0
- data/docs/PingResponse.md +20 -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/SchedulePayoutRequest.md +20 -0
- data/docs/ScheduleStatus.md +15 -0
- data/docs/ScheduleStatus2.md +15 -0
- 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 +32 -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 +38 -33
- data/docs/UserStatus.md +4 -5
- data/docs/UserType.md +4 -5
- data/docs/UserType2.md +4 -5
- data/docs/UsersApi.md +528 -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 +365 -0
- data/docs/WebhooksResponse.md +22 -0
- data/docs/WithdrawPaymentRequest.md +18 -0
- 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 +541 -78
- data/lib/velopayments/api/funding_manager_private_api.rb +81 -14
- data/lib/velopayments/api/login_api.rb +29 -16
- data/lib/velopayments/api/payee_invitation_api.rb +116 -158
- data/lib/velopayments/api/payees_api.rb +317 -209
- data/lib/velopayments/api/payment_audit_service_api.rb +181 -461
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
- data/lib/velopayments/api/payors_api.rb +64 -44
- data/lib/velopayments/api/payors_private_api.rb +10 -6
- data/lib/velopayments/api/payout_service_api.rb +659 -0
- data/lib/velopayments/api/tokens_api.rb +10 -6
- data/lib/velopayments/api/users_api.rb +188 -63
- data/lib/velopayments/api/webhooks_api.rb +356 -0
- data/lib/velopayments/api_client.rb +54 -50
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +42 -12
- data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +45 -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 +295 -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/{individual_v1_name.rb → create_individual_name.rb} +23 -11
- data/lib/velopayments/models/create_payee.rb +25 -12
- data/lib/velopayments/models/create_payee2.rb +26 -13
- 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_request.rb +47 -46
- data/lib/velopayments/models/create_payees_csv_request2.rb +22 -21
- 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/failed_payee.rb +313 -0
- 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/funding_request_v3.rb +267 -0
- 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} +97 -116
- data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +98 -117
- 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 +53 -57
- 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/{create_individual2_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 +51 -14
- data/lib/velopayments/models/inline_response412.rb +258 -0
- data/lib/velopayments/models/instruct_payout_request.rb +219 -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 +54 -20
- 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/{paged_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/list_source_account_response_v2_links.rb +227 -0
- 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} +78 -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_response409_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} +46 -24
- data/lib/velopayments/models/{payee_response_v2.rb → payee_detail_response2.rb} +78 -65
- 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 +5 -4
- data/lib/velopayments/models/payee_type2.rb +37 -0
- 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/{list_payments_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} +108 -15
- 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_response400_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 +120 -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 +399 -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 +31 -9
- 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_logo_request.rb +20 -8
- data/lib/velopayments/models/payor_v1.rb +33 -12
- data/lib/velopayments/models/payor_v2.rb +75 -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_schedule.rb +291 -0
- data/lib/velopayments/models/{payee_payor_ref_v2.rb → payout_schedule2.rb} +81 -78
- 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} +51 -21
- data/lib/velopayments/models/payout_summary_audit_v3.rb +20 -8
- data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +53 -18
- data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +6 -5
- data/lib/velopayments/models/{paged_payee_response2_summary.rb → ping.rb} +68 -48
- data/lib/velopayments/models/{invitation_status_response.rb → ping_response.rb} +39 -25
- 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} +25 -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} +42 -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/{inline_response401_errors.rb → schedule_payout_request.rb} +48 -45
- data/lib/velopayments/models/schedule_status.rb +38 -0
- data/lib/velopayments/models/schedule_status2.rb +38 -0
- 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} +23 -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 +20 -8
- data/lib/velopayments/models/{supported_country2.rb → supported_country_v2.rb} +24 -12
- data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +24 -12
- data/lib/velopayments/models/{supported_currency.rb → supported_currency_v2.rb} +23 -11
- 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/{currency_type.rb → transmission_types.rb} +60 -45
- data/lib/velopayments/models/transmission_types2.rb +254 -0
- 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/update_payee_details_request2.rb +302 -0
- 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 +102 -19
- 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/lib/velopayments.rb +117 -68
- 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 +65 -49
- data/spec/api/payment_audit_service_api_spec.rb +35 -113
- 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/api/payout_service_api_spec.rb +154 -0
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +18 -4
- data/spec/api/webhooks_api_spec.rb +96 -0
- data/spec/api_client_spec.rb +4 -4
- 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_request2_spec.rb +8 -19
- data/spec/models/create_payees_csv_request_spec.rb +11 -18
- 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/{ofac_status2_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/{individual_response_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 +17 -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 +11 -12
- data/spec/models/inline_response412_spec.rb +46 -0
- data/spec/models/instruct_payout_request_spec.rb +34 -0
- data/spec/models/{location_type_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 +16 -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/{language2_spec.rb → payee_type2_spec.rb} +8 -15
- 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/payment_audit_currency_spec.rb +28 -0
- 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 +67 -14
- data/spec/models/payment_status_changed_all_of_spec.rb +34 -0
- data/spec/models/payment_status_changed_spec.rb +70 -0
- data/spec/models/{user_response2_spec.rb → payment_v3_spec.rb} +24 -45
- 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_logo_request_spec.rb +5 -12
- data/spec/models/payor_v1_spec.rb +12 -13
- data/spec/models/payor_v2_spec.rb +36 -13
- data/spec/models/payout_company_v3_spec.rb +34 -0
- data/spec/models/{user_response2_roles_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_schedule2_spec.rb +58 -0
- data/spec/models/{paged_payee_response2_summary_spec.rb → payout_schedule_spec.rb} +18 -19
- 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} +20 -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} +20 -15
- data/spec/models/payout_type_spec.rb +28 -0
- data/spec/models/ping_response_spec.rb +40 -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/schedule_payout_request_spec.rb +40 -0
- data/spec/models/schedule_status2_spec.rb +28 -0
- data/spec/models/schedule_status_spec.rb +28 -0
- 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 -12
- data/spec/models/{supported_country2_spec.rb → supported_country_v2_spec.rb} +8 -15
- 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/{payee_payment_channel2_spec.rb → update_payee_details_request2_spec.rb} +20 -25
- data/spec/models/update_payee_details_request_spec.rb +70 -0
- 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 +24 -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 +48 -13
- data/specs/api/currencies_api_spec.rb +8 -6
- data/specs/api/funding_manager_api_spec.rb +197 -30
- data/specs/api/funding_manager_private_api_spec.rb +6 -6
- data/specs/api/login_api_spec.rb +6 -6
- data/specs/api/payee_invitation_api_spec.rb +45 -37
- data/specs/api/payees_api_spec.rb +53 -65
- data/specs/api/payment_audit_service_api_spec.rb +125 -74
- data/specs/api/{payout_history_api_spec.rb → payment_audit_service_deprecated_api_spec.rb} +115 -33
- data/specs/api/payors_api_spec.rb +50 -17
- data/specs/api/payors_private_api_spec.rb +3 -3
- data/{spec/models/payee2_spec.rb → specs/api/payout_service_api_spec.rb} +72 -110
- data/specs/api/tokens_api_spec.rb +3 -3
- data/specs/api/users_api_spec.rb +70 -21
- data/specs/api/webhooks_api_spec.rb +96 -0
- data/velopayments.gemspec +3 -4
- metadata +466 -293
- 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/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/InlineResponse409Errors.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/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/inline_response403_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/get_payout_api_spec.rb +0 -47
- data/spec/api/instruct_payout_api_spec.rb +0 -47
- data/spec/api/quote_payout_api_spec.rb +0 -47
- data/spec/api/submit_payout_api_spec.rb +0 -47
- data/spec/api/withdraw_payout_api_spec.rb +0 -47
- data/spec/models/create_funding_account_request_spec.rb +0 -59
- 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/inline_response409_errors_spec.rb +0 -59
- data/spec/models/invitation_status_response_spec.rb +0 -41
- 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/specs/api/get_payout_api_spec.rb +0 -47
- data/specs/api/instruct_payout_api_spec.rb +0 -47
- data/specs/api/quote_payout_api_spec.rb +0 -47
- data/specs/api/submit_payout_api_spec.rb +0 -47
- data/specs/api/withdraw_payout_api_spec.rb +0 -47
data/docs/UsersApi.md
CHANGED
|
@@ -2,25 +2,25 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.sandbox.velopayments.com*
|
|
4
4
|
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
|
|
7
|
-
[**delete_user_by_id_v2**](UsersApi.md#delete_user_by_id_v2) | **DELETE** /v2/users/{userId} | Delete a User
|
|
8
|
-
[**disable_user_v2**](UsersApi.md#disable_user_v2) | **POST** /v2/users/{userId}/disable | Disable a User
|
|
9
|
-
[**enable_user_v2**](UsersApi.md#enable_user_v2) | **POST** /v2/users/{userId}/enable | Enable a User
|
|
10
|
-
[**get_self**](UsersApi.md#get_self) | **GET** /v2/users/self | Get Self
|
|
11
|
-
[**get_user_by_id_v2**](UsersApi.md#get_user_by_id_v2) | **GET** /v2/users/{userId} | Get User
|
|
12
|
-
[**invite_user**](UsersApi.md#invite_user) | **POST** /v2/users/invite | Invite a User
|
|
13
|
-
[**list_users**](UsersApi.md#list_users) | **GET** /v2/users | List Users
|
|
14
|
-
[**register_sms**](UsersApi.md#register_sms) | **POST** /v2/users/registration/sms | Register SMS Number
|
|
15
|
-
[**resend_token**](UsersApi.md#resend_token) | **POST** /v2/users/{userId}/tokens | Resend a token
|
|
16
|
-
[**role_update**](UsersApi.md#role_update) | **POST** /v2/users/{userId}/roleUpdate | Update User Role
|
|
17
|
-
[**unlock_user_v2**](UsersApi.md#unlock_user_v2) | **POST** /v2/users/{userId}/unlock | Unlock a User
|
|
18
|
-
[**unregister_mfa**](UsersApi.md#unregister_mfa) | **POST** /v2/users/{userId}/mfa/unregister | Unregister MFA for the user
|
|
19
|
-
[**unregister_mfa_for_self**](UsersApi.md#unregister_mfa_for_self) | **POST** /v2/users/self/mfa/unregister | Unregister MFA for Self
|
|
20
|
-
[**update_password_self**](UsersApi.md#update_password_self) | **POST** /v2/users/self/password | Update Password for self
|
|
21
|
-
[**user_details_update**](UsersApi.md#user_details_update) | **POST** /v2/users/{userId}/userDetailsUpdate | Update User Details
|
|
22
|
-
[**
|
|
23
|
-
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**delete_user_by_id_v2**](UsersApi.md#delete_user_by_id_v2) | **DELETE** /v2/users/{userId} | Delete a User |
|
|
8
|
+
| [**disable_user_v2**](UsersApi.md#disable_user_v2) | **POST** /v2/users/{userId}/disable | Disable a User |
|
|
9
|
+
| [**enable_user_v2**](UsersApi.md#enable_user_v2) | **POST** /v2/users/{userId}/enable | Enable a User |
|
|
10
|
+
| [**get_self**](UsersApi.md#get_self) | **GET** /v2/users/self | Get Self |
|
|
11
|
+
| [**get_user_by_id_v2**](UsersApi.md#get_user_by_id_v2) | **GET** /v2/users/{userId} | Get User |
|
|
12
|
+
| [**invite_user**](UsersApi.md#invite_user) | **POST** /v2/users/invite | Invite a User |
|
|
13
|
+
| [**list_users**](UsersApi.md#list_users) | **GET** /v2/users | List Users |
|
|
14
|
+
| [**register_sms**](UsersApi.md#register_sms) | **POST** /v2/users/registration/sms | Register SMS Number |
|
|
15
|
+
| [**resend_token**](UsersApi.md#resend_token) | **POST** /v2/users/{userId}/tokens | Resend a token |
|
|
16
|
+
| [**role_update**](UsersApi.md#role_update) | **POST** /v2/users/{userId}/roleUpdate | Update User Role |
|
|
17
|
+
| [**unlock_user_v2**](UsersApi.md#unlock_user_v2) | **POST** /v2/users/{userId}/unlock | Unlock a User |
|
|
18
|
+
| [**unregister_mfa**](UsersApi.md#unregister_mfa) | **POST** /v2/users/{userId}/mfa/unregister | Unregister MFA for the user |
|
|
19
|
+
| [**unregister_mfa_for_self**](UsersApi.md#unregister_mfa_for_self) | **POST** /v2/users/self/mfa/unregister | Unregister MFA for Self |
|
|
20
|
+
| [**update_password_self**](UsersApi.md#update_password_self) | **POST** /v2/users/self/password | Update Password for self |
|
|
21
|
+
| [**user_details_update**](UsersApi.md#user_details_update) | **POST** /v2/users/{userId}/userDetailsUpdate | Update User Details |
|
|
22
|
+
| [**user_details_update_for_self**](UsersApi.md#user_details_update_for_self) | **POST** /v2/users/self/userDetailsUpdate | Update User Details for self |
|
|
23
|
+
| [**validate_password_self**](UsersApi.md#validate_password_self) | **POST** /v2/users/self/password/validate | Validate the proposed password |
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
## delete_user_by_id_v2
|
|
@@ -31,10 +31,10 @@ Delete a User
|
|
|
31
31
|
|
|
32
32
|
Delete User by Id.
|
|
33
33
|
|
|
34
|
-
###
|
|
34
|
+
### Examples
|
|
35
35
|
|
|
36
36
|
```ruby
|
|
37
|
-
|
|
37
|
+
require 'time'
|
|
38
38
|
require 'velopayments'
|
|
39
39
|
# setup authorization
|
|
40
40
|
VeloPayments.configure do |config|
|
|
@@ -43,22 +43,39 @@ VeloPayments.configure do |config|
|
|
|
43
43
|
end
|
|
44
44
|
|
|
45
45
|
api_instance = VeloPayments::UsersApi.new
|
|
46
|
-
user_id = '
|
|
46
|
+
user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
|
|
47
47
|
|
|
48
48
|
begin
|
|
49
|
-
#Delete a User
|
|
49
|
+
# Delete a User
|
|
50
50
|
api_instance.delete_user_by_id_v2(user_id)
|
|
51
51
|
rescue VeloPayments::ApiError => e
|
|
52
|
-
puts "
|
|
52
|
+
puts "Error when calling UsersApi->delete_user_by_id_v2: #{e}"
|
|
53
53
|
end
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
|
|
56
|
+
#### Using the delete_user_by_id_v2_with_http_info variant
|
|
57
57
|
|
|
58
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
58
59
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
60
|
+
> <Array(nil, Integer, Hash)> delete_user_by_id_v2_with_http_info(user_id)
|
|
61
|
+
|
|
62
|
+
```ruby
|
|
63
|
+
begin
|
|
64
|
+
# Delete a User
|
|
65
|
+
data, status_code, headers = api_instance.delete_user_by_id_v2_with_http_info(user_id)
|
|
66
|
+
p status_code # => 2xx
|
|
67
|
+
p headers # => { ... }
|
|
68
|
+
p data # => nil
|
|
69
|
+
rescue VeloPayments::ApiError => e
|
|
70
|
+
puts "Error when calling UsersApi->delete_user_by_id_v2_with_http_info: #{e}"
|
|
71
|
+
end
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Parameters
|
|
75
|
+
|
|
76
|
+
| Name | Type | Description | Notes |
|
|
77
|
+
| ---- | ---- | ----------- | ----- |
|
|
78
|
+
| **user_id** | **String** | The UUID of the User. | |
|
|
62
79
|
|
|
63
80
|
### Return type
|
|
64
81
|
|
|
@@ -82,10 +99,10 @@ Disable a User
|
|
|
82
99
|
|
|
83
100
|
<p>If a user is enabled this endpoint will disable them </p> <p>The invoker must have the appropriate permission </p> <p>A user cannot disable themself </p> <p>When a user is disabled any active access tokens will be revoked and the user will not be able to log in</p>
|
|
84
101
|
|
|
85
|
-
###
|
|
102
|
+
### Examples
|
|
86
103
|
|
|
87
104
|
```ruby
|
|
88
|
-
|
|
105
|
+
require 'time'
|
|
89
106
|
require 'velopayments'
|
|
90
107
|
# setup authorization
|
|
91
108
|
VeloPayments.configure do |config|
|
|
@@ -94,22 +111,39 @@ VeloPayments.configure do |config|
|
|
|
94
111
|
end
|
|
95
112
|
|
|
96
113
|
api_instance = VeloPayments::UsersApi.new
|
|
97
|
-
user_id = '
|
|
114
|
+
user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
|
|
98
115
|
|
|
99
116
|
begin
|
|
100
|
-
#Disable a User
|
|
117
|
+
# Disable a User
|
|
101
118
|
api_instance.disable_user_v2(user_id)
|
|
102
119
|
rescue VeloPayments::ApiError => e
|
|
103
|
-
puts "
|
|
120
|
+
puts "Error when calling UsersApi->disable_user_v2: #{e}"
|
|
104
121
|
end
|
|
105
122
|
```
|
|
106
123
|
|
|
107
|
-
|
|
124
|
+
#### Using the disable_user_v2_with_http_info variant
|
|
125
|
+
|
|
126
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
108
127
|
|
|
128
|
+
> <Array(nil, Integer, Hash)> disable_user_v2_with_http_info(user_id)
|
|
109
129
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
130
|
+
```ruby
|
|
131
|
+
begin
|
|
132
|
+
# Disable a User
|
|
133
|
+
data, status_code, headers = api_instance.disable_user_v2_with_http_info(user_id)
|
|
134
|
+
p status_code # => 2xx
|
|
135
|
+
p headers # => { ... }
|
|
136
|
+
p data # => nil
|
|
137
|
+
rescue VeloPayments::ApiError => e
|
|
138
|
+
puts "Error when calling UsersApi->disable_user_v2_with_http_info: #{e}"
|
|
139
|
+
end
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Parameters
|
|
143
|
+
|
|
144
|
+
| Name | Type | Description | Notes |
|
|
145
|
+
| ---- | ---- | ----------- | ----- |
|
|
146
|
+
| **user_id** | **String** | The UUID of the User. | |
|
|
113
147
|
|
|
114
148
|
### Return type
|
|
115
149
|
|
|
@@ -133,10 +167,10 @@ Enable a User
|
|
|
133
167
|
|
|
134
168
|
<p>If a user has been disabled this endpoints will enable them </p> <p>The invoker must have the appropriate permission </p> <p>A user cannot enable themself </p> <p>If the user is a payor user and the payor is disabled this operation is not allowed</p> <p>If enabling a payor user would breach the limit for master admin payor users the request will be rejected </p>
|
|
135
169
|
|
|
136
|
-
###
|
|
170
|
+
### Examples
|
|
137
171
|
|
|
138
172
|
```ruby
|
|
139
|
-
|
|
173
|
+
require 'time'
|
|
140
174
|
require 'velopayments'
|
|
141
175
|
# setup authorization
|
|
142
176
|
VeloPayments.configure do |config|
|
|
@@ -145,22 +179,39 @@ VeloPayments.configure do |config|
|
|
|
145
179
|
end
|
|
146
180
|
|
|
147
181
|
api_instance = VeloPayments::UsersApi.new
|
|
148
|
-
user_id = '
|
|
182
|
+
user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
|
|
149
183
|
|
|
150
184
|
begin
|
|
151
|
-
#Enable a User
|
|
185
|
+
# Enable a User
|
|
152
186
|
api_instance.enable_user_v2(user_id)
|
|
153
187
|
rescue VeloPayments::ApiError => e
|
|
154
|
-
puts "
|
|
188
|
+
puts "Error when calling UsersApi->enable_user_v2: #{e}"
|
|
155
189
|
end
|
|
156
190
|
```
|
|
157
191
|
|
|
158
|
-
|
|
192
|
+
#### Using the enable_user_v2_with_http_info variant
|
|
193
|
+
|
|
194
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
195
|
+
|
|
196
|
+
> <Array(nil, Integer, Hash)> enable_user_v2_with_http_info(user_id)
|
|
197
|
+
|
|
198
|
+
```ruby
|
|
199
|
+
begin
|
|
200
|
+
# Enable a User
|
|
201
|
+
data, status_code, headers = api_instance.enable_user_v2_with_http_info(user_id)
|
|
202
|
+
p status_code # => 2xx
|
|
203
|
+
p headers # => { ... }
|
|
204
|
+
p data # => nil
|
|
205
|
+
rescue VeloPayments::ApiError => e
|
|
206
|
+
puts "Error when calling UsersApi->enable_user_v2_with_http_info: #{e}"
|
|
207
|
+
end
|
|
208
|
+
```
|
|
159
209
|
|
|
210
|
+
### Parameters
|
|
160
211
|
|
|
161
|
-
Name | Type | Description
|
|
162
|
-
|
|
163
|
-
**user_id** |
|
|
212
|
+
| Name | Type | Description | Notes |
|
|
213
|
+
| ---- | ---- | ----------- | ----- |
|
|
214
|
+
| **user_id** | **String** | The UUID of the User. | |
|
|
164
215
|
|
|
165
216
|
### Return type
|
|
166
217
|
|
|
@@ -178,16 +229,16 @@ nil (empty response body)
|
|
|
178
229
|
|
|
179
230
|
## get_self
|
|
180
231
|
|
|
181
|
-
>
|
|
232
|
+
> <UserResponse> get_self
|
|
182
233
|
|
|
183
234
|
Get Self
|
|
184
235
|
|
|
185
236
|
Get the user's details
|
|
186
237
|
|
|
187
|
-
###
|
|
238
|
+
### Examples
|
|
188
239
|
|
|
189
240
|
```ruby
|
|
190
|
-
|
|
241
|
+
require 'time'
|
|
191
242
|
require 'velopayments'
|
|
192
243
|
# setup authorization
|
|
193
244
|
VeloPayments.configure do |config|
|
|
@@ -198,11 +249,29 @@ end
|
|
|
198
249
|
api_instance = VeloPayments::UsersApi.new
|
|
199
250
|
|
|
200
251
|
begin
|
|
201
|
-
#Get Self
|
|
252
|
+
# Get Self
|
|
202
253
|
result = api_instance.get_self
|
|
203
254
|
p result
|
|
204
255
|
rescue VeloPayments::ApiError => e
|
|
205
|
-
puts "
|
|
256
|
+
puts "Error when calling UsersApi->get_self: #{e}"
|
|
257
|
+
end
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
#### Using the get_self_with_http_info variant
|
|
261
|
+
|
|
262
|
+
This returns an Array which contains the response data, status code and headers.
|
|
263
|
+
|
|
264
|
+
> <Array(<UserResponse>, Integer, Hash)> get_self_with_http_info
|
|
265
|
+
|
|
266
|
+
```ruby
|
|
267
|
+
begin
|
|
268
|
+
# Get Self
|
|
269
|
+
data, status_code, headers = api_instance.get_self_with_http_info
|
|
270
|
+
p status_code # => 2xx
|
|
271
|
+
p headers # => { ... }
|
|
272
|
+
p data # => <UserResponse>
|
|
273
|
+
rescue VeloPayments::ApiError => e
|
|
274
|
+
puts "Error when calling UsersApi->get_self_with_http_info: #{e}"
|
|
206
275
|
end
|
|
207
276
|
```
|
|
208
277
|
|
|
@@ -212,7 +281,7 @@ This endpoint does not need any parameter.
|
|
|
212
281
|
|
|
213
282
|
### Return type
|
|
214
283
|
|
|
215
|
-
[**
|
|
284
|
+
[**UserResponse**](UserResponse.md)
|
|
216
285
|
|
|
217
286
|
### Authorization
|
|
218
287
|
|
|
@@ -226,16 +295,16 @@ This endpoint does not need any parameter.
|
|
|
226
295
|
|
|
227
296
|
## get_user_by_id_v2
|
|
228
297
|
|
|
229
|
-
> UserResponse get_user_by_id_v2(user_id)
|
|
298
|
+
> <UserResponse> get_user_by_id_v2(user_id)
|
|
230
299
|
|
|
231
300
|
Get User
|
|
232
301
|
|
|
233
302
|
Get a Single User by Id.
|
|
234
303
|
|
|
235
|
-
###
|
|
304
|
+
### Examples
|
|
236
305
|
|
|
237
306
|
```ruby
|
|
238
|
-
|
|
307
|
+
require 'time'
|
|
239
308
|
require 'velopayments'
|
|
240
309
|
# setup authorization
|
|
241
310
|
VeloPayments.configure do |config|
|
|
@@ -244,23 +313,40 @@ VeloPayments.configure do |config|
|
|
|
244
313
|
end
|
|
245
314
|
|
|
246
315
|
api_instance = VeloPayments::UsersApi.new
|
|
247
|
-
user_id = '
|
|
316
|
+
user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
|
|
248
317
|
|
|
249
318
|
begin
|
|
250
|
-
#Get User
|
|
319
|
+
# Get User
|
|
251
320
|
result = api_instance.get_user_by_id_v2(user_id)
|
|
252
321
|
p result
|
|
253
322
|
rescue VeloPayments::ApiError => e
|
|
254
|
-
puts "
|
|
323
|
+
puts "Error when calling UsersApi->get_user_by_id_v2: #{e}"
|
|
255
324
|
end
|
|
256
325
|
```
|
|
257
326
|
|
|
258
|
-
|
|
327
|
+
#### Using the get_user_by_id_v2_with_http_info variant
|
|
259
328
|
|
|
329
|
+
This returns an Array which contains the response data, status code and headers.
|
|
260
330
|
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
331
|
+
> <Array(<UserResponse>, Integer, Hash)> get_user_by_id_v2_with_http_info(user_id)
|
|
332
|
+
|
|
333
|
+
```ruby
|
|
334
|
+
begin
|
|
335
|
+
# Get User
|
|
336
|
+
data, status_code, headers = api_instance.get_user_by_id_v2_with_http_info(user_id)
|
|
337
|
+
p status_code # => 2xx
|
|
338
|
+
p headers # => { ... }
|
|
339
|
+
p data # => <UserResponse>
|
|
340
|
+
rescue VeloPayments::ApiError => e
|
|
341
|
+
puts "Error when calling UsersApi->get_user_by_id_v2_with_http_info: #{e}"
|
|
342
|
+
end
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
### Parameters
|
|
346
|
+
|
|
347
|
+
| Name | Type | Description | Notes |
|
|
348
|
+
| ---- | ---- | ----------- | ----- |
|
|
349
|
+
| **user_id** | **String** | The UUID of the User. | |
|
|
264
350
|
|
|
265
351
|
### Return type
|
|
266
352
|
|
|
@@ -284,10 +370,10 @@ Invite a User
|
|
|
284
370
|
|
|
285
371
|
Create a User and invite them to the system
|
|
286
372
|
|
|
287
|
-
###
|
|
373
|
+
### Examples
|
|
288
374
|
|
|
289
375
|
```ruby
|
|
290
|
-
|
|
376
|
+
require 'time'
|
|
291
377
|
require 'velopayments'
|
|
292
378
|
# setup authorization
|
|
293
379
|
VeloPayments.configure do |config|
|
|
@@ -296,22 +382,39 @@ VeloPayments.configure do |config|
|
|
|
296
382
|
end
|
|
297
383
|
|
|
298
384
|
api_instance = VeloPayments::UsersApi.new
|
|
299
|
-
invite_user_request = VeloPayments::InviteUserRequest.new # InviteUserRequest | Details of User to invite
|
|
385
|
+
invite_user_request = VeloPayments::InviteUserRequest.new({email: 'foo@example.com', mfa_type: 'SMS', sms_number: '11235555555', primary_contact_number: '11235555555', roles: ["velo.payor.admin"]}) # InviteUserRequest | Details of User to invite
|
|
300
386
|
|
|
301
387
|
begin
|
|
302
|
-
#Invite a User
|
|
388
|
+
# Invite a User
|
|
303
389
|
api_instance.invite_user(invite_user_request)
|
|
304
390
|
rescue VeloPayments::ApiError => e
|
|
305
|
-
puts "
|
|
391
|
+
puts "Error when calling UsersApi->invite_user: #{e}"
|
|
306
392
|
end
|
|
307
393
|
```
|
|
308
394
|
|
|
309
|
-
|
|
395
|
+
#### Using the invite_user_with_http_info variant
|
|
310
396
|
|
|
397
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
311
398
|
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
399
|
+
> <Array(nil, Integer, Hash)> invite_user_with_http_info(invite_user_request)
|
|
400
|
+
|
|
401
|
+
```ruby
|
|
402
|
+
begin
|
|
403
|
+
# Invite a User
|
|
404
|
+
data, status_code, headers = api_instance.invite_user_with_http_info(invite_user_request)
|
|
405
|
+
p status_code # => 2xx
|
|
406
|
+
p headers # => { ... }
|
|
407
|
+
p data # => nil
|
|
408
|
+
rescue VeloPayments::ApiError => e
|
|
409
|
+
puts "Error when calling UsersApi->invite_user_with_http_info: #{e}"
|
|
410
|
+
end
|
|
411
|
+
```
|
|
412
|
+
|
|
413
|
+
### Parameters
|
|
414
|
+
|
|
415
|
+
| Name | Type | Description | Notes |
|
|
416
|
+
| ---- | ---- | ----------- | ----- |
|
|
417
|
+
| **invite_user_request** | [**InviteUserRequest**](InviteUserRequest.md) | Details of User to invite | |
|
|
315
418
|
|
|
316
419
|
### Return type
|
|
317
420
|
|
|
@@ -329,16 +432,16 @@ nil (empty response body)
|
|
|
329
432
|
|
|
330
433
|
## list_users
|
|
331
434
|
|
|
332
|
-
> PagedUserResponse list_users(opts)
|
|
435
|
+
> <PagedUserResponse> list_users(opts)
|
|
333
436
|
|
|
334
437
|
List Users
|
|
335
438
|
|
|
336
439
|
Get a paginated response listing the Users
|
|
337
440
|
|
|
338
|
-
###
|
|
441
|
+
### Examples
|
|
339
442
|
|
|
340
443
|
```ruby
|
|
341
|
-
|
|
444
|
+
require 'time'
|
|
342
445
|
require 'velopayments'
|
|
343
446
|
# setup authorization
|
|
344
447
|
VeloPayments.configure do |config|
|
|
@@ -348,34 +451,53 @@ end
|
|
|
348
451
|
|
|
349
452
|
api_instance = VeloPayments::UsersApi.new
|
|
350
453
|
opts = {
|
|
351
|
-
type: VeloPayments::UserType
|
|
352
|
-
status: VeloPayments::UserStatus
|
|
353
|
-
entity_id: '
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
454
|
+
type: VeloPayments::UserType::BACKOFFICE, # UserType | The Type of the User.
|
|
455
|
+
status: VeloPayments::UserStatus::ENABLED, # UserStatus | The status of the User.
|
|
456
|
+
entity_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The entityId of the User.
|
|
457
|
+
payee_type: VeloPayments::PayeeType::COMPANY, # PayeeType | The Type of the Payee entity. Either COMPANY or INDIVIDUAL.
|
|
458
|
+
page: 56, # Integer | Page number. Default is 1.
|
|
459
|
+
page_size: 56, # Integer | The number of results to return in a page
|
|
460
|
+
sort: 'sort_example' # String | List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae.
|
|
357
461
|
}
|
|
358
462
|
|
|
359
463
|
begin
|
|
360
|
-
#List Users
|
|
464
|
+
# List Users
|
|
361
465
|
result = api_instance.list_users(opts)
|
|
362
466
|
p result
|
|
363
467
|
rescue VeloPayments::ApiError => e
|
|
364
|
-
puts "
|
|
468
|
+
puts "Error when calling UsersApi->list_users: #{e}"
|
|
365
469
|
end
|
|
366
470
|
```
|
|
367
471
|
|
|
368
|
-
|
|
472
|
+
#### Using the list_users_with_http_info variant
|
|
473
|
+
|
|
474
|
+
This returns an Array which contains the response data, status code and headers.
|
|
475
|
+
|
|
476
|
+
> <Array(<PagedUserResponse>, Integer, Hash)> list_users_with_http_info(opts)
|
|
477
|
+
|
|
478
|
+
```ruby
|
|
479
|
+
begin
|
|
480
|
+
# List Users
|
|
481
|
+
data, status_code, headers = api_instance.list_users_with_http_info(opts)
|
|
482
|
+
p status_code # => 2xx
|
|
483
|
+
p headers # => { ... }
|
|
484
|
+
p data # => <PagedUserResponse>
|
|
485
|
+
rescue VeloPayments::ApiError => e
|
|
486
|
+
puts "Error when calling UsersApi->list_users_with_http_info: #{e}"
|
|
487
|
+
end
|
|
488
|
+
```
|
|
369
489
|
|
|
490
|
+
### Parameters
|
|
370
491
|
|
|
371
|
-
Name | Type | Description
|
|
372
|
-
|
|
373
|
-
**type** | [**UserType**](.md)| The Type of the User. | [optional]
|
|
374
|
-
**status** | [**UserStatus**](.md)| The status of the User. | [optional]
|
|
375
|
-
**entity_id** |
|
|
376
|
-
**
|
|
377
|
-
**
|
|
378
|
-
**
|
|
492
|
+
| Name | Type | Description | Notes |
|
|
493
|
+
| ---- | ---- | ----------- | ----- |
|
|
494
|
+
| **type** | [**UserType**](.md) | The Type of the User. | [optional] |
|
|
495
|
+
| **status** | [**UserStatus**](.md) | The status of the User. | [optional] |
|
|
496
|
+
| **entity_id** | **String** | The entityId of the User. | [optional] |
|
|
497
|
+
| **payee_type** | [**PayeeType**](.md) | The Type of the Payee entity. Either COMPANY or INDIVIDUAL. | [optional] |
|
|
498
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
|
499
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
|
|
500
|
+
| **sort** | **String** | List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae. | [optional][default to 'email:asc'] |
|
|
379
501
|
|
|
380
502
|
### Return type
|
|
381
503
|
|
|
@@ -399,10 +521,10 @@ Register SMS Number
|
|
|
399
521
|
|
|
400
522
|
<p>Register an Sms number and send an OTP to it </p> <p>Used for manual verification of a user </p> <p>The backoffice user initiates the request to send the OTP to the user's sms </p> <p>The user then reads back the OTP which the backoffice user enters in the verifactionCode property for requests that require it</p>
|
|
401
523
|
|
|
402
|
-
###
|
|
524
|
+
### Examples
|
|
403
525
|
|
|
404
526
|
```ruby
|
|
405
|
-
|
|
527
|
+
require 'time'
|
|
406
528
|
require 'velopayments'
|
|
407
529
|
# setup authorization
|
|
408
530
|
VeloPayments.configure do |config|
|
|
@@ -411,22 +533,39 @@ VeloPayments.configure do |config|
|
|
|
411
533
|
end
|
|
412
534
|
|
|
413
535
|
api_instance = VeloPayments::UsersApi.new
|
|
414
|
-
register_sms_request = VeloPayments::RegisterSmsRequest.new # RegisterSmsRequest | a SMS Number to send an OTP to
|
|
536
|
+
register_sms_request = VeloPayments::RegisterSmsRequest.new({sms_number: '11235555555'}) # RegisterSmsRequest | a SMS Number to send an OTP to
|
|
415
537
|
|
|
416
538
|
begin
|
|
417
|
-
#Register SMS Number
|
|
539
|
+
# Register SMS Number
|
|
418
540
|
api_instance.register_sms(register_sms_request)
|
|
419
541
|
rescue VeloPayments::ApiError => e
|
|
420
|
-
puts "
|
|
542
|
+
puts "Error when calling UsersApi->register_sms: #{e}"
|
|
421
543
|
end
|
|
422
544
|
```
|
|
423
545
|
|
|
424
|
-
|
|
546
|
+
#### Using the register_sms_with_http_info variant
|
|
547
|
+
|
|
548
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
549
|
+
|
|
550
|
+
> <Array(nil, Integer, Hash)> register_sms_with_http_info(register_sms_request)
|
|
551
|
+
|
|
552
|
+
```ruby
|
|
553
|
+
begin
|
|
554
|
+
# Register SMS Number
|
|
555
|
+
data, status_code, headers = api_instance.register_sms_with_http_info(register_sms_request)
|
|
556
|
+
p status_code # => 2xx
|
|
557
|
+
p headers # => { ... }
|
|
558
|
+
p data # => nil
|
|
559
|
+
rescue VeloPayments::ApiError => e
|
|
560
|
+
puts "Error when calling UsersApi->register_sms_with_http_info: #{e}"
|
|
561
|
+
end
|
|
562
|
+
```
|
|
425
563
|
|
|
564
|
+
### Parameters
|
|
426
565
|
|
|
427
|
-
Name | Type | Description
|
|
428
|
-
|
|
429
|
-
**register_sms_request** | [**RegisterSmsRequest**](RegisterSmsRequest.md)| a SMS Number to send an OTP to |
|
|
566
|
+
| Name | Type | Description | Notes |
|
|
567
|
+
| ---- | ---- | ----------- | ----- |
|
|
568
|
+
| **register_sms_request** | [**RegisterSmsRequest**](RegisterSmsRequest.md) | a SMS Number to send an OTP to | |
|
|
430
569
|
|
|
431
570
|
### Return type
|
|
432
571
|
|
|
@@ -450,10 +589,10 @@ Resend a token
|
|
|
450
589
|
|
|
451
590
|
<p>Resend the specified token </p> <p>The token to resend must already exist for the user </p> <p>It will be revoked and a new one issued</p>
|
|
452
591
|
|
|
453
|
-
###
|
|
592
|
+
### Examples
|
|
454
593
|
|
|
455
594
|
```ruby
|
|
456
|
-
|
|
595
|
+
require 'time'
|
|
457
596
|
require 'velopayments'
|
|
458
597
|
# setup authorization
|
|
459
598
|
VeloPayments.configure do |config|
|
|
@@ -462,24 +601,41 @@ VeloPayments.configure do |config|
|
|
|
462
601
|
end
|
|
463
602
|
|
|
464
603
|
api_instance = VeloPayments::UsersApi.new
|
|
465
|
-
user_id = '
|
|
466
|
-
resend_token_request = VeloPayments::ResendTokenRequest.new # ResendTokenRequest | The type of token to resend
|
|
604
|
+
user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
|
|
605
|
+
resend_token_request = VeloPayments::ResendTokenRequest.new({token_type: 'INVITE_MFA_USER'}) # ResendTokenRequest | The type of token to resend
|
|
467
606
|
|
|
468
607
|
begin
|
|
469
|
-
#Resend a token
|
|
608
|
+
# Resend a token
|
|
470
609
|
api_instance.resend_token(user_id, resend_token_request)
|
|
471
610
|
rescue VeloPayments::ApiError => e
|
|
472
|
-
puts "
|
|
611
|
+
puts "Error when calling UsersApi->resend_token: #{e}"
|
|
473
612
|
end
|
|
474
613
|
```
|
|
475
614
|
|
|
476
|
-
|
|
615
|
+
#### Using the resend_token_with_http_info variant
|
|
477
616
|
|
|
617
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
618
|
+
|
|
619
|
+
> <Array(nil, Integer, Hash)> resend_token_with_http_info(user_id, resend_token_request)
|
|
620
|
+
|
|
621
|
+
```ruby
|
|
622
|
+
begin
|
|
623
|
+
# Resend a token
|
|
624
|
+
data, status_code, headers = api_instance.resend_token_with_http_info(user_id, resend_token_request)
|
|
625
|
+
p status_code # => 2xx
|
|
626
|
+
p headers # => { ... }
|
|
627
|
+
p data # => nil
|
|
628
|
+
rescue VeloPayments::ApiError => e
|
|
629
|
+
puts "Error when calling UsersApi->resend_token_with_http_info: #{e}"
|
|
630
|
+
end
|
|
631
|
+
```
|
|
632
|
+
|
|
633
|
+
### Parameters
|
|
478
634
|
|
|
479
|
-
Name | Type | Description
|
|
480
|
-
|
|
481
|
-
**user_id** |
|
|
482
|
-
**resend_token_request** | [**ResendTokenRequest**](ResendTokenRequest.md)| The type of token to resend |
|
|
635
|
+
| Name | Type | Description | Notes |
|
|
636
|
+
| ---- | ---- | ----------- | ----- |
|
|
637
|
+
| **user_id** | **String** | The UUID of the User. | |
|
|
638
|
+
| **resend_token_request** | [**ResendTokenRequest**](ResendTokenRequest.md) | The type of token to resend | |
|
|
483
639
|
|
|
484
640
|
### Return type
|
|
485
641
|
|
|
@@ -503,10 +659,10 @@ Update User Role
|
|
|
503
659
|
|
|
504
660
|
<p>Update the user's Role</p>
|
|
505
661
|
|
|
506
|
-
###
|
|
662
|
+
### Examples
|
|
507
663
|
|
|
508
664
|
```ruby
|
|
509
|
-
|
|
665
|
+
require 'time'
|
|
510
666
|
require 'velopayments'
|
|
511
667
|
# setup authorization
|
|
512
668
|
VeloPayments.configure do |config|
|
|
@@ -515,24 +671,41 @@ VeloPayments.configure do |config|
|
|
|
515
671
|
end
|
|
516
672
|
|
|
517
673
|
api_instance = VeloPayments::UsersApi.new
|
|
518
|
-
user_id = '
|
|
519
|
-
role_update_request = VeloPayments::RoleUpdateRequest.new # RoleUpdateRequest | The Role to change to
|
|
674
|
+
user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
|
|
675
|
+
role_update_request = VeloPayments::RoleUpdateRequest.new({roles: ["payor.admin"]}) # RoleUpdateRequest | The Role to change to
|
|
520
676
|
|
|
521
677
|
begin
|
|
522
|
-
#Update User Role
|
|
678
|
+
# Update User Role
|
|
523
679
|
api_instance.role_update(user_id, role_update_request)
|
|
524
680
|
rescue VeloPayments::ApiError => e
|
|
525
|
-
puts "
|
|
681
|
+
puts "Error when calling UsersApi->role_update: #{e}"
|
|
526
682
|
end
|
|
527
683
|
```
|
|
528
684
|
|
|
529
|
-
|
|
685
|
+
#### Using the role_update_with_http_info variant
|
|
686
|
+
|
|
687
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
530
688
|
|
|
689
|
+
> <Array(nil, Integer, Hash)> role_update_with_http_info(user_id, role_update_request)
|
|
531
690
|
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
691
|
+
```ruby
|
|
692
|
+
begin
|
|
693
|
+
# Update User Role
|
|
694
|
+
data, status_code, headers = api_instance.role_update_with_http_info(user_id, role_update_request)
|
|
695
|
+
p status_code # => 2xx
|
|
696
|
+
p headers # => { ... }
|
|
697
|
+
p data # => nil
|
|
698
|
+
rescue VeloPayments::ApiError => e
|
|
699
|
+
puts "Error when calling UsersApi->role_update_with_http_info: #{e}"
|
|
700
|
+
end
|
|
701
|
+
```
|
|
702
|
+
|
|
703
|
+
### Parameters
|
|
704
|
+
|
|
705
|
+
| Name | Type | Description | Notes |
|
|
706
|
+
| ---- | ---- | ----------- | ----- |
|
|
707
|
+
| **user_id** | **String** | The UUID of the User. | |
|
|
708
|
+
| **role_update_request** | [**RoleUpdateRequest**](RoleUpdateRequest.md) | The Role to change to | |
|
|
536
709
|
|
|
537
710
|
### Return type
|
|
538
711
|
|
|
@@ -556,10 +729,10 @@ Unlock a User
|
|
|
556
729
|
|
|
557
730
|
If a user is locked this endpoint will unlock them
|
|
558
731
|
|
|
559
|
-
###
|
|
732
|
+
### Examples
|
|
560
733
|
|
|
561
734
|
```ruby
|
|
562
|
-
|
|
735
|
+
require 'time'
|
|
563
736
|
require 'velopayments'
|
|
564
737
|
# setup authorization
|
|
565
738
|
VeloPayments.configure do |config|
|
|
@@ -568,22 +741,39 @@ VeloPayments.configure do |config|
|
|
|
568
741
|
end
|
|
569
742
|
|
|
570
743
|
api_instance = VeloPayments::UsersApi.new
|
|
571
|
-
user_id = '
|
|
744
|
+
user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
|
|
572
745
|
|
|
573
746
|
begin
|
|
574
|
-
#Unlock a User
|
|
747
|
+
# Unlock a User
|
|
575
748
|
api_instance.unlock_user_v2(user_id)
|
|
576
749
|
rescue VeloPayments::ApiError => e
|
|
577
|
-
puts "
|
|
750
|
+
puts "Error when calling UsersApi->unlock_user_v2: #{e}"
|
|
578
751
|
end
|
|
579
752
|
```
|
|
580
753
|
|
|
581
|
-
|
|
754
|
+
#### Using the unlock_user_v2_with_http_info variant
|
|
582
755
|
|
|
756
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
583
757
|
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
758
|
+
> <Array(nil, Integer, Hash)> unlock_user_v2_with_http_info(user_id)
|
|
759
|
+
|
|
760
|
+
```ruby
|
|
761
|
+
begin
|
|
762
|
+
# Unlock a User
|
|
763
|
+
data, status_code, headers = api_instance.unlock_user_v2_with_http_info(user_id)
|
|
764
|
+
p status_code # => 2xx
|
|
765
|
+
p headers # => { ... }
|
|
766
|
+
p data # => nil
|
|
767
|
+
rescue VeloPayments::ApiError => e
|
|
768
|
+
puts "Error when calling UsersApi->unlock_user_v2_with_http_info: #{e}"
|
|
769
|
+
end
|
|
770
|
+
```
|
|
771
|
+
|
|
772
|
+
### Parameters
|
|
773
|
+
|
|
774
|
+
| Name | Type | Description | Notes |
|
|
775
|
+
| ---- | ---- | ----------- | ----- |
|
|
776
|
+
| **user_id** | **String** | The UUID of the User. | |
|
|
587
777
|
|
|
588
778
|
### Return type
|
|
589
779
|
|
|
@@ -607,10 +797,10 @@ Unregister MFA for the user
|
|
|
607
797
|
|
|
608
798
|
<p>Unregister the MFA device for the user </p> <p>If the user does not require further verification then a register new MFA device token will be sent to them via their email address</p>
|
|
609
799
|
|
|
610
|
-
###
|
|
800
|
+
### Examples
|
|
611
801
|
|
|
612
802
|
```ruby
|
|
613
|
-
|
|
803
|
+
require 'time'
|
|
614
804
|
require 'velopayments'
|
|
615
805
|
# setup authorization
|
|
616
806
|
VeloPayments.configure do |config|
|
|
@@ -619,24 +809,41 @@ VeloPayments.configure do |config|
|
|
|
619
809
|
end
|
|
620
810
|
|
|
621
811
|
api_instance = VeloPayments::UsersApi.new
|
|
622
|
-
user_id = '
|
|
623
|
-
unregister_mfa_request = VeloPayments::UnregisterMFARequest.new # UnregisterMFARequest | The MFA Type to unregister
|
|
812
|
+
user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
|
|
813
|
+
unregister_mfa_request = VeloPayments::UnregisterMFARequest.new({mfa_type: 'YUBIKEY'}) # UnregisterMFARequest | The MFA Type to unregister
|
|
624
814
|
|
|
625
815
|
begin
|
|
626
|
-
#Unregister MFA for the user
|
|
816
|
+
# Unregister MFA for the user
|
|
627
817
|
api_instance.unregister_mfa(user_id, unregister_mfa_request)
|
|
628
818
|
rescue VeloPayments::ApiError => e
|
|
629
|
-
puts "
|
|
819
|
+
puts "Error when calling UsersApi->unregister_mfa: #{e}"
|
|
630
820
|
end
|
|
631
821
|
```
|
|
632
822
|
|
|
633
|
-
|
|
823
|
+
#### Using the unregister_mfa_with_http_info variant
|
|
824
|
+
|
|
825
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
826
|
+
|
|
827
|
+
> <Array(nil, Integer, Hash)> unregister_mfa_with_http_info(user_id, unregister_mfa_request)
|
|
828
|
+
|
|
829
|
+
```ruby
|
|
830
|
+
begin
|
|
831
|
+
# Unregister MFA for the user
|
|
832
|
+
data, status_code, headers = api_instance.unregister_mfa_with_http_info(user_id, unregister_mfa_request)
|
|
833
|
+
p status_code # => 2xx
|
|
834
|
+
p headers # => { ... }
|
|
835
|
+
p data # => nil
|
|
836
|
+
rescue VeloPayments::ApiError => e
|
|
837
|
+
puts "Error when calling UsersApi->unregister_mfa_with_http_info: #{e}"
|
|
838
|
+
end
|
|
839
|
+
```
|
|
634
840
|
|
|
841
|
+
### Parameters
|
|
635
842
|
|
|
636
|
-
Name | Type | Description
|
|
637
|
-
|
|
638
|
-
**user_id** |
|
|
639
|
-
**unregister_mfa_request** | [**UnregisterMFARequest**](UnregisterMFARequest.md)| The MFA Type to unregister |
|
|
843
|
+
| Name | Type | Description | Notes |
|
|
844
|
+
| ---- | ---- | ----------- | ----- |
|
|
845
|
+
| **user_id** | **String** | The UUID of the User. | |
|
|
846
|
+
| **unregister_mfa_request** | [**UnregisterMFARequest**](UnregisterMFARequest.md) | The MFA Type to unregister | |
|
|
640
847
|
|
|
641
848
|
### Return type
|
|
642
849
|
|
|
@@ -654,16 +861,16 @@ nil (empty response body)
|
|
|
654
861
|
|
|
655
862
|
## unregister_mfa_for_self
|
|
656
863
|
|
|
657
|
-
> unregister_mfa_for_self(self_mfa_type_unregister_request)
|
|
864
|
+
> unregister_mfa_for_self(self_mfa_type_unregister_request, opts)
|
|
658
865
|
|
|
659
866
|
Unregister MFA for Self
|
|
660
867
|
|
|
661
868
|
<p>Unregister the MFA device for the user </p> <p>If the user does not require further verification then a register new MFA device token will be sent to them via their email address</p>
|
|
662
869
|
|
|
663
|
-
###
|
|
870
|
+
### Examples
|
|
664
871
|
|
|
665
872
|
```ruby
|
|
666
|
-
|
|
873
|
+
require 'time'
|
|
667
874
|
require 'velopayments'
|
|
668
875
|
# setup authorization
|
|
669
876
|
VeloPayments.configure do |config|
|
|
@@ -672,22 +879,43 @@ VeloPayments.configure do |config|
|
|
|
672
879
|
end
|
|
673
880
|
|
|
674
881
|
api_instance = VeloPayments::UsersApi.new
|
|
675
|
-
self_mfa_type_unregister_request = VeloPayments::SelfMFATypeUnregisterRequest.new # SelfMFATypeUnregisterRequest | The MFA Type to unregister
|
|
882
|
+
self_mfa_type_unregister_request = VeloPayments::SelfMFATypeUnregisterRequest.new({mfa_type: 'SMS'}) # SelfMFATypeUnregisterRequest | The MFA Type to unregister
|
|
883
|
+
opts = {
|
|
884
|
+
authorization: 'authorization_example' # String | Bearer token authorization leg of validate
|
|
885
|
+
}
|
|
676
886
|
|
|
677
887
|
begin
|
|
678
|
-
#Unregister MFA for Self
|
|
679
|
-
api_instance.unregister_mfa_for_self(self_mfa_type_unregister_request)
|
|
888
|
+
# Unregister MFA for Self
|
|
889
|
+
api_instance.unregister_mfa_for_self(self_mfa_type_unregister_request, opts)
|
|
680
890
|
rescue VeloPayments::ApiError => e
|
|
681
|
-
puts "
|
|
891
|
+
puts "Error when calling UsersApi->unregister_mfa_for_self: #{e}"
|
|
682
892
|
end
|
|
683
893
|
```
|
|
684
894
|
|
|
685
|
-
|
|
895
|
+
#### Using the unregister_mfa_for_self_with_http_info variant
|
|
896
|
+
|
|
897
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
898
|
+
|
|
899
|
+
> <Array(nil, Integer, Hash)> unregister_mfa_for_self_with_http_info(self_mfa_type_unregister_request, opts)
|
|
900
|
+
|
|
901
|
+
```ruby
|
|
902
|
+
begin
|
|
903
|
+
# Unregister MFA for Self
|
|
904
|
+
data, status_code, headers = api_instance.unregister_mfa_for_self_with_http_info(self_mfa_type_unregister_request, opts)
|
|
905
|
+
p status_code # => 2xx
|
|
906
|
+
p headers # => { ... }
|
|
907
|
+
p data # => nil
|
|
908
|
+
rescue VeloPayments::ApiError => e
|
|
909
|
+
puts "Error when calling UsersApi->unregister_mfa_for_self_with_http_info: #{e}"
|
|
910
|
+
end
|
|
911
|
+
```
|
|
686
912
|
|
|
913
|
+
### Parameters
|
|
687
914
|
|
|
688
|
-
Name | Type | Description
|
|
689
|
-
|
|
690
|
-
**self_mfa_type_unregister_request** | [**SelfMFATypeUnregisterRequest**](SelfMFATypeUnregisterRequest.md)| The MFA Type to unregister |
|
|
915
|
+
| Name | Type | Description | Notes |
|
|
916
|
+
| ---- | ---- | ----------- | ----- |
|
|
917
|
+
| **self_mfa_type_unregister_request** | [**SelfMFATypeUnregisterRequest**](SelfMFATypeUnregisterRequest.md) | The MFA Type to unregister | |
|
|
918
|
+
| **authorization** | **String** | Bearer token authorization leg of validate | [optional] |
|
|
691
919
|
|
|
692
920
|
### Return type
|
|
693
921
|
|
|
@@ -711,10 +939,10 @@ Update Password for self
|
|
|
711
939
|
|
|
712
940
|
Update password for self
|
|
713
941
|
|
|
714
|
-
###
|
|
942
|
+
### Examples
|
|
715
943
|
|
|
716
944
|
```ruby
|
|
717
|
-
|
|
945
|
+
require 'time'
|
|
718
946
|
require 'velopayments'
|
|
719
947
|
# setup authorization
|
|
720
948
|
VeloPayments.configure do |config|
|
|
@@ -723,22 +951,39 @@ VeloPayments.configure do |config|
|
|
|
723
951
|
end
|
|
724
952
|
|
|
725
953
|
api_instance = VeloPayments::UsersApi.new
|
|
726
|
-
self_update_password_request = VeloPayments::SelfUpdatePasswordRequest.new # SelfUpdatePasswordRequest | The password
|
|
954
|
+
self_update_password_request = VeloPayments::SelfUpdatePasswordRequest.new({old_password: 'My_current_password', new_password: 'My_new_password'}) # SelfUpdatePasswordRequest | The password
|
|
727
955
|
|
|
728
956
|
begin
|
|
729
|
-
#Update Password for self
|
|
957
|
+
# Update Password for self
|
|
730
958
|
api_instance.update_password_self(self_update_password_request)
|
|
731
959
|
rescue VeloPayments::ApiError => e
|
|
732
|
-
puts "
|
|
960
|
+
puts "Error when calling UsersApi->update_password_self: #{e}"
|
|
733
961
|
end
|
|
734
962
|
```
|
|
735
963
|
|
|
736
|
-
|
|
964
|
+
#### Using the update_password_self_with_http_info variant
|
|
737
965
|
|
|
966
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
967
|
+
|
|
968
|
+
> <Array(nil, Integer, Hash)> update_password_self_with_http_info(self_update_password_request)
|
|
969
|
+
|
|
970
|
+
```ruby
|
|
971
|
+
begin
|
|
972
|
+
# Update Password for self
|
|
973
|
+
data, status_code, headers = api_instance.update_password_self_with_http_info(self_update_password_request)
|
|
974
|
+
p status_code # => 2xx
|
|
975
|
+
p headers # => { ... }
|
|
976
|
+
p data # => nil
|
|
977
|
+
rescue VeloPayments::ApiError => e
|
|
978
|
+
puts "Error when calling UsersApi->update_password_self_with_http_info: #{e}"
|
|
979
|
+
end
|
|
980
|
+
```
|
|
981
|
+
|
|
982
|
+
### Parameters
|
|
738
983
|
|
|
739
|
-
Name | Type | Description
|
|
740
|
-
|
|
741
|
-
**self_update_password_request** | [**SelfUpdatePasswordRequest**](SelfUpdatePasswordRequest.md)| The password |
|
|
984
|
+
| Name | Type | Description | Notes |
|
|
985
|
+
| ---- | ---- | ----------- | ----- |
|
|
986
|
+
| **self_update_password_request** | [**SelfUpdatePasswordRequest**](SelfUpdatePasswordRequest.md) | The password | |
|
|
742
987
|
|
|
743
988
|
### Return type
|
|
744
989
|
|
|
@@ -762,10 +1007,10 @@ Update User Details
|
|
|
762
1007
|
|
|
763
1008
|
<p>Update the profile details for the given user</p> <p>When updating Payor users with the role of payor.master_admin a verificationCode is required</p>
|
|
764
1009
|
|
|
765
|
-
###
|
|
1010
|
+
### Examples
|
|
766
1011
|
|
|
767
1012
|
```ruby
|
|
768
|
-
|
|
1013
|
+
require 'time'
|
|
769
1014
|
require 'velopayments'
|
|
770
1015
|
# setup authorization
|
|
771
1016
|
VeloPayments.configure do |config|
|
|
@@ -774,24 +1019,109 @@ VeloPayments.configure do |config|
|
|
|
774
1019
|
end
|
|
775
1020
|
|
|
776
1021
|
api_instance = VeloPayments::UsersApi.new
|
|
777
|
-
user_id = '
|
|
1022
|
+
user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The UUID of the User.
|
|
778
1023
|
user_details_update_request = VeloPayments::UserDetailsUpdateRequest.new # UserDetailsUpdateRequest | The details of the user to update
|
|
779
1024
|
|
|
780
1025
|
begin
|
|
781
|
-
#Update User Details
|
|
1026
|
+
# Update User Details
|
|
782
1027
|
api_instance.user_details_update(user_id, user_details_update_request)
|
|
783
1028
|
rescue VeloPayments::ApiError => e
|
|
784
|
-
puts "
|
|
1029
|
+
puts "Error when calling UsersApi->user_details_update: #{e}"
|
|
1030
|
+
end
|
|
1031
|
+
```
|
|
1032
|
+
|
|
1033
|
+
#### Using the user_details_update_with_http_info variant
|
|
1034
|
+
|
|
1035
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1036
|
+
|
|
1037
|
+
> <Array(nil, Integer, Hash)> user_details_update_with_http_info(user_id, user_details_update_request)
|
|
1038
|
+
|
|
1039
|
+
```ruby
|
|
1040
|
+
begin
|
|
1041
|
+
# Update User Details
|
|
1042
|
+
data, status_code, headers = api_instance.user_details_update_with_http_info(user_id, user_details_update_request)
|
|
1043
|
+
p status_code # => 2xx
|
|
1044
|
+
p headers # => { ... }
|
|
1045
|
+
p data # => nil
|
|
1046
|
+
rescue VeloPayments::ApiError => e
|
|
1047
|
+
puts "Error when calling UsersApi->user_details_update_with_http_info: #{e}"
|
|
785
1048
|
end
|
|
786
1049
|
```
|
|
787
1050
|
|
|
788
1051
|
### Parameters
|
|
789
1052
|
|
|
1053
|
+
| Name | Type | Description | Notes |
|
|
1054
|
+
| ---- | ---- | ----------- | ----- |
|
|
1055
|
+
| **user_id** | **String** | The UUID of the User. | |
|
|
1056
|
+
| **user_details_update_request** | [**UserDetailsUpdateRequest**](UserDetailsUpdateRequest.md) | The details of the user to update | |
|
|
1057
|
+
|
|
1058
|
+
### Return type
|
|
790
1059
|
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
1060
|
+
nil (empty response body)
|
|
1061
|
+
|
|
1062
|
+
### Authorization
|
|
1063
|
+
|
|
1064
|
+
[OAuth2](../README.md#OAuth2)
|
|
1065
|
+
|
|
1066
|
+
### HTTP request headers
|
|
1067
|
+
|
|
1068
|
+
- **Content-Type**: application/json
|
|
1069
|
+
- **Accept**: application/json
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
## user_details_update_for_self
|
|
1073
|
+
|
|
1074
|
+
> user_details_update_for_self(payee_user_self_update_request)
|
|
1075
|
+
|
|
1076
|
+
Update User Details for self
|
|
1077
|
+
|
|
1078
|
+
<p>Update the profile details for the given user</p> <p>Only Payee user types are supported</p>
|
|
1079
|
+
|
|
1080
|
+
### Examples
|
|
1081
|
+
|
|
1082
|
+
```ruby
|
|
1083
|
+
require 'time'
|
|
1084
|
+
require 'velopayments'
|
|
1085
|
+
# setup authorization
|
|
1086
|
+
VeloPayments.configure do |config|
|
|
1087
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
1088
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1089
|
+
end
|
|
1090
|
+
|
|
1091
|
+
api_instance = VeloPayments::UsersApi.new
|
|
1092
|
+
payee_user_self_update_request = VeloPayments::PayeeUserSelfUpdateRequest.new # PayeeUserSelfUpdateRequest | The details of the user to update
|
|
1093
|
+
|
|
1094
|
+
begin
|
|
1095
|
+
# Update User Details for self
|
|
1096
|
+
api_instance.user_details_update_for_self(payee_user_self_update_request)
|
|
1097
|
+
rescue VeloPayments::ApiError => e
|
|
1098
|
+
puts "Error when calling UsersApi->user_details_update_for_self: #{e}"
|
|
1099
|
+
end
|
|
1100
|
+
```
|
|
1101
|
+
|
|
1102
|
+
#### Using the user_details_update_for_self_with_http_info variant
|
|
1103
|
+
|
|
1104
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1105
|
+
|
|
1106
|
+
> <Array(nil, Integer, Hash)> user_details_update_for_self_with_http_info(payee_user_self_update_request)
|
|
1107
|
+
|
|
1108
|
+
```ruby
|
|
1109
|
+
begin
|
|
1110
|
+
# Update User Details for self
|
|
1111
|
+
data, status_code, headers = api_instance.user_details_update_for_self_with_http_info(payee_user_self_update_request)
|
|
1112
|
+
p status_code # => 2xx
|
|
1113
|
+
p headers # => { ... }
|
|
1114
|
+
p data # => nil
|
|
1115
|
+
rescue VeloPayments::ApiError => e
|
|
1116
|
+
puts "Error when calling UsersApi->user_details_update_for_self_with_http_info: #{e}"
|
|
1117
|
+
end
|
|
1118
|
+
```
|
|
1119
|
+
|
|
1120
|
+
### Parameters
|
|
1121
|
+
|
|
1122
|
+
| Name | Type | Description | Notes |
|
|
1123
|
+
| ---- | ---- | ----------- | ----- |
|
|
1124
|
+
| **payee_user_self_update_request** | [**PayeeUserSelfUpdateRequest**](PayeeUserSelfUpdateRequest.md) | The details of the user to update | |
|
|
795
1125
|
|
|
796
1126
|
### Return type
|
|
797
1127
|
|
|
@@ -809,16 +1139,16 @@ nil (empty response body)
|
|
|
809
1139
|
|
|
810
1140
|
## validate_password_self
|
|
811
1141
|
|
|
812
|
-
> ValidatePasswordResponse validate_password_self(password_request)
|
|
1142
|
+
> <ValidatePasswordResponse> validate_password_self(password_request)
|
|
813
1143
|
|
|
814
1144
|
Validate the proposed password
|
|
815
1145
|
|
|
816
1146
|
validate the password and return a score
|
|
817
1147
|
|
|
818
|
-
###
|
|
1148
|
+
### Examples
|
|
819
1149
|
|
|
820
1150
|
```ruby
|
|
821
|
-
|
|
1151
|
+
require 'time'
|
|
822
1152
|
require 'velopayments'
|
|
823
1153
|
# setup authorization
|
|
824
1154
|
VeloPayments.configure do |config|
|
|
@@ -827,23 +1157,40 @@ VeloPayments.configure do |config|
|
|
|
827
1157
|
end
|
|
828
1158
|
|
|
829
1159
|
api_instance = VeloPayments::UsersApi.new
|
|
830
|
-
password_request = VeloPayments::PasswordRequest.new # PasswordRequest | The password
|
|
1160
|
+
password_request = VeloPayments::PasswordRequest.new({password: 'My_strong_password'}) # PasswordRequest | The password
|
|
831
1161
|
|
|
832
1162
|
begin
|
|
833
|
-
#Validate the proposed password
|
|
1163
|
+
# Validate the proposed password
|
|
834
1164
|
result = api_instance.validate_password_self(password_request)
|
|
835
1165
|
p result
|
|
836
1166
|
rescue VeloPayments::ApiError => e
|
|
837
|
-
puts "
|
|
1167
|
+
puts "Error when calling UsersApi->validate_password_self: #{e}"
|
|
838
1168
|
end
|
|
839
1169
|
```
|
|
840
1170
|
|
|
841
|
-
|
|
1171
|
+
#### Using the validate_password_self_with_http_info variant
|
|
1172
|
+
|
|
1173
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1174
|
+
|
|
1175
|
+
> <Array(<ValidatePasswordResponse>, Integer, Hash)> validate_password_self_with_http_info(password_request)
|
|
1176
|
+
|
|
1177
|
+
```ruby
|
|
1178
|
+
begin
|
|
1179
|
+
# Validate the proposed password
|
|
1180
|
+
data, status_code, headers = api_instance.validate_password_self_with_http_info(password_request)
|
|
1181
|
+
p status_code # => 2xx
|
|
1182
|
+
p headers # => { ... }
|
|
1183
|
+
p data # => <ValidatePasswordResponse>
|
|
1184
|
+
rescue VeloPayments::ApiError => e
|
|
1185
|
+
puts "Error when calling UsersApi->validate_password_self_with_http_info: #{e}"
|
|
1186
|
+
end
|
|
1187
|
+
```
|
|
842
1188
|
|
|
1189
|
+
### Parameters
|
|
843
1190
|
|
|
844
|
-
Name | Type | Description
|
|
845
|
-
|
|
846
|
-
**password_request** | [**PasswordRequest**](PasswordRequest.md)| The password |
|
|
1191
|
+
| Name | Type | Description | Notes |
|
|
1192
|
+
| ---- | ---- | ----------- | ----- |
|
|
1193
|
+
| **password_request** | [**PasswordRequest**](PasswordRequest.md) | The password | |
|
|
847
1194
|
|
|
848
1195
|
### Return type
|
|
849
1196
|
|