mx-platform-ruby 1.10.0 → 1.10.1
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/Gemfile.lock +1 -1
- data/docs/ACHResponse.md +74 -0
- data/docs/ACHReturnCreateRequest.md +48 -0
- data/docs/ACHReturnCreateRequestBody.md +18 -0
- data/docs/ACHReturnResponseBody.md +18 -0
- data/docs/{HoldingsResponseBody.md → ACHReturnsResponseBody.md} +4 -4
- data/docs/AccountCreateRequest.md +9 -9
- data/docs/AccountNumberResponse.md +3 -3
- data/docs/AccountResponse.md +37 -37
- data/docs/AccountUpdateRequest.md +30 -30
- data/docs/AccountsApi.md +780 -0
- data/docs/AchReturnApi.md +234 -0
- data/docs/AuthorizationCodeResponseBody.md +1 -1
- data/docs/BudgetResponse.md +1 -1
- data/docs/BudgetsApi.md +115 -115
- data/docs/CategoriesApi.md +600 -0
- data/docs/CategoryCreateRequest.md +1 -1
- data/docs/CategoryResponse.md +1 -1
- data/docs/ConnectWidgetRequest.md +5 -3
- data/docs/CreditCardProduct.md +1 -1
- data/docs/GoalResponse.md +1 -1
- data/docs/GoalsApi.md +117 -113
- data/docs/GoalsResponse.md +1 -1
- data/docs/ImageOptionResponse.md +0 -2
- data/docs/InsightResponse.md +3 -1
- data/docs/InsightResponseBody.md +1 -1
- data/docs/InsightUpdateRequestBody.md +18 -0
- data/docs/InsightsApi.md +170 -91
- data/docs/InstitutionResponse.md +15 -7
- data/docs/InstitutionsApi.md +319 -0
- data/docs/InvestmentHoldingResponse.md +90 -0
- data/docs/InvestmentHoldingResponseBody.md +18 -0
- data/docs/InvestmentHoldingsApi.md +386 -0
- data/docs/InvestmentHoldingsDeactivation.md +20 -0
- data/docs/InvestmentHoldingsResponseBody.md +20 -0
- data/docs/ManagedAccountCreateRequest.md +15 -15
- data/docs/ManagedAccountUpdateRequest.md +14 -14
- data/docs/ManagedDataApi.md +1228 -0
- data/docs/ManagedTransactionCreateRequest.md +1 -1
- data/docs/MemberCreateRequest.md +5 -3
- data/docs/MemberCreateRequestBody.md +3 -3
- data/docs/MemberElements.md +22 -0
- data/docs/MemberResponse.md +1 -3
- data/docs/MemberStatusResponse.md +2 -2
- data/docs/MemberUpdateRequest.md +4 -2
- data/docs/MembersApi.md +997 -0
- data/docs/MerchantsApi.md +226 -0
- data/docs/{MicrodepositRequest.md → MicrodepositElements.md} +7 -7
- data/docs/MicrodepositRequestBody.md +1 -1
- data/docs/MicrodepositResponse.md +0 -14
- data/docs/MicrodepositResponseBody.md +1 -1
- data/docs/MicrodepositResponseBodyMicroDepositInner.md +44 -0
- data/docs/MicrodepositVerifyRequest.md +4 -4
- data/docs/MicrodepositsApi.md +153 -82
- data/docs/MonthlyCashFlowProfileApi.md +151 -0
- data/docs/MonthlyCashFlowResponse.md +3 -3
- data/docs/NotificationResponse.md +36 -0
- data/docs/NotificationResponseBody.md +18 -0
- data/docs/NotificationsApi.md +236 -0
- data/docs/NotificationsResponseBody.md +18 -0
- data/docs/OptionResponse.md +0 -2
- data/docs/PaymentAccount.md +34 -0
- data/docs/PaymentAccountBody.md +18 -0
- data/docs/PaymentAccountBodyPaymentAccount.md +40 -0
- data/docs/PaymentProcessorAuthorizationCodeRequest.md +3 -3
- data/docs/ProcessorAccountNumber.md +34 -0
- data/docs/ProcessorAccountNumberBody.md +18 -0
- data/docs/ProcessorAccountNumberBodyAccountNumbersInner.md +40 -0
- data/docs/ProcessorOwner.md +34 -0
- data/docs/ProcessorOwnerBody.md +20 -0
- data/docs/ProcessorOwnerBodyAccountOwnersInner.md +40 -0
- data/docs/ProcessorTokenApi.md +490 -0
- data/docs/RepeatingTransactionResponse.md +40 -0
- data/docs/RepeatingTransactionsResponseBody.md +18 -0
- data/docs/{RewardsResponse.md → RewardElements.md} +3 -9
- data/docs/RewardResponseBody.md +1 -1
- data/docs/RewardsApi.md +299 -0
- data/docs/RewardsResponseBody.md +1 -1
- data/docs/{RewardResponse.md → RewardsResponseBodyRewardsInner.md} +8 -8
- data/docs/ScheduledPaymentsResponseBody.md +3 -3
- data/docs/SpendingPlanApi.md +142 -63
- data/docs/SpendingPlanIterationItemResponse.md +5 -5
- data/docs/StatementsApi.md +309 -0
- data/docs/StatementsResponseBody.md +3 -3
- data/docs/TaggingsApi.md +377 -0
- data/docs/TaggingsResponseBody.md +3 -3
- data/docs/TagsApi.md +379 -0
- data/docs/TagsResponseBody.md +3 -3
- data/docs/TokenRequestBody.md +18 -0
- data/docs/TokenResponse.md +24 -0
- data/docs/TokenResponseBody.md +18 -0
- data/docs/TransactionIncludesResponse.md +112 -0
- data/docs/TransactionIncludesResponseAllOfClassification.md +20 -0
- data/docs/TransactionIncludesResponseAllOfGeolocation.md +24 -0
- data/docs/TransactionIncludesResponseAllOfMerchant.md +24 -0
- data/docs/TransactionIncludesResponseAllOfRepeatingTransaction.md +22 -0
- data/docs/TransactionResponse.md +38 -36
- data/docs/TransactionRulesApi.md +305 -0
- data/docs/TransactionRulesResponseBody.md +3 -3
- data/docs/TransactionUpdateRequest.md +7 -1
- data/docs/TransactionsApi.md +1232 -14
- data/docs/TransactionsResponseBody.md +3 -3
- data/docs/TransactionsResponseBodyIncludes.md +20 -0
- data/docs/UsersApi.md +375 -0
- data/docs/UsersResponseBody.md +3 -3
- data/docs/VCResponse.md +18 -0
- data/docs/VerifiableCredentialsApi.md +232 -0
- data/docs/WidgetRequest.md +31 -23
- data/docs/WidgetsApi.md +244 -0
- data/lib/mx-platform-ruby/api/accounts_api.rb +781 -0
- data/lib/mx-platform-ruby/api/ach_return_api.rb +231 -0
- data/lib/mx-platform-ruby/api/budgets_api.rb +131 -131
- data/lib/mx-platform-ruby/api/categories_api.rb +576 -0
- data/lib/mx-platform-ruby/api/goals_api.rb +148 -134
- data/lib/mx-platform-ruby/api/insights_api.rb +162 -87
- data/lib/mx-platform-ruby/api/institutions_api.rb +301 -0
- data/lib/mx-platform-ruby/api/investment_holdings_api.rb +373 -0
- data/lib/mx-platform-ruby/api/managed_data_api.rb +1265 -0
- data/lib/mx-platform-ruby/api/members_api.rb +977 -0
- data/lib/mx-platform-ruby/api/merchants_api.rb +214 -0
- data/lib/mx-platform-ruby/api/microdeposits_api.rb +159 -96
- data/lib/mx-platform-ruby/api/monthly_cash_flow_profile_api.rb +159 -0
- data/lib/mx-platform-ruby/api/notifications_api.rb +243 -0
- data/lib/mx-platform-ruby/api/processor_token_api.rb +450 -0
- data/lib/mx-platform-ruby/api/rewards_api.rb +298 -0
- data/lib/mx-platform-ruby/api/spending_plan_api.rb +139 -64
- data/lib/mx-platform-ruby/api/statements_api.rb +316 -0
- data/lib/mx-platform-ruby/api/taggings_api.rb +381 -0
- data/lib/mx-platform-ruby/api/tags_api.rb +388 -0
- data/lib/mx-platform-ruby/api/transaction_rules_api.rb +314 -0
- data/lib/mx-platform-ruby/api/transactions_api.rb +1237 -15
- data/lib/mx-platform-ruby/api/users_api.rb +367 -0
- data/lib/mx-platform-ruby/api/verifiable_credentials_api.rb +235 -0
- data/lib/mx-platform-ruby/api/widgets_api.rb +260 -0
- data/lib/mx-platform-ruby/api_client.rb +2 -2
- data/lib/mx-platform-ruby/api_error.rb +2 -2
- data/lib/mx-platform-ruby/configuration.rb +12 -5
- data/lib/mx-platform-ruby/models/account_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/account_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/account_number_response.rb +13 -13
- data/lib/mx-platform-ruby/models/account_numbers_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/account_owner_response.rb +2 -2
- data/lib/mx-platform-ruby/models/account_owners_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/account_response.rb +2 -2
- data/lib/mx-platform-ruby/models/account_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/account_update_request.rb +23 -2
- data/lib/mx-platform-ruby/models/account_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/accounts_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/ach_response.rb +485 -0
- data/lib/mx-platform-ruby/models/ach_return_create_request.rb +400 -0
- data/lib/mx-platform-ruby/models/ach_return_create_request_body.rb +214 -0
- data/lib/mx-platform-ruby/models/ach_return_response_body.rb +214 -0
- data/lib/mx-platform-ruby/models/{holdings_response_body.rb → ach_returns_response_body.rb} +13 -13
- data/lib/mx-platform-ruby/models/authorization_code_request.rb +2 -2
- data/lib/mx-platform-ruby/models/authorization_code_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/authorization_code_response.rb +2 -2
- data/lib/mx-platform-ruby/models/authorization_code_response_body.rb +4 -6
- data/lib/mx-platform-ruby/models/budget_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/budget_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/budget_response.rb +2 -2
- data/lib/mx-platform-ruby/models/budget_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/budget_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/budget_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/categories_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/category_create_request.rb +9 -2
- data/lib/mx-platform-ruby/models/category_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/category_response.rb +3 -2
- data/lib/mx-platform-ruby/models/category_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/category_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/category_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/challenge_response.rb +2 -2
- data/lib/mx-platform-ruby/models/challenges_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/connect_widget_request.rb +13 -3
- data/lib/mx-platform-ruby/models/connect_widget_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/connect_widget_response.rb +2 -2
- data/lib/mx-platform-ruby/models/connect_widget_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/credential_request.rb +2 -2
- data/lib/mx-platform-ruby/models/credential_response.rb +2 -2
- data/lib/mx-platform-ruby/models/credentials_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/credit_card_product.rb +4 -2
- data/lib/mx-platform-ruby/models/credit_card_product_response.rb +2 -2
- data/lib/mx-platform-ruby/models/enhance_transaction_response.rb +2 -2
- data/lib/mx-platform-ruby/models/enhance_transactions_request.rb +2 -2
- data/lib/mx-platform-ruby/models/enhance_transactions_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/enhance_transactions_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/goal_request.rb +2 -2
- data/lib/mx-platform-ruby/models/goal_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/goal_response.rb +2 -2
- data/lib/mx-platform-ruby/models/goal_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/goals_response.rb +2 -2
- data/lib/mx-platform-ruby/models/goals_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/image_option_response.rb +3 -13
- data/lib/mx-platform-ruby/models/insight_response.rb +13 -3
- data/lib/mx-platform-ruby/models/insight_response_body.rb +4 -6
- data/lib/mx-platform-ruby/models/insight_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/{tax_document_response_body.rb → insight_update_request_body.rb} +12 -12
- data/lib/mx-platform-ruby/models/insights_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/institution_response.rb +35 -3
- data/lib/mx-platform-ruby/models/institution_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/institutions_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/investment_holding_response.rb +575 -0
- data/lib/mx-platform-ruby/models/investment_holding_response_body.rb +214 -0
- data/lib/mx-platform-ruby/models/investment_holdings_deactivation.rb +225 -0
- data/lib/mx-platform-ruby/models/investment_holdings_response_body.rb +225 -0
- data/lib/mx-platform-ruby/models/managed_account_create_request.rb +9 -2
- data/lib/mx-platform-ruby/models/managed_account_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_account_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_account_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_member_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_member_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_member_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_member_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_transaction_create_request.rb +9 -2
- data/lib/mx-platform-ruby/models/managed_transaction_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_transaction_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_transaction_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/member_create_request.rb +40 -6
- data/lib/mx-platform-ruby/models/member_create_request_body.rb +3 -2
- data/lib/mx-platform-ruby/models/member_elements.rb +232 -0
- data/lib/mx-platform-ruby/models/member_response.rb +3 -13
- data/lib/mx-platform-ruby/models/member_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/member_resume_request.rb +2 -2
- data/lib/mx-platform-ruby/models/member_resume_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/member_status_response.rb +13 -13
- data/lib/mx-platform-ruby/models/member_status_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/member_update_request.rb +40 -6
- data/lib/mx-platform-ruby/models/member_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/members_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/merchant_location_response.rb +2 -2
- data/lib/mx-platform-ruby/models/merchant_location_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/merchant_response.rb +2 -2
- data/lib/mx-platform-ruby/models/merchant_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/merchants_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/{microdeposit_request.rb → microdeposit_elements.rb} +29 -29
- data/lib/mx-platform-ruby/models/microdeposit_request_body.rb +3 -3
- data/lib/mx-platform-ruby/models/microdeposit_response.rb +5 -66
- data/lib/mx-platform-ruby/models/microdeposit_response_body.rb +6 -4
- data/lib/mx-platform-ruby/models/microdeposit_response_body_micro_deposit_inner.rb +362 -0
- data/lib/mx-platform-ruby/models/microdeposit_verify_request.rb +4 -4
- data/lib/mx-platform-ruby/models/microdeposit_verify_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/microdeposits_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/monthly_cash_flow_profile_request.rb +2 -2
- data/lib/mx-platform-ruby/models/monthly_cash_flow_profile_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/monthly_cash_flow_response.rb +4 -3
- data/lib/mx-platform-ruby/models/monthly_cash_flow_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/notification_response.rb +305 -0
- data/lib/mx-platform-ruby/models/{tax_documents_response_body.rb → notification_response_body.rb} +12 -23
- data/lib/mx-platform-ruby/models/notifications_response_body.rb +216 -0
- data/lib/mx-platform-ruby/models/o_auth_window_response.rb +2 -2
- data/lib/mx-platform-ruby/models/o_auth_window_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/option_response.rb +3 -13
- data/lib/mx-platform-ruby/models/pagination_response.rb +2 -2
- data/lib/mx-platform-ruby/models/{tax_document_response.rb → payment_account.rb} +66 -76
- data/lib/mx-platform-ruby/models/payment_account_body.rb +214 -0
- data/lib/mx-platform-ruby/models/payment_account_body_payment_account.rb +330 -0
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request.rb +23 -5
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response.rb +2 -2
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/processor_account_number.rb +292 -0
- data/lib/mx-platform-ruby/models/processor_account_number_body.rb +216 -0
- data/lib/mx-platform-ruby/models/processor_account_number_body_account_numbers_inner.rb +327 -0
- data/lib/mx-platform-ruby/models/processor_owner.rb +295 -0
- data/lib/mx-platform-ruby/models/processor_owner_body.rb +225 -0
- data/lib/mx-platform-ruby/models/processor_owner_body_account_owners_inner.rb +330 -0
- data/lib/mx-platform-ruby/models/{holding_response.rb → repeating_transaction_response.rb} +100 -135
- data/lib/mx-platform-ruby/models/repeating_transactions_response_body.rb +216 -0
- data/lib/mx-platform-ruby/models/reposition_request.rb +2 -2
- data/lib/mx-platform-ruby/models/reposition_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/reposition_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/{rewards_response.rb → reward_elements.rb} +9 -36
- data/lib/mx-platform-ruby/models/reward_response_body.rb +3 -3
- data/lib/mx-platform-ruby/models/rewards_response_body.rb +3 -3
- data/lib/mx-platform-ruby/models/{reward_response.rb → rewards_response_body_rewards_inner.rb} +35 -27
- data/lib/mx-platform-ruby/models/scheduled_payment_response.rb +2 -2
- data/lib/mx-platform-ruby/models/scheduled_payments_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/spending_plan_account_response.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_accounts_response.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_iteration_item_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_iteration_item_response.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_iteration_items_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_iteration_response.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_iterations_response.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_response.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plans_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/split_transaction_request.rb +2 -2
- data/lib/mx-platform-ruby/models/split_transaction_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/split_transactions_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/statement_response.rb +2 -2
- data/lib/mx-platform-ruby/models/statement_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/statements_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/tag_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/tag_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/tag_response.rb +2 -2
- data/lib/mx-platform-ruby/models/tag_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/tag_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/tag_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/tagging_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/tagging_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/tagging_response.rb +2 -2
- data/lib/mx-platform-ruby/models/tagging_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/tagging_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/tagging_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/taggings_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/tags_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/{holding_response_body.rb → token_request_body.rb} +12 -12
- data/lib/mx-platform-ruby/models/token_response.rb +241 -0
- data/lib/mx-platform-ruby/models/token_response_body.rb +216 -0
- data/lib/mx-platform-ruby/models/transaction_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_create_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_includes_response.rb +692 -0
- data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_classification.rb +257 -0
- data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_geolocation.rb +241 -0
- data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_merchant.rb +241 -0
- data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_repeating_transaction.rb +278 -0
- data/lib/mx-platform-ruby/models/transaction_response.rb +13 -3
- data/lib/mx-platform-ruby/models/transaction_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rule_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rule_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rule_response.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rule_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rule_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rule_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rules_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/transaction_update_request.rb +30 -10
- data/lib/mx-platform-ruby/models/transaction_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transactions_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/transactions_response_body_includes.rb +225 -0
- data/lib/mx-platform-ruby/models/update_goal_request.rb +2 -2
- data/lib/mx-platform-ruby/models/update_goal_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/user_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/user_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/user_response.rb +2 -2
- data/lib/mx-platform-ruby/models/user_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/user_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/user_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/users_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/vc_response.rb +214 -0
- data/lib/mx-platform-ruby/models/widget_request.rb +89 -3
- data/lib/mx-platform-ruby/models/widget_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/widget_response.rb +2 -2
- data/lib/mx-platform-ruby/models/widget_response_body.rb +2 -2
- data/lib/mx-platform-ruby/version.rb +3 -3
- data/lib/mx-platform-ruby.rb +60 -12
- data/mx-platform-ruby.gemspec +2 -2
- data/openapi/config.yml +1 -1
- data/spec/api/accounts_api_spec.rb +182 -0
- data/spec/api/ach_return_api_spec.rb +77 -0
- data/spec/api/budgets_api_spec.rb +38 -38
- data/spec/api/categories_api_spec.rb +141 -0
- data/spec/api/goals_api_spec.rb +42 -40
- data/spec/api/insights_api_spec.rb +53 -38
- data/spec/api/institutions_api_spec.rb +94 -0
- data/spec/api/investment_holdings_api_spec.rb +104 -0
- data/spec/api/managed_data_api_spec.rb +267 -0
- data/spec/api/members_api_spec.rb +218 -0
- data/spec/api/merchants_api_spec.rb +73 -0
- data/spec/api/microdeposits_api_spec.rb +40 -28
- data/spec/api/monthly_cash_flow_profile_api_spec.rb +60 -0
- data/spec/api/notifications_api_spec.rb +78 -0
- data/spec/api/processor_token_api_spec.rb +115 -0
- data/spec/api/rewards_api_spec.rb +87 -0
- data/spec/api/spending_plan_api_spec.rb +48 -33
- data/spec/api/statements_api_spec.rb +91 -0
- data/spec/api/taggings_api_spec.rb +102 -0
- data/spec/api/tags_api_spec.rb +103 -0
- data/spec/api/transaction_rules_api_spec.rb +89 -0
- data/spec/api/transactions_api_spec.rb +258 -6
- data/spec/api/users_api_spec.rb +101 -0
- data/spec/api/verifiable_credentials_api_spec.rb +76 -0
- data/spec/api/widgets_api_spec.rb +81 -0
- data/spec/models/account_create_request_body_spec.rb +2 -2
- data/spec/models/account_create_request_spec.rb +2 -2
- data/spec/models/account_number_response_spec.rb +5 -5
- data/spec/models/account_numbers_response_body_spec.rb +2 -2
- data/spec/models/account_owner_response_spec.rb +2 -2
- data/spec/models/account_owners_response_body_spec.rb +2 -2
- data/spec/models/account_response_body_spec.rb +2 -2
- data/spec/models/account_response_spec.rb +2 -2
- data/spec/models/account_update_request_body_spec.rb +2 -2
- data/spec/models/account_update_request_spec.rb +2 -2
- data/spec/models/accounts_response_body_spec.rb +2 -2
- data/spec/models/ach_response_spec.rb +204 -0
- data/spec/models/ach_return_create_request_body_spec.rb +36 -0
- data/spec/models/{holding_response_spec.rb → ach_return_create_request_spec.rb} +22 -40
- data/spec/models/ach_return_response_body_spec.rb +36 -0
- data/spec/models/{tax_documents_response_body_spec.rb → ach_returns_response_body_spec.rb} +10 -10
- data/spec/models/authorization_code_request_body_spec.rb +2 -2
- data/spec/models/authorization_code_request_spec.rb +2 -2
- data/spec/models/authorization_code_response_body_spec.rb +2 -2
- data/spec/models/authorization_code_response_spec.rb +2 -2
- data/spec/models/budget_create_request_body_spec.rb +2 -2
- data/spec/models/budget_create_request_spec.rb +2 -2
- data/spec/models/budget_response_body_spec.rb +2 -2
- data/spec/models/budget_response_spec.rb +2 -2
- data/spec/models/budget_update_request_body_spec.rb +2 -2
- data/spec/models/budget_update_request_spec.rb +2 -2
- data/spec/models/categories_response_body_spec.rb +2 -2
- data/spec/models/category_create_request_body_spec.rb +2 -2
- data/spec/models/category_create_request_spec.rb +2 -2
- data/spec/models/category_response_body_spec.rb +2 -2
- data/spec/models/category_response_spec.rb +2 -2
- data/spec/models/category_update_request_body_spec.rb +2 -2
- data/spec/models/category_update_request_spec.rb +2 -2
- data/spec/models/challenge_response_spec.rb +2 -2
- data/spec/models/challenges_response_body_spec.rb +2 -2
- data/spec/models/connect_widget_request_body_spec.rb +2 -2
- data/spec/models/connect_widget_request_spec.rb +8 -2
- data/spec/models/connect_widget_response_body_spec.rb +2 -2
- data/spec/models/connect_widget_response_spec.rb +2 -2
- data/spec/models/credential_request_spec.rb +2 -2
- data/spec/models/credential_response_spec.rb +2 -2
- data/spec/models/credentials_response_body_spec.rb +2 -2
- data/spec/models/credit_card_product_response_spec.rb +2 -2
- data/spec/models/credit_card_product_spec.rb +2 -2
- data/spec/models/enhance_transaction_response_spec.rb +2 -2
- data/spec/models/enhance_transactions_request_body_spec.rb +2 -2
- data/spec/models/enhance_transactions_request_spec.rb +2 -2
- data/spec/models/enhance_transactions_response_body_spec.rb +2 -2
- data/spec/models/goal_request_body_spec.rb +2 -2
- data/spec/models/goal_request_spec.rb +2 -2
- data/spec/models/goal_response_body_spec.rb +2 -2
- data/spec/models/goal_response_spec.rb +2 -2
- data/spec/models/goals_response_body_spec.rb +2 -2
- data/spec/models/goals_response_spec.rb +2 -2
- data/spec/models/image_option_response_spec.rb +2 -8
- data/spec/models/insight_response_body_spec.rb +2 -2
- data/spec/models/insight_response_spec.rb +8 -2
- data/spec/models/insight_update_request_body_spec.rb +36 -0
- data/spec/models/insight_update_request_spec.rb +2 -2
- data/spec/models/insights_response_body_spec.rb +2 -2
- data/spec/models/institution_response_body_spec.rb +2 -2
- data/spec/models/institution_response_spec.rb +20 -2
- data/spec/models/institutions_response_body_spec.rb +2 -2
- data/spec/models/investment_holding_response_body_spec.rb +36 -0
- data/spec/models/investment_holding_response_spec.rb +252 -0
- data/spec/models/investment_holdings_deactivation_spec.rb +42 -0
- data/spec/models/investment_holdings_response_body_spec.rb +42 -0
- data/spec/models/managed_account_create_request_body_spec.rb +2 -2
- data/spec/models/managed_account_create_request_spec.rb +2 -2
- data/spec/models/managed_account_update_request_body_spec.rb +2 -2
- data/spec/models/managed_account_update_request_spec.rb +2 -2
- data/spec/models/managed_member_create_request_body_spec.rb +2 -2
- data/spec/models/managed_member_create_request_spec.rb +2 -2
- data/spec/models/managed_member_update_request_body_spec.rb +2 -2
- data/spec/models/managed_member_update_request_spec.rb +2 -2
- data/spec/models/managed_transaction_create_request_body_spec.rb +2 -2
- data/spec/models/managed_transaction_create_request_spec.rb +2 -2
- data/spec/models/managed_transaction_update_request_body_spec.rb +2 -2
- data/spec/models/managed_transaction_update_request_spec.rb +2 -2
- data/spec/models/member_create_request_body_spec.rb +2 -2
- data/spec/models/member_create_request_spec.rb +12 -2
- data/spec/models/member_elements_spec.rb +48 -0
- data/spec/models/member_response_body_spec.rb +2 -2
- data/spec/models/member_response_spec.rb +2 -8
- data/spec/models/member_resume_request_body_spec.rb +2 -2
- data/spec/models/member_resume_request_spec.rb +2 -2
- data/spec/models/member_status_response_body_spec.rb +2 -2
- data/spec/models/member_status_response_spec.rb +4 -4
- data/spec/models/member_update_request_body_spec.rb +2 -2
- data/spec/models/member_update_request_spec.rb +12 -2
- data/spec/models/members_response_body_spec.rb +2 -2
- data/spec/models/merchant_location_response_body_spec.rb +2 -2
- data/spec/models/merchant_location_response_spec.rb +2 -2
- data/spec/models/merchant_response_body_spec.rb +2 -2
- data/spec/models/merchant_response_spec.rb +2 -2
- data/spec/models/merchants_response_body_spec.rb +2 -2
- data/spec/models/{microdeposit_request_spec.rb → microdeposit_elements_spec.rb} +15 -15
- data/spec/models/microdeposit_request_body_spec.rb +2 -2
- data/spec/models/microdeposit_response_body_micro_deposit_inner_spec.rb +114 -0
- data/spec/models/microdeposit_response_body_spec.rb +2 -2
- data/spec/models/microdeposit_response_spec.rb +2 -44
- data/spec/models/microdeposit_verify_request_body_spec.rb +2 -2
- data/spec/models/microdeposit_verify_request_spec.rb +2 -2
- data/spec/models/microdeposits_response_body_spec.rb +2 -2
- data/spec/models/monthly_cash_flow_profile_request_body_spec.rb +2 -2
- data/spec/models/monthly_cash_flow_profile_request_spec.rb +2 -2
- data/spec/models/monthly_cash_flow_response_body_spec.rb +2 -2
- data/spec/models/monthly_cash_flow_response_spec.rb +2 -2
- data/spec/models/notification_response_body_spec.rb +36 -0
- data/spec/models/{tax_document_response_spec.rb → notification_response_spec.rb} +18 -18
- data/spec/models/notifications_response_body_spec.rb +36 -0
- data/spec/models/o_auth_window_response_body_spec.rb +2 -2
- data/spec/models/o_auth_window_response_spec.rb +2 -2
- data/spec/models/option_response_spec.rb +2 -8
- data/spec/models/pagination_response_spec.rb +2 -2
- data/spec/models/{reward_response_spec.rb → payment_account_body_payment_account_spec.rb} +24 -18
- data/spec/models/payment_account_body_spec.rb +36 -0
- data/spec/models/payment_account_spec.rb +84 -0
- data/spec/models/payment_processor_authorization_code_request_body_spec.rb +2 -2
- data/spec/models/payment_processor_authorization_code_request_spec.rb +2 -2
- data/spec/models/payment_processor_authorization_code_response_body_spec.rb +2 -2
- data/spec/models/payment_processor_authorization_code_response_spec.rb +2 -2
- data/spec/models/processor_account_number_body_account_numbers_inner_spec.rb +102 -0
- data/spec/models/processor_account_number_body_spec.rb +36 -0
- data/spec/models/processor_account_number_spec.rb +84 -0
- data/spec/models/processor_owner_body_account_owners_inner_spec.rb +102 -0
- data/spec/models/{holdings_response_body_spec.rb → processor_owner_body_spec.rb} +9 -9
- data/spec/models/processor_owner_spec.rb +84 -0
- data/spec/models/repeating_transaction_response_spec.rb +110 -0
- data/spec/models/repeating_transactions_response_body_spec.rb +36 -0
- data/spec/models/reposition_request_body_spec.rb +2 -2
- data/spec/models/reposition_request_spec.rb +2 -2
- data/spec/models/reposition_response_body_spec.rb +2 -2
- data/spec/models/reward_elements_spec.rb +78 -0
- data/spec/models/reward_response_body_spec.rb +2 -2
- data/spec/models/{rewards_response_spec.rb → rewards_response_body_rewards_inner_spec.rb} +18 -18
- data/spec/models/rewards_response_body_spec.rb +2 -2
- data/spec/models/scheduled_payment_response_spec.rb +2 -2
- data/spec/models/scheduled_payments_response_body_spec.rb +4 -4
- data/spec/models/spending_plan_account_response_spec.rb +2 -2
- data/spec/models/spending_plan_accounts_response_spec.rb +2 -2
- data/spec/models/spending_plan_iteration_item_create_request_body_spec.rb +2 -2
- data/spec/models/spending_plan_iteration_item_response_spec.rb +2 -2
- data/spec/models/spending_plan_iteration_items_response_body_spec.rb +2 -2
- data/spec/models/spending_plan_iteration_response_spec.rb +2 -2
- data/spec/models/spending_plan_iterations_response_spec.rb +2 -2
- data/spec/models/spending_plan_response_spec.rb +2 -2
- data/spec/models/spending_plans_response_body_spec.rb +2 -2
- data/spec/models/split_transaction_request_body_spec.rb +2 -2
- data/spec/models/split_transaction_request_spec.rb +2 -2
- data/spec/models/split_transactions_response_body_spec.rb +2 -2
- data/spec/models/statement_response_body_spec.rb +2 -2
- data/spec/models/statement_response_spec.rb +2 -2
- data/spec/models/statements_response_body_spec.rb +4 -4
- data/spec/models/tag_create_request_body_spec.rb +2 -2
- data/spec/models/tag_create_request_spec.rb +2 -2
- data/spec/models/tag_response_body_spec.rb +2 -2
- data/spec/models/tag_response_spec.rb +2 -2
- data/spec/models/tag_update_request_body_spec.rb +2 -2
- data/spec/models/tag_update_request_spec.rb +2 -2
- data/spec/models/tagging_create_request_body_spec.rb +2 -2
- data/spec/models/tagging_create_request_spec.rb +2 -2
- data/spec/models/tagging_response_body_spec.rb +2 -2
- data/spec/models/tagging_response_spec.rb +2 -2
- data/spec/models/tagging_update_request_body_spec.rb +2 -2
- data/spec/models/tagging_update_request_spec.rb +2 -2
- data/spec/models/taggings_response_body_spec.rb +4 -4
- data/spec/models/tags_response_body_spec.rb +4 -4
- data/spec/models/{tax_document_response_body_spec.rb → token_request_body_spec.rb} +9 -9
- data/spec/models/token_response_body_spec.rb +36 -0
- data/spec/models/token_response_spec.rb +54 -0
- data/spec/models/transaction_create_request_body_spec.rb +2 -2
- data/spec/models/transaction_create_request_spec.rb +2 -2
- data/spec/models/transaction_create_response_body_spec.rb +2 -2
- data/spec/models/transaction_includes_response_all_of_classification_spec.rb +46 -0
- data/spec/models/transaction_includes_response_all_of_geolocation_spec.rb +54 -0
- data/spec/models/transaction_includes_response_all_of_merchant_spec.rb +54 -0
- data/spec/models/transaction_includes_response_all_of_repeating_transaction_spec.rb +56 -0
- data/spec/models/transaction_includes_response_spec.rb +318 -0
- data/spec/models/transaction_response_body_spec.rb +2 -2
- data/spec/models/transaction_response_spec.rb +8 -2
- data/spec/models/transaction_rule_create_request_body_spec.rb +2 -2
- data/spec/models/transaction_rule_create_request_spec.rb +2 -2
- data/spec/models/transaction_rule_response_body_spec.rb +2 -2
- data/spec/models/transaction_rule_response_spec.rb +2 -2
- data/spec/models/transaction_rule_update_request_body_spec.rb +2 -2
- data/spec/models/transaction_rule_update_request_spec.rb +2 -2
- data/spec/models/transaction_rules_response_body_spec.rb +4 -4
- data/spec/models/transaction_update_request_body_spec.rb +2 -2
- data/spec/models/transaction_update_request_spec.rb +20 -2
- data/spec/models/transactions_response_body_includes_spec.rb +42 -0
- data/spec/models/transactions_response_body_spec.rb +4 -4
- data/spec/models/update_goal_request_body_spec.rb +2 -2
- data/spec/models/update_goal_request_spec.rb +2 -2
- data/spec/models/user_create_request_body_spec.rb +2 -2
- data/spec/models/user_create_request_spec.rb +2 -2
- data/spec/models/user_response_body_spec.rb +2 -2
- data/spec/models/user_response_spec.rb +2 -2
- data/spec/models/user_update_request_body_spec.rb +2 -2
- data/spec/models/user_update_request_spec.rb +2 -2
- data/spec/models/users_response_body_spec.rb +4 -4
- data/spec/models/{holding_response_body_spec.rb → vc_response_spec.rb} +9 -9
- data/spec/models/widget_request_body_spec.rb +2 -2
- data/spec/models/widget_request_spec.rb +30 -2
- data/spec/models/widget_response_body_spec.rb +2 -2
- data/spec/models/widget_response_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +233 -41
- data/docs/HoldingResponse.md +0 -54
- data/docs/HoldingResponseBody.md +0 -18
- data/docs/MxPlatformApi.md +0 -8065
- data/docs/TaxDocumentResponse.md +0 -36
- data/docs/TaxDocumentResponseBody.md +0 -18
- data/docs/TaxDocumentsResponseBody.md +0 -20
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +0 -7795
- data/spec/api/mx_platform_api_spec.rb +0 -1519
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#MX Platform API
|
|
3
3
|
|
|
4
|
-
#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
|
|
4
|
+
#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions. Just getting started? See our [use case guides](/use-cases/).
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document:
|
|
6
|
+
The version of the OpenAPI document: 20111101
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.8.0
|
|
@@ -21,38 +21,38 @@ module MxPlatformRuby
|
|
|
21
21
|
end
|
|
22
22
|
# Create manual transaction
|
|
23
23
|
# This endpoint can only be used to create manual transactions that are under a manual account. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter.
|
|
24
|
-
# @param user_guid [String] The unique identifier for the
|
|
25
|
-
# @param account_guid [String] The unique
|
|
24
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
25
|
+
# @param account_guid [String] The unique id for an `account`.
|
|
26
26
|
# @param transaction_create_request_body [TransactionCreateRequestBody]
|
|
27
27
|
# @param [Hash] opts the optional parameters
|
|
28
28
|
# @return [TransactionCreateResponseBody]
|
|
29
|
-
def
|
|
30
|
-
data, _status_code, _headers =
|
|
29
|
+
def create_manual_transaction(user_guid, account_guid, transaction_create_request_body, opts = {})
|
|
30
|
+
data, _status_code, _headers = create_manual_transaction_with_http_info(user_guid, account_guid, transaction_create_request_body, opts)
|
|
31
31
|
data
|
|
32
32
|
end
|
|
33
33
|
|
|
34
34
|
# Create manual transaction
|
|
35
35
|
# This endpoint can only be used to create manual transactions that are under a manual account. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter.
|
|
36
|
-
# @param user_guid [String] The unique identifier for the
|
|
37
|
-
# @param account_guid [String] The unique
|
|
36
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
37
|
+
# @param account_guid [String] The unique id for an `account`.
|
|
38
38
|
# @param transaction_create_request_body [TransactionCreateRequestBody]
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
40
|
# @return [Array<(TransactionCreateResponseBody, Integer, Hash)>] TransactionCreateResponseBody data, response status code and response headers
|
|
41
|
-
def
|
|
41
|
+
def create_manual_transaction_with_http_info(user_guid, account_guid, transaction_create_request_body, opts = {})
|
|
42
42
|
if @api_client.config.debugging
|
|
43
|
-
@api_client.config.logger.debug 'Calling API: TransactionsApi.
|
|
43
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.create_manual_transaction ...'
|
|
44
44
|
end
|
|
45
45
|
# verify the required parameter 'user_guid' is set
|
|
46
46
|
if @api_client.config.client_side_validation && user_guid.nil?
|
|
47
|
-
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.
|
|
47
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.create_manual_transaction"
|
|
48
48
|
end
|
|
49
49
|
# verify the required parameter 'account_guid' is set
|
|
50
50
|
if @api_client.config.client_side_validation && account_guid.nil?
|
|
51
|
-
fail ArgumentError, "Missing the required parameter 'account_guid' when calling TransactionsApi.
|
|
51
|
+
fail ArgumentError, "Missing the required parameter 'account_guid' when calling TransactionsApi.create_manual_transaction"
|
|
52
52
|
end
|
|
53
53
|
# verify the required parameter 'transaction_create_request_body' is set
|
|
54
54
|
if @api_client.config.client_side_validation && transaction_create_request_body.nil?
|
|
55
|
-
fail ArgumentError, "Missing the required parameter 'transaction_create_request_body' when calling TransactionsApi.
|
|
55
|
+
fail ArgumentError, "Missing the required parameter 'transaction_create_request_body' when calling TransactionsApi.create_manual_transaction"
|
|
56
56
|
end
|
|
57
57
|
# resource path
|
|
58
58
|
local_var_path = '/users/{user_guid}/accounts/{account_guid}/transactions'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s))
|
|
@@ -83,7 +83,7 @@ module MxPlatformRuby
|
|
|
83
83
|
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
84
84
|
|
|
85
85
|
new_options = opts.merge(
|
|
86
|
-
:operation => :"TransactionsApi.
|
|
86
|
+
:operation => :"TransactionsApi.create_manual_transaction",
|
|
87
87
|
:header_params => header_params,
|
|
88
88
|
:query_params => query_params,
|
|
89
89
|
:form_params => form_params,
|
|
@@ -94,7 +94,1229 @@ module MxPlatformRuby
|
|
|
94
94
|
|
|
95
95
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
96
96
|
if @api_client.config.debugging
|
|
97
|
-
@api_client.config.logger.debug "API called: TransactionsApi#
|
|
97
|
+
@api_client.config.logger.debug "API called: TransactionsApi#create_manual_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
98
|
+
end
|
|
99
|
+
return data, status_code, headers
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# Create split transactions
|
|
103
|
+
# This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can't be split again. In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction's `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again.
|
|
104
|
+
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
105
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
106
|
+
# @param [Hash] opts the optional parameters
|
|
107
|
+
# @option opts [SplitTransactionRequestBody] :split_transaction_request_body
|
|
108
|
+
# @return [SplitTransactionsResponseBody]
|
|
109
|
+
def create_split_transactions(transaction_guid, user_guid, opts = {})
|
|
110
|
+
data, _status_code, _headers = create_split_transactions_with_http_info(transaction_guid, user_guid, opts)
|
|
111
|
+
data
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
# Create split transactions
|
|
115
|
+
# This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can't be split again. In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction's `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again.
|
|
116
|
+
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
117
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
118
|
+
# @param [Hash] opts the optional parameters
|
|
119
|
+
# @option opts [SplitTransactionRequestBody] :split_transaction_request_body
|
|
120
|
+
# @return [Array<(SplitTransactionsResponseBody, Integer, Hash)>] SplitTransactionsResponseBody data, response status code and response headers
|
|
121
|
+
def create_split_transactions_with_http_info(transaction_guid, user_guid, opts = {})
|
|
122
|
+
if @api_client.config.debugging
|
|
123
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.create_split_transactions ...'
|
|
124
|
+
end
|
|
125
|
+
# verify the required parameter 'transaction_guid' is set
|
|
126
|
+
if @api_client.config.client_side_validation && transaction_guid.nil?
|
|
127
|
+
fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling TransactionsApi.create_split_transactions"
|
|
128
|
+
end
|
|
129
|
+
# verify the required parameter 'user_guid' is set
|
|
130
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
131
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.create_split_transactions"
|
|
132
|
+
end
|
|
133
|
+
# resource path
|
|
134
|
+
local_var_path = '/users/{user_guid}/transactions/{transaction_guid}/split'.sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
|
135
|
+
|
|
136
|
+
# query parameters
|
|
137
|
+
query_params = opts[:query_params] || {}
|
|
138
|
+
|
|
139
|
+
# header parameters
|
|
140
|
+
header_params = opts[:header_params] || {}
|
|
141
|
+
# HTTP header 'Accept' (if needed)
|
|
142
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
|
|
143
|
+
# HTTP header 'Content-Type'
|
|
144
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
145
|
+
if !content_type.nil?
|
|
146
|
+
header_params['Content-Type'] = content_type
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# form parameters
|
|
150
|
+
form_params = opts[:form_params] || {}
|
|
151
|
+
|
|
152
|
+
# http body (model)
|
|
153
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'split_transaction_request_body'])
|
|
154
|
+
|
|
155
|
+
# return_type
|
|
156
|
+
return_type = opts[:debug_return_type] || 'SplitTransactionsResponseBody'
|
|
157
|
+
|
|
158
|
+
# auth_names
|
|
159
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
160
|
+
|
|
161
|
+
new_options = opts.merge(
|
|
162
|
+
:operation => :"TransactionsApi.create_split_transactions",
|
|
163
|
+
:header_params => header_params,
|
|
164
|
+
:query_params => query_params,
|
|
165
|
+
:form_params => form_params,
|
|
166
|
+
:body => post_body,
|
|
167
|
+
:auth_names => auth_names,
|
|
168
|
+
:return_type => return_type
|
|
169
|
+
)
|
|
170
|
+
|
|
171
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
172
|
+
if @api_client.config.debugging
|
|
173
|
+
@api_client.config.logger.debug "API called: TransactionsApi#create_split_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
174
|
+
end
|
|
175
|
+
return data, status_code, headers
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
# Delete manual transactions
|
|
179
|
+
# Delete a manual transaction. In the path, use the manual transaction guid as the `transaction_guid`, such as `MAN-810828b0-5210-4878-9bd3-f4ce514f90c4`.
|
|
180
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
181
|
+
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
182
|
+
# @param [Hash] opts the optional parameters
|
|
183
|
+
# @return [nil]
|
|
184
|
+
def delete_manual_transactions(user_guid, transaction_guid, opts = {})
|
|
185
|
+
delete_manual_transactions_with_http_info(user_guid, transaction_guid, opts)
|
|
186
|
+
nil
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
# Delete manual transactions
|
|
190
|
+
# Delete a manual transaction. In the path, use the manual transaction guid as the `transaction_guid`, such as `MAN-810828b0-5210-4878-9bd3-f4ce514f90c4`.
|
|
191
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
192
|
+
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
193
|
+
# @param [Hash] opts the optional parameters
|
|
194
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
195
|
+
def delete_manual_transactions_with_http_info(user_guid, transaction_guid, opts = {})
|
|
196
|
+
if @api_client.config.debugging
|
|
197
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.delete_manual_transactions ...'
|
|
198
|
+
end
|
|
199
|
+
# verify the required parameter 'user_guid' is set
|
|
200
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
201
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.delete_manual_transactions"
|
|
202
|
+
end
|
|
203
|
+
# verify the required parameter 'transaction_guid' is set
|
|
204
|
+
if @api_client.config.client_side_validation && transaction_guid.nil?
|
|
205
|
+
fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling TransactionsApi.delete_manual_transactions"
|
|
206
|
+
end
|
|
207
|
+
# resource path
|
|
208
|
+
local_var_path = '/users/{user_guid}/transactions/{transaction_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s))
|
|
209
|
+
|
|
210
|
+
# query parameters
|
|
211
|
+
query_params = opts[:query_params] || {}
|
|
212
|
+
|
|
213
|
+
# header parameters
|
|
214
|
+
header_params = opts[:header_params] || {}
|
|
215
|
+
|
|
216
|
+
# form parameters
|
|
217
|
+
form_params = opts[:form_params] || {}
|
|
218
|
+
|
|
219
|
+
# http body (model)
|
|
220
|
+
post_body = opts[:debug_body]
|
|
221
|
+
|
|
222
|
+
# return_type
|
|
223
|
+
return_type = opts[:debug_return_type]
|
|
224
|
+
|
|
225
|
+
# auth_names
|
|
226
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
227
|
+
|
|
228
|
+
new_options = opts.merge(
|
|
229
|
+
:operation => :"TransactionsApi.delete_manual_transactions",
|
|
230
|
+
:header_params => header_params,
|
|
231
|
+
:query_params => query_params,
|
|
232
|
+
:form_params => form_params,
|
|
233
|
+
:body => post_body,
|
|
234
|
+
:auth_names => auth_names,
|
|
235
|
+
:return_type => return_type
|
|
236
|
+
)
|
|
237
|
+
|
|
238
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
239
|
+
if @api_client.config.debugging
|
|
240
|
+
@api_client.config.logger.debug "API called: TransactionsApi#delete_manual_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
241
|
+
end
|
|
242
|
+
return data, status_code, headers
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
# Delete split transactions
|
|
246
|
+
# This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction's has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header.
|
|
247
|
+
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
248
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
249
|
+
# @param [Hash] opts the optional parameters
|
|
250
|
+
# @return [nil]
|
|
251
|
+
def delete_split_transactions(transaction_guid, user_guid, opts = {})
|
|
252
|
+
delete_split_transactions_with_http_info(transaction_guid, user_guid, opts)
|
|
253
|
+
nil
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
# Delete split transactions
|
|
257
|
+
# This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction's has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header.
|
|
258
|
+
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
259
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
260
|
+
# @param [Hash] opts the optional parameters
|
|
261
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
262
|
+
def delete_split_transactions_with_http_info(transaction_guid, user_guid, opts = {})
|
|
263
|
+
if @api_client.config.debugging
|
|
264
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.delete_split_transactions ...'
|
|
265
|
+
end
|
|
266
|
+
# verify the required parameter 'transaction_guid' is set
|
|
267
|
+
if @api_client.config.client_side_validation && transaction_guid.nil?
|
|
268
|
+
fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling TransactionsApi.delete_split_transactions"
|
|
269
|
+
end
|
|
270
|
+
# verify the required parameter 'user_guid' is set
|
|
271
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
272
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.delete_split_transactions"
|
|
273
|
+
end
|
|
274
|
+
# resource path
|
|
275
|
+
local_var_path = '/users/{user_guid}/transactions/{transaction_guid}/split'.sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
|
276
|
+
|
|
277
|
+
# query parameters
|
|
278
|
+
query_params = opts[:query_params] || {}
|
|
279
|
+
|
|
280
|
+
# header parameters
|
|
281
|
+
header_params = opts[:header_params] || {}
|
|
282
|
+
|
|
283
|
+
# form parameters
|
|
284
|
+
form_params = opts[:form_params] || {}
|
|
285
|
+
|
|
286
|
+
# http body (model)
|
|
287
|
+
post_body = opts[:debug_body]
|
|
288
|
+
|
|
289
|
+
# return_type
|
|
290
|
+
return_type = opts[:debug_return_type]
|
|
291
|
+
|
|
292
|
+
# auth_names
|
|
293
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
294
|
+
|
|
295
|
+
new_options = opts.merge(
|
|
296
|
+
:operation => :"TransactionsApi.delete_split_transactions",
|
|
297
|
+
:header_params => header_params,
|
|
298
|
+
:query_params => query_params,
|
|
299
|
+
:form_params => form_params,
|
|
300
|
+
:body => post_body,
|
|
301
|
+
:auth_names => auth_names,
|
|
302
|
+
:return_type => return_type
|
|
303
|
+
)
|
|
304
|
+
|
|
305
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
306
|
+
if @api_client.config.debugging
|
|
307
|
+
@api_client.config.logger.debug "API called: TransactionsApi#delete_split_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
308
|
+
end
|
|
309
|
+
return data, status_code, headers
|
|
310
|
+
end
|
|
311
|
+
|
|
312
|
+
# Delete transaction rule
|
|
313
|
+
# Use this endpoint to permanently delete a transaction rule based on its unique GUID.
|
|
314
|
+
# @param transaction_rule_guid [String] The unique id for a `transaction_rule`.
|
|
315
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
316
|
+
# @param [Hash] opts the optional parameters
|
|
317
|
+
# @return [nil]
|
|
318
|
+
def delete_transaction_rule(transaction_rule_guid, user_guid, opts = {})
|
|
319
|
+
delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts)
|
|
320
|
+
nil
|
|
321
|
+
end
|
|
322
|
+
|
|
323
|
+
# Delete transaction rule
|
|
324
|
+
# Use this endpoint to permanently delete a transaction rule based on its unique GUID.
|
|
325
|
+
# @param transaction_rule_guid [String] The unique id for a `transaction_rule`.
|
|
326
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
327
|
+
# @param [Hash] opts the optional parameters
|
|
328
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
329
|
+
def delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts = {})
|
|
330
|
+
if @api_client.config.debugging
|
|
331
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.delete_transaction_rule ...'
|
|
332
|
+
end
|
|
333
|
+
# verify the required parameter 'transaction_rule_guid' is set
|
|
334
|
+
if @api_client.config.client_side_validation && transaction_rule_guid.nil?
|
|
335
|
+
fail ArgumentError, "Missing the required parameter 'transaction_rule_guid' when calling TransactionsApi.delete_transaction_rule"
|
|
336
|
+
end
|
|
337
|
+
# verify the required parameter 'user_guid' is set
|
|
338
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
339
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.delete_transaction_rule"
|
|
340
|
+
end
|
|
341
|
+
# resource path
|
|
342
|
+
local_var_path = '/users/{user_guid}/transaction_rules/{transaction_rule_guid}'.sub('{' + 'transaction_rule_guid' + '}', CGI.escape(transaction_rule_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
|
343
|
+
|
|
344
|
+
# query parameters
|
|
345
|
+
query_params = opts[:query_params] || {}
|
|
346
|
+
|
|
347
|
+
# header parameters
|
|
348
|
+
header_params = opts[:header_params] || {}
|
|
349
|
+
|
|
350
|
+
# form parameters
|
|
351
|
+
form_params = opts[:form_params] || {}
|
|
352
|
+
|
|
353
|
+
# http body (model)
|
|
354
|
+
post_body = opts[:debug_body]
|
|
355
|
+
|
|
356
|
+
# return_type
|
|
357
|
+
return_type = opts[:debug_return_type]
|
|
358
|
+
|
|
359
|
+
# auth_names
|
|
360
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
361
|
+
|
|
362
|
+
new_options = opts.merge(
|
|
363
|
+
:operation => :"TransactionsApi.delete_transaction_rule",
|
|
364
|
+
:header_params => header_params,
|
|
365
|
+
:query_params => query_params,
|
|
366
|
+
:form_params => form_params,
|
|
367
|
+
:body => post_body,
|
|
368
|
+
:auth_names => auth_names,
|
|
369
|
+
:return_type => return_type
|
|
370
|
+
)
|
|
371
|
+
|
|
372
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
373
|
+
if @api_client.config.debugging
|
|
374
|
+
@api_client.config.logger.debug "API called: TransactionsApi#delete_transaction_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
375
|
+
end
|
|
376
|
+
return data, status_code, headers
|
|
377
|
+
end
|
|
378
|
+
|
|
379
|
+
# Enhance transactions
|
|
380
|
+
# Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. <br /><br />For more information on returned data, please see the [Enhanced Transactions fields guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions).
|
|
381
|
+
# @param enhance_transactions_request_body [EnhanceTransactionsRequestBody] Transaction object to be enhanced
|
|
382
|
+
# @param [Hash] opts the optional parameters
|
|
383
|
+
# @return [EnhanceTransactionsResponseBody]
|
|
384
|
+
def enhance_transactions(enhance_transactions_request_body, opts = {})
|
|
385
|
+
data, _status_code, _headers = enhance_transactions_with_http_info(enhance_transactions_request_body, opts)
|
|
386
|
+
data
|
|
387
|
+
end
|
|
388
|
+
|
|
389
|
+
# Enhance transactions
|
|
390
|
+
# Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. <br /><br />For more information on returned data, please see the [Enhanced Transactions fields guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions).
|
|
391
|
+
# @param enhance_transactions_request_body [EnhanceTransactionsRequestBody] Transaction object to be enhanced
|
|
392
|
+
# @param [Hash] opts the optional parameters
|
|
393
|
+
# @return [Array<(EnhanceTransactionsResponseBody, Integer, Hash)>] EnhanceTransactionsResponseBody data, response status code and response headers
|
|
394
|
+
def enhance_transactions_with_http_info(enhance_transactions_request_body, opts = {})
|
|
395
|
+
if @api_client.config.debugging
|
|
396
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.enhance_transactions ...'
|
|
397
|
+
end
|
|
398
|
+
# verify the required parameter 'enhance_transactions_request_body' is set
|
|
399
|
+
if @api_client.config.client_side_validation && enhance_transactions_request_body.nil?
|
|
400
|
+
fail ArgumentError, "Missing the required parameter 'enhance_transactions_request_body' when calling TransactionsApi.enhance_transactions"
|
|
401
|
+
end
|
|
402
|
+
# resource path
|
|
403
|
+
local_var_path = '/transactions/enhance'
|
|
404
|
+
|
|
405
|
+
# query parameters
|
|
406
|
+
query_params = opts[:query_params] || {}
|
|
407
|
+
|
|
408
|
+
# header parameters
|
|
409
|
+
header_params = opts[:header_params] || {}
|
|
410
|
+
# HTTP header 'Accept' (if needed)
|
|
411
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
|
|
412
|
+
# HTTP header 'Content-Type'
|
|
413
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
414
|
+
if !content_type.nil?
|
|
415
|
+
header_params['Content-Type'] = content_type
|
|
416
|
+
end
|
|
417
|
+
|
|
418
|
+
# form parameters
|
|
419
|
+
form_params = opts[:form_params] || {}
|
|
420
|
+
|
|
421
|
+
# http body (model)
|
|
422
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(enhance_transactions_request_body)
|
|
423
|
+
|
|
424
|
+
# return_type
|
|
425
|
+
return_type = opts[:debug_return_type] || 'EnhanceTransactionsResponseBody'
|
|
426
|
+
|
|
427
|
+
# auth_names
|
|
428
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
429
|
+
|
|
430
|
+
new_options = opts.merge(
|
|
431
|
+
:operation => :"TransactionsApi.enhance_transactions",
|
|
432
|
+
:header_params => header_params,
|
|
433
|
+
:query_params => query_params,
|
|
434
|
+
:form_params => form_params,
|
|
435
|
+
:body => post_body,
|
|
436
|
+
:auth_names => auth_names,
|
|
437
|
+
:return_type => return_type
|
|
438
|
+
)
|
|
439
|
+
|
|
440
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
441
|
+
if @api_client.config.debugging
|
|
442
|
+
@api_client.config.logger.debug "API called: TransactionsApi#enhance_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
443
|
+
end
|
|
444
|
+
return data, status_code, headers
|
|
445
|
+
end
|
|
446
|
+
|
|
447
|
+
# Extend history
|
|
448
|
+
# Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication.
|
|
449
|
+
# @param member_guid [String] The unique id for a `member`.
|
|
450
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
451
|
+
# @param [Hash] opts the optional parameters
|
|
452
|
+
# @return [MemberResponseBody]
|
|
453
|
+
def extend_history(member_guid, user_guid, opts = {})
|
|
454
|
+
data, _status_code, _headers = extend_history_with_http_info(member_guid, user_guid, opts)
|
|
455
|
+
data
|
|
456
|
+
end
|
|
457
|
+
|
|
458
|
+
# Extend history
|
|
459
|
+
# Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication.
|
|
460
|
+
# @param member_guid [String] The unique id for a `member`.
|
|
461
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
462
|
+
# @param [Hash] opts the optional parameters
|
|
463
|
+
# @return [Array<(MemberResponseBody, Integer, Hash)>] MemberResponseBody data, response status code and response headers
|
|
464
|
+
def extend_history_with_http_info(member_guid, user_guid, opts = {})
|
|
465
|
+
if @api_client.config.debugging
|
|
466
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.extend_history ...'
|
|
467
|
+
end
|
|
468
|
+
# verify the required parameter 'member_guid' is set
|
|
469
|
+
if @api_client.config.client_side_validation && member_guid.nil?
|
|
470
|
+
fail ArgumentError, "Missing the required parameter 'member_guid' when calling TransactionsApi.extend_history"
|
|
471
|
+
end
|
|
472
|
+
# verify the required parameter 'user_guid' is set
|
|
473
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
474
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.extend_history"
|
|
475
|
+
end
|
|
476
|
+
# resource path
|
|
477
|
+
local_var_path = '/users/{user_guid}/members/{member_guid}/extend_history'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
|
478
|
+
|
|
479
|
+
# query parameters
|
|
480
|
+
query_params = opts[:query_params] || {}
|
|
481
|
+
|
|
482
|
+
# header parameters
|
|
483
|
+
header_params = opts[:header_params] || {}
|
|
484
|
+
# HTTP header 'Accept' (if needed)
|
|
485
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
|
|
486
|
+
|
|
487
|
+
# form parameters
|
|
488
|
+
form_params = opts[:form_params] || {}
|
|
489
|
+
|
|
490
|
+
# http body (model)
|
|
491
|
+
post_body = opts[:debug_body]
|
|
492
|
+
|
|
493
|
+
# return_type
|
|
494
|
+
return_type = opts[:debug_return_type] || 'MemberResponseBody'
|
|
495
|
+
|
|
496
|
+
# auth_names
|
|
497
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
498
|
+
|
|
499
|
+
new_options = opts.merge(
|
|
500
|
+
:operation => :"TransactionsApi.extend_history",
|
|
501
|
+
:header_params => header_params,
|
|
502
|
+
:query_params => query_params,
|
|
503
|
+
:form_params => form_params,
|
|
504
|
+
:body => post_body,
|
|
505
|
+
:auth_names => auth_names,
|
|
506
|
+
:return_type => return_type
|
|
507
|
+
)
|
|
508
|
+
|
|
509
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
510
|
+
if @api_client.config.debugging
|
|
511
|
+
@api_client.config.logger.debug "API called: TransactionsApi#extend_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
512
|
+
end
|
|
513
|
+
return data, status_code, headers
|
|
514
|
+
end
|
|
515
|
+
|
|
516
|
+
# List transactions
|
|
517
|
+
# Requests to this endpoint return a list of transactions associated with the specified `user`, across all members and accounts associated with that `user`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
518
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
519
|
+
# @param [Hash] opts the optional parameters
|
|
520
|
+
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
521
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
522
|
+
# @option opts [String] :from_date Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
|
|
523
|
+
# @option opts [String] :to_date Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
|
|
524
|
+
# @option opts [String] :from_created_at Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
525
|
+
# @option opts [String] :to_created_at Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
526
|
+
# @option opts [String] :from_updated_at Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
527
|
+
# @option opts [String] :to_updated_at Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
528
|
+
# @option opts [String] :category_guid Filter transactions belonging to specified `category_guid`. For example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
529
|
+
# @option opts [Array<String>] :category_guid2 Filter transactions belonging to any specified `category_guid[]` in url. For example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
530
|
+
# @option opts [String] :top_level_category_guid Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid. For example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
531
|
+
# @option opts [Array<String>] :top_level_category_guid2 Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s). For example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
532
|
+
# @option opts [String] :use_case The use case associated with the member. Valid values are `PFM` and `MONEY_MOVEMENT`. For example, you can append either `?use_case=PFM` or `?use_case=MONEY_MOVEMENT`.
|
|
533
|
+
# @option opts [String] :includes Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
|
|
534
|
+
# @return [TransactionsResponseBodyIncludes]
|
|
535
|
+
def list_transactions(user_guid, opts = {})
|
|
536
|
+
data, _status_code, _headers = list_transactions_with_http_info(user_guid, opts)
|
|
537
|
+
data
|
|
538
|
+
end
|
|
539
|
+
|
|
540
|
+
# List transactions
|
|
541
|
+
# Requests to this endpoint return a list of transactions associated with the specified `user`, across all members and accounts associated with that `user`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
542
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
543
|
+
# @param [Hash] opts the optional parameters
|
|
544
|
+
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
545
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
546
|
+
# @option opts [String] :from_date Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
|
|
547
|
+
# @option opts [String] :to_date Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
|
|
548
|
+
# @option opts [String] :from_created_at Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
549
|
+
# @option opts [String] :to_created_at Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
550
|
+
# @option opts [String] :from_updated_at Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
551
|
+
# @option opts [String] :to_updated_at Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
552
|
+
# @option opts [String] :category_guid Filter transactions belonging to specified `category_guid`. For example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
553
|
+
# @option opts [Array<String>] :category_guid2 Filter transactions belonging to any specified `category_guid[]` in url. For example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
554
|
+
# @option opts [String] :top_level_category_guid Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid. For example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
555
|
+
# @option opts [Array<String>] :top_level_category_guid2 Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s). For example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
556
|
+
# @option opts [String] :use_case The use case associated with the member. Valid values are `PFM` and `MONEY_MOVEMENT`. For example, you can append either `?use_case=PFM` or `?use_case=MONEY_MOVEMENT`.
|
|
557
|
+
# @option opts [String] :includes Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
|
|
558
|
+
# @return [Array<(TransactionsResponseBodyIncludes, Integer, Hash)>] TransactionsResponseBodyIncludes data, response status code and response headers
|
|
559
|
+
def list_transactions_with_http_info(user_guid, opts = {})
|
|
560
|
+
if @api_client.config.debugging
|
|
561
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.list_transactions ...'
|
|
562
|
+
end
|
|
563
|
+
# verify the required parameter 'user_guid' is set
|
|
564
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
565
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.list_transactions"
|
|
566
|
+
end
|
|
567
|
+
# resource path
|
|
568
|
+
local_var_path = '/users/{user_guid}/transactions'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
|
569
|
+
|
|
570
|
+
# query parameters
|
|
571
|
+
query_params = opts[:query_params] || {}
|
|
572
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
573
|
+
query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
|
|
574
|
+
query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
|
|
575
|
+
query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
|
|
576
|
+
query_params[:'from_created_at'] = opts[:'from_created_at'] if !opts[:'from_created_at'].nil?
|
|
577
|
+
query_params[:'to_created_at'] = opts[:'to_created_at'] if !opts[:'to_created_at'].nil?
|
|
578
|
+
query_params[:'from_updated_at'] = opts[:'from_updated_at'] if !opts[:'from_updated_at'].nil?
|
|
579
|
+
query_params[:'to_updated_at'] = opts[:'to_updated_at'] if !opts[:'to_updated_at'].nil?
|
|
580
|
+
query_params[:'category_guid'] = opts[:'category_guid'] if !opts[:'category_guid'].nil?
|
|
581
|
+
query_params[:'category_guid[]'] = @api_client.build_collection_param(opts[:'category_guid2'], :multi) if !opts[:'category_guid2'].nil?
|
|
582
|
+
query_params[:'top_level_category_guid'] = opts[:'top_level_category_guid'] if !opts[:'top_level_category_guid'].nil?
|
|
583
|
+
query_params[:'top_level_category_guid[]'] = @api_client.build_collection_param(opts[:'top_level_category_guid2'], :multi) if !opts[:'top_level_category_guid2'].nil?
|
|
584
|
+
query_params[:'use_case'] = opts[:'use_case'] if !opts[:'use_case'].nil?
|
|
585
|
+
query_params[:'includes'] = opts[:'includes'] if !opts[:'includes'].nil?
|
|
586
|
+
|
|
587
|
+
# header parameters
|
|
588
|
+
header_params = opts[:header_params] || {}
|
|
589
|
+
# HTTP header 'Accept' (if needed)
|
|
590
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
|
|
591
|
+
|
|
592
|
+
# form parameters
|
|
593
|
+
form_params = opts[:form_params] || {}
|
|
594
|
+
|
|
595
|
+
# http body (model)
|
|
596
|
+
post_body = opts[:debug_body]
|
|
597
|
+
|
|
598
|
+
# return_type
|
|
599
|
+
return_type = opts[:debug_return_type] || 'TransactionsResponseBodyIncludes'
|
|
600
|
+
|
|
601
|
+
# auth_names
|
|
602
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
603
|
+
|
|
604
|
+
new_options = opts.merge(
|
|
605
|
+
:operation => :"TransactionsApi.list_transactions",
|
|
606
|
+
:header_params => header_params,
|
|
607
|
+
:query_params => query_params,
|
|
608
|
+
:form_params => form_params,
|
|
609
|
+
:body => post_body,
|
|
610
|
+
:auth_names => auth_names,
|
|
611
|
+
:return_type => return_type
|
|
612
|
+
)
|
|
613
|
+
|
|
614
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
615
|
+
if @api_client.config.debugging
|
|
616
|
+
@api_client.config.logger.debug "API called: TransactionsApi#list_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
617
|
+
end
|
|
618
|
+
return data, status_code, headers
|
|
619
|
+
end
|
|
620
|
+
|
|
621
|
+
# List transactions by account
|
|
622
|
+
# Requests to this endpoint return a list of transactions associated with the specified account. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
623
|
+
# @param account_guid [String] The unique id for an `account`.
|
|
624
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
625
|
+
# @param [Hash] opts the optional parameters
|
|
626
|
+
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
627
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
628
|
+
# @option opts [String] :from_date Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
|
|
629
|
+
# @option opts [String] :to_date Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
|
|
630
|
+
# @option opts [String] :from_created_at Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
631
|
+
# @option opts [String] :to_created_at Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
632
|
+
# @option opts [String] :from_updated_at Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
633
|
+
# @option opts [String] :to_updated_at Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
634
|
+
# @option opts [String] :category_guid Filter transactions belonging to specified `category_guid`. For example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
635
|
+
# @option opts [Array<String>] :category_guid2 Filter transactions belonging to any specified `category_guid[]` in url. For example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
636
|
+
# @option opts [String] :top_level_category_guid Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid. For example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
637
|
+
# @option opts [Array<String>] :top_level_category_guid2 Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s). For example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
638
|
+
# @option opts [String] :includes Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
|
|
639
|
+
# @return [TransactionsResponseBodyIncludes]
|
|
640
|
+
def list_transactions_by_account(account_guid, user_guid, opts = {})
|
|
641
|
+
data, _status_code, _headers = list_transactions_by_account_with_http_info(account_guid, user_guid, opts)
|
|
642
|
+
data
|
|
643
|
+
end
|
|
644
|
+
|
|
645
|
+
# List transactions by account
|
|
646
|
+
# Requests to this endpoint return a list of transactions associated with the specified account. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
647
|
+
# @param account_guid [String] The unique id for an `account`.
|
|
648
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
649
|
+
# @param [Hash] opts the optional parameters
|
|
650
|
+
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
651
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
652
|
+
# @option opts [String] :from_date Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
|
|
653
|
+
# @option opts [String] :to_date Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
|
|
654
|
+
# @option opts [String] :from_created_at Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
655
|
+
# @option opts [String] :to_created_at Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
656
|
+
# @option opts [String] :from_updated_at Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
657
|
+
# @option opts [String] :to_updated_at Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
658
|
+
# @option opts [String] :category_guid Filter transactions belonging to specified `category_guid`. For example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
659
|
+
# @option opts [Array<String>] :category_guid2 Filter transactions belonging to any specified `category_guid[]` in url. For example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
660
|
+
# @option opts [String] :top_level_category_guid Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid. For example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
661
|
+
# @option opts [Array<String>] :top_level_category_guid2 Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s). For example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
662
|
+
# @option opts [String] :includes Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
|
|
663
|
+
# @return [Array<(TransactionsResponseBodyIncludes, Integer, Hash)>] TransactionsResponseBodyIncludes data, response status code and response headers
|
|
664
|
+
def list_transactions_by_account_with_http_info(account_guid, user_guid, opts = {})
|
|
665
|
+
if @api_client.config.debugging
|
|
666
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.list_transactions_by_account ...'
|
|
667
|
+
end
|
|
668
|
+
# verify the required parameter 'account_guid' is set
|
|
669
|
+
if @api_client.config.client_side_validation && account_guid.nil?
|
|
670
|
+
fail ArgumentError, "Missing the required parameter 'account_guid' when calling TransactionsApi.list_transactions_by_account"
|
|
671
|
+
end
|
|
672
|
+
# verify the required parameter 'user_guid' is set
|
|
673
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
674
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.list_transactions_by_account"
|
|
675
|
+
end
|
|
676
|
+
# resource path
|
|
677
|
+
local_var_path = '/users/{user_guid}/accounts/{account_guid}/transactions'.sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
|
678
|
+
|
|
679
|
+
# query parameters
|
|
680
|
+
query_params = opts[:query_params] || {}
|
|
681
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
682
|
+
query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
|
|
683
|
+
query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
|
|
684
|
+
query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
|
|
685
|
+
query_params[:'from_created_at'] = opts[:'from_created_at'] if !opts[:'from_created_at'].nil?
|
|
686
|
+
query_params[:'to_created_at'] = opts[:'to_created_at'] if !opts[:'to_created_at'].nil?
|
|
687
|
+
query_params[:'from_updated_at'] = opts[:'from_updated_at'] if !opts[:'from_updated_at'].nil?
|
|
688
|
+
query_params[:'to_updated_at'] = opts[:'to_updated_at'] if !opts[:'to_updated_at'].nil?
|
|
689
|
+
query_params[:'category_guid'] = opts[:'category_guid'] if !opts[:'category_guid'].nil?
|
|
690
|
+
query_params[:'category_guid[]'] = @api_client.build_collection_param(opts[:'category_guid2'], :multi) if !opts[:'category_guid2'].nil?
|
|
691
|
+
query_params[:'top_level_category_guid'] = opts[:'top_level_category_guid'] if !opts[:'top_level_category_guid'].nil?
|
|
692
|
+
query_params[:'top_level_category_guid[]'] = @api_client.build_collection_param(opts[:'top_level_category_guid2'], :multi) if !opts[:'top_level_category_guid2'].nil?
|
|
693
|
+
query_params[:'includes'] = opts[:'includes'] if !opts[:'includes'].nil?
|
|
694
|
+
|
|
695
|
+
# header parameters
|
|
696
|
+
header_params = opts[:header_params] || {}
|
|
697
|
+
# HTTP header 'Accept' (if needed)
|
|
698
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
|
|
699
|
+
|
|
700
|
+
# form parameters
|
|
701
|
+
form_params = opts[:form_params] || {}
|
|
702
|
+
|
|
703
|
+
# http body (model)
|
|
704
|
+
post_body = opts[:debug_body]
|
|
705
|
+
|
|
706
|
+
# return_type
|
|
707
|
+
return_type = opts[:debug_return_type] || 'TransactionsResponseBodyIncludes'
|
|
708
|
+
|
|
709
|
+
# auth_names
|
|
710
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
711
|
+
|
|
712
|
+
new_options = opts.merge(
|
|
713
|
+
:operation => :"TransactionsApi.list_transactions_by_account",
|
|
714
|
+
:header_params => header_params,
|
|
715
|
+
:query_params => query_params,
|
|
716
|
+
:form_params => form_params,
|
|
717
|
+
:body => post_body,
|
|
718
|
+
:auth_names => auth_names,
|
|
719
|
+
:return_type => return_type
|
|
720
|
+
)
|
|
721
|
+
|
|
722
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
723
|
+
if @api_client.config.debugging
|
|
724
|
+
@api_client.config.logger.debug "API called: TransactionsApi#list_transactions_by_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
725
|
+
end
|
|
726
|
+
return data, status_code, headers
|
|
727
|
+
end
|
|
728
|
+
|
|
729
|
+
# List transactions by member
|
|
730
|
+
# Requests to this endpoint return a list of transactions associated with the specified `member`, across all accounts associated with that `member`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
731
|
+
# @param member_guid [String] The unique id for a `member`.
|
|
732
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
733
|
+
# @param [Hash] opts the optional parameters
|
|
734
|
+
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
735
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
736
|
+
# @option opts [String] :from_date Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
|
|
737
|
+
# @option opts [String] :to_date Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
|
|
738
|
+
# @option opts [String] :from_created_at Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
739
|
+
# @option opts [String] :to_created_at Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
740
|
+
# @option opts [String] :from_updated_at Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
741
|
+
# @option opts [String] :to_updated_at Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
742
|
+
# @option opts [String] :category_guid Filter transactions belonging to specified `category_guid`. For example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
743
|
+
# @option opts [Array<String>] :category_guid2 Filter transactions belonging to any specified `category_guid[]` in url. For example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
744
|
+
# @option opts [String] :top_level_category_guid Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid. For example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
745
|
+
# @option opts [Array<String>] :top_level_category_guid2 Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s). For example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
746
|
+
# @option opts [String] :includes Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
|
|
747
|
+
# @return [TransactionsResponseBodyIncludes]
|
|
748
|
+
def list_transactions_by_member(member_guid, user_guid, opts = {})
|
|
749
|
+
data, _status_code, _headers = list_transactions_by_member_with_http_info(member_guid, user_guid, opts)
|
|
750
|
+
data
|
|
751
|
+
end
|
|
752
|
+
|
|
753
|
+
# List transactions by member
|
|
754
|
+
# Requests to this endpoint return a list of transactions associated with the specified `member`, across all accounts associated with that `member`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
755
|
+
# @param member_guid [String] The unique id for a `member`.
|
|
756
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
757
|
+
# @param [Hash] opts the optional parameters
|
|
758
|
+
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
759
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
760
|
+
# @option opts [String] :from_date Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
|
|
761
|
+
# @option opts [String] :to_date Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
|
|
762
|
+
# @option opts [String] :from_created_at Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
763
|
+
# @option opts [String] :to_created_at Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
764
|
+
# @option opts [String] :from_updated_at Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
765
|
+
# @option opts [String] :to_updated_at Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
766
|
+
# @option opts [String] :category_guid Filter transactions belonging to specified `category_guid`. For example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
767
|
+
# @option opts [Array<String>] :category_guid2 Filter transactions belonging to any specified `category_guid[]` in url. For example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
768
|
+
# @option opts [String] :top_level_category_guid Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid. For example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
769
|
+
# @option opts [Array<String>] :top_level_category_guid2 Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s). For example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
770
|
+
# @option opts [String] :includes Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
|
|
771
|
+
# @return [Array<(TransactionsResponseBodyIncludes, Integer, Hash)>] TransactionsResponseBodyIncludes data, response status code and response headers
|
|
772
|
+
def list_transactions_by_member_with_http_info(member_guid, user_guid, opts = {})
|
|
773
|
+
if @api_client.config.debugging
|
|
774
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.list_transactions_by_member ...'
|
|
775
|
+
end
|
|
776
|
+
# verify the required parameter 'member_guid' is set
|
|
777
|
+
if @api_client.config.client_side_validation && member_guid.nil?
|
|
778
|
+
fail ArgumentError, "Missing the required parameter 'member_guid' when calling TransactionsApi.list_transactions_by_member"
|
|
779
|
+
end
|
|
780
|
+
# verify the required parameter 'user_guid' is set
|
|
781
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
782
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.list_transactions_by_member"
|
|
783
|
+
end
|
|
784
|
+
# resource path
|
|
785
|
+
local_var_path = '/users/{user_guid}/members/{member_guid}/transactions'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
|
786
|
+
|
|
787
|
+
# query parameters
|
|
788
|
+
query_params = opts[:query_params] || {}
|
|
789
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
790
|
+
query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
|
|
791
|
+
query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
|
|
792
|
+
query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
|
|
793
|
+
query_params[:'from_created_at'] = opts[:'from_created_at'] if !opts[:'from_created_at'].nil?
|
|
794
|
+
query_params[:'to_created_at'] = opts[:'to_created_at'] if !opts[:'to_created_at'].nil?
|
|
795
|
+
query_params[:'from_updated_at'] = opts[:'from_updated_at'] if !opts[:'from_updated_at'].nil?
|
|
796
|
+
query_params[:'to_updated_at'] = opts[:'to_updated_at'] if !opts[:'to_updated_at'].nil?
|
|
797
|
+
query_params[:'category_guid'] = opts[:'category_guid'] if !opts[:'category_guid'].nil?
|
|
798
|
+
query_params[:'category_guid[]'] = @api_client.build_collection_param(opts[:'category_guid2'], :multi) if !opts[:'category_guid2'].nil?
|
|
799
|
+
query_params[:'top_level_category_guid'] = opts[:'top_level_category_guid'] if !opts[:'top_level_category_guid'].nil?
|
|
800
|
+
query_params[:'top_level_category_guid[]'] = @api_client.build_collection_param(opts[:'top_level_category_guid2'], :multi) if !opts[:'top_level_category_guid2'].nil?
|
|
801
|
+
query_params[:'includes'] = opts[:'includes'] if !opts[:'includes'].nil?
|
|
802
|
+
|
|
803
|
+
# header parameters
|
|
804
|
+
header_params = opts[:header_params] || {}
|
|
805
|
+
# HTTP header 'Accept' (if needed)
|
|
806
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
|
|
807
|
+
|
|
808
|
+
# form parameters
|
|
809
|
+
form_params = opts[:form_params] || {}
|
|
810
|
+
|
|
811
|
+
# http body (model)
|
|
812
|
+
post_body = opts[:debug_body]
|
|
813
|
+
|
|
814
|
+
# return_type
|
|
815
|
+
return_type = opts[:debug_return_type] || 'TransactionsResponseBodyIncludes'
|
|
816
|
+
|
|
817
|
+
# auth_names
|
|
818
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
819
|
+
|
|
820
|
+
new_options = opts.merge(
|
|
821
|
+
:operation => :"TransactionsApi.list_transactions_by_member",
|
|
822
|
+
:header_params => header_params,
|
|
823
|
+
:query_params => query_params,
|
|
824
|
+
:form_params => form_params,
|
|
825
|
+
:body => post_body,
|
|
826
|
+
:auth_names => auth_names,
|
|
827
|
+
:return_type => return_type
|
|
828
|
+
)
|
|
829
|
+
|
|
830
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
831
|
+
if @api_client.config.debugging
|
|
832
|
+
@api_client.config.logger.debug "API called: TransactionsApi#list_transactions_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
833
|
+
end
|
|
834
|
+
return data, status_code, headers
|
|
835
|
+
end
|
|
836
|
+
|
|
837
|
+
# List transactions by tag
|
|
838
|
+
# Use this endpoint to get a list of all transactions associated with a particular tag according to the tag's unique GUID. This lists all transactions that have been assigned to a particular tag using the create tagging endpoint. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
839
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
840
|
+
# @param tag_guid [String] The unique id for a `tag`.
|
|
841
|
+
# @param [Hash] opts the optional parameters
|
|
842
|
+
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
843
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
844
|
+
# @option opts [String] :from_date Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
|
|
845
|
+
# @option opts [String] :to_date Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
|
|
846
|
+
# @option opts [String] :from_created_at Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
847
|
+
# @option opts [String] :to_created_at Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
848
|
+
# @option opts [String] :from_updated_at Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
849
|
+
# @option opts [String] :to_updated_at Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
850
|
+
# @option opts [String] :category_guid Filter transactions belonging to specified `category_guid`. For example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
851
|
+
# @option opts [Array<String>] :category_guid2 Filter transactions belonging to any specified `category_guid[]` in url. For example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
852
|
+
# @option opts [String] :top_level_category_guid Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid. For example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
853
|
+
# @option opts [Array<String>] :top_level_category_guid2 Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s). For example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
854
|
+
# @option opts [String] :use_case The use case associated with the member. Valid values are `PFM` and `MONEY_MOVEMENT`. For example, you can append either `?use_case=PFM` or `?use_case=MONEY_MOVEMENT`.
|
|
855
|
+
# @option opts [String] :includes Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
|
|
856
|
+
# @return [TransactionsResponseBodyIncludes]
|
|
857
|
+
def list_transactions_by_tag(user_guid, tag_guid, opts = {})
|
|
858
|
+
data, _status_code, _headers = list_transactions_by_tag_with_http_info(user_guid, tag_guid, opts)
|
|
859
|
+
data
|
|
860
|
+
end
|
|
861
|
+
|
|
862
|
+
# List transactions by tag
|
|
863
|
+
# Use this endpoint to get a list of all transactions associated with a particular tag according to the tag's unique GUID. This lists all transactions that have been assigned to a particular tag using the create tagging endpoint. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
864
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
865
|
+
# @param tag_guid [String] The unique id for a `tag`.
|
|
866
|
+
# @param [Hash] opts the optional parameters
|
|
867
|
+
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
868
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
869
|
+
# @option opts [String] :from_date Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
|
|
870
|
+
# @option opts [String] :to_date Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
|
|
871
|
+
# @option opts [String] :from_created_at Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
872
|
+
# @option opts [String] :to_created_at Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
873
|
+
# @option opts [String] :from_updated_at Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
874
|
+
# @option opts [String] :to_updated_at Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
|
|
875
|
+
# @option opts [String] :category_guid Filter transactions belonging to specified `category_guid`. For example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
876
|
+
# @option opts [Array<String>] :category_guid2 Filter transactions belonging to any specified `category_guid[]` in url. For example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
877
|
+
# @option opts [String] :top_level_category_guid Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid. For example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
878
|
+
# @option opts [Array<String>] :top_level_category_guid2 Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s). For example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
|
|
879
|
+
# @option opts [String] :use_case The use case associated with the member. Valid values are `PFM` and `MONEY_MOVEMENT`. For example, you can append either `?use_case=PFM` or `?use_case=MONEY_MOVEMENT`.
|
|
880
|
+
# @option opts [String] :includes Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
|
|
881
|
+
# @return [Array<(TransactionsResponseBodyIncludes, Integer, Hash)>] TransactionsResponseBodyIncludes data, response status code and response headers
|
|
882
|
+
def list_transactions_by_tag_with_http_info(user_guid, tag_guid, opts = {})
|
|
883
|
+
if @api_client.config.debugging
|
|
884
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.list_transactions_by_tag ...'
|
|
885
|
+
end
|
|
886
|
+
# verify the required parameter 'user_guid' is set
|
|
887
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
888
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.list_transactions_by_tag"
|
|
889
|
+
end
|
|
890
|
+
# verify the required parameter 'tag_guid' is set
|
|
891
|
+
if @api_client.config.client_side_validation && tag_guid.nil?
|
|
892
|
+
fail ArgumentError, "Missing the required parameter 'tag_guid' when calling TransactionsApi.list_transactions_by_tag"
|
|
893
|
+
end
|
|
894
|
+
# resource path
|
|
895
|
+
local_var_path = '/users/{user_guid}/tags/{tag_guid}/transactions'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'tag_guid' + '}', CGI.escape(tag_guid.to_s))
|
|
896
|
+
|
|
897
|
+
# query parameters
|
|
898
|
+
query_params = opts[:query_params] || {}
|
|
899
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
900
|
+
query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
|
|
901
|
+
query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
|
|
902
|
+
query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
|
|
903
|
+
query_params[:'from_created_at'] = opts[:'from_created_at'] if !opts[:'from_created_at'].nil?
|
|
904
|
+
query_params[:'to_created_at'] = opts[:'to_created_at'] if !opts[:'to_created_at'].nil?
|
|
905
|
+
query_params[:'from_updated_at'] = opts[:'from_updated_at'] if !opts[:'from_updated_at'].nil?
|
|
906
|
+
query_params[:'to_updated_at'] = opts[:'to_updated_at'] if !opts[:'to_updated_at'].nil?
|
|
907
|
+
query_params[:'category_guid'] = opts[:'category_guid'] if !opts[:'category_guid'].nil?
|
|
908
|
+
query_params[:'category_guid[]'] = @api_client.build_collection_param(opts[:'category_guid2'], :multi) if !opts[:'category_guid2'].nil?
|
|
909
|
+
query_params[:'top_level_category_guid'] = opts[:'top_level_category_guid'] if !opts[:'top_level_category_guid'].nil?
|
|
910
|
+
query_params[:'top_level_category_guid[]'] = @api_client.build_collection_param(opts[:'top_level_category_guid2'], :multi) if !opts[:'top_level_category_guid2'].nil?
|
|
911
|
+
query_params[:'use_case'] = opts[:'use_case'] if !opts[:'use_case'].nil?
|
|
912
|
+
query_params[:'includes'] = opts[:'includes'] if !opts[:'includes'].nil?
|
|
913
|
+
|
|
914
|
+
# header parameters
|
|
915
|
+
header_params = opts[:header_params] || {}
|
|
916
|
+
# HTTP header 'Accept' (if needed)
|
|
917
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
|
|
918
|
+
|
|
919
|
+
# form parameters
|
|
920
|
+
form_params = opts[:form_params] || {}
|
|
921
|
+
|
|
922
|
+
# http body (model)
|
|
923
|
+
post_body = opts[:debug_body]
|
|
924
|
+
|
|
925
|
+
# return_type
|
|
926
|
+
return_type = opts[:debug_return_type] || 'TransactionsResponseBodyIncludes'
|
|
927
|
+
|
|
928
|
+
# auth_names
|
|
929
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
930
|
+
|
|
931
|
+
new_options = opts.merge(
|
|
932
|
+
:operation => :"TransactionsApi.list_transactions_by_tag",
|
|
933
|
+
:header_params => header_params,
|
|
934
|
+
:query_params => query_params,
|
|
935
|
+
:form_params => form_params,
|
|
936
|
+
:body => post_body,
|
|
937
|
+
:auth_names => auth_names,
|
|
938
|
+
:return_type => return_type
|
|
939
|
+
)
|
|
940
|
+
|
|
941
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
942
|
+
if @api_client.config.debugging
|
|
943
|
+
@api_client.config.logger.debug "API called: TransactionsApi#list_transactions_by_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
944
|
+
end
|
|
945
|
+
return data, status_code, headers
|
|
946
|
+
end
|
|
947
|
+
|
|
948
|
+
# Read transaction
|
|
949
|
+
# Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
950
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
951
|
+
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
952
|
+
# @param [Hash] opts the optional parameters
|
|
953
|
+
# @option opts [String] :includes Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
|
|
954
|
+
# @return [TransactionsResponseBodyIncludes]
|
|
955
|
+
def read_transaction(user_guid, transaction_guid, opts = {})
|
|
956
|
+
data, _status_code, _headers = read_transaction_with_http_info(user_guid, transaction_guid, opts)
|
|
957
|
+
data
|
|
958
|
+
end
|
|
959
|
+
|
|
960
|
+
# Read transaction
|
|
961
|
+
# Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
962
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
963
|
+
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
964
|
+
# @param [Hash] opts the optional parameters
|
|
965
|
+
# @option opts [String] :includes Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
|
|
966
|
+
# @return [Array<(TransactionsResponseBodyIncludes, Integer, Hash)>] TransactionsResponseBodyIncludes data, response status code and response headers
|
|
967
|
+
def read_transaction_with_http_info(user_guid, transaction_guid, opts = {})
|
|
968
|
+
if @api_client.config.debugging
|
|
969
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.read_transaction ...'
|
|
970
|
+
end
|
|
971
|
+
# verify the required parameter 'user_guid' is set
|
|
972
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
973
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.read_transaction"
|
|
974
|
+
end
|
|
975
|
+
# verify the required parameter 'transaction_guid' is set
|
|
976
|
+
if @api_client.config.client_side_validation && transaction_guid.nil?
|
|
977
|
+
fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling TransactionsApi.read_transaction"
|
|
978
|
+
end
|
|
979
|
+
# resource path
|
|
980
|
+
local_var_path = '/users/{user_guid}/transactions/{transaction_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s))
|
|
981
|
+
|
|
982
|
+
# query parameters
|
|
983
|
+
query_params = opts[:query_params] || {}
|
|
984
|
+
query_params[:'includes'] = opts[:'includes'] if !opts[:'includes'].nil?
|
|
985
|
+
|
|
986
|
+
# header parameters
|
|
987
|
+
header_params = opts[:header_params] || {}
|
|
988
|
+
# HTTP header 'Accept' (if needed)
|
|
989
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
|
|
990
|
+
|
|
991
|
+
# form parameters
|
|
992
|
+
form_params = opts[:form_params] || {}
|
|
993
|
+
|
|
994
|
+
# http body (model)
|
|
995
|
+
post_body = opts[:debug_body]
|
|
996
|
+
|
|
997
|
+
# return_type
|
|
998
|
+
return_type = opts[:debug_return_type] || 'TransactionsResponseBodyIncludes'
|
|
999
|
+
|
|
1000
|
+
# auth_names
|
|
1001
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
1002
|
+
|
|
1003
|
+
new_options = opts.merge(
|
|
1004
|
+
:operation => :"TransactionsApi.read_transaction",
|
|
1005
|
+
:header_params => header_params,
|
|
1006
|
+
:query_params => query_params,
|
|
1007
|
+
:form_params => form_params,
|
|
1008
|
+
:body => post_body,
|
|
1009
|
+
:auth_names => auth_names,
|
|
1010
|
+
:return_type => return_type
|
|
1011
|
+
)
|
|
1012
|
+
|
|
1013
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1014
|
+
if @api_client.config.debugging
|
|
1015
|
+
@api_client.config.logger.debug "API called: TransactionsApi#read_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1016
|
+
end
|
|
1017
|
+
return data, status_code, headers
|
|
1018
|
+
end
|
|
1019
|
+
|
|
1020
|
+
# List Repeating Transactions
|
|
1021
|
+
# Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx).
|
|
1022
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1023
|
+
# @param [Hash] opts the optional parameters
|
|
1024
|
+
# @return [RepeatingTransactionsResponseBody]
|
|
1025
|
+
def repeating_transactions(user_guid, opts = {})
|
|
1026
|
+
data, _status_code, _headers = repeating_transactions_with_http_info(user_guid, opts)
|
|
1027
|
+
data
|
|
1028
|
+
end
|
|
1029
|
+
|
|
1030
|
+
# List Repeating Transactions
|
|
1031
|
+
# Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx).
|
|
1032
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1033
|
+
# @param [Hash] opts the optional parameters
|
|
1034
|
+
# @return [Array<(RepeatingTransactionsResponseBody, Integer, Hash)>] RepeatingTransactionsResponseBody data, response status code and response headers
|
|
1035
|
+
def repeating_transactions_with_http_info(user_guid, opts = {})
|
|
1036
|
+
if @api_client.config.debugging
|
|
1037
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.repeating_transactions ...'
|
|
1038
|
+
end
|
|
1039
|
+
# verify the required parameter 'user_guid' is set
|
|
1040
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
1041
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.repeating_transactions"
|
|
1042
|
+
end
|
|
1043
|
+
# resource path
|
|
1044
|
+
local_var_path = '/users/{user_guid}/repeating_transactions'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
|
1045
|
+
|
|
1046
|
+
# query parameters
|
|
1047
|
+
query_params = opts[:query_params] || {}
|
|
1048
|
+
|
|
1049
|
+
# header parameters
|
|
1050
|
+
header_params = opts[:header_params] || {}
|
|
1051
|
+
# HTTP header 'Accept' (if needed)
|
|
1052
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
|
|
1053
|
+
|
|
1054
|
+
# form parameters
|
|
1055
|
+
form_params = opts[:form_params] || {}
|
|
1056
|
+
|
|
1057
|
+
# http body (model)
|
|
1058
|
+
post_body = opts[:debug_body]
|
|
1059
|
+
|
|
1060
|
+
# return_type
|
|
1061
|
+
return_type = opts[:debug_return_type] || 'RepeatingTransactionsResponseBody'
|
|
1062
|
+
|
|
1063
|
+
# auth_names
|
|
1064
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
1065
|
+
|
|
1066
|
+
new_options = opts.merge(
|
|
1067
|
+
:operation => :"TransactionsApi.repeating_transactions",
|
|
1068
|
+
:header_params => header_params,
|
|
1069
|
+
:query_params => query_params,
|
|
1070
|
+
:form_params => form_params,
|
|
1071
|
+
:body => post_body,
|
|
1072
|
+
:auth_names => auth_names,
|
|
1073
|
+
:return_type => return_type
|
|
1074
|
+
)
|
|
1075
|
+
|
|
1076
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1077
|
+
if @api_client.config.debugging
|
|
1078
|
+
@api_client.config.logger.debug "API called: TransactionsApi#repeating_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1079
|
+
end
|
|
1080
|
+
return data, status_code, headers
|
|
1081
|
+
end
|
|
1082
|
+
|
|
1083
|
+
# Get a Repeating Transaction
|
|
1084
|
+
# Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx)
|
|
1085
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1086
|
+
# @param repeating_transaction_guid [String] The unique id for a recurring transaction.
|
|
1087
|
+
# @param [Hash] opts the optional parameters
|
|
1088
|
+
# @return [RepeatingTransactionsResponseBody]
|
|
1089
|
+
def specific_repeating_transaction(user_guid, repeating_transaction_guid, opts = {})
|
|
1090
|
+
data, _status_code, _headers = specific_repeating_transaction_with_http_info(user_guid, repeating_transaction_guid, opts)
|
|
1091
|
+
data
|
|
1092
|
+
end
|
|
1093
|
+
|
|
1094
|
+
# Get a Repeating Transaction
|
|
1095
|
+
# Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx)
|
|
1096
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1097
|
+
# @param repeating_transaction_guid [String] The unique id for a recurring transaction.
|
|
1098
|
+
# @param [Hash] opts the optional parameters
|
|
1099
|
+
# @return [Array<(RepeatingTransactionsResponseBody, Integer, Hash)>] RepeatingTransactionsResponseBody data, response status code and response headers
|
|
1100
|
+
def specific_repeating_transaction_with_http_info(user_guid, repeating_transaction_guid, opts = {})
|
|
1101
|
+
if @api_client.config.debugging
|
|
1102
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.specific_repeating_transaction ...'
|
|
1103
|
+
end
|
|
1104
|
+
# verify the required parameter 'user_guid' is set
|
|
1105
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
1106
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.specific_repeating_transaction"
|
|
1107
|
+
end
|
|
1108
|
+
# verify the required parameter 'repeating_transaction_guid' is set
|
|
1109
|
+
if @api_client.config.client_side_validation && repeating_transaction_guid.nil?
|
|
1110
|
+
fail ArgumentError, "Missing the required parameter 'repeating_transaction_guid' when calling TransactionsApi.specific_repeating_transaction"
|
|
1111
|
+
end
|
|
1112
|
+
# resource path
|
|
1113
|
+
local_var_path = '/users/{user_guid}/repeating_transactions/{repeating_transaction_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'repeating_transaction_guid' + '}', CGI.escape(repeating_transaction_guid.to_s))
|
|
1114
|
+
|
|
1115
|
+
# query parameters
|
|
1116
|
+
query_params = opts[:query_params] || {}
|
|
1117
|
+
|
|
1118
|
+
# header parameters
|
|
1119
|
+
header_params = opts[:header_params] || {}
|
|
1120
|
+
# HTTP header 'Accept' (if needed)
|
|
1121
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
|
|
1122
|
+
|
|
1123
|
+
# form parameters
|
|
1124
|
+
form_params = opts[:form_params] || {}
|
|
1125
|
+
|
|
1126
|
+
# http body (model)
|
|
1127
|
+
post_body = opts[:debug_body]
|
|
1128
|
+
|
|
1129
|
+
# return_type
|
|
1130
|
+
return_type = opts[:debug_return_type] || 'RepeatingTransactionsResponseBody'
|
|
1131
|
+
|
|
1132
|
+
# auth_names
|
|
1133
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
1134
|
+
|
|
1135
|
+
new_options = opts.merge(
|
|
1136
|
+
:operation => :"TransactionsApi.specific_repeating_transaction",
|
|
1137
|
+
:header_params => header_params,
|
|
1138
|
+
:query_params => query_params,
|
|
1139
|
+
:form_params => form_params,
|
|
1140
|
+
:body => post_body,
|
|
1141
|
+
:auth_names => auth_names,
|
|
1142
|
+
:return_type => return_type
|
|
1143
|
+
)
|
|
1144
|
+
|
|
1145
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1146
|
+
if @api_client.config.debugging
|
|
1147
|
+
@api_client.config.logger.debug "API called: TransactionsApi#specific_repeating_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1148
|
+
end
|
|
1149
|
+
return data, status_code, headers
|
|
1150
|
+
end
|
|
1151
|
+
|
|
1152
|
+
# Update transaction
|
|
1153
|
+
# Use this endpoint to update a specific transaction according to its unique GUID.
|
|
1154
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1155
|
+
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
1156
|
+
# @param transaction_update_request_body [TransactionUpdateRequestBody] Transaction object with the fields to be updated.
|
|
1157
|
+
# @param [Hash] opts the optional parameters
|
|
1158
|
+
# @return [TransactionResponseBody]
|
|
1159
|
+
def update_transaction(user_guid, transaction_guid, transaction_update_request_body, opts = {})
|
|
1160
|
+
data, _status_code, _headers = update_transaction_with_http_info(user_guid, transaction_guid, transaction_update_request_body, opts)
|
|
1161
|
+
data
|
|
1162
|
+
end
|
|
1163
|
+
|
|
1164
|
+
# Update transaction
|
|
1165
|
+
# Use this endpoint to update a specific transaction according to its unique GUID.
|
|
1166
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1167
|
+
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
1168
|
+
# @param transaction_update_request_body [TransactionUpdateRequestBody] Transaction object with the fields to be updated.
|
|
1169
|
+
# @param [Hash] opts the optional parameters
|
|
1170
|
+
# @return [Array<(TransactionResponseBody, Integer, Hash)>] TransactionResponseBody data, response status code and response headers
|
|
1171
|
+
def update_transaction_with_http_info(user_guid, transaction_guid, transaction_update_request_body, opts = {})
|
|
1172
|
+
if @api_client.config.debugging
|
|
1173
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.update_transaction ...'
|
|
1174
|
+
end
|
|
1175
|
+
# verify the required parameter 'user_guid' is set
|
|
1176
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
1177
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.update_transaction"
|
|
1178
|
+
end
|
|
1179
|
+
# verify the required parameter 'transaction_guid' is set
|
|
1180
|
+
if @api_client.config.client_side_validation && transaction_guid.nil?
|
|
1181
|
+
fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling TransactionsApi.update_transaction"
|
|
1182
|
+
end
|
|
1183
|
+
# verify the required parameter 'transaction_update_request_body' is set
|
|
1184
|
+
if @api_client.config.client_side_validation && transaction_update_request_body.nil?
|
|
1185
|
+
fail ArgumentError, "Missing the required parameter 'transaction_update_request_body' when calling TransactionsApi.update_transaction"
|
|
1186
|
+
end
|
|
1187
|
+
# resource path
|
|
1188
|
+
local_var_path = '/users/{user_guid}/transactions/{transaction_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s))
|
|
1189
|
+
|
|
1190
|
+
# query parameters
|
|
1191
|
+
query_params = opts[:query_params] || {}
|
|
1192
|
+
|
|
1193
|
+
# header parameters
|
|
1194
|
+
header_params = opts[:header_params] || {}
|
|
1195
|
+
# HTTP header 'Accept' (if needed)
|
|
1196
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
|
|
1197
|
+
# HTTP header 'Content-Type'
|
|
1198
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1199
|
+
if !content_type.nil?
|
|
1200
|
+
header_params['Content-Type'] = content_type
|
|
1201
|
+
end
|
|
1202
|
+
|
|
1203
|
+
# form parameters
|
|
1204
|
+
form_params = opts[:form_params] || {}
|
|
1205
|
+
|
|
1206
|
+
# http body (model)
|
|
1207
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction_update_request_body)
|
|
1208
|
+
|
|
1209
|
+
# return_type
|
|
1210
|
+
return_type = opts[:debug_return_type] || 'TransactionResponseBody'
|
|
1211
|
+
|
|
1212
|
+
# auth_names
|
|
1213
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
1214
|
+
|
|
1215
|
+
new_options = opts.merge(
|
|
1216
|
+
:operation => :"TransactionsApi.update_transaction",
|
|
1217
|
+
:header_params => header_params,
|
|
1218
|
+
:query_params => query_params,
|
|
1219
|
+
:form_params => form_params,
|
|
1220
|
+
:body => post_body,
|
|
1221
|
+
:auth_names => auth_names,
|
|
1222
|
+
:return_type => return_type
|
|
1223
|
+
)
|
|
1224
|
+
|
|
1225
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1226
|
+
if @api_client.config.debugging
|
|
1227
|
+
@api_client.config.logger.debug "API called: TransactionsApi#update_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1228
|
+
end
|
|
1229
|
+
return data, status_code, headers
|
|
1230
|
+
end
|
|
1231
|
+
|
|
1232
|
+
# Update Transaction by Account
|
|
1233
|
+
# Use this endpoint to update a specific transaction according to its unique GUID.
|
|
1234
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1235
|
+
# @param member_guid [String] The unique id for a `member`.
|
|
1236
|
+
# @param account_guid [String] The unique id for an `account`.
|
|
1237
|
+
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
1238
|
+
# @param transaction_update_request_body [TransactionUpdateRequestBody] Transaction object to be updated
|
|
1239
|
+
# @param [Hash] opts the optional parameters
|
|
1240
|
+
# @return [TransactionResponseBody]
|
|
1241
|
+
def update_transaction_by_account(user_guid, member_guid, account_guid, transaction_guid, transaction_update_request_body, opts = {})
|
|
1242
|
+
data, _status_code, _headers = update_transaction_by_account_with_http_info(user_guid, member_guid, account_guid, transaction_guid, transaction_update_request_body, opts)
|
|
1243
|
+
data
|
|
1244
|
+
end
|
|
1245
|
+
|
|
1246
|
+
# Update Transaction by Account
|
|
1247
|
+
# Use this endpoint to update a specific transaction according to its unique GUID.
|
|
1248
|
+
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1249
|
+
# @param member_guid [String] The unique id for a `member`.
|
|
1250
|
+
# @param account_guid [String] The unique id for an `account`.
|
|
1251
|
+
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
1252
|
+
# @param transaction_update_request_body [TransactionUpdateRequestBody] Transaction object to be updated
|
|
1253
|
+
# @param [Hash] opts the optional parameters
|
|
1254
|
+
# @return [Array<(TransactionResponseBody, Integer, Hash)>] TransactionResponseBody data, response status code and response headers
|
|
1255
|
+
def update_transaction_by_account_with_http_info(user_guid, member_guid, account_guid, transaction_guid, transaction_update_request_body, opts = {})
|
|
1256
|
+
if @api_client.config.debugging
|
|
1257
|
+
@api_client.config.logger.debug 'Calling API: TransactionsApi.update_transaction_by_account ...'
|
|
1258
|
+
end
|
|
1259
|
+
# verify the required parameter 'user_guid' is set
|
|
1260
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
1261
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.update_transaction_by_account"
|
|
1262
|
+
end
|
|
1263
|
+
# verify the required parameter 'member_guid' is set
|
|
1264
|
+
if @api_client.config.client_side_validation && member_guid.nil?
|
|
1265
|
+
fail ArgumentError, "Missing the required parameter 'member_guid' when calling TransactionsApi.update_transaction_by_account"
|
|
1266
|
+
end
|
|
1267
|
+
# verify the required parameter 'account_guid' is set
|
|
1268
|
+
if @api_client.config.client_side_validation && account_guid.nil?
|
|
1269
|
+
fail ArgumentError, "Missing the required parameter 'account_guid' when calling TransactionsApi.update_transaction_by_account"
|
|
1270
|
+
end
|
|
1271
|
+
# verify the required parameter 'transaction_guid' is set
|
|
1272
|
+
if @api_client.config.client_side_validation && transaction_guid.nil?
|
|
1273
|
+
fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling TransactionsApi.update_transaction_by_account"
|
|
1274
|
+
end
|
|
1275
|
+
# verify the required parameter 'transaction_update_request_body' is set
|
|
1276
|
+
if @api_client.config.client_side_validation && transaction_update_request_body.nil?
|
|
1277
|
+
fail ArgumentError, "Missing the required parameter 'transaction_update_request_body' when calling TransactionsApi.update_transaction_by_account"
|
|
1278
|
+
end
|
|
1279
|
+
# resource path
|
|
1280
|
+
local_var_path = '/users/{user_guid}/members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s)).sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s))
|
|
1281
|
+
|
|
1282
|
+
# query parameters
|
|
1283
|
+
query_params = opts[:query_params] || {}
|
|
1284
|
+
|
|
1285
|
+
# header parameters
|
|
1286
|
+
header_params = opts[:header_params] || {}
|
|
1287
|
+
# HTTP header 'Accept' (if needed)
|
|
1288
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1289
|
+
# HTTP header 'Content-Type'
|
|
1290
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1291
|
+
if !content_type.nil?
|
|
1292
|
+
header_params['Content-Type'] = content_type
|
|
1293
|
+
end
|
|
1294
|
+
|
|
1295
|
+
# form parameters
|
|
1296
|
+
form_params = opts[:form_params] || {}
|
|
1297
|
+
|
|
1298
|
+
# http body (model)
|
|
1299
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction_update_request_body)
|
|
1300
|
+
|
|
1301
|
+
# return_type
|
|
1302
|
+
return_type = opts[:debug_return_type] || 'TransactionResponseBody'
|
|
1303
|
+
|
|
1304
|
+
# auth_names
|
|
1305
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
1306
|
+
|
|
1307
|
+
new_options = opts.merge(
|
|
1308
|
+
:operation => :"TransactionsApi.update_transaction_by_account",
|
|
1309
|
+
:header_params => header_params,
|
|
1310
|
+
:query_params => query_params,
|
|
1311
|
+
:form_params => form_params,
|
|
1312
|
+
:body => post_body,
|
|
1313
|
+
:auth_names => auth_names,
|
|
1314
|
+
:return_type => return_type
|
|
1315
|
+
)
|
|
1316
|
+
|
|
1317
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1318
|
+
if @api_client.config.debugging
|
|
1319
|
+
@api_client.config.logger.debug "API called: TransactionsApi#update_transaction_by_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
98
1320
|
end
|
|
99
1321
|
return data, status_code, headers
|
|
100
1322
|
end
|