velopayments 2.19.40.beta1 → 2.26.124.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Dockerfile +7 -0
- data/Gemfile +1 -1
- data/Makefile +7 -12
- data/README.md +164 -101
- data/docs/AcceptedPaymentV3.md +32 -0
- data/docs/AccessTokenResponse.md +20 -19
- data/docs/AccessTokenValidationRequest.md +8 -7
- data/docs/AuthResponse.md +18 -17
- data/docs/AutoTopUpConfig.md +12 -11
- data/docs/AutoTopUpConfig2.md +24 -0
- data/docs/Category.md +15 -0
- data/docs/Challenge.md +10 -9
- data/docs/Challenge2.md +20 -0
- data/docs/Company.md +12 -11
- data/docs/Company2.md +12 -11
- data/docs/CountriesApi.md +91 -38
- data/docs/CreateFundingAccountRequestV2.md +30 -0
- data/docs/CreateIndividual.md +12 -11
- data/docs/CreateIndividual2.md +12 -11
- data/docs/CreateIndividualName.md +24 -0
- data/docs/CreatePayee.md +28 -27
- data/docs/CreatePayee2.md +28 -27
- data/docs/CreatePayeeAddress.md +22 -21
- data/docs/CreatePayeeAddress2.md +22 -21
- data/docs/CreatePayeesCSVResponse.md +10 -9
- data/docs/CreatePayeesCSVResponse2.md +10 -9
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +12 -11
- data/docs/CreatePayeesRequest.md +10 -9
- data/docs/CreatePayeesRequest2.md +10 -9
- data/docs/CreatePaymentChannel.md +20 -19
- data/docs/CreatePaymentChannel2.md +20 -19
- data/docs/CreatePayorLinkRequest.md +12 -11
- data/docs/CreatePayoutRequestV3.md +24 -0
- data/docs/CreateWebhookRequest.md +26 -0
- data/docs/CurrenciesApi.md +29 -12
- data/docs/DebitEvent.md +24 -0
- data/docs/DebitEventAllOf.md +18 -0
- data/docs/DebitStatusChanged.md +26 -0
- data/docs/DebitStatusChangedAllOf.md +18 -0
- data/docs/Error.md +20 -13
- data/docs/ErrorData.md +20 -0
- data/docs/ErrorResponse.md +12 -9
- data/docs/FailedPayee.md +38 -0
- data/docs/FailedPayee2.md +38 -0
- data/docs/FailedSubmission.md +10 -9
- data/docs/FailedSubmission2.md +10 -9
- data/docs/FundingAccountResponse.md +26 -17
- data/docs/FundingAccountResponse2.md +36 -0
- data/docs/FundingAccountType.md +15 -0
- data/docs/FundingAudit.md +24 -23
- data/docs/FundingEvent.md +14 -13
- data/docs/FundingEventType.md +4 -5
- data/docs/FundingManagerApi.md +772 -185
- data/docs/FundingManagerPrivateApi.md +101 -16
- data/docs/FundingPayorStatusAuditResponse.md +14 -13
- data/docs/FundingRequestV1.md +8 -7
- data/docs/FundingRequestV2.md +8 -7
- data/docs/FundingRequestV3.md +20 -0
- data/docs/FxSummary.md +36 -0
- data/docs/FxSummaryV3.md +26 -25
- data/docs/GetFundingsResponse.md +12 -11
- data/docs/GetFundingsResponseLinks.md +20 -0
- data/docs/GetPayeeListResponse.md +50 -0
- data/docs/GetPayeeListResponse2.md +50 -0
- data/docs/GetPayeeListResponseCompany.md +20 -0
- data/docs/GetPayeeListResponseCompany2.md +20 -0
- data/docs/GetPayeeListResponseIndividual.md +18 -0
- data/docs/GetPayeeListResponseIndividual2.md +18 -0
- data/docs/GetPaymentsForPayoutResponseV3.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV3Page.md +16 -15
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +26 -25
- data/docs/GetPaymentsForPayoutResponseV4.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +44 -41
- data/docs/GetPayoutStatistics.md +10 -9
- data/docs/GetPayoutsResponse.md +22 -0
- data/docs/GetPayoutsResponseV3.md +12 -11
- data/docs/GetPayoutsResponseV3Links.md +10 -9
- data/docs/GetPayoutsResponseV3Page.md +16 -15
- data/docs/Individual.md +12 -11
- data/docs/Individual2.md +12 -11
- data/docs/IndividualName.md +24 -0
- data/docs/InlineResponse400.md +12 -9
- data/docs/InlineResponse401.md +12 -9
- data/docs/InlineResponse403.md +12 -9
- data/docs/InlineResponse404.md +22 -0
- data/docs/InlineResponse409.md +22 -0
- data/docs/InlineResponse412.md +22 -0
- data/docs/InvitationStatus.md +4 -5
- data/docs/InvitationStatus2.md +15 -0
- data/docs/InvitePayeeRequest.md +8 -7
- data/docs/InvitePayeeRequest2.md +8 -7
- data/docs/InviteUserRequest.md +26 -25
- data/docs/KycState.md +4 -5
- data/docs/LinkForResponse.md +10 -9
- data/docs/ListFundingAccountsResponse.md +12 -11
- data/docs/ListFundingAccountsResponse2.md +22 -0
- data/docs/ListPaymentsResponseV3.md +22 -0
- data/docs/ListPaymentsResponseV3Page.md +26 -0
- data/docs/ListPaymentsResponseV4.md +12 -11
- data/docs/ListSourceAccountResponse.md +12 -11
- data/docs/ListSourceAccountResponseLinks.md +10 -9
- data/docs/ListSourceAccountResponsePage.md +16 -15
- data/docs/ListSourceAccountResponseV2.md +12 -11
- data/docs/ListSourceAccountResponseV2Links.md +20 -0
- data/docs/ListSourceAccountResponseV3.md +22 -0
- data/docs/ListSourceAccountResponseV3Links.md +20 -0
- data/docs/LocalisationDetails.md +20 -0
- data/docs/LoginApi.md +113 -41
- data/docs/MFADetails.md +10 -9
- data/docs/MFAType.md +4 -5
- data/docs/Name.md +24 -0
- data/docs/Name2.md +24 -0
- data/docs/Notification.md +26 -0
- data/docs/Notifications.md +8 -7
- data/docs/Notifications2.md +18 -0
- data/docs/OfacStatus.md +4 -5
- data/docs/OnboardedStatus.md +4 -5
- data/docs/OnboardedStatus2.md +4 -5
- data/docs/OnboardingStatusChanged.md +26 -0
- data/docs/PageForResponse.md +16 -15
- data/docs/PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse2.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponsePage.md +16 -15
- data/docs/PagedPayeeResponse.md +14 -13
- data/docs/PagedPayeeResponse2.md +14 -13
- data/docs/PagedPayeeResponseLinks.md +10 -9
- data/docs/PagedPayeeResponsePage.md +16 -15
- data/docs/PagedPayeeResponseSummary.md +16 -15
- data/docs/PagedPaymentsResponseV3.md +22 -0
- data/docs/PagedUserResponse.md +12 -11
- data/docs/PagedUserResponseLinks.md +10 -9
- data/docs/PagedUserResponsePage.md +16 -15
- data/docs/PasswordRequest.md +8 -7
- data/docs/PayableIssue.md +20 -0
- data/docs/PayableIssue2.md +20 -0
- data/docs/PayableStatusChanged.md +26 -0
- data/docs/PayeeAddress.md +22 -21
- data/docs/PayeeAddress2.md +22 -21
- data/docs/PayeeDelta.md +20 -19
- data/docs/PayeeDelta2.md +20 -19
- data/docs/PayeeDeltaResponse.md +12 -11
- data/docs/PayeeDeltaResponse2.md +12 -11
- data/docs/PayeeDeltaResponse2Links.md +10 -9
- data/docs/PayeeDeltaResponseLinks.md +10 -9
- data/docs/PayeeDeltaResponsePage.md +16 -15
- data/docs/PayeeDetailResponse.md +74 -0
- data/docs/PayeeDetailResponse2.md +74 -0
- data/docs/PayeeDetailsChanged.md +26 -0
- data/docs/PayeeEvent.md +26 -0
- data/docs/PayeeEventAllOf.md +20 -0
- data/docs/PayeeEventAllOfReasons.md +20 -0
- data/docs/PayeeInvitationApi.md +258 -176
- data/docs/PayeeInvitationStatusResponse.md +12 -11
- data/docs/PayeeInvitationStatusResponse2.md +12 -11
- data/docs/PayeePayorRef.md +20 -11
- data/docs/PayeePayorRefV3.md +20 -15
- data/docs/PayeeType.md +4 -5
- data/docs/PayeeUserSelfUpdateRequest.md +28 -0
- data/docs/PayeesApi.md +479 -219
- data/docs/PaymentAuditCurrency.md +15 -0
- data/docs/PaymentAuditCurrencyV3.md +4 -5
- data/docs/PaymentAuditServiceApi.md +280 -437
- data/docs/PaymentAuditServiceDeprecatedApi.md +675 -0
- data/docs/PaymentChannelCountry.md +10 -9
- data/docs/PaymentChannelRule.md +20 -19
- data/docs/PaymentChannelRulesResponse.md +8 -7
- data/docs/PaymentDelta.md +22 -21
- data/docs/PaymentDeltaResponse.md +12 -11
- data/docs/PaymentDeltaResponseV1.md +22 -0
- data/docs/PaymentDeltaV1.md +32 -0
- data/docs/PaymentEvent.md +28 -0
- data/docs/PaymentEventAllOf.md +22 -0
- data/docs/PaymentEventResponse.md +40 -0
- data/docs/PaymentEventResponseV3.md +30 -29
- data/docs/PaymentInstructionV3.md +34 -0
- data/docs/PaymentRails.md +4 -5
- data/docs/PaymentRejectedOrReturned.md +34 -0
- data/docs/PaymentRejectedOrReturnedAllOf.md +20 -0
- data/docs/PaymentResponseV3.md +78 -77
- data/docs/PaymentResponseV4.md +96 -79
- data/docs/PaymentResponseV4Payout.md +12 -11
- data/docs/PaymentStatusChanged.md +30 -0
- data/docs/PaymentStatusChangedAllOf.md +18 -0
- data/docs/PaymentV3.md +42 -0
- data/docs/PayorAddress.md +22 -21
- data/docs/PayorAddressV2.md +22 -21
- data/docs/PayorAmlTransaction.md +70 -0
- data/docs/PayorAmlTransactionV3.md +56 -61
- data/docs/PayorBrandingResponse.md +16 -15
- data/docs/PayorCreateApiKeyRequest.md +12 -11
- data/docs/PayorCreateApiKeyResponse.md +10 -9
- data/docs/PayorCreateApplicationRequest.md +10 -9
- data/docs/PayorEmailOptOutRequest.md +8 -7
- data/docs/PayorLinksResponse.md +10 -9
- data/docs/PayorLinksResponseLinks.md +14 -13
- data/docs/PayorLinksResponsePayors.md +14 -13
- data/docs/PayorV1.md +50 -47
- data/docs/PayorV2.md +52 -45
- data/docs/PayorsApi.md +236 -101
- data/docs/PayorsPrivateApi.md +29 -13
- data/docs/PayoutCompanyV3.md +18 -0
- data/docs/PayoutIndividualV3.md +18 -0
- data/docs/PayoutNameV3.md +20 -0
- data/docs/PayoutPayeeV3.md +22 -0
- data/docs/PayoutPayor.md +26 -0
- data/docs/PayoutPayorIds.md +22 -0
- data/docs/PayoutPrincipal.md +20 -0
- data/docs/PayoutServiceApi.md +513 -0
- data/docs/PayoutStatus.md +15 -0
- data/docs/PayoutStatusV3.md +4 -5
- data/docs/PayoutSummaryAudit.md +48 -0
- data/docs/PayoutSummaryAuditV3.md +30 -29
- data/docs/PayoutSummaryResponseV3.md +36 -0
- data/docs/PayoutType.md +15 -0
- data/docs/Ping.md +22 -0
- data/docs/QueryBatchResponse.md +14 -13
- data/docs/QueryBatchResponse2.md +14 -13
- data/docs/QuoteFxSummaryV3.md +38 -0
- data/docs/QuoteResponseV3.md +18 -0
- data/docs/RegionV2.md +20 -0
- data/docs/RegisterSmsRequest.md +8 -7
- data/docs/RejectedPaymentV3.md +38 -0
- data/docs/ResendTokenRequest.md +10 -9
- data/docs/ResetPasswordRequest.md +8 -7
- data/docs/Role.md +8 -7
- data/docs/RoleUpdateRequest.md +10 -9
- data/docs/SelfMFATypeUnregisterRequest.md +8 -7
- data/docs/SelfUpdatePasswordRequest.md +10 -9
- data/docs/SetNotificationsRequest.md +8 -7
- data/docs/SourceAccountResponse.md +34 -31
- data/docs/SourceAccountResponseV2.md +38 -35
- data/docs/SourceAccountResponseV3.md +52 -0
- data/docs/SourceAccountSummary.md +22 -0
- data/docs/SourceAccountSummaryV3.md +12 -11
- data/docs/SourceAccountType.md +15 -0
- data/docs/SourceAccountV3.md +24 -0
- data/docs/SourceEvent.md +22 -0
- data/docs/SupportedCountriesResponse.md +8 -7
- data/docs/SupportedCountriesResponseV2.md +18 -0
- data/docs/SupportedCountry.md +10 -9
- data/docs/SupportedCountryV2.md +22 -0
- data/docs/SupportedCurrencyResponseV2.md +18 -0
- data/docs/SupportedCurrencyV2.md +20 -0
- data/docs/TokensApi.md +31 -15
- data/docs/TransferRequest.md +12 -11
- data/docs/TransferRequest2.md +22 -0
- data/docs/TransmissionType.md +15 -0
- data/docs/TransmissionTypes.md +22 -0
- data/docs/TransmissionTypes2.md +22 -0
- data/docs/UnregisterMFARequest.md +10 -9
- data/docs/UpdatePayeeDetailsRequest.md +30 -0
- data/docs/UpdatePayeeDetailsRequest2.md +30 -0
- data/docs/UpdateRemoteIdRequest.md +10 -9
- data/docs/UpdateRemoteIdRequest2.md +20 -0
- data/docs/UpdateWebhookRequest.md +24 -0
- data/docs/UserDetailsUpdateRequest.md +22 -21
- data/docs/UserInfo.md +12 -11
- data/docs/UserResponse.md +34 -33
- data/docs/UserStatus.md +4 -5
- data/docs/UserType.md +4 -5
- data/docs/UserType2.md +4 -5
- data/docs/UsersApi.md +526 -181
- data/docs/ValidatePasswordResponse.md +14 -13
- data/docs/WatchlistStatus.md +4 -5
- data/docs/WatchlistStatus2.md +15 -0
- data/docs/WebhookResponse.md +28 -0
- data/docs/WebhooksApi.md +297 -0
- data/docs/WebhooksResponse.md +22 -0
- data/docs/WithdrawPaymentRequest.md +18 -0
- data/lib/velopayments.rb +110 -70
- data/lib/velopayments/api/countries_api.rb +38 -35
- data/lib/velopayments/api/currencies_api.rb +13 -12
- data/lib/velopayments/api/funding_manager_api.rb +519 -74
- data/lib/velopayments/api/funding_manager_private_api.rb +77 -13
- data/lib/velopayments/api/login_api.rb +21 -14
- data/lib/velopayments/api/payee_invitation_api.rb +100 -154
- data/lib/velopayments/api/payees_api.rb +299 -203
- data/lib/velopayments/api/payment_audit_service_api.rb +153 -459
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
- data/lib/velopayments/api/payors_api.rb +48 -40
- data/lib/velopayments/api/payors_private_api.rb +6 -5
- data/lib/velopayments/api/payout_service_api.rb +513 -0
- data/lib/velopayments/api/tokens_api.rb +6 -5
- data/lib/velopayments/api/users_api.rb +146 -54
- data/lib/velopayments/api/webhooks_api.rb +291 -0
- data/lib/velopayments/api_client.rb +51 -47
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +40 -11
- data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +57 -15
- data/lib/velopayments/models/access_token_response.rb +20 -8
- data/lib/velopayments/models/access_token_validation_request.rb +20 -8
- data/lib/velopayments/models/auth_response.rb +20 -8
- data/lib/velopayments/models/auto_top_up_config.rb +20 -8
- data/lib/velopayments/models/auto_top_up_config2.rb +256 -0
- data/lib/velopayments/models/{language.rb → category.rb} +9 -16
- data/lib/velopayments/models/challenge.rb +20 -8
- data/lib/velopayments/models/challenge2.rb +293 -0
- data/lib/velopayments/models/company.rb +25 -13
- data/lib/velopayments/models/company2.rb +25 -13
- data/lib/velopayments/models/{payee_payment_channel.rb → create_funding_account_request_v2.rb} +146 -148
- data/lib/velopayments/models/create_individual.rb +21 -9
- data/lib/velopayments/models/create_individual2.rb +21 -9
- data/lib/velopayments/models/{create_individual2_name.rb → create_individual_name.rb} +23 -11
- data/lib/velopayments/models/create_payee.rb +24 -11
- data/lib/velopayments/models/create_payee2.rb +25 -12
- data/lib/velopayments/models/create_payee_address.rb +53 -25
- data/lib/velopayments/models/create_payee_address2.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response2.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +20 -8
- data/lib/velopayments/models/create_payees_request.rb +20 -8
- data/lib/velopayments/models/create_payees_request2.rb +20 -8
- data/lib/velopayments/models/create_payment_channel.rb +20 -8
- data/lib/velopayments/models/create_payment_channel2.rb +20 -8
- data/lib/velopayments/models/create_payor_link_request.rb +20 -8
- data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +56 -26
- data/lib/velopayments/models/create_webhook_request.rb +338 -0
- data/lib/velopayments/models/debit_event.rb +278 -0
- data/lib/velopayments/models/debit_event_all_of.rb +224 -0
- data/lib/velopayments/models/debit_status_changed.rb +293 -0
- data/lib/velopayments/models/debit_status_changed_all_of.rb +224 -0
- data/lib/velopayments/models/error.rb +54 -14
- data/lib/velopayments/models/error_data.rb +229 -0
- data/lib/velopayments/models/error_response.rb +49 -14
- data/lib/velopayments/models/{payee_payor_ref_v2.rb → failed_payee.rb} +104 -69
- data/lib/velopayments/models/failed_payee2.rb +313 -0
- data/lib/velopayments/models/failed_submission.rb +21 -9
- data/lib/velopayments/models/failed_submission2.rb +21 -9
- data/lib/velopayments/models/funding_account_response.rb +115 -12
- data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +116 -97
- data/lib/velopayments/models/{location_type.rb → funding_account_type.rb} +8 -10
- data/lib/velopayments/models/funding_audit.rb +33 -19
- data/lib/velopayments/models/funding_event.rb +21 -9
- data/lib/velopayments/models/funding_event_type.rb +3 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +57 -9
- data/lib/velopayments/models/funding_request_v1.rb +20 -8
- data/lib/velopayments/models/funding_request_v2.rb +20 -8
- data/lib/velopayments/models/{payor_logo_request.rb → funding_request_v3.rb} +79 -18
- data/lib/velopayments/models/{fx_summary_v4.rb → fx_summary.rb} +26 -14
- data/lib/velopayments/models/fx_summary_v3.rb +21 -9
- data/lib/velopayments/models/get_fundings_response.rb +23 -18
- data/lib/velopayments/models/{get_fundings_response_all_of.rb → get_fundings_response_links.rb} +39 -20
- data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +96 -115
- data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +97 -116
- data/lib/velopayments/models/{company_response.rb → get_payee_list_response_company.rb} +29 -26
- data/lib/velopayments/models/{company_v1.rb → get_payee_list_response_company2.rb} +30 -55
- data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +24 -12
- data/lib/velopayments/models/{paged_response.rb → get_payee_list_response_individual2.rb} +30 -29
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +23 -11
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +43 -56
- data/lib/velopayments/models/get_payout_statistics.rb +20 -8
- data/lib/velopayments/models/{get_payouts_response_v4.rb → get_payouts_response.rb} +24 -12
- data/lib/velopayments/models/get_payouts_response_v3.rb +20 -8
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +20 -8
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +20 -8
- data/lib/velopayments/models/individual.rb +21 -9
- data/lib/velopayments/models/individual2.rb +21 -9
- data/lib/velopayments/models/{individual_v1_name.rb → individual_name.rb} +23 -11
- data/lib/velopayments/models/inline_response400.rb +51 -14
- data/lib/velopayments/models/inline_response401.rb +51 -14
- data/lib/velopayments/models/inline_response403.rb +51 -14
- data/lib/velopayments/models/inline_response404.rb +258 -0
- data/lib/velopayments/models/inline_response409.rb +258 -0
- data/lib/velopayments/models/inline_response412.rb +258 -0
- data/lib/velopayments/models/invitation_status.rb +3 -2
- data/lib/velopayments/models/invitation_status2.rb +38 -0
- data/lib/velopayments/models/invite_payee_request.rb +20 -8
- data/lib/velopayments/models/invite_payee_request2.rb +20 -8
- data/lib/velopayments/models/invite_user_request.rb +29 -17
- data/lib/velopayments/models/kyc_state.rb +3 -2
- data/lib/velopayments/models/link_for_response.rb +20 -8
- data/lib/velopayments/models/list_funding_accounts_response.rb +20 -8
- data/lib/velopayments/models/list_funding_accounts_response2.rb +241 -0
- data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +24 -12
- data/lib/velopayments/models/{list_payments_response_page.rb → list_payments_response_v3_page.rb} +23 -11
- data/lib/velopayments/models/list_payments_response_v4.rb +21 -9
- data/lib/velopayments/models/list_source_account_response.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_links.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_page.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_v2.rb +21 -9
- data/lib/velopayments/models/{invitation_status_response.rb → list_source_account_response_v2_links.rb} +39 -25
- data/lib/velopayments/models/list_source_account_response_v3.rb +241 -0
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +227 -0
- data/lib/velopayments/models/localisation_details.rb +231 -0
- data/lib/velopayments/models/mfa_details.rb +20 -8
- data/lib/velopayments/models/mfa_type.rb +3 -2
- data/lib/velopayments/models/name.rb +341 -0
- data/lib/velopayments/models/name2.rb +341 -0
- data/lib/velopayments/models/{individual_v1.rb → notification.rb} +77 -58
- data/lib/velopayments/models/notifications.rb +20 -8
- data/lib/velopayments/models/{marketing_opt_in.rb → notifications2.rb} +30 -27
- data/lib/velopayments/models/ofac_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status2.rb +3 -2
- data/lib/velopayments/models/{inline_response400_errors.rb → onboarding_status_changed.rb} +92 -39
- data/lib/velopayments/models/page_for_response.rb +20 -8
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +20 -8
- data/lib/velopayments/models/paged_payee_response.rb +21 -9
- data/lib/velopayments/models/paged_payee_response2.rb +22 -10
- data/lib/velopayments/models/paged_payee_response_links.rb +20 -8
- data/lib/velopayments/models/paged_payee_response_page.rb +20 -8
- data/lib/velopayments/models/paged_payee_response_summary.rb +27 -15
- data/lib/velopayments/models/paged_payments_response_v3.rb +241 -0
- data/lib/velopayments/models/paged_user_response.rb +20 -8
- data/lib/velopayments/models/paged_user_response_links.rb +20 -8
- data/lib/velopayments/models/paged_user_response_page.rb +20 -8
- data/lib/velopayments/models/password_request.rb +20 -8
- data/lib/velopayments/models/payable_issue.rb +238 -0
- data/lib/velopayments/models/payable_issue2.rb +238 -0
- data/lib/velopayments/models/payable_status_changed.rb +289 -0
- data/lib/velopayments/models/payee_address.rb +20 -8
- data/lib/velopayments/models/payee_address2.rb +20 -8
- data/lib/velopayments/models/payee_delta.rb +21 -9
- data/lib/velopayments/models/payee_delta2.rb +20 -8
- data/lib/velopayments/models/payee_delta_response.rb +20 -8
- data/lib/velopayments/models/payee_delta_response2.rb +20 -8
- data/lib/velopayments/models/payee_delta_response2_links.rb +20 -8
- data/lib/velopayments/models/payee_delta_response_links.rb +20 -8
- data/lib/velopayments/models/payee_delta_response_page.rb +20 -8
- data/lib/velopayments/models/{payee_response_v3.rb → payee_detail_response.rb} +45 -23
- data/lib/velopayments/models/{payee_response_v2.rb → payee_detail_response2.rb} +77 -64
- data/lib/velopayments/models/payee_details_changed.rb +289 -0
- data/lib/velopayments/models/{payee_invitation_status.rb → payee_event.rb} +86 -64
- data/lib/velopayments/models/payee_event_all_of.rb +236 -0
- data/lib/velopayments/models/payee_event_all_of_reasons.rb +237 -0
- data/lib/velopayments/models/payee_invitation_status_response.rb +20 -8
- data/lib/velopayments/models/payee_invitation_status_response2.rb +20 -8
- data/lib/velopayments/models/payee_payor_ref.rb +66 -12
- data/lib/velopayments/models/payee_payor_ref_v3.rb +46 -46
- data/lib/velopayments/models/payee_type.rb +3 -2
- data/lib/velopayments/models/{user_response2.rb → payee_user_self_update_request.rb} +64 -196
- data/lib/velopayments/models/{payment_audit_currency_v4.rb → payment_audit_currency.rb} +6 -5
- data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
- data/lib/velopayments/models/payment_channel_country.rb +20 -8
- data/lib/velopayments/models/payment_channel_rule.rb +20 -8
- data/lib/velopayments/models/payment_channel_rules_response.rb +20 -8
- data/lib/velopayments/models/payment_delta.rb +20 -8
- data/lib/velopayments/models/payment_delta_response.rb +20 -8
- data/lib/velopayments/models/payment_delta_response_v1.rb +241 -0
- data/lib/velopayments/models/payment_delta_v1.rb +297 -0
- data/lib/velopayments/models/payment_event.rb +297 -0
- data/lib/velopayments/models/{paged_response_page.rb → payment_event_all_of.rb} +49 -48
- data/lib/velopayments/models/{payment_event_response_v4.rb → payment_event_response.rb} +28 -16
- data/lib/velopayments/models/payment_event_response_v3.rb +21 -9
- data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +148 -16
- data/lib/velopayments/models/payment_rails.rb +3 -2
- data/lib/velopayments/models/payment_rejected_or_returned.rb +342 -0
- data/lib/velopayments/models/{inline_response403_errors.rb → payment_rejected_or_returned_all_of.rb} +48 -45
- data/lib/velopayments/models/payment_response_v3.rb +21 -9
- data/lib/velopayments/models/payment_response_v4.rb +101 -13
- data/lib/velopayments/models/payment_response_v4_payout.rb +22 -10
- data/lib/velopayments/models/payment_status_changed.rb +312 -0
- data/lib/velopayments/models/payment_status_changed_all_of.rb +224 -0
- data/lib/velopayments/models/payment_v3.rb +389 -0
- data/lib/velopayments/models/payor_address.rb +20 -8
- data/lib/velopayments/models/payor_address_v2.rb +20 -8
- data/lib/velopayments/models/{payor_aml_transaction_v4.rb → payor_aml_transaction.rb} +24 -21
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +21 -36
- data/lib/velopayments/models/payor_branding_response.rb +20 -8
- data/lib/velopayments/models/payor_create_api_key_request.rb +30 -8
- data/lib/velopayments/models/payor_create_api_key_response.rb +20 -8
- data/lib/velopayments/models/payor_create_application_request.rb +20 -8
- data/lib/velopayments/models/payor_email_opt_out_request.rb +20 -8
- data/lib/velopayments/models/payor_links_response.rb +20 -8
- data/lib/velopayments/models/payor_links_response_links.rb +20 -8
- data/lib/velopayments/models/payor_links_response_payors.rb +20 -8
- data/lib/velopayments/models/payor_v1.rb +33 -12
- data/lib/velopayments/models/payor_v2.rb +55 -12
- data/lib/velopayments/models/payout_company_v3.rb +223 -0
- data/lib/velopayments/models/{individual_response.rb → payout_individual_v3.rb} +24 -12
- data/lib/velopayments/models/payout_name_v3.rb +237 -0
- data/lib/velopayments/models/payout_payee_v3.rb +242 -0
- data/lib/velopayments/models/{payout_payor_v4.rb → payout_payor.rb} +23 -11
- data/lib/velopayments/models/payout_payor_ids.rb +255 -0
- data/lib/velopayments/models/{payout_principal_v4.rb → payout_principal.rb} +23 -11
- data/lib/velopayments/models/{payout_status_v4.rb → payout_status.rb} +6 -5
- data/lib/velopayments/models/payout_status_v3.rb +3 -2
- data/lib/velopayments/models/{payout_summary_audit_v4.rb → payout_summary_audit.rb} +39 -18
- data/lib/velopayments/models/payout_summary_audit_v3.rb +20 -8
- data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +42 -16
- data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +6 -5
- data/lib/velopayments/models/ping.rb +262 -0
- data/lib/velopayments/models/query_batch_response.rb +20 -8
- data/lib/velopayments/models/query_batch_response2.rb +20 -8
- data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +49 -13
- data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +24 -12
- data/lib/velopayments/models/{region.rb → region_v2.rb} +23 -11
- data/lib/velopayments/models/register_sms_request.rb +23 -11
- data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +54 -12
- data/lib/velopayments/models/resend_token_request.rb +20 -8
- data/lib/velopayments/models/reset_password_request.rb +20 -8
- data/lib/velopayments/models/role.rb +20 -8
- data/lib/velopayments/models/role_update_request.rb +20 -8
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +20 -8
- data/lib/velopayments/models/self_update_password_request.rb +20 -8
- data/lib/velopayments/models/set_notifications_request.rb +20 -8
- data/lib/velopayments/models/source_account_response.rb +34 -13
- data/lib/velopayments/models/source_account_response_v2.rb +36 -15
- data/lib/velopayments/models/{payee_payment_channel2.rb → source_account_response_v3.rb} +196 -182
- data/lib/velopayments/models/{source_account_summary_v4.rb → source_account_summary.rb} +24 -12
- data/lib/velopayments/models/source_account_summary_v3.rb +20 -8
- data/lib/velopayments/models/source_account_type.rb +37 -0
- data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +63 -11
- data/lib/velopayments/models/source_event.rb +255 -0
- data/lib/velopayments/models/supported_countries_response.rb +20 -8
- data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +24 -12
- data/lib/velopayments/models/supported_country.rb +51 -37
- data/lib/velopayments/models/{supported_country2.rb → supported_country_v2.rb} +55 -41
- data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +24 -12
- data/lib/velopayments/models/supported_currency_v2.rb +264 -0
- data/lib/velopayments/models/transfer_request.rb +20 -8
- data/lib/velopayments/models/transfer_request2.rb +309 -0
- data/lib/velopayments/models/transmission_type.rb +38 -0
- data/lib/velopayments/models/{supported_currency.rb → transmission_types.rb} +63 -26
- data/lib/velopayments/models/{currency_type.rb → transmission_types2.rb} +60 -45
- data/lib/velopayments/models/unregister_mfa_request.rb +20 -8
- data/lib/velopayments/models/update_payee_details_request.rb +275 -0
- data/lib/velopayments/models/{paged_payee_response2_summary.rb → update_payee_details_request2.rb} +75 -42
- data/lib/velopayments/models/update_remote_id_request.rb +20 -8
- data/lib/velopayments/models/update_remote_id_request2.rb +265 -0
- data/lib/velopayments/models/update_webhook_request.rb +312 -0
- data/lib/velopayments/models/user_details_update_request.rb +29 -17
- data/lib/velopayments/models/user_info.rb +20 -8
- data/lib/velopayments/models/user_response.rb +45 -18
- data/lib/velopayments/models/user_status.rb +3 -2
- data/lib/velopayments/models/user_type.rb +3 -2
- data/lib/velopayments/models/user_type2.rb +3 -2
- data/lib/velopayments/models/validate_password_response.rb +20 -8
- data/lib/velopayments/models/watchlist_status.rb +3 -2
- data/lib/velopayments/models/{ofac_status2.rb → watchlist_status2.rb} +8 -5
- data/lib/velopayments/models/webhook_response.rb +265 -0
- data/lib/velopayments/models/webhooks_response.rb +241 -0
- data/lib/velopayments/models/withdraw_payment_request.rb +252 -0
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +12 -12
- data/spec/api/currencies_api_spec.rb +5 -5
- data/spec/api/funding_manager_api_spec.rb +94 -18
- data/spec/api/funding_manager_private_api_spec.rb +17 -5
- data/spec/api/login_api_spec.rb +3 -2
- data/spec/api/payee_invitation_api_spec.rb +23 -35
- data/spec/api/payees_api_spec.rb +63 -47
- data/spec/api/payment_audit_service_api_spec.rb +28 -112
- data/spec/api/{payout_history_api_spec.rb → payment_audit_service_deprecated_api_spec.rb} +115 -33
- data/spec/api/payors_api_spec.rb +9 -9
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/{models/payee2_spec.rb → api/payout_service_api_spec.rb} +66 -103
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +17 -4
- data/spec/api/webhooks_api_spec.rb +86 -0
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/accepted_payment_v3_spec.rb +76 -0
- data/spec/models/access_token_response_spec.rb +5 -12
- data/spec/models/access_token_validation_request_spec.rb +5 -12
- data/spec/models/auth_response_spec.rb +5 -12
- data/spec/models/{inline_response401_errors_spec.rb → auto_top_up_config2_spec.rb} +12 -19
- data/spec/models/auto_top_up_config_spec.rb +5 -12
- data/spec/models/{language_spec.rb → category_spec.rb} +8 -15
- data/spec/models/{paged_response_spec.rb → challenge2_spec.rb} +10 -17
- data/spec/models/challenge_spec.rb +5 -12
- data/spec/models/company2_spec.rb +5 -12
- data/spec/models/company_spec.rb +5 -12
- data/spec/models/{payee_payment_channel_spec.rb → create_funding_account_request_v2_spec.rb} +19 -26
- data/spec/models/create_individual2_spec.rb +5 -12
- data/spec/models/{individual_v1_name_spec.rb → create_individual_name_spec.rb} +8 -15
- data/spec/models/create_individual_spec.rb +5 -12
- data/spec/models/create_payee2_spec.rb +5 -12
- data/spec/models/create_payee_address2_spec.rb +6 -13
- data/spec/models/create_payee_address_spec.rb +9 -12
- data/spec/models/create_payee_spec.rb +5 -12
- data/spec/models/create_payees_csv_response2_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_spec.rb +5 -12
- data/spec/models/create_payees_request2_spec.rb +5 -12
- data/spec/models/create_payees_request_spec.rb +5 -12
- data/spec/models/create_payment_channel2_spec.rb +7 -14
- data/spec/models/create_payment_channel_spec.rb +7 -14
- data/spec/models/create_payor_link_request_spec.rb +6 -13
- data/spec/models/{create_payout_request_spec.rb → create_payout_request_v3_spec.rb} +8 -21
- data/spec/models/create_webhook_request_spec.rb +58 -0
- data/spec/models/debit_event_all_of_spec.rb +34 -0
- data/spec/models/debit_event_spec.rb +52 -0
- data/spec/models/{currency_type_spec.rb → debit_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/debit_status_changed_spec.rb +58 -0
- data/spec/models/{marketing_opt_in_spec.rb → error_data_spec.rb} +10 -17
- data/spec/models/error_response_spec.rb +11 -12
- data/spec/models/error_spec.rb +24 -13
- data/spec/models/failed_payee2_spec.rb +94 -0
- data/spec/models/failed_payee_spec.rb +94 -0
- data/spec/models/failed_submission2_spec.rb +5 -12
- data/spec/models/failed_submission_spec.rb +5 -12
- data/spec/models/funding_account_response2_spec.rb +88 -0
- data/spec/models/funding_account_response_spec.rb +29 -12
- data/spec/models/{language2_spec.rb → funding_account_type_spec.rb} +8 -15
- data/spec/models/funding_audit_spec.rb +14 -21
- data/spec/models/funding_event_spec.rb +5 -12
- data/spec/models/funding_event_type_spec.rb +5 -12
- data/spec/models/funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/funding_request_v1_spec.rb +5 -12
- data/spec/models/funding_request_v2_spec.rb +5 -12
- data/spec/models/funding_request_v3_spec.rb +40 -0
- data/spec/models/{fx_summary_v4_spec.rb → fx_summary_spec.rb} +10 -17
- data/spec/models/fx_summary_v3_spec.rb +7 -14
- data/spec/models/get_fundings_response_links_spec.rb +40 -0
- data/spec/models/get_fundings_response_spec.rb +5 -12
- data/spec/models/{payee_response2_spec.rb → get_payee_list_response2_spec.rb} +21 -46
- data/spec/models/get_payee_list_response_company2_spec.rb +40 -0
- data/spec/models/{company_response_spec.rb → get_payee_list_response_company_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_individual2_spec.rb +34 -0
- data/spec/models/{user_response2_roles_spec.rb → get_payee_list_response_individual_spec.rb} +8 -15
- data/spec/models/{payee_spec.rb → get_payee_list_response_spec.rb} +21 -46
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +6 -13
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +11 -16
- data/spec/models/get_payout_statistics_spec.rb +5 -12
- data/spec/models/{company_v1_spec.rb → get_payouts_response_spec.rb} +11 -18
- data/spec/models/get_payouts_response_v3_links_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_spec.rb +5 -12
- data/spec/models/individual2_spec.rb +5 -12
- data/spec/models/{create_individual2_name_spec.rb → individual_name_spec.rb} +8 -15
- data/spec/models/individual_spec.rb +5 -12
- data/spec/models/inline_response400_spec.rb +11 -12
- data/spec/models/inline_response401_spec.rb +11 -12
- data/spec/models/inline_response403_spec.rb +11 -12
- data/spec/models/{individual_v1_spec.rb → inline_response404_spec.rb} +11 -18
- data/spec/models/inline_response409_spec.rb +46 -0
- data/spec/models/inline_response412_spec.rb +46 -0
- data/spec/models/{ofac_status2_spec.rb → invitation_status2_spec.rb} +8 -15
- data/spec/models/invitation_status_spec.rb +5 -12
- data/spec/models/invite_payee_request2_spec.rb +5 -12
- data/spec/models/invite_payee_request_spec.rb +5 -12
- data/spec/models/invite_user_request_spec.rb +6 -13
- data/spec/models/kyc_state_spec.rb +5 -12
- data/spec/models/link_for_response_spec.rb +5 -12
- data/spec/models/{list_payments_response_spec.rb → list_funding_accounts_response2_spec.rb} +8 -15
- data/spec/models/list_funding_accounts_response_spec.rb +5 -12
- data/spec/models/{paged_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -15
- data/spec/models/list_payments_response_v3_spec.rb +46 -0
- data/spec/models/list_payments_response_v4_spec.rb +5 -12
- data/spec/models/list_source_account_response_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_page_spec.rb +5 -12
- data/spec/models/list_source_account_response_spec.rb +5 -12
- data/spec/models/list_source_account_response_v2_links_spec.rb +40 -0
- data/spec/models/list_source_account_response_v2_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_links_spec.rb +40 -0
- data/spec/models/list_source_account_response_v3_spec.rb +46 -0
- data/spec/models/localisation_details_spec.rb +40 -0
- data/spec/models/mfa_details_spec.rb +5 -12
- data/spec/models/mfa_type_spec.rb +5 -12
- data/spec/models/name2_spec.rb +52 -0
- data/spec/models/name_spec.rb +52 -0
- data/spec/models/notification_spec.rb +58 -0
- data/spec/models/notifications2_spec.rb +34 -0
- data/spec/models/notifications_spec.rb +5 -12
- data/spec/models/ofac_status_spec.rb +5 -12
- data/spec/models/onboarded_status2_spec.rb +5 -12
- data/spec/models/onboarded_status_spec.rb +5 -12
- data/spec/models/{list_payments_response_page_spec.rb → onboarding_status_changed_spec.rb} +13 -20
- data/spec/models/page_for_response_spec.rb +5 -12
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_spec.rb +5 -12
- data/spec/models/paged_payee_response2_spec.rb +5 -12
- data/spec/models/paged_payee_response_links_spec.rb +5 -12
- data/spec/models/paged_payee_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_response_spec.rb +5 -12
- data/spec/models/paged_payee_response_summary_spec.rb +6 -13
- data/spec/models/{get_payouts_response_v4_spec.rb → paged_payments_response_v3_spec.rb} +8 -15
- data/spec/models/paged_user_response_links_spec.rb +5 -12
- data/spec/models/paged_user_response_page_spec.rb +5 -12
- data/spec/models/paged_user_response_spec.rb +5 -12
- data/spec/models/password_request_spec.rb +5 -12
- data/spec/models/payable_issue2_spec.rb +40 -0
- data/spec/models/payable_issue_spec.rb +40 -0
- data/spec/models/payable_status_changed_spec.rb +58 -0
- data/spec/models/payee_address2_spec.rb +5 -12
- data/spec/models/payee_address_spec.rb +5 -12
- data/spec/models/payee_delta2_spec.rb +5 -12
- data/spec/models/payee_delta_response2_links_spec.rb +5 -12
- data/spec/models/payee_delta_response2_spec.rb +5 -12
- data/spec/models/payee_delta_response_links_spec.rb +5 -12
- data/spec/models/payee_delta_response_page_spec.rb +5 -12
- data/spec/models/payee_delta_response_spec.rb +5 -12
- data/spec/models/payee_delta_spec.rb +5 -12
- data/spec/models/{payee_response_v2_spec.rb → payee_detail_response2_spec.rb} +28 -35
- data/spec/models/{payee_response_v3_spec.rb → payee_detail_response_spec.rb} +14 -15
- data/spec/models/payee_details_changed_spec.rb +58 -0
- data/spec/models/payee_event_all_of_reasons_spec.rb +40 -0
- data/spec/models/payee_event_all_of_spec.rb +40 -0
- data/spec/models/{inline_response400_errors_spec.rb → payee_event_spec.rb} +17 -18
- data/spec/models/payee_invitation_status_response2_spec.rb +6 -13
- data/spec/models/payee_invitation_status_response_spec.rb +6 -13
- data/spec/models/payee_payor_ref_spec.rb +29 -12
- data/spec/models/payee_payor_ref_v3_spec.rb +17 -16
- data/spec/models/payee_type_spec.rb +5 -12
- data/spec/models/{payment_instruction_spec.rb → payee_user_self_update_request_spec.rb} +14 -21
- data/spec/models/{location_type_spec.rb → payment_audit_currency_spec.rb} +8 -15
- data/spec/models/payment_audit_currency_v3_spec.rb +5 -12
- data/spec/models/payment_channel_country_spec.rb +5 -12
- data/spec/models/payment_channel_rule_spec.rb +5 -12
- data/spec/models/payment_channel_rules_response_spec.rb +5 -12
- data/spec/models/payment_delta_response_spec.rb +5 -12
- data/spec/models/payment_delta_response_v1_spec.rb +46 -0
- data/spec/models/payment_delta_spec.rb +5 -12
- data/spec/models/payment_delta_v1_spec.rb +76 -0
- data/spec/models/payment_event_all_of_spec.rb +46 -0
- data/spec/models/{payment_event_response_v4_spec.rb → payment_event_response_spec.rb} +10 -17
- data/spec/models/payment_event_response_v3_spec.rb +6 -13
- data/spec/models/{accepted_payment_spec.rb → payment_event_spec.rb} +14 -21
- data/spec/models/{rejected_payment_spec.rb → payment_instruction_v3_spec.rb} +15 -22
- data/spec/models/payment_rails_spec.rb +5 -12
- data/spec/models/payment_rejected_or_returned_all_of_spec.rb +40 -0
- data/spec/models/payment_rejected_or_returned_spec.rb +82 -0
- data/spec/models/payment_response_v3_spec.rb +7 -14
- data/spec/models/payment_response_v4_payout_spec.rb +5 -12
- data/spec/models/payment_response_v4_spec.rb +55 -14
- data/spec/models/{payor_logo_request_spec.rb → payment_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/payment_status_changed_spec.rb +70 -0
- data/spec/models/payment_v3_spec.rb +110 -0
- data/spec/models/payor_address_spec.rb +5 -12
- data/spec/models/payor_address_v2_spec.rb +5 -12
- data/spec/models/{payor_aml_transaction_v4_spec.rb → payor_aml_transaction_spec.rb} +8 -21
- data/spec/models/payor_aml_transaction_v3_spec.rb +5 -30
- data/spec/models/payor_branding_response_spec.rb +5 -12
- data/spec/models/payor_create_api_key_request_spec.rb +6 -13
- data/spec/models/payor_create_api_key_response_spec.rb +5 -12
- data/spec/models/payor_create_application_request_spec.rb +5 -12
- data/spec/models/payor_email_opt_out_request_spec.rb +5 -12
- data/spec/models/payor_links_response_links_spec.rb +6 -13
- data/spec/models/payor_links_response_payors_spec.rb +6 -13
- data/spec/models/payor_links_response_spec.rb +5 -12
- data/spec/models/payor_v1_spec.rb +12 -13
- data/spec/models/payor_v2_spec.rb +24 -13
- data/spec/models/payout_company_v3_spec.rb +34 -0
- data/spec/models/{individual_response_spec.rb → payout_individual_v3_spec.rb} +8 -15
- data/spec/models/payout_name_v3_spec.rb +40 -0
- data/spec/models/payout_payee_v3_spec.rb +46 -0
- data/spec/models/payout_payor_ids_spec.rb +46 -0
- data/spec/models/{payout_payor_v4_spec.rb → payout_payor_spec.rb} +8 -15
- data/spec/models/{payout_principal_v4_spec.rb → payout_principal_spec.rb} +8 -15
- data/spec/models/payout_status_spec.rb +28 -0
- data/spec/models/payout_status_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_audit_v4_spec.rb → payout_summary_audit_spec.rb} +14 -15
- data/spec/models/payout_summary_audit_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +14 -15
- data/spec/models/payout_type_spec.rb +28 -0
- data/spec/models/ping_spec.rb +46 -0
- data/spec/models/query_batch_response2_spec.rb +6 -13
- data/spec/models/query_batch_response_spec.rb +6 -13
- data/spec/models/{quote_fx_summary_spec.rb → quote_fx_summary_v3_spec.rb} +10 -17
- data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -15
- data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -15
- data/spec/models/register_sms_request_spec.rb +5 -12
- data/spec/models/rejected_payment_v3_spec.rb +94 -0
- data/spec/models/resend_token_request_spec.rb +6 -13
- data/spec/models/reset_password_request_spec.rb +5 -12
- data/spec/models/role_spec.rb +5 -12
- data/spec/models/role_update_request_spec.rb +5 -12
- data/spec/models/self_mfa_type_unregister_request_spec.rb +6 -13
- data/spec/models/self_update_password_request_spec.rb +5 -12
- data/spec/models/set_notifications_request_spec.rb +5 -12
- data/spec/models/source_account_response_spec.rb +12 -13
- data/spec/models/source_account_response_v2_spec.rb +12 -13
- data/spec/models/{payee_response_spec.rb → source_account_response_v3_spec.rb} +30 -45
- data/spec/models/{source_account_summary_v4_spec.rb → source_account_summary_spec.rb} +8 -15
- data/spec/models/source_account_summary_v3_spec.rb +5 -12
- data/spec/models/source_account_type_spec.rb +28 -0
- data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -15
- data/spec/models/source_event_spec.rb +46 -0
- data/spec/models/supported_countries_response_spec.rb +5 -12
- data/spec/models/supported_countries_response_v2_spec.rb +34 -0
- data/spec/models/supported_country_spec.rb +5 -20
- data/spec/models/supported_country_v2_spec.rb +46 -0
- data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -15
- data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -15
- data/spec/models/transfer_request2_spec.rb +46 -0
- data/spec/models/transfer_request_spec.rb +5 -12
- data/spec/models/transmission_type_spec.rb +28 -0
- data/spec/models/transmission_types2_spec.rb +46 -0
- data/spec/models/transmission_types_spec.rb +46 -0
- data/spec/models/unregister_mfa_request_spec.rb +6 -13
- data/spec/models/update_payee_details_request2_spec.rb +70 -0
- data/spec/models/{payee_payment_channel2_spec.rb → update_payee_details_request_spec.rb} +15 -26
- data/spec/models/update_remote_id_request2_spec.rb +40 -0
- data/spec/models/update_remote_id_request_spec.rb +5 -12
- data/spec/models/update_webhook_request_spec.rb +52 -0
- data/spec/models/user_details_update_request_spec.rb +5 -12
- data/spec/models/user_info_spec.rb +5 -12
- data/spec/models/user_response_spec.rb +8 -15
- data/spec/models/user_status_spec.rb +5 -12
- data/spec/models/user_type2_spec.rb +5 -12
- data/spec/models/user_type_spec.rb +5 -12
- data/spec/models/validate_password_response_spec.rb +5 -12
- data/spec/models/watchlist_status2_spec.rb +28 -0
- data/spec/models/watchlist_status_spec.rb +5 -12
- data/spec/models/webhook_response_spec.rb +64 -0
- data/spec/models/webhooks_response_spec.rb +46 -0
- data/spec/models/withdraw_payment_request_spec.rb +34 -0
- data/spec/spec_helper.rb +2 -2
- data/specs/api/countries_api_spec.rb +103 -0
- data/{spec/api/quote_payout_api_spec.rb → specs/api/currencies_api_spec.rb} +16 -15
- data/specs/api/funding_manager_api_spec.rb +372 -0
- data/{spec/api/get_payout_api_spec.rb → specs/api/funding_manager_private_api_spec.rb} +15 -15
- data/specs/api/login_api_spec.rb +82 -0
- data/specs/api/payee_invitation_api_spec.rb +161 -0
- data/specs/api/payees_api_spec.rb +186 -0
- data/specs/api/payment_audit_service_api_spec.rb +318 -0
- data/specs/api/payors_api_spec.rb +171 -0
- data/{spec/api/instruct_payout_api_spec.rb → specs/api/payors_private_api_spec.rb} +14 -14
- data/specs/api/payout_service_api_spec.rb +127 -0
- data/{spec/api/withdraw_payout_api_spec.rb → specs/api/tokens_api_spec.rb} +15 -14
- data/specs/api/users_api_spec.rb +284 -0
- data/velopayments.gemspec +3 -4
- metadata +449 -295
- data/docs/AcceptedPayment.md +0 -27
- data/docs/CompanyResponse.md +0 -19
- data/docs/CompanyV1.md +0 -21
- data/docs/CreateFundingAccountRequest.md +0 -23
- data/docs/CreateIndividual2Name.md +0 -23
- data/docs/CreatePayeesCSVRequest.md +0 -73
- data/docs/CreatePayeesCSVRequest2.md +0 -73
- data/docs/CreatePayoutRequest.md +0 -25
- data/docs/CurrencyType.md +0 -17
- data/docs/FxSummaryV4.md +0 -35
- data/docs/GetFundingsResponseAllOf.md +0 -17
- data/docs/GetPayoutApi.md +0 -61
- data/docs/GetPayoutsResponseV4.md +0 -21
- data/docs/IndividualResponse.md +0 -17
- data/docs/IndividualV1.md +0 -21
- data/docs/IndividualV1Name.md +0 -23
- data/docs/InlineResponse400Errors.md +0 -23
- data/docs/InlineResponse401Errors.md +0 -23
- data/docs/InlineResponse403Errors.md +0 -23
- data/docs/InstructPayoutApi.md +0 -60
- data/docs/InvitationStatusResponse.md +0 -17
- data/docs/Language.md +0 -16
- data/docs/Language2.md +0 -16
- data/docs/ListPaymentsResponse.md +0 -21
- data/docs/ListPaymentsResponsePage.md +0 -25
- data/docs/LocationType.md +0 -16
- data/docs/MarketingOptIn.md +0 -19
- data/docs/OfacStatus2.md +0 -16
- data/docs/PagedPayeeResponse2Summary.md +0 -25
- data/docs/PagedResponse.md +0 -19
- data/docs/PagedResponsePage.md +0 -25
- data/docs/Payee.md +0 -55
- data/docs/Payee2.md +0 -57
- data/docs/PayeeInvitationStatus.md +0 -21
- data/docs/PayeePaymentChannel.md +0 -29
- data/docs/PayeePaymentChannel2.md +0 -29
- data/docs/PayeePayorRefV2.md +0 -25
- data/docs/PayeeResponse.md +0 -55
- data/docs/PayeeResponse2.md +0 -55
- data/docs/PayeeResponseV2.md +0 -73
- data/docs/PayeeResponseV3.md +0 -71
- data/docs/PaymentAuditCurrencyV4.md +0 -16
- data/docs/PaymentEventResponseV4.md +0 -39
- data/docs/PaymentInstruction.md +0 -27
- data/docs/PayorAmlTransactionV4.md +0 -71
- data/docs/PayorLogoRequest.md +0 -17
- data/docs/PayoutHistoryApi.md +0 -221
- data/docs/PayoutPayorV4.md +0 -25
- data/docs/PayoutPrincipalV4.md +0 -19
- data/docs/PayoutStatusV4.md +0 -16
- data/docs/PayoutSummaryAuditV4.md +0 -45
- data/docs/PayoutSummaryResponse.md +0 -33
- data/docs/PayoutTypeV4.md +0 -16
- data/docs/QuoteFxSummary.md +0 -37
- data/docs/QuotePayoutApi.md +0 -61
- data/docs/QuoteResponse.md +0 -17
- data/docs/Region.md +0 -19
- data/docs/RejectedPayment.md +0 -33
- data/docs/SourceAccount.md +0 -23
- data/docs/SourceAccountSummaryV4.md +0 -21
- data/docs/SubmitPayoutApi.md +0 -60
- data/docs/SupportedCountriesResponse2.md +0 -17
- data/docs/SupportedCountry2.md +0 -21
- data/docs/SupportedCurrency.md +0 -19
- data/docs/SupportedCurrencyResponse.md +0 -17
- data/docs/UserResponse2.md +0 -45
- data/docs/UserResponse2Roles.md +0 -17
- data/docs/WithdrawPayoutApi.md +0 -60
- data/lib/velopayments/api/get_payout_api.rb +0 -84
- data/lib/velopayments/api/instruct_payout_api.rb +0 -84
- data/lib/velopayments/api/payout_history_api.rb +0 -285
- data/lib/velopayments/api/quote_payout_api.rb +0 -84
- data/lib/velopayments/api/submit_payout_api.rb +0 -86
- data/lib/velopayments/api/withdraw_payout_api.rb +0 -84
- data/lib/velopayments/models/create_payees_csv_request.rb +0 -1148
- data/lib/velopayments/models/create_payees_csv_request2.rb +0 -1148
- data/lib/velopayments/models/inline_response401_errors.rb +0 -236
- data/lib/velopayments/models/language2.rb +0 -45
- data/lib/velopayments/models/payee2.rb +0 -456
- data/lib/velopayments/models/payee_response.rb +0 -388
- data/spec/api/submit_payout_api_spec.rb +0 -47
- data/spec/models/create_funding_account_request_spec.rb +0 -59
- data/spec/models/create_payees_csv_request2_spec.rb +0 -225
- data/spec/models/create_payees_csv_request_spec.rb +0 -221
- data/spec/models/get_fundings_response_all_of_spec.rb +0 -41
- data/spec/models/inline_response403_errors_spec.rb +0 -59
- data/spec/models/invitation_status_response_spec.rb +0 -41
- data/spec/models/paged_payee_response2_summary_spec.rb +0 -65
- data/spec/models/payee_invitation_status_spec.rb +0 -57
- data/spec/models/payee_payor_ref_v2_spec.rb +0 -69
- data/spec/models/payment_audit_currency_v4_spec.rb +0 -35
- data/spec/models/payout_status_v4_spec.rb +0 -35
- data/spec/models/payout_type_v4_spec.rb +0 -35
- data/spec/models/supported_countries_response2_spec.rb +0 -41
- data/spec/models/supported_country2_spec.rb +0 -61
- data/spec/models/user_response2_spec.rb +0 -137
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# VeloPayments::UpdatePayeeDetailsRequest2
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **address** | [**PayeeAddress2**](PayeeAddress2.md) | | [optional] |
|
|
8
|
+
| **individual** | [**Individual2**](Individual2.md) | | [optional] |
|
|
9
|
+
| **company** | [**Company2**](Company2.md) | | [optional] |
|
|
10
|
+
| **language** | **String** | An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR> See the /v1/supportedLanguages endpoint to list the available codes for an environment. | [optional] |
|
|
11
|
+
| **payee_type** | [**PayeeType**](PayeeType.md) | | [optional] |
|
|
12
|
+
| **challenge** | [**Challenge2**](Challenge2.md) | | [optional] |
|
|
13
|
+
| **email** | **String** | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'velopayments'
|
|
19
|
+
|
|
20
|
+
instance = VeloPayments::UpdatePayeeDetailsRequest2.new(
|
|
21
|
+
address: null,
|
|
22
|
+
individual: null,
|
|
23
|
+
company: null,
|
|
24
|
+
language: en-US,
|
|
25
|
+
payee_type: null,
|
|
26
|
+
challenge: null,
|
|
27
|
+
email: bob@example.com
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**payor_id** | **String** | |
|
|
8
|
-
**remote_id** | **String** | |
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **payor_id** | **String** | | |
|
|
8
|
+
| **remote_id** | **String** | | |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Example
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'velopayments'
|
|
14
14
|
|
|
15
|
-
instance = VeloPayments::UpdateRemoteIdRequest.new(
|
|
16
|
-
|
|
15
|
+
instance = VeloPayments::UpdateRemoteIdRequest.new(
|
|
16
|
+
payor_id: 9ac75325-5dcd-42d5-b992-175d7e0a035e,
|
|
17
|
+
remote_id: remoteId123
|
|
18
|
+
)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# VeloPayments::UpdateRemoteIdRequest2
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **payor_id** | **String** | | |
|
|
8
|
+
| **remote_id** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'velopayments'
|
|
14
|
+
|
|
15
|
+
instance = VeloPayments::UpdateRemoteIdRequest2.new(
|
|
16
|
+
payor_id: 9ac75325-5dcd-42d5-b992-175d7e0a035e,
|
|
17
|
+
remote_id: remoteId123
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# VeloPayments::UpdateWebhookRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **webhook_url** | **String** | the webhook URL to use. | [optional] |
|
|
8
|
+
| **authorization_header** | **String** | the authorization header to include with the notification. | [optional] |
|
|
9
|
+
| **enabled** | **Boolean** | whether the webhook is enabled. | [optional] |
|
|
10
|
+
| **categories** | [**Array<Category>**](Category.md) | The notification categories to enable. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'velopayments'
|
|
16
|
+
|
|
17
|
+
instance = VeloPayments::UpdateWebhookRequest.new(
|
|
18
|
+
webhook_url: null,
|
|
19
|
+
authorization_header: null,
|
|
20
|
+
enabled: null,
|
|
21
|
+
categories: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -2,30 +2,31 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**primary_contact_number** | **String** | The main contact number for the user | [optional]
|
|
8
|
-
**secondary_contact_number** | **String** | The secondary contact number for the user | [optional]
|
|
9
|
-
**first_name** | **String** | | [optional]
|
|
10
|
-
**last_name** | **String** | | [optional]
|
|
11
|
-
**email** | **String** | the email address of the user | [optional]
|
|
12
|
-
**sms_number** | **String** | The phone number of a device that the user can receive sms messages on | [optional]
|
|
13
|
-
**mfa_type** | [**MFAType**](MFAType.md) | | [optional]
|
|
14
|
-
**verification_code** | **String** | <p>Optional property that MUST be suppied when manually verifying a user</p> <p>The user's smsNumber is registered via a separate endpoint and an OTP sent to them</p> | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **primary_contact_number** | **String** | The main contact number for the user | [optional] |
|
|
8
|
+
| **secondary_contact_number** | **String** | The secondary contact number for the user | [optional] |
|
|
9
|
+
| **first_name** | **String** | | [optional] |
|
|
10
|
+
| **last_name** | **String** | | [optional] |
|
|
11
|
+
| **email** | **String** | the email address of the user | [optional] |
|
|
12
|
+
| **sms_number** | **String** | The phone number of a device that the user can receive sms messages on | [optional] |
|
|
13
|
+
| **mfa_type** | [**MFAType**](MFAType.md) | | [optional] |
|
|
14
|
+
| **verification_code** | **String** | <p>Optional property that MUST be suppied when manually verifying a user</p> <p>The user's smsNumber is registered via a separate endpoint and an OTP sent to them</p> | [optional] |
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Example
|
|
17
17
|
|
|
18
18
|
```ruby
|
|
19
|
-
require '
|
|
19
|
+
require 'velopayments'
|
|
20
20
|
|
|
21
|
-
instance = VeloPayments::UserDetailsUpdateRequest.new(
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
21
|
+
instance = VeloPayments::UserDetailsUpdateRequest.new(
|
|
22
|
+
primary_contact_number: 11235555555,
|
|
23
|
+
secondary_contact_number: 11235555550,
|
|
24
|
+
first_name: John,
|
|
25
|
+
last_name: Doe,
|
|
26
|
+
email: foo@example.com,
|
|
27
|
+
sms_number: 11235555555,
|
|
28
|
+
mfa_type: null,
|
|
29
|
+
verification_code: 123456
|
|
30
|
+
)
|
|
29
31
|
```
|
|
30
32
|
|
|
31
|
-
|
data/docs/UserInfo.md
CHANGED
|
@@ -2,20 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**user_id** | **String** | the id of the user | [optional]
|
|
8
|
-
**user_type** | [**UserType2**](UserType2.md) | | [optional]
|
|
9
|
-
**mfa_details** | [**MFADetails**](MFADetails.md) | | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **user_id** | **String** | the id of the user | [optional] |
|
|
8
|
+
| **user_type** | [**UserType2**](UserType2.md) | | [optional] |
|
|
9
|
+
| **mfa_details** | [**MFADetails**](MFADetails.md) | | [optional] |
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Example
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
|
-
require '
|
|
14
|
+
require 'velopayments'
|
|
15
15
|
|
|
16
|
-
instance = VeloPayments::UserInfo.new(
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
instance = VeloPayments::UserInfo.new(
|
|
17
|
+
user_id: 39976ee5-dc4c-4b21-a966-a04fa71ef9e1,
|
|
18
|
+
user_type: null,
|
|
19
|
+
mfa_details: null
|
|
20
|
+
)
|
|
19
21
|
```
|
|
20
22
|
|
|
21
|
-
|
data/docs/UserResponse.md
CHANGED
|
@@ -2,42 +2,43 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**id** | **String** | The id of the user | [optional]
|
|
8
|
-
**status** | **String** | The status of the user when the user has been invited but not yet enrolled they will have a PENDING status | [optional]
|
|
9
|
-
**email** | **String** | the email address of the user | [optional]
|
|
10
|
-
**sms_number** | **String** | The phone number of a device that the user can receive sms messages on | [optional]
|
|
11
|
-
**primary_contact_number** | **String** | The main contact number for the user | [optional]
|
|
12
|
-
**secondary_contact_number** | **String** | The secondary contact number for the user | [optional]
|
|
13
|
-
**first_name** | **String** | | [optional]
|
|
14
|
-
**last_name** | **String** | | [optional]
|
|
15
|
-
**entity_id** | **String** | The payorId or payeeId or null if the user is not a payor or payee user | [optional]
|
|
16
|
-
**roles** | [**Array<Role>**](Role.md) | The role(s) for the user | [optional]
|
|
17
|
-
**mfa_type** | **String** | The type of the MFA device | [optional]
|
|
18
|
-
**mfa_status** | **String** | The status of the MFA device | [optional]
|
|
19
|
-
**locked_out** | **Boolean** | If true the user is currently locked out and unable to log in | [optional]
|
|
20
|
-
**locked_out_timestamp** | **
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The id of the user | [optional] |
|
|
8
|
+
| **status** | **String** | The status of the user when the user has been invited but not yet enrolled they will have a PENDING status | [optional] |
|
|
9
|
+
| **email** | **String** | the email address of the user | [optional] |
|
|
10
|
+
| **sms_number** | **String** | The phone number of a device that the user can receive sms messages on | [optional] |
|
|
11
|
+
| **primary_contact_number** | **String** | The main contact number for the user | [optional] |
|
|
12
|
+
| **secondary_contact_number** | **String** | The secondary contact number for the user | [optional] |
|
|
13
|
+
| **first_name** | **String** | | [optional] |
|
|
14
|
+
| **last_name** | **String** | | [optional] |
|
|
15
|
+
| **entity_id** | **String** | The payorId or payeeId or null if the user is not a payor or payee user | [optional] |
|
|
16
|
+
| **roles** | [**Array<Role>**](Role.md) | The role(s) for the user | [optional] |
|
|
17
|
+
| **mfa_type** | **String** | The type of the MFA device | [optional] |
|
|
18
|
+
| **mfa_status** | **String** | The status of the MFA device | [optional] |
|
|
19
|
+
| **locked_out** | **Boolean** | If true the user is currently locked out and unable to log in | [optional] |
|
|
20
|
+
| **locked_out_timestamp** | **Time** | A timestamp showing when the user was locked out If null then the user is not currently locked out | [optional] |
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## Example
|
|
23
23
|
|
|
24
24
|
```ruby
|
|
25
|
-
require '
|
|
25
|
+
require 'velopayments'
|
|
26
26
|
|
|
27
|
-
instance = VeloPayments::UserResponse.new(
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
27
|
+
instance = VeloPayments::UserResponse.new(
|
|
28
|
+
id: 8bbf301c-948f-4445-b411-357eec53e441,
|
|
29
|
+
status: ENABLED,
|
|
30
|
+
email: foo@example.com,
|
|
31
|
+
sms_number: 11235555555,
|
|
32
|
+
primary_contact_number: 11235555555,
|
|
33
|
+
secondary_contact_number: 11235555550,
|
|
34
|
+
first_name: John,
|
|
35
|
+
last_name: Doe,
|
|
36
|
+
entity_id: 7fffa261-ac68-49e6-b605-d24a444d9206,
|
|
37
|
+
roles: ["payor.admin"],
|
|
38
|
+
mfa_type: TOTP,
|
|
39
|
+
mfa_status: REGISTERED,
|
|
40
|
+
locked_out: true,
|
|
41
|
+
locked_out_timestamp: null
|
|
42
|
+
)
|
|
41
43
|
```
|
|
42
44
|
|
|
43
|
-
|
data/docs/UserStatus.md
CHANGED
|
@@ -2,15 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## Example
|
|
9
9
|
|
|
10
10
|
```ruby
|
|
11
|
-
require '
|
|
11
|
+
require 'velopayments'
|
|
12
12
|
|
|
13
13
|
instance = VeloPayments::UserStatus.new()
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
data/docs/UserType.md
CHANGED
|
@@ -2,15 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## Example
|
|
9
9
|
|
|
10
10
|
```ruby
|
|
11
|
-
require '
|
|
11
|
+
require 'velopayments'
|
|
12
12
|
|
|
13
13
|
instance = VeloPayments::UserType.new()
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
data/docs/UserType2.md
CHANGED
|
@@ -2,15 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## Example
|
|
9
9
|
|
|
10
10
|
```ruby
|
|
11
|
-
require '
|
|
11
|
+
require 'velopayments'
|
|
12
12
|
|
|
13
13
|
instance = VeloPayments::UserType2.new()
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
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 = TODO # 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**](.md) | 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 = TODO # 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**](.md) | 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 = TODO # 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** | [**String**](.md)| The UUID of the User. |
|
|
212
|
+
| Name | Type | Description | Notes |
|
|
213
|
+
| ---- | ---- | ----------- | ----- |
|
|
214
|
+
| **user_id** | [**String**](.md) | 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 = TODO # 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**](.md) | 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: ['roles_example']}) # 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,51 @@ 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
|
-
page:
|
|
355
|
-
page_size:
|
|
356
|
-
sort: '
|
|
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: TODO, # String | The entityId of the User.
|
|
457
|
+
page: 56, # Integer | Page number. Default is 1.
|
|
458
|
+
page_size: 56, # Integer | The number of results to return in a page
|
|
459
|
+
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
460
|
}
|
|
358
461
|
|
|
359
462
|
begin
|
|
360
|
-
#List Users
|
|
463
|
+
# List Users
|
|
361
464
|
result = api_instance.list_users(opts)
|
|
362
465
|
p result
|
|
363
466
|
rescue VeloPayments::ApiError => e
|
|
364
|
-
puts "
|
|
467
|
+
puts "Error when calling UsersApi->list_users: #{e}"
|
|
365
468
|
end
|
|
366
469
|
```
|
|
367
470
|
|
|
368
|
-
|
|
471
|
+
#### Using the list_users_with_http_info variant
|
|
472
|
+
|
|
473
|
+
This returns an Array which contains the response data, status code and headers.
|
|
474
|
+
|
|
475
|
+
> <Array(<PagedUserResponse>, Integer, Hash)> list_users_with_http_info(opts)
|
|
476
|
+
|
|
477
|
+
```ruby
|
|
478
|
+
begin
|
|
479
|
+
# List Users
|
|
480
|
+
data, status_code, headers = api_instance.list_users_with_http_info(opts)
|
|
481
|
+
p status_code # => 2xx
|
|
482
|
+
p headers # => { ... }
|
|
483
|
+
p data # => <PagedUserResponse>
|
|
484
|
+
rescue VeloPayments::ApiError => e
|
|
485
|
+
puts "Error when calling UsersApi->list_users_with_http_info: #{e}"
|
|
486
|
+
end
|
|
487
|
+
```
|
|
369
488
|
|
|
489
|
+
### Parameters
|
|
370
490
|
|
|
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** | [**String**](.md)| The entityId of the User. | [optional]
|
|
376
|
-
**page** | **Integer
|
|
377
|
-
**page_size** | **Integer
|
|
378
|
-
**sort** | **String
|
|
491
|
+
| Name | Type | Description | Notes |
|
|
492
|
+
| ---- | ---- | ----------- | ----- |
|
|
493
|
+
| **type** | [**UserType**](.md) | The Type of the User. | [optional] |
|
|
494
|
+
| **status** | [**UserStatus**](.md) | The status of the User. | [optional] |
|
|
495
|
+
| **entity_id** | [**String**](.md) | The entityId of the User. | [optional] |
|
|
496
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
|
497
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
|
|
498
|
+
| **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
499
|
|
|
380
500
|
### Return type
|
|
381
501
|
|
|
@@ -399,10 +519,10 @@ Register SMS Number
|
|
|
399
519
|
|
|
400
520
|
<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
521
|
|
|
402
|
-
###
|
|
522
|
+
### Examples
|
|
403
523
|
|
|
404
524
|
```ruby
|
|
405
|
-
|
|
525
|
+
require 'time'
|
|
406
526
|
require 'velopayments'
|
|
407
527
|
# setup authorization
|
|
408
528
|
VeloPayments.configure do |config|
|
|
@@ -411,22 +531,39 @@ VeloPayments.configure do |config|
|
|
|
411
531
|
end
|
|
412
532
|
|
|
413
533
|
api_instance = VeloPayments::UsersApi.new
|
|
414
|
-
register_sms_request = VeloPayments::RegisterSmsRequest.new # RegisterSmsRequest | a SMS Number to send an OTP to
|
|
534
|
+
register_sms_request = VeloPayments::RegisterSmsRequest.new({sms_number: '11235555555'}) # RegisterSmsRequest | a SMS Number to send an OTP to
|
|
415
535
|
|
|
416
536
|
begin
|
|
417
|
-
#Register SMS Number
|
|
537
|
+
# Register SMS Number
|
|
418
538
|
api_instance.register_sms(register_sms_request)
|
|
419
539
|
rescue VeloPayments::ApiError => e
|
|
420
|
-
puts "
|
|
540
|
+
puts "Error when calling UsersApi->register_sms: #{e}"
|
|
421
541
|
end
|
|
422
542
|
```
|
|
423
543
|
|
|
424
|
-
|
|
544
|
+
#### Using the register_sms_with_http_info variant
|
|
545
|
+
|
|
546
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
547
|
+
|
|
548
|
+
> <Array(nil, Integer, Hash)> register_sms_with_http_info(register_sms_request)
|
|
549
|
+
|
|
550
|
+
```ruby
|
|
551
|
+
begin
|
|
552
|
+
# Register SMS Number
|
|
553
|
+
data, status_code, headers = api_instance.register_sms_with_http_info(register_sms_request)
|
|
554
|
+
p status_code # => 2xx
|
|
555
|
+
p headers # => { ... }
|
|
556
|
+
p data # => nil
|
|
557
|
+
rescue VeloPayments::ApiError => e
|
|
558
|
+
puts "Error when calling UsersApi->register_sms_with_http_info: #{e}"
|
|
559
|
+
end
|
|
560
|
+
```
|
|
425
561
|
|
|
562
|
+
### Parameters
|
|
426
563
|
|
|
427
|
-
Name | Type | Description
|
|
428
|
-
|
|
429
|
-
**register_sms_request** | [**RegisterSmsRequest**](RegisterSmsRequest.md)| a SMS Number to send an OTP to |
|
|
564
|
+
| Name | Type | Description | Notes |
|
|
565
|
+
| ---- | ---- | ----------- | ----- |
|
|
566
|
+
| **register_sms_request** | [**RegisterSmsRequest**](RegisterSmsRequest.md) | a SMS Number to send an OTP to | |
|
|
430
567
|
|
|
431
568
|
### Return type
|
|
432
569
|
|
|
@@ -450,10 +587,10 @@ Resend a token
|
|
|
450
587
|
|
|
451
588
|
<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
589
|
|
|
453
|
-
###
|
|
590
|
+
### Examples
|
|
454
591
|
|
|
455
592
|
```ruby
|
|
456
|
-
|
|
593
|
+
require 'time'
|
|
457
594
|
require 'velopayments'
|
|
458
595
|
# setup authorization
|
|
459
596
|
VeloPayments.configure do |config|
|
|
@@ -462,24 +599,41 @@ VeloPayments.configure do |config|
|
|
|
462
599
|
end
|
|
463
600
|
|
|
464
601
|
api_instance = VeloPayments::UsersApi.new
|
|
465
|
-
user_id =
|
|
466
|
-
resend_token_request = VeloPayments::ResendTokenRequest.new # ResendTokenRequest | The type of token to resend
|
|
602
|
+
user_id = TODO # String | The UUID of the User.
|
|
603
|
+
resend_token_request = VeloPayments::ResendTokenRequest.new({token_type: 'INVITE_MFA_USER'}) # ResendTokenRequest | The type of token to resend
|
|
467
604
|
|
|
468
605
|
begin
|
|
469
|
-
#Resend a token
|
|
606
|
+
# Resend a token
|
|
470
607
|
api_instance.resend_token(user_id, resend_token_request)
|
|
471
608
|
rescue VeloPayments::ApiError => e
|
|
472
|
-
puts "
|
|
609
|
+
puts "Error when calling UsersApi->resend_token: #{e}"
|
|
473
610
|
end
|
|
474
611
|
```
|
|
475
612
|
|
|
476
|
-
|
|
613
|
+
#### Using the resend_token_with_http_info variant
|
|
477
614
|
|
|
615
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
616
|
+
|
|
617
|
+
> <Array(nil, Integer, Hash)> resend_token_with_http_info(user_id, resend_token_request)
|
|
618
|
+
|
|
619
|
+
```ruby
|
|
620
|
+
begin
|
|
621
|
+
# Resend a token
|
|
622
|
+
data, status_code, headers = api_instance.resend_token_with_http_info(user_id, resend_token_request)
|
|
623
|
+
p status_code # => 2xx
|
|
624
|
+
p headers # => { ... }
|
|
625
|
+
p data # => nil
|
|
626
|
+
rescue VeloPayments::ApiError => e
|
|
627
|
+
puts "Error when calling UsersApi->resend_token_with_http_info: #{e}"
|
|
628
|
+
end
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
### Parameters
|
|
478
632
|
|
|
479
|
-
Name | Type | Description
|
|
480
|
-
|
|
481
|
-
**user_id** | [**String**](.md)| The UUID of the User. |
|
|
482
|
-
**resend_token_request** | [**ResendTokenRequest**](ResendTokenRequest.md)| The type of token to resend |
|
|
633
|
+
| Name | Type | Description | Notes |
|
|
634
|
+
| ---- | ---- | ----------- | ----- |
|
|
635
|
+
| **user_id** | [**String**](.md) | The UUID of the User. | |
|
|
636
|
+
| **resend_token_request** | [**ResendTokenRequest**](ResendTokenRequest.md) | The type of token to resend | |
|
|
483
637
|
|
|
484
638
|
### Return type
|
|
485
639
|
|
|
@@ -503,10 +657,10 @@ Update User Role
|
|
|
503
657
|
|
|
504
658
|
<p>Update the user's Role</p>
|
|
505
659
|
|
|
506
|
-
###
|
|
660
|
+
### Examples
|
|
507
661
|
|
|
508
662
|
```ruby
|
|
509
|
-
|
|
663
|
+
require 'time'
|
|
510
664
|
require 'velopayments'
|
|
511
665
|
# setup authorization
|
|
512
666
|
VeloPayments.configure do |config|
|
|
@@ -515,24 +669,41 @@ VeloPayments.configure do |config|
|
|
|
515
669
|
end
|
|
516
670
|
|
|
517
671
|
api_instance = VeloPayments::UsersApi.new
|
|
518
|
-
user_id =
|
|
519
|
-
role_update_request = VeloPayments::RoleUpdateRequest.new # RoleUpdateRequest | The Role to change to
|
|
672
|
+
user_id = TODO # String | The UUID of the User.
|
|
673
|
+
role_update_request = VeloPayments::RoleUpdateRequest.new({roles: ['roles_example']}) # RoleUpdateRequest | The Role to change to
|
|
520
674
|
|
|
521
675
|
begin
|
|
522
|
-
#Update User Role
|
|
676
|
+
# Update User Role
|
|
523
677
|
api_instance.role_update(user_id, role_update_request)
|
|
524
678
|
rescue VeloPayments::ApiError => e
|
|
525
|
-
puts "
|
|
679
|
+
puts "Error when calling UsersApi->role_update: #{e}"
|
|
526
680
|
end
|
|
527
681
|
```
|
|
528
682
|
|
|
529
|
-
|
|
683
|
+
#### Using the role_update_with_http_info variant
|
|
684
|
+
|
|
685
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
530
686
|
|
|
687
|
+
> <Array(nil, Integer, Hash)> role_update_with_http_info(user_id, role_update_request)
|
|
531
688
|
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
689
|
+
```ruby
|
|
690
|
+
begin
|
|
691
|
+
# Update User Role
|
|
692
|
+
data, status_code, headers = api_instance.role_update_with_http_info(user_id, role_update_request)
|
|
693
|
+
p status_code # => 2xx
|
|
694
|
+
p headers # => { ... }
|
|
695
|
+
p data # => nil
|
|
696
|
+
rescue VeloPayments::ApiError => e
|
|
697
|
+
puts "Error when calling UsersApi->role_update_with_http_info: #{e}"
|
|
698
|
+
end
|
|
699
|
+
```
|
|
700
|
+
|
|
701
|
+
### Parameters
|
|
702
|
+
|
|
703
|
+
| Name | Type | Description | Notes |
|
|
704
|
+
| ---- | ---- | ----------- | ----- |
|
|
705
|
+
| **user_id** | [**String**](.md) | The UUID of the User. | |
|
|
706
|
+
| **role_update_request** | [**RoleUpdateRequest**](RoleUpdateRequest.md) | The Role to change to | |
|
|
536
707
|
|
|
537
708
|
### Return type
|
|
538
709
|
|
|
@@ -556,10 +727,10 @@ Unlock a User
|
|
|
556
727
|
|
|
557
728
|
If a user is locked this endpoint will unlock them
|
|
558
729
|
|
|
559
|
-
###
|
|
730
|
+
### Examples
|
|
560
731
|
|
|
561
732
|
```ruby
|
|
562
|
-
|
|
733
|
+
require 'time'
|
|
563
734
|
require 'velopayments'
|
|
564
735
|
# setup authorization
|
|
565
736
|
VeloPayments.configure do |config|
|
|
@@ -568,22 +739,39 @@ VeloPayments.configure do |config|
|
|
|
568
739
|
end
|
|
569
740
|
|
|
570
741
|
api_instance = VeloPayments::UsersApi.new
|
|
571
|
-
user_id =
|
|
742
|
+
user_id = TODO # String | The UUID of the User.
|
|
572
743
|
|
|
573
744
|
begin
|
|
574
|
-
#Unlock a User
|
|
745
|
+
# Unlock a User
|
|
575
746
|
api_instance.unlock_user_v2(user_id)
|
|
576
747
|
rescue VeloPayments::ApiError => e
|
|
577
|
-
puts "
|
|
748
|
+
puts "Error when calling UsersApi->unlock_user_v2: #{e}"
|
|
578
749
|
end
|
|
579
750
|
```
|
|
580
751
|
|
|
581
|
-
|
|
752
|
+
#### Using the unlock_user_v2_with_http_info variant
|
|
582
753
|
|
|
754
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
583
755
|
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
756
|
+
> <Array(nil, Integer, Hash)> unlock_user_v2_with_http_info(user_id)
|
|
757
|
+
|
|
758
|
+
```ruby
|
|
759
|
+
begin
|
|
760
|
+
# Unlock a User
|
|
761
|
+
data, status_code, headers = api_instance.unlock_user_v2_with_http_info(user_id)
|
|
762
|
+
p status_code # => 2xx
|
|
763
|
+
p headers # => { ... }
|
|
764
|
+
p data # => nil
|
|
765
|
+
rescue VeloPayments::ApiError => e
|
|
766
|
+
puts "Error when calling UsersApi->unlock_user_v2_with_http_info: #{e}"
|
|
767
|
+
end
|
|
768
|
+
```
|
|
769
|
+
|
|
770
|
+
### Parameters
|
|
771
|
+
|
|
772
|
+
| Name | Type | Description | Notes |
|
|
773
|
+
| ---- | ---- | ----------- | ----- |
|
|
774
|
+
| **user_id** | [**String**](.md) | The UUID of the User. | |
|
|
587
775
|
|
|
588
776
|
### Return type
|
|
589
777
|
|
|
@@ -607,10 +795,10 @@ Unregister MFA for the user
|
|
|
607
795
|
|
|
608
796
|
<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
797
|
|
|
610
|
-
###
|
|
798
|
+
### Examples
|
|
611
799
|
|
|
612
800
|
```ruby
|
|
613
|
-
|
|
801
|
+
require 'time'
|
|
614
802
|
require 'velopayments'
|
|
615
803
|
# setup authorization
|
|
616
804
|
VeloPayments.configure do |config|
|
|
@@ -619,24 +807,41 @@ VeloPayments.configure do |config|
|
|
|
619
807
|
end
|
|
620
808
|
|
|
621
809
|
api_instance = VeloPayments::UsersApi.new
|
|
622
|
-
user_id =
|
|
623
|
-
unregister_mfa_request = VeloPayments::UnregisterMFARequest.new # UnregisterMFARequest | The MFA Type to unregister
|
|
810
|
+
user_id = TODO # String | The UUID of the User.
|
|
811
|
+
unregister_mfa_request = VeloPayments::UnregisterMFARequest.new({mfa_type: 'YUBIKEY'}) # UnregisterMFARequest | The MFA Type to unregister
|
|
624
812
|
|
|
625
813
|
begin
|
|
626
|
-
#Unregister MFA for the user
|
|
814
|
+
# Unregister MFA for the user
|
|
627
815
|
api_instance.unregister_mfa(user_id, unregister_mfa_request)
|
|
628
816
|
rescue VeloPayments::ApiError => e
|
|
629
|
-
puts "
|
|
817
|
+
puts "Error when calling UsersApi->unregister_mfa: #{e}"
|
|
630
818
|
end
|
|
631
819
|
```
|
|
632
820
|
|
|
633
|
-
|
|
821
|
+
#### Using the unregister_mfa_with_http_info variant
|
|
822
|
+
|
|
823
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
824
|
+
|
|
825
|
+
> <Array(nil, Integer, Hash)> unregister_mfa_with_http_info(user_id, unregister_mfa_request)
|
|
826
|
+
|
|
827
|
+
```ruby
|
|
828
|
+
begin
|
|
829
|
+
# Unregister MFA for the user
|
|
830
|
+
data, status_code, headers = api_instance.unregister_mfa_with_http_info(user_id, unregister_mfa_request)
|
|
831
|
+
p status_code # => 2xx
|
|
832
|
+
p headers # => { ... }
|
|
833
|
+
p data # => nil
|
|
834
|
+
rescue VeloPayments::ApiError => e
|
|
835
|
+
puts "Error when calling UsersApi->unregister_mfa_with_http_info: #{e}"
|
|
836
|
+
end
|
|
837
|
+
```
|
|
634
838
|
|
|
839
|
+
### Parameters
|
|
635
840
|
|
|
636
|
-
Name | Type | Description
|
|
637
|
-
|
|
638
|
-
**user_id** | [**String**](.md)| The UUID of the User. |
|
|
639
|
-
**unregister_mfa_request** | [**UnregisterMFARequest**](UnregisterMFARequest.md)| The MFA Type to unregister |
|
|
841
|
+
| Name | Type | Description | Notes |
|
|
842
|
+
| ---- | ---- | ----------- | ----- |
|
|
843
|
+
| **user_id** | [**String**](.md) | The UUID of the User. | |
|
|
844
|
+
| **unregister_mfa_request** | [**UnregisterMFARequest**](UnregisterMFARequest.md) | The MFA Type to unregister | |
|
|
640
845
|
|
|
641
846
|
### Return type
|
|
642
847
|
|
|
@@ -654,16 +859,16 @@ nil (empty response body)
|
|
|
654
859
|
|
|
655
860
|
## unregister_mfa_for_self
|
|
656
861
|
|
|
657
|
-
> unregister_mfa_for_self(self_mfa_type_unregister_request)
|
|
862
|
+
> unregister_mfa_for_self(self_mfa_type_unregister_request, opts)
|
|
658
863
|
|
|
659
864
|
Unregister MFA for Self
|
|
660
865
|
|
|
661
866
|
<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
867
|
|
|
663
|
-
###
|
|
868
|
+
### Examples
|
|
664
869
|
|
|
665
870
|
```ruby
|
|
666
|
-
|
|
871
|
+
require 'time'
|
|
667
872
|
require 'velopayments'
|
|
668
873
|
# setup authorization
|
|
669
874
|
VeloPayments.configure do |config|
|
|
@@ -672,22 +877,43 @@ VeloPayments.configure do |config|
|
|
|
672
877
|
end
|
|
673
878
|
|
|
674
879
|
api_instance = VeloPayments::UsersApi.new
|
|
675
|
-
self_mfa_type_unregister_request = VeloPayments::SelfMFATypeUnregisterRequest.new # SelfMFATypeUnregisterRequest | The MFA Type to unregister
|
|
880
|
+
self_mfa_type_unregister_request = VeloPayments::SelfMFATypeUnregisterRequest.new({mfa_type: 'SMS'}) # SelfMFATypeUnregisterRequest | The MFA Type to unregister
|
|
881
|
+
opts = {
|
|
882
|
+
authorization: 'authorization_example' # String | Bearer token authorization leg of validate
|
|
883
|
+
}
|
|
676
884
|
|
|
677
885
|
begin
|
|
678
|
-
#Unregister MFA for Self
|
|
679
|
-
api_instance.unregister_mfa_for_self(self_mfa_type_unregister_request)
|
|
886
|
+
# Unregister MFA for Self
|
|
887
|
+
api_instance.unregister_mfa_for_self(self_mfa_type_unregister_request, opts)
|
|
680
888
|
rescue VeloPayments::ApiError => e
|
|
681
|
-
puts "
|
|
889
|
+
puts "Error when calling UsersApi->unregister_mfa_for_self: #{e}"
|
|
682
890
|
end
|
|
683
891
|
```
|
|
684
892
|
|
|
685
|
-
|
|
893
|
+
#### Using the unregister_mfa_for_self_with_http_info variant
|
|
894
|
+
|
|
895
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
896
|
+
|
|
897
|
+
> <Array(nil, Integer, Hash)> unregister_mfa_for_self_with_http_info(self_mfa_type_unregister_request, opts)
|
|
898
|
+
|
|
899
|
+
```ruby
|
|
900
|
+
begin
|
|
901
|
+
# Unregister MFA for Self
|
|
902
|
+
data, status_code, headers = api_instance.unregister_mfa_for_self_with_http_info(self_mfa_type_unregister_request, opts)
|
|
903
|
+
p status_code # => 2xx
|
|
904
|
+
p headers # => { ... }
|
|
905
|
+
p data # => nil
|
|
906
|
+
rescue VeloPayments::ApiError => e
|
|
907
|
+
puts "Error when calling UsersApi->unregister_mfa_for_self_with_http_info: #{e}"
|
|
908
|
+
end
|
|
909
|
+
```
|
|
686
910
|
|
|
911
|
+
### Parameters
|
|
687
912
|
|
|
688
|
-
Name | Type | Description
|
|
689
|
-
|
|
690
|
-
**self_mfa_type_unregister_request** | [**SelfMFATypeUnregisterRequest**](SelfMFATypeUnregisterRequest.md)| The MFA Type to unregister |
|
|
913
|
+
| Name | Type | Description | Notes |
|
|
914
|
+
| ---- | ---- | ----------- | ----- |
|
|
915
|
+
| **self_mfa_type_unregister_request** | [**SelfMFATypeUnregisterRequest**](SelfMFATypeUnregisterRequest.md) | The MFA Type to unregister | |
|
|
916
|
+
| **authorization** | **String** | Bearer token authorization leg of validate | [optional] |
|
|
691
917
|
|
|
692
918
|
### Return type
|
|
693
919
|
|
|
@@ -711,10 +937,10 @@ Update Password for self
|
|
|
711
937
|
|
|
712
938
|
Update password for self
|
|
713
939
|
|
|
714
|
-
###
|
|
940
|
+
### Examples
|
|
715
941
|
|
|
716
942
|
```ruby
|
|
717
|
-
|
|
943
|
+
require 'time'
|
|
718
944
|
require 'velopayments'
|
|
719
945
|
# setup authorization
|
|
720
946
|
VeloPayments.configure do |config|
|
|
@@ -723,22 +949,39 @@ VeloPayments.configure do |config|
|
|
|
723
949
|
end
|
|
724
950
|
|
|
725
951
|
api_instance = VeloPayments::UsersApi.new
|
|
726
|
-
self_update_password_request = VeloPayments::SelfUpdatePasswordRequest.new # SelfUpdatePasswordRequest | The password
|
|
952
|
+
self_update_password_request = VeloPayments::SelfUpdatePasswordRequest.new({old_password: 'My_current_password', new_password: 'My_new_password'}) # SelfUpdatePasswordRequest | The password
|
|
727
953
|
|
|
728
954
|
begin
|
|
729
|
-
#Update Password for self
|
|
955
|
+
# Update Password for self
|
|
730
956
|
api_instance.update_password_self(self_update_password_request)
|
|
731
957
|
rescue VeloPayments::ApiError => e
|
|
732
|
-
puts "
|
|
958
|
+
puts "Error when calling UsersApi->update_password_self: #{e}"
|
|
733
959
|
end
|
|
734
960
|
```
|
|
735
961
|
|
|
736
|
-
|
|
962
|
+
#### Using the update_password_self_with_http_info variant
|
|
737
963
|
|
|
964
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
965
|
+
|
|
966
|
+
> <Array(nil, Integer, Hash)> update_password_self_with_http_info(self_update_password_request)
|
|
967
|
+
|
|
968
|
+
```ruby
|
|
969
|
+
begin
|
|
970
|
+
# Update Password for self
|
|
971
|
+
data, status_code, headers = api_instance.update_password_self_with_http_info(self_update_password_request)
|
|
972
|
+
p status_code # => 2xx
|
|
973
|
+
p headers # => { ... }
|
|
974
|
+
p data # => nil
|
|
975
|
+
rescue VeloPayments::ApiError => e
|
|
976
|
+
puts "Error when calling UsersApi->update_password_self_with_http_info: #{e}"
|
|
977
|
+
end
|
|
978
|
+
```
|
|
979
|
+
|
|
980
|
+
### Parameters
|
|
738
981
|
|
|
739
|
-
Name | Type | Description
|
|
740
|
-
|
|
741
|
-
**self_update_password_request** | [**SelfUpdatePasswordRequest**](SelfUpdatePasswordRequest.md)| The password |
|
|
982
|
+
| Name | Type | Description | Notes |
|
|
983
|
+
| ---- | ---- | ----------- | ----- |
|
|
984
|
+
| **self_update_password_request** | [**SelfUpdatePasswordRequest**](SelfUpdatePasswordRequest.md) | The password | |
|
|
742
985
|
|
|
743
986
|
### Return type
|
|
744
987
|
|
|
@@ -762,10 +1005,10 @@ Update User Details
|
|
|
762
1005
|
|
|
763
1006
|
<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
1007
|
|
|
765
|
-
###
|
|
1008
|
+
### Examples
|
|
766
1009
|
|
|
767
1010
|
```ruby
|
|
768
|
-
|
|
1011
|
+
require 'time'
|
|
769
1012
|
require 'velopayments'
|
|
770
1013
|
# setup authorization
|
|
771
1014
|
VeloPayments.configure do |config|
|
|
@@ -774,24 +1017,109 @@ VeloPayments.configure do |config|
|
|
|
774
1017
|
end
|
|
775
1018
|
|
|
776
1019
|
api_instance = VeloPayments::UsersApi.new
|
|
777
|
-
user_id =
|
|
1020
|
+
user_id = TODO # String | The UUID of the User.
|
|
778
1021
|
user_details_update_request = VeloPayments::UserDetailsUpdateRequest.new # UserDetailsUpdateRequest | The details of the user to update
|
|
779
1022
|
|
|
780
1023
|
begin
|
|
781
|
-
#Update User Details
|
|
1024
|
+
# Update User Details
|
|
782
1025
|
api_instance.user_details_update(user_id, user_details_update_request)
|
|
783
1026
|
rescue VeloPayments::ApiError => e
|
|
784
|
-
puts "
|
|
1027
|
+
puts "Error when calling UsersApi->user_details_update: #{e}"
|
|
1028
|
+
end
|
|
1029
|
+
```
|
|
1030
|
+
|
|
1031
|
+
#### Using the user_details_update_with_http_info variant
|
|
1032
|
+
|
|
1033
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1034
|
+
|
|
1035
|
+
> <Array(nil, Integer, Hash)> user_details_update_with_http_info(user_id, user_details_update_request)
|
|
1036
|
+
|
|
1037
|
+
```ruby
|
|
1038
|
+
begin
|
|
1039
|
+
# Update User Details
|
|
1040
|
+
data, status_code, headers = api_instance.user_details_update_with_http_info(user_id, user_details_update_request)
|
|
1041
|
+
p status_code # => 2xx
|
|
1042
|
+
p headers # => { ... }
|
|
1043
|
+
p data # => nil
|
|
1044
|
+
rescue VeloPayments::ApiError => e
|
|
1045
|
+
puts "Error when calling UsersApi->user_details_update_with_http_info: #{e}"
|
|
785
1046
|
end
|
|
786
1047
|
```
|
|
787
1048
|
|
|
788
1049
|
### Parameters
|
|
789
1050
|
|
|
1051
|
+
| Name | Type | Description | Notes |
|
|
1052
|
+
| ---- | ---- | ----------- | ----- |
|
|
1053
|
+
| **user_id** | [**String**](.md) | The UUID of the User. | |
|
|
1054
|
+
| **user_details_update_request** | [**UserDetailsUpdateRequest**](UserDetailsUpdateRequest.md) | The details of the user to update | |
|
|
1055
|
+
|
|
1056
|
+
### Return type
|
|
790
1057
|
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
1058
|
+
nil (empty response body)
|
|
1059
|
+
|
|
1060
|
+
### Authorization
|
|
1061
|
+
|
|
1062
|
+
[OAuth2](../README.md#OAuth2)
|
|
1063
|
+
|
|
1064
|
+
### HTTP request headers
|
|
1065
|
+
|
|
1066
|
+
- **Content-Type**: application/json
|
|
1067
|
+
- **Accept**: application/json
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
## user_details_update_for_self
|
|
1071
|
+
|
|
1072
|
+
> user_details_update_for_self(payee_user_self_update_request)
|
|
1073
|
+
|
|
1074
|
+
Update User Details for self
|
|
1075
|
+
|
|
1076
|
+
<p>Update the profile details for the given user</p> <p>Only Payee user types are supported</p>
|
|
1077
|
+
|
|
1078
|
+
### Examples
|
|
1079
|
+
|
|
1080
|
+
```ruby
|
|
1081
|
+
require 'time'
|
|
1082
|
+
require 'velopayments'
|
|
1083
|
+
# setup authorization
|
|
1084
|
+
VeloPayments.configure do |config|
|
|
1085
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
1086
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1087
|
+
end
|
|
1088
|
+
|
|
1089
|
+
api_instance = VeloPayments::UsersApi.new
|
|
1090
|
+
payee_user_self_update_request = VeloPayments::PayeeUserSelfUpdateRequest.new # PayeeUserSelfUpdateRequest | The details of the user to update
|
|
1091
|
+
|
|
1092
|
+
begin
|
|
1093
|
+
# Update User Details for self
|
|
1094
|
+
api_instance.user_details_update_for_self(payee_user_self_update_request)
|
|
1095
|
+
rescue VeloPayments::ApiError => e
|
|
1096
|
+
puts "Error when calling UsersApi->user_details_update_for_self: #{e}"
|
|
1097
|
+
end
|
|
1098
|
+
```
|
|
1099
|
+
|
|
1100
|
+
#### Using the user_details_update_for_self_with_http_info variant
|
|
1101
|
+
|
|
1102
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1103
|
+
|
|
1104
|
+
> <Array(nil, Integer, Hash)> user_details_update_for_self_with_http_info(payee_user_self_update_request)
|
|
1105
|
+
|
|
1106
|
+
```ruby
|
|
1107
|
+
begin
|
|
1108
|
+
# Update User Details for self
|
|
1109
|
+
data, status_code, headers = api_instance.user_details_update_for_self_with_http_info(payee_user_self_update_request)
|
|
1110
|
+
p status_code # => 2xx
|
|
1111
|
+
p headers # => { ... }
|
|
1112
|
+
p data # => nil
|
|
1113
|
+
rescue VeloPayments::ApiError => e
|
|
1114
|
+
puts "Error when calling UsersApi->user_details_update_for_self_with_http_info: #{e}"
|
|
1115
|
+
end
|
|
1116
|
+
```
|
|
1117
|
+
|
|
1118
|
+
### Parameters
|
|
1119
|
+
|
|
1120
|
+
| Name | Type | Description | Notes |
|
|
1121
|
+
| ---- | ---- | ----------- | ----- |
|
|
1122
|
+
| **payee_user_self_update_request** | [**PayeeUserSelfUpdateRequest**](PayeeUserSelfUpdateRequest.md) | The details of the user to update | |
|
|
795
1123
|
|
|
796
1124
|
### Return type
|
|
797
1125
|
|
|
@@ -809,16 +1137,16 @@ nil (empty response body)
|
|
|
809
1137
|
|
|
810
1138
|
## validate_password_self
|
|
811
1139
|
|
|
812
|
-
> ValidatePasswordResponse validate_password_self(password_request)
|
|
1140
|
+
> <ValidatePasswordResponse> validate_password_self(password_request)
|
|
813
1141
|
|
|
814
1142
|
Validate the proposed password
|
|
815
1143
|
|
|
816
1144
|
validate the password and return a score
|
|
817
1145
|
|
|
818
|
-
###
|
|
1146
|
+
### Examples
|
|
819
1147
|
|
|
820
1148
|
```ruby
|
|
821
|
-
|
|
1149
|
+
require 'time'
|
|
822
1150
|
require 'velopayments'
|
|
823
1151
|
# setup authorization
|
|
824
1152
|
VeloPayments.configure do |config|
|
|
@@ -827,23 +1155,40 @@ VeloPayments.configure do |config|
|
|
|
827
1155
|
end
|
|
828
1156
|
|
|
829
1157
|
api_instance = VeloPayments::UsersApi.new
|
|
830
|
-
password_request = VeloPayments::PasswordRequest.new # PasswordRequest | The password
|
|
1158
|
+
password_request = VeloPayments::PasswordRequest.new({password: 'My_strong_password'}) # PasswordRequest | The password
|
|
831
1159
|
|
|
832
1160
|
begin
|
|
833
|
-
#Validate the proposed password
|
|
1161
|
+
# Validate the proposed password
|
|
834
1162
|
result = api_instance.validate_password_self(password_request)
|
|
835
1163
|
p result
|
|
836
1164
|
rescue VeloPayments::ApiError => e
|
|
837
|
-
puts "
|
|
1165
|
+
puts "Error when calling UsersApi->validate_password_self: #{e}"
|
|
838
1166
|
end
|
|
839
1167
|
```
|
|
840
1168
|
|
|
841
|
-
|
|
1169
|
+
#### Using the validate_password_self_with_http_info variant
|
|
1170
|
+
|
|
1171
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1172
|
+
|
|
1173
|
+
> <Array(<ValidatePasswordResponse>, Integer, Hash)> validate_password_self_with_http_info(password_request)
|
|
1174
|
+
|
|
1175
|
+
```ruby
|
|
1176
|
+
begin
|
|
1177
|
+
# Validate the proposed password
|
|
1178
|
+
data, status_code, headers = api_instance.validate_password_self_with_http_info(password_request)
|
|
1179
|
+
p status_code # => 2xx
|
|
1180
|
+
p headers # => { ... }
|
|
1181
|
+
p data # => <ValidatePasswordResponse>
|
|
1182
|
+
rescue VeloPayments::ApiError => e
|
|
1183
|
+
puts "Error when calling UsersApi->validate_password_self_with_http_info: #{e}"
|
|
1184
|
+
end
|
|
1185
|
+
```
|
|
842
1186
|
|
|
1187
|
+
### Parameters
|
|
843
1188
|
|
|
844
|
-
Name | Type | Description
|
|
845
|
-
|
|
846
|
-
**password_request** | [**PasswordRequest**](PasswordRequest.md)| The password |
|
|
1189
|
+
| Name | Type | Description | Notes |
|
|
1190
|
+
| ---- | ---- | ----------- | ----- |
|
|
1191
|
+
| **password_request** | [**PasswordRequest**](PasswordRequest.md) | The password | |
|
|
847
1192
|
|
|
848
1193
|
### Return type
|
|
849
1194
|
|