fdx-api-sdk-ruby 1.0.0
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 +7 -0
- data/LICENSE +28 -0
- data/README.md +125 -0
- data/lib/fdx_api/api_helper.rb +10 -0
- data/lib/fdx_api/client.rb +187 -0
- data/lib/fdx_api/configuration.rb +133 -0
- data/lib/fdx_api/controllers/account_information_controller.rb +135 -0
- data/lib/fdx_api/controllers/account_statements_controller.rb +132 -0
- data/lib/fdx_api/controllers/account_transactions_controller.rb +126 -0
- data/lib/fdx_api/controllers/base_controller.rb +65 -0
- data/lib/fdx_api/controllers/event_notifications_controller.rb +274 -0
- data/lib/fdx_api/controllers/fraud_notification_controller.rb +37 -0
- data/lib/fdx_api/controllers/internal_transfers_controller.rb +206 -0
- data/lib/fdx_api/controllers/meta_controller.rb +105 -0
- data/lib/fdx_api/controllers/money_movement_controller.rb +92 -0
- data/lib/fdx_api/controllers/payee_management_controller.rb +257 -0
- data/lib/fdx_api/controllers/payment_initiation_parties_controller.rb +439 -0
- data/lib/fdx_api/controllers/payments_controller.rb +280 -0
- data/lib/fdx_api/controllers/payroll_information_controller.rb +117 -0
- data/lib/fdx_api/controllers/personal_information_controller.rb +155 -0
- data/lib/fdx_api/controllers/recipients_controller.rb +197 -0
- data/lib/fdx_api/controllers/recurring_payments_controller.rb +339 -0
- data/lib/fdx_api/controllers/resource_information_controller.rb +121 -0
- data/lib/fdx_api/controllers/reward_program_categories_controller.rb +64 -0
- data/lib/fdx_api/controllers/reward_program_information_controller.rb +88 -0
- data/lib/fdx_api/controllers/submit_tax_forms_controller.rb +106 -0
- data/lib/fdx_api/controllers/tax_forms_controller.rb +190 -0
- data/lib/fdx_api/controllers/user_consent_controller.rb +125 -0
- data/lib/fdx_api/exceptions/api_exception.rb +21 -0
- data/lib/fdx_api/exceptions/error_exception.rb +65 -0
- data/lib/fdx_api/exceptions/payee_entity_error_exception.rb +48 -0
- data/lib/fdx_api/exceptions/payment_entity_error_exception.rb +160 -0
- data/lib/fdx_api/exceptions/recurring_payment_entity_error_exception.rb +140 -0
- data/lib/fdx_api/http/api_response.rb +19 -0
- data/lib/fdx_api/http/auth/bearer_auth.rb +43 -0
- data/lib/fdx_api/http/auth/tax_basic_auth.rb +50 -0
- data/lib/fdx_api/http/http_call_back.rb +10 -0
- data/lib/fdx_api/http/http_method_enum.rb +10 -0
- data/lib/fdx_api/http/http_request.rb +10 -0
- data/lib/fdx_api/http/http_response.rb +10 -0
- data/lib/fdx_api/http/proxy_settings.rb +13 -0
- data/lib/fdx_api/logging/configuration/api_logging_configuration.rb +114 -0
- data/lib/fdx_api/logging/sdk_logger.rb +17 -0
- data/lib/fdx_api/models/account_bill_pay_status.rb +32 -0
- data/lib/fdx_api/models/account_bill_pay_status2.rb +29 -0
- data/lib/fdx_api/models/account_category_type.rb +41 -0
- data/lib/fdx_api/models/account_contact_entity.rb +132 -0
- data/lib/fdx_api/models/account_contact_entity2.rb +142 -0
- data/lib/fdx_api/models/account_descriptor_entity.rb +253 -0
- data/lib/fdx_api/models/account_entity.rb +380 -0
- data/lib/fdx_api/models/account_holder_entity.rb +263 -0
- data/lib/fdx_api/models/account_holder_relationship.rb +79 -0
- data/lib/fdx_api/models/account_holder_relationship1.rb +79 -0
- data/lib/fdx_api/models/account_status.rb +41 -0
- data/lib/fdx_api/models/account_status2.rb +42 -0
- data/lib/fdx_api/models/account_type.rb +240 -0
- data/lib/fdx_api/models/accounts_entity.rb +109 -0
- data/lib/fdx_api/models/active_inactive_status.rb +23 -0
- data/lib/fdx_api/models/active_inactive_status2.rb +23 -0
- data/lib/fdx_api/models/address.rb +151 -0
- data/lib/fdx_api/models/an_array_of_statements.rb +105 -0
- data/lib/fdx_api/models/annuity_account_entity.rb +347 -0
- data/lib/fdx_api/models/array_of_account_payment_networks.rb +104 -0
- data/lib/fdx_api/models/asset_class.rb +38 -0
- data/lib/fdx_api/models/asset_class2.rb +38 -0
- data/lib/fdx_api/models/asset_transfer_network.rb +134 -0
- data/lib/fdx_api/models/asset_transfer_network_list.rb +85 -0
- data/lib/fdx_api/models/asset_transfer_type.rb +26 -0
- data/lib/fdx_api/models/asset_transfer_type2.rb +26 -0
- data/lib/fdx_api/models/availability_entity.rb +115 -0
- data/lib/fdx_api/models/availability_entity1.rb +115 -0
- data/lib/fdx_api/models/availability_list_entity.rb +85 -0
- data/lib/fdx_api/models/availability_status.rb +29 -0
- data/lib/fdx_api/models/availability_status1.rb +29 -0
- data/lib/fdx_api/models/availability_status3.rb +29 -0
- data/lib/fdx_api/models/balance_type.rb +25 -0
- data/lib/fdx_api/models/balance_type2.rb +24 -0
- data/lib/fdx_api/models/base_model.rb +110 -0
- data/lib/fdx_api/models/base_payroll_rate.rb +82 -0
- data/lib/fdx_api/models/base_payroll_rate1.rb +82 -0
- data/lib/fdx_api/models/basic_auth_credentials.rb +105 -0
- data/lib/fdx_api/models/basic_auth_credentials1.rb +105 -0
- data/lib/fdx_api/models/basic_auth_for_qr.rb +96 -0
- data/lib/fdx_api/models/bills_entity.rb +201 -0
- data/lib/fdx_api/models/branch_entity.rb +116 -0
- data/lib/fdx_api/models/branch_entity1.rb +126 -0
- data/lib/fdx_api/models/business_customer_entity.rb +136 -0
- data/lib/fdx_api/models/business_income_statement.rb +604 -0
- data/lib/fdx_api/models/business_name.rb +85 -0
- data/lib/fdx_api/models/business_or_consumer_type.rb +23 -0
- data/lib/fdx_api/models/business_or_consumer_type1.rb +23 -0
- data/lib/fdx_api/models/call_type.rb +29 -0
- data/lib/fdx_api/models/call_type2.rb +29 -0
- data/lib/fdx_api/models/capability_entity.rb +139 -0
- data/lib/fdx_api/models/card_art_entity.rb +91 -0
- data/lib/fdx_api/models/card_art_entity2.rb +101 -0
- data/lib/fdx_api/models/certification_metric_entity.rb +172 -0
- data/lib/fdx_api/models/certification_metrics_entity.rb +84 -0
- data/lib/fdx_api/models/code_and_amount.rb +85 -0
- data/lib/fdx_api/models/commercial_account_entity.rb +457 -0
- data/lib/fdx_api/models/commercial_balance_entity.rb +106 -0
- data/lib/fdx_api/models/commercial_code_entity.rb +91 -0
- data/lib/fdx_api/models/commercial_code_entity1.rb +96 -0
- data/lib/fdx_api/models/commercial_transaction_entity.rb +286 -0
- data/lib/fdx_api/models/compounding_period.rb +38 -0
- data/lib/fdx_api/models/compounding_period2.rb +38 -0
- data/lib/fdx_api/models/consent_duration_type.rb +26 -0
- data/lib/fdx_api/models/consent_grant_entity.rb +232 -0
- data/lib/fdx_api/models/consent_grant_resource_entity.rb +92 -0
- data/lib/fdx_api/models/consent_grant_status.rb +26 -0
- data/lib/fdx_api/models/consent_grant_status1.rb +26 -0
- data/lib/fdx_api/models/consent_grant_status3.rb +26 -0
- data/lib/fdx_api/models/consent_request_entity.rb +121 -0
- data/lib/fdx_api/models/consent_requested_resource_entity.rb +82 -0
- data/lib/fdx_api/models/consent_resource_type.rb +27 -0
- data/lib/fdx_api/models/consent_resource_type1.rb +26 -0
- data/lib/fdx_api/models/consent_resource_type3.rb +26 -0
- data/lib/fdx_api/models/consent_revocation_entity.rb +114 -0
- data/lib/fdx_api/models/consent_revocation_list_entity.rb +85 -0
- data/lib/fdx_api/models/consent_revocation_request_entity.rb +85 -0
- data/lib/fdx_api/models/consent_update_reason.rb +23 -0
- data/lib/fdx_api/models/consent_update_reason1.rb +23 -0
- data/lib/fdx_api/models/contact_preferences_type.rb +32 -0
- data/lib/fdx_api/models/contact_preferences_type2.rb +32 -0
- data/lib/fdx_api/models/contacts_entity.rb +113 -0
- data/lib/fdx_api/models/content_types.rb +38 -0
- data/lib/fdx_api/models/contribution_entity.rb +275 -0
- data/lib/fdx_api/models/coupon_mature_frequency.rb +32 -0
- data/lib/fdx_api/models/coupon_mature_frequency2.rb +32 -0
- data/lib/fdx_api/models/coverage_month.rb +56 -0
- data/lib/fdx_api/models/coverage_month1.rb +56 -0
- data/lib/fdx_api/models/coverage_month3.rb +56 -0
- data/lib/fdx_api/models/cryptocurrency_tax_statement_list.rb +239 -0
- data/lib/fdx_api/models/cryptocurrency_tax_statement_list1.rb +239 -0
- data/lib/fdx_api/models/currency_entity.rb +98 -0
- data/lib/fdx_api/models/currency_entity1.rb +108 -0
- data/lib/fdx_api/models/currency_entity2.rb +108 -0
- data/lib/fdx_api/models/currency_entity4.rb +108 -0
- data/lib/fdx_api/models/customer_entity.rb +241 -0
- data/lib/fdx_api/models/customer_name_entity.rb +134 -0
- data/lib/fdx_api/models/customer_name_entity1.rb +134 -0
- data/lib/fdx_api/models/customer_to_account_relationship_entity.rb +114 -0
- data/lib/fdx_api/models/customers_entity.rb +104 -0
- data/lib/fdx_api/models/data_cluster.rb +63 -0
- data/lib/fdx_api/models/date_and_amount.rb +95 -0
- data/lib/fdx_api/models/debit_credit_memo.rb +26 -0
- data/lib/fdx_api/models/debit_credit_memo2.rb +26 -0
- data/lib/fdx_api/models/debt_class.rb +29 -0
- data/lib/fdx_api/models/debt_class2.rb +29 -0
- data/lib/fdx_api/models/debt_security_entity.rb +209 -0
- data/lib/fdx_api/models/debt_type.rb +23 -0
- data/lib/fdx_api/models/debt_type2.rb +23 -0
- data/lib/fdx_api/models/delivery_address.rb +160 -0
- data/lib/fdx_api/models/delivery_address1.rb +150 -0
- data/lib/fdx_api/models/delivery_address_type.rb +29 -0
- data/lib/fdx_api/models/deposit_account_entity.rb +335 -0
- data/lib/fdx_api/models/deposit_transaction_entity.rb +223 -0
- data/lib/fdx_api/models/deposit_transaction_type.rb +59 -0
- data/lib/fdx_api/models/deposit_transaction_type2.rb +61 -0
- data/lib/fdx_api/models/description_and_amount.rb +85 -0
- data/lib/fdx_api/models/digital_wallet_account_entity.rb +316 -0
- data/lib/fdx_api/models/digital_wallet_transaction_entity.rb +213 -0
- data/lib/fdx_api/models/digital_wallet_transaction_type.rb +59 -0
- data/lib/fdx_api/models/digital_wallet_transaction_type2.rb +61 -0
- data/lib/fdx_api/models/direct_deposit_entity.rb +98 -0
- data/lib/fdx_api/models/document_status.rb +26 -0
- data/lib/fdx_api/models/document_status2.rb +26 -0
- data/lib/fdx_api/models/domicile_entity.rb +95 -0
- data/lib/fdx_api/models/domicile_entity1.rb +95 -0
- data/lib/fdx_api/models/electronic_address_entity.rb +87 -0
- data/lib/fdx_api/models/employee_entity.rb +175 -0
- data/lib/fdx_api/models/employee_entity1.rb +175 -0
- data/lib/fdx_api/models/employer_entity.rb +125 -0
- data/lib/fdx_api/models/employer_entity1.rb +125 -0
- data/lib/fdx_api/models/employment.rb +149 -0
- data/lib/fdx_api/models/employment1.rb +149 -0
- data/lib/fdx_api/models/employment_type.rb +36 -0
- data/lib/fdx_api/models/employment_type2.rb +36 -0
- data/lib/fdx_api/models/error1.rb +113 -0
- data/lib/fdx_api/models/expired_option_type.rb +23 -0
- data/lib/fdx_api/models/expired_option_type2.rb +24 -0
- data/lib/fdx_api/models/external_account_id_scheme_entity.rb +85 -0
- data/lib/fdx_api/models/external_financial_institution_id_scheme_entity.rb +85 -0
- data/lib/fdx_api/models/farm_income_statement.rb +628 -0
- data/lib/fdx_api/models/farm_rental_income_statement.rb +586 -0
- data/lib/fdx_api/models/fdx_api_actor_type.rb +24 -0
- data/lib/fdx_api/models/fdx_jwt_profile.rb +171 -0
- data/lib/fdx_api/models/fdx_oauth_token_introspection_response.rb +180 -0
- data/lib/fdx_api/models/fdx_resource_operation_id.rb +227 -0
- data/lib/fdx_api/models/fdx_resource_operation_id1.rb +227 -0
- data/lib/fdx_api/models/fdx_resource_operation_id3.rb +227 -0
- data/lib/fdx_api/models/fdx_version.rb +119 -0
- data/lib/fdx_api/models/fi_attribute_entity.rb +95 -0
- data/lib/fdx_api/models/fi_portion_entity.rb +95 -0
- data/lib/fdx_api/models/financial_institution_entity.rb +116 -0
- data/lib/fdx_api/models/financial_institution_entity2.rb +116 -0
- data/lib/fdx_api/models/form1041_k1.rb +572 -0
- data/lib/fdx_api/models/form1041_k11.rb +570 -0
- data/lib/fdx_api/models/form1042_s.rb +541 -0
- data/lib/fdx_api/models/form1042_s1.rb +539 -0
- data/lib/fdx_api/models/form1042_s_agent.rb +207 -0
- data/lib/fdx_api/models/form1042_s_agent1.rb +196 -0
- data/lib/fdx_api/models/form1042_s_agent2.rb +196 -0
- data/lib/fdx_api/models/form1042_s_agent3.rb +196 -0
- data/lib/fdx_api/models/form1042_s_agent4.rb +196 -0
- data/lib/fdx_api/models/form1042_s_recipient.rb +216 -0
- data/lib/fdx_api/models/form1042_s_recipient1.rb +216 -0
- data/lib/fdx_api/models/form1065_k1.rb +1177 -0
- data/lib/fdx_api/models/form1065_k11.rb +1176 -0
- data/lib/fdx_api/models/form1095_a.rb +364 -0
- data/lib/fdx_api/models/form1095_a1.rb +364 -0
- data/lib/fdx_api/models/form1095_b.rb +281 -0
- data/lib/fdx_api/models/form1095_b1.rb +280 -0
- data/lib/fdx_api/models/form1095_c.rb +294 -0
- data/lib/fdx_api/models/form1095_c1.rb +293 -0
- data/lib/fdx_api/models/form1097_btc.rb +314 -0
- data/lib/fdx_api/models/form1097_btc1.rb +313 -0
- data/lib/fdx_api/models/form1098.rb +388 -0
- data/lib/fdx_api/models/form10981.rb +387 -0
- data/lib/fdx_api/models/form1098_c.rb +421 -0
- data/lib/fdx_api/models/form1098_c1.rb +420 -0
- data/lib/fdx_api/models/form1098_e.rb +255 -0
- data/lib/fdx_api/models/form1098_e1.rb +254 -0
- data/lib/fdx_api/models/form1098_ma.rb +276 -0
- data/lib/fdx_api/models/form1098_ma1.rb +275 -0
- data/lib/fdx_api/models/form1098_q.rb +338 -0
- data/lib/fdx_api/models/form1098_q1.rb +337 -0
- data/lib/fdx_api/models/form1098_t.rb +338 -0
- data/lib/fdx_api/models/form1098_t1.rb +337 -0
- data/lib/fdx_api/models/form1099_a.rb +289 -0
- data/lib/fdx_api/models/form1099_a1.rb +288 -0
- data/lib/fdx_api/models/form1099_b.rb +368 -0
- data/lib/fdx_api/models/form1099_b1.rb +367 -0
- data/lib/fdx_api/models/form1099_c.rb +310 -0
- data/lib/fdx_api/models/form1099_c1.rb +309 -0
- data/lib/fdx_api/models/form1099_cap.rb +274 -0
- data/lib/fdx_api/models/form1099_cap1.rb +273 -0
- data/lib/fdx_api/models/form1099_consolidated_statement.rb +327 -0
- data/lib/fdx_api/models/form1099_consolidated_statement1.rb +325 -0
- data/lib/fdx_api/models/form1099_div.rb +538 -0
- data/lib/fdx_api/models/form1099_div1.rb +537 -0
- data/lib/fdx_api/models/form1099_g.rb +363 -0
- data/lib/fdx_api/models/form1099_g1.rb +362 -0
- data/lib/fdx_api/models/form1099_h.rb +263 -0
- data/lib/fdx_api/models/form1099_h1.rb +262 -0
- data/lib/fdx_api/models/form1099_int.rb +488 -0
- data/lib/fdx_api/models/form1099_int1.rb +487 -0
- data/lib/fdx_api/models/form1099_k.rb +413 -0
- data/lib/fdx_api/models/form1099_k1.rb +412 -0
- data/lib/fdx_api/models/form1099_ls.rb +274 -0
- data/lib/fdx_api/models/form1099_ls1.rb +273 -0
- data/lib/fdx_api/models/form1099_ltc.rb +339 -0
- data/lib/fdx_api/models/form1099_ltc1.rb +338 -0
- data/lib/fdx_api/models/form1099_misc.rb +438 -0
- data/lib/fdx_api/models/form1099_misc1.rb +437 -0
- data/lib/fdx_api/models/form1099_nec.rb +301 -0
- data/lib/fdx_api/models/form1099_nec1.rb +300 -0
- data/lib/fdx_api/models/form1099_oid.rb +431 -0
- data/lib/fdx_api/models/form1099_oid1.rb +430 -0
- data/lib/fdx_api/models/form1099_patr.rb +421 -0
- data/lib/fdx_api/models/form1099_patr1.rb +420 -0
- data/lib/fdx_api/models/form1099_q.rb +335 -0
- data/lib/fdx_api/models/form1099_q1.rb +334 -0
- data/lib/fdx_api/models/form1099_qa.rb +295 -0
- data/lib/fdx_api/models/form1099_qa1.rb +294 -0
- data/lib/fdx_api/models/form1099_r.rb +475 -0
- data/lib/fdx_api/models/form1099_r1.rb +474 -0
- data/lib/fdx_api/models/form1099_s.rb +306 -0
- data/lib/fdx_api/models/form1099_s1.rb +305 -0
- data/lib/fdx_api/models/form1099_sa.rb +306 -0
- data/lib/fdx_api/models/form1099_sa1.rb +305 -0
- data/lib/fdx_api/models/form1099_sb.rb +267 -0
- data/lib/fdx_api/models/form1099_sb1.rb +266 -0
- data/lib/fdx_api/models/form1120_sk1.rb +670 -0
- data/lib/fdx_api/models/form1120_sk11.rb +669 -0
- data/lib/fdx_api/models/form2439.rb +306 -0
- data/lib/fdx_api/models/form24391.rb +305 -0
- data/lib/fdx_api/models/form3921.rb +298 -0
- data/lib/fdx_api/models/form39211.rb +297 -0
- data/lib/fdx_api/models/form3922.rb +327 -0
- data/lib/fdx_api/models/form39221.rb +326 -0
- data/lib/fdx_api/models/form5498.rb +486 -0
- data/lib/fdx_api/models/form54981.rb +485 -0
- data/lib/fdx_api/models/form5498_esa.rb +258 -0
- data/lib/fdx_api/models/form5498_esa1.rb +257 -0
- data/lib/fdx_api/models/form5498_qa.rb +311 -0
- data/lib/fdx_api/models/form5498_qa1.rb +310 -0
- data/lib/fdx_api/models/form5498_sa.rb +321 -0
- data/lib/fdx_api/models/form5498_sa1.rb +320 -0
- data/lib/fdx_api/models/form_w2.rb +459 -0
- data/lib/fdx_api/models/form_w21.rb +458 -0
- data/lib/fdx_api/models/form_w22.rb +458 -0
- data/lib/fdx_api/models/form_w24.rb +458 -0
- data/lib/fdx_api/models/form_w2_c.rb +276 -0
- data/lib/fdx_api/models/form_w2_c2.rb +275 -0
- data/lib/fdx_api/models/form_w2_g.rb +354 -0
- data/lib/fdx_api/models/form_w2_g2.rb +353 -0
- data/lib/fdx_api/models/gain_or_loss_from_cryptocurrency_transaction.rb +173 -0
- data/lib/fdx_api/models/generic_account_identification_entity.rb +107 -0
- data/lib/fdx_api/models/generic_financial_institution_id_entity.rb +107 -0
- data/lib/fdx_api/models/government_issued_id_type.rb +23 -0
- data/lib/fdx_api/models/government_issued_id_type2.rb +23 -0
- data/lib/fdx_api/models/government_issued_party_identification_entity.rb +118 -0
- data/lib/fdx_api/models/hateoas_link.rb +119 -0
- data/lib/fdx_api/models/health_insurance_coverage.rb +115 -0
- data/lib/fdx_api/models/health_insurance_covered_individual.rb +118 -0
- data/lib/fdx_api/models/health_insurance_marketplace_covered_individual.rb +119 -0
- data/lib/fdx_api/models/held_in_account.rb +29 -0
- data/lib/fdx_api/models/held_in_account2.rb +29 -0
- data/lib/fdx_api/models/holding_entity.rb +448 -0
- data/lib/fdx_api/models/holding_sub_type.rb +23 -0
- data/lib/fdx_api/models/holding_sub_type2.rb +23 -0
- data/lib/fdx_api/models/holding_type.rb +51 -0
- data/lib/fdx_api/models/holding_type2.rb +41 -0
- data/lib/fdx_api/models/http_action_type.rb +32 -0
- data/lib/fdx_api/models/iban2007_identifier_entity.rb +86 -0
- data/lib/fdx_api/models/income.rb +124 -0
- data/lib/fdx_api/models/income_type.rb +26 -0
- data/lib/fdx_api/models/income_type2.rb +27 -0
- data/lib/fdx_api/models/incoming_and_outgoing_transfer_limits.rb +85 -0
- data/lib/fdx_api/models/incoming_and_outgoing_transfer_limits2.rb +85 -0
- data/lib/fdx_api/models/individual_name.rb +115 -0
- data/lib/fdx_api/models/industry_classification_system.rb +38 -0
- data/lib/fdx_api/models/industry_code.rb +95 -0
- data/lib/fdx_api/models/insurance_account_entity.rb +326 -0
- data/lib/fdx_api/models/insurance_transaction_entity.rb +201 -0
- data/lib/fdx_api/models/insurance_transaction_type.rb +29 -0
- data/lib/fdx_api/models/interest_rate_type.rb +23 -0
- data/lib/fdx_api/models/interest_rate_type2.rb +23 -0
- data/lib/fdx_api/models/intermediary.rb +139 -0
- data/lib/fdx_api/models/investment401_k_source_type.rb +38 -0
- data/lib/fdx_api/models/investment401_k_source_type1.rb +40 -0
- data/lib/fdx_api/models/investment401_k_source_type2.rb +39 -0
- data/lib/fdx_api/models/investment401_k_source_type4.rb +39 -0
- data/lib/fdx_api/models/investment_account_entity.rb +548 -0
- data/lib/fdx_api/models/investment_balance_entity.rb +138 -0
- data/lib/fdx_api/models/investment_balance_type.rb +23 -0
- data/lib/fdx_api/models/investment_balance_type2.rb +23 -0
- data/lib/fdx_api/models/investment_loan_entity.rb +261 -0
- data/lib/fdx_api/models/investment_sale_type.rb +38 -0
- data/lib/fdx_api/models/investment_transaction_entity.rb +669 -0
- data/lib/fdx_api/models/investment_transaction_type.rb +155 -0
- data/lib/fdx_api/models/investment_transaction_type2.rb +161 -0
- data/lib/fdx_api/models/investment_transfer_action_direction.rb +23 -0
- data/lib/fdx_api/models/investment_transfer_action_direction2.rb +23 -0
- data/lib/fdx_api/models/iso3166_country_code.rb +764 -0
- data/lib/fdx_api/models/iso3166_country_code1.rb +764 -0
- data/lib/fdx_api/models/iso3166_country_code2.rb +764 -0
- data/lib/fdx_api/models/iso4217_currency_code.rb +560 -0
- data/lib/fdx_api/models/iso4217_currency_code1.rb +560 -0
- data/lib/fdx_api/models/iso4217_currency_code2.rb +560 -0
- data/lib/fdx_api/models/iso93622014_business_identifier_code_entity.rb +93 -0
- data/lib/fdx_api/models/iso93622022_business_identifier_code_entity.rb +91 -0
- data/lib/fdx_api/models/line_item_entity.rb +156 -0
- data/lib/fdx_api/models/line_of_credit_account_entity.rb +474 -0
- data/lib/fdx_api/models/line_of_credit_transaction_entity.rb +223 -0
- data/lib/fdx_api/models/line_of_credit_transaction_type.rb +38 -0
- data/lib/fdx_api/models/line_of_credit_transaction_type2.rb +38 -0
- data/lib/fdx_api/models/loan_account_entity.rb +432 -0
- data/lib/fdx_api/models/loan_payment_frequency.rb +47 -0
- data/lib/fdx_api/models/loan_payment_frequency2.rb +48 -0
- data/lib/fdx_api/models/loan_transaction_entity.rb +212 -0
- data/lib/fdx_api/models/loan_transaction_type.rb +49 -0
- data/lib/fdx_api/models/loan_transaction_type2.rb +41 -0
- data/lib/fdx_api/models/local_tax_withholding.rb +96 -0
- data/lib/fdx_api/models/local_tax_withholding1.rb +96 -0
- data/lib/fdx_api/models/merchant_entity.rb +159 -0
- data/lib/fdx_api/models/merchant_entity1.rb +159 -0
- data/lib/fdx_api/models/merchant_for_update_entity.rb +118 -0
- data/lib/fdx_api/models/merchant_for_update_entity1.rb +118 -0
- data/lib/fdx_api/models/message_format.rb +20 -0
- data/lib/fdx_api/models/message_format2.rb +20 -0
- data/lib/fdx_api/models/monetary_amount.rb +84 -0
- data/lib/fdx_api/models/monetary_amount1.rb +84 -0
- data/lib/fdx_api/models/monetary_amount2.rb +84 -0
- data/lib/fdx_api/models/monetary_amount3.rb +84 -0
- data/lib/fdx_api/models/monetary_amount4.rb +84 -0
- data/lib/fdx_api/models/monetary_amount5.rb +84 -0
- data/lib/fdx_api/models/monetary_amount6.rb +84 -0
- data/lib/fdx_api/models/month_abbreviation.rb +53 -0
- data/lib/fdx_api/models/month_abbreviation1.rb +53 -0
- data/lib/fdx_api/models/month_and_amount.rb +85 -0
- data/lib/fdx_api/models/mutual_fund_security_entity.rb +161 -0
- data/lib/fdx_api/models/mutual_fund_type.rb +26 -0
- data/lib/fdx_api/models/mutual_fund_type2.rb +26 -0
- data/lib/fdx_api/models/name_address_and_phone.rb +171 -0
- data/lib/fdx_api/models/name_address_and_phone1.rb +171 -0
- data/lib/fdx_api/models/name_and_address.rb +159 -0
- data/lib/fdx_api/models/notification_category.rb +32 -0
- data/lib/fdx_api/models/notification_category1.rb +32 -0
- data/lib/fdx_api/models/notification_entity.rb +169 -0
- data/lib/fdx_api/models/notification_payload_entity.rb +95 -0
- data/lib/fdx_api/models/notification_payload_entity2.rb +95 -0
- data/lib/fdx_api/models/notification_payload_id_type.rb +32 -0
- data/lib/fdx_api/models/notification_payload_id_type2.rb +32 -0
- data/lib/fdx_api/models/notification_priority.rb +26 -0
- data/lib/fdx_api/models/notification_priority2.rb +26 -0
- data/lib/fdx_api/models/notification_severity.rb +32 -0
- data/lib/fdx_api/models/notification_severity2.rb +32 -0
- data/lib/fdx_api/models/notification_subscription_entity.rb +123 -0
- data/lib/fdx_api/models/notification_type.rb +38 -0
- data/lib/fdx_api/models/notifications_entity.rb +104 -0
- data/lib/fdx_api/models/occurrence_based_limits_for_a_payment_network.rb +95 -0
- data/lib/fdx_api/models/occurrence_based_limits_for_a_payment_network2.rb +94 -0
- data/lib/fdx_api/models/offer_of_health_insurance_coverage.rb +119 -0
- data/lib/fdx_api/models/open_order_entity.rb +231 -0
- data/lib/fdx_api/models/operation_entity.rb +150 -0
- data/lib/fdx_api/models/option_security_entity.rb +135 -0
- data/lib/fdx_api/models/option_type.rb +23 -0
- data/lib/fdx_api/models/option_type2.rb +23 -0
- data/lib/fdx_api/models/order_duration.rb +26 -0
- data/lib/fdx_api/models/order_duration2.rb +26 -0
- data/lib/fdx_api/models/order_type.rb +41 -0
- data/lib/fdx_api/models/order_type2.rb +42 -0
- data/lib/fdx_api/models/organization_name_entity.rb +87 -0
- data/lib/fdx_api/models/other_monetary_amount.rb +94 -0
- data/lib/fdx_api/models/other_security_entity.rb +94 -0
- data/lib/fdx_api/models/page_metadata.rb +108 -0
- data/lib/fdx_api/models/page_metadata_links.rb +95 -0
- data/lib/fdx_api/models/page_metadata_links1.rb +85 -0
- data/lib/fdx_api/models/party_entity.rb +139 -0
- data/lib/fdx_api/models/party_group_entity.rb +86 -0
- data/lib/fdx_api/models/party_status.rb +33 -0
- data/lib/fdx_api/models/party_status1.rb +29 -0
- data/lib/fdx_api/models/party_status3.rb +29 -0
- data/lib/fdx_api/models/party_type.rb +35 -0
- data/lib/fdx_api/models/party_type1.rb +35 -0
- data/lib/fdx_api/models/party_type2.rb +35 -0
- data/lib/fdx_api/models/payee_entity.rb +75 -0
- data/lib/fdx_api/models/payee_for_update_entity.rb +74 -0
- data/lib/fdx_api/models/payee_for_update_entity1.rb +74 -0
- data/lib/fdx_api/models/payees_entity.rb +113 -0
- data/lib/fdx_api/models/payment_amounts.rb +133 -0
- data/lib/fdx_api/models/payment_amounts1.rb +92 -0
- data/lib/fdx_api/models/payment_amounts2.rb +133 -0
- data/lib/fdx_api/models/payment_amounts3.rb +92 -0
- data/lib/fdx_api/models/payment_delivery_address_entity.rb +99 -0
- data/lib/fdx_api/models/payment_details_entity.rb +142 -0
- data/lib/fdx_api/models/payment_entity.rb +262 -0
- data/lib/fdx_api/models/payment_for_update_entity.rb +113 -0
- data/lib/fdx_api/models/payment_for_update_entity1.rb +113 -0
- data/lib/fdx_api/models/payment_for_update_entity2.rb +113 -0
- data/lib/fdx_api/models/payment_frequency.rb +38 -0
- data/lib/fdx_api/models/payment_frequency1.rb +38 -0
- data/lib/fdx_api/models/payment_frequency3.rb +38 -0
- data/lib/fdx_api/models/payment_generic_account_entity.rb +138 -0
- data/lib/fdx_api/models/payment_generic_account_entity1.rb +138 -0
- data/lib/fdx_api/models/payment_generic_account_entity2.rb +138 -0
- data/lib/fdx_api/models/payment_initiation_parties_entity.rb +108 -0
- data/lib/fdx_api/models/payment_initiation_party_contact_method_entity.rb +97 -0
- data/lib/fdx_api/models/payment_initiation_party_create_response_entity.rb +85 -0
- data/lib/fdx_api/models/payment_initiation_party_entity.rb +292 -0
- data/lib/fdx_api/models/payment_initiation_party_method_create_response_entity.rb +78 -0
- data/lib/fdx_api/models/payment_initiation_party_name_entity.rb +98 -0
- data/lib/fdx_api/models/payment_initiation_party_name_entity1.rb +97 -0
- data/lib/fdx_api/models/payment_initiation_party_name_entity3.rb +97 -0
- data/lib/fdx_api/models/payment_initiation_party_summary_entity.rb +90 -0
- data/lib/fdx_api/models/payment_initiation_party_to_payment_method_entity.rb +130 -0
- data/lib/fdx_api/models/payment_method_credit_account_entity.rb +111 -0
- data/lib/fdx_api/models/payment_method_debit_account_entity.rb +100 -0
- data/lib/fdx_api/models/payment_method_entity.rb +139 -0
- data/lib/fdx_api/models/payment_method_entity2.rb +149 -0
- data/lib/fdx_api/models/payment_method_id.rb +96 -0
- data/lib/fdx_api/models/payment_method_system_code.rb +90 -0
- data/lib/fdx_api/models/payment_method_system_proprietary.rb +85 -0
- data/lib/fdx_api/models/payment_network_identifier_type.rb +23 -0
- data/lib/fdx_api/models/payment_network_identifier_type1.rb +23 -0
- data/lib/fdx_api/models/payment_network_identifier_type3.rb +23 -0
- data/lib/fdx_api/models/payment_network_supported_by_account.rb +161 -0
- data/lib/fdx_api/models/payment_network_type.rb +43 -0
- data/lib/fdx_api/models/payment_network_type2.rb +39 -0
- data/lib/fdx_api/models/payment_status.rb +41 -0
- data/lib/fdx_api/models/payment_status1.rb +35 -0
- data/lib/fdx_api/models/payment_status3.rb +35 -0
- data/lib/fdx_api/models/payments_entity.rb +113 -0
- data/lib/fdx_api/models/payout_mode.rb +41 -0
- data/lib/fdx_api/models/payout_mode2.rb +38 -0
- data/lib/fdx_api/models/payout_type.rb +26 -0
- data/lib/fdx_api/models/payout_type2.rb +23 -0
- data/lib/fdx_api/models/payroll_frequency_type.rb +50 -0
- data/lib/fdx_api/models/payroll_frequency_type2.rb +50 -0
- data/lib/fdx_api/models/payroll_rate_type.rb +29 -0
- data/lib/fdx_api/models/payroll_rate_type2.rb +29 -0
- data/lib/fdx_api/models/payroll_report_entity.rb +162 -0
- data/lib/fdx_api/models/payroll_report_list_entity.rb +103 -0
- data/lib/fdx_api/models/payroll_report_summary_entity.rb +160 -0
- data/lib/fdx_api/models/payroll_report_type.rb +24 -0
- data/lib/fdx_api/models/payroll_report_type1.rb +23 -0
- data/lib/fdx_api/models/pension_source_entity.rb +136 -0
- data/lib/fdx_api/models/period_certain_type.rb +36 -0
- data/lib/fdx_api/models/period_certain_type2.rb +33 -0
- data/lib/fdx_api/models/planned_availability_entity.rb +122 -0
- data/lib/fdx_api/models/policy_premium_term_type.rb +23 -0
- data/lib/fdx_api/models/policy_premium_term_type2.rb +23 -0
- data/lib/fdx_api/models/policy_product_type.rb +26 -0
- data/lib/fdx_api/models/policy_product_type2.rb +23 -0
- data/lib/fdx_api/models/policy_status.rb +52 -0
- data/lib/fdx_api/models/policy_status2.rb +41 -0
- data/lib/fdx_api/models/portion_entity.rb +95 -0
- data/lib/fdx_api/models/position_type.rb +23 -0
- data/lib/fdx_api/models/position_type1.rb +23 -0
- data/lib/fdx_api/models/proprietary_account_id_scheme_entity.rb +88 -0
- data/lib/fdx_api/models/proprietary_financial_institution_id_scheme_entity.rb +86 -0
- data/lib/fdx_api/models/recipient_provider.rb +293 -0
- data/lib/fdx_api/models/recipient_record_at_ecosystem_registry.rb +223 -0
- data/lib/fdx_api/models/recipient_records_at_ecosystem_registry.rb +105 -0
- data/lib/fdx_api/models/recipient_request.rb +214 -0
- data/lib/fdx_api/models/recurring_payment_duration_entity.rb +86 -0
- data/lib/fdx_api/models/recurring_payment_duration_entity2.rb +86 -0
- data/lib/fdx_api/models/recurring_payment_duration_type.rb +24 -0
- data/lib/fdx_api/models/recurring_payment_duration_type2.rb +23 -0
- data/lib/fdx_api/models/recurring_payment_entity.rb +231 -0
- data/lib/fdx_api/models/recurring_payment_for_update_entity.rb +133 -0
- data/lib/fdx_api/models/recurring_payment_for_update_entity1.rb +132 -0
- data/lib/fdx_api/models/recurring_payment_for_update_entity2.rb +132 -0
- data/lib/fdx_api/models/recurring_payment_frequency.rb +46 -0
- data/lib/fdx_api/models/recurring_payment_frequency2.rb +44 -0
- data/lib/fdx_api/models/recurring_payment_status.rb +33 -0
- data/lib/fdx_api/models/recurring_payment_status2.rb +29 -0
- data/lib/fdx_api/models/recurring_payments_entity.rb +113 -0
- data/lib/fdx_api/models/registry.rb +30 -0
- data/lib/fdx_api/models/registry_reference.rb +102 -0
- data/lib/fdx_api/models/rental_income_statement.rb +424 -0
- data/lib/fdx_api/models/resource_entity.rb +114 -0
- data/lib/fdx_api/models/resource_list_entity.rb +104 -0
- data/lib/fdx_api/models/resource_status.rb +26 -0
- data/lib/fdx_api/models/resource_status2.rb +26 -0
- data/lib/fdx_api/models/result_type.rb +26 -0
- data/lib/fdx_api/models/reward_balance_entity.rb +144 -0
- data/lib/fdx_api/models/reward_categories_entity.rb +104 -0
- data/lib/fdx_api/models/reward_category_entity.rb +136 -0
- data/lib/fdx_api/models/reward_program_entity.rb +136 -0
- data/lib/fdx_api/models/reward_program_membership_entity.rb +147 -0
- data/lib/fdx_api/models/reward_programs_entity.rb +104 -0
- data/lib/fdx_api/models/reward_type.rb +30 -0
- data/lib/fdx_api/models/reward_type2.rb +26 -0
- data/lib/fdx_api/models/royalty_income_statement.rb +424 -0
- data/lib/fdx_api/models/sale_proceeds_type.rb +23 -0
- data/lib/fdx_api/models/sale_proceeds_type2.rb +23 -0
- data/lib/fdx_api/models/secured.rb +23 -0
- data/lib/fdx_api/models/secured2.rb +23 -0
- data/lib/fdx_api/models/security_category.rb +35 -0
- data/lib/fdx_api/models/security_detail_irs_form1099_b.rb +390 -0
- data/lib/fdx_api/models/security_entity.rb +96 -0
- data/lib/fdx_api/models/security_id_entity.rb +95 -0
- data/lib/fdx_api/models/security_id_type.rb +60 -0
- data/lib/fdx_api/models/security_id_type1.rb +50 -0
- data/lib/fdx_api/models/security_type.rb +51 -0
- data/lib/fdx_api/models/security_type2.rb +41 -0
- data/lib/fdx_api/models/state_and_local_tax_withholding.rb +95 -0
- data/lib/fdx_api/models/state_and_local_tax_withholding1.rb +95 -0
- data/lib/fdx_api/models/state_and_local_tax_withholding2.rb +95 -0
- data/lib/fdx_api/models/state_code.rb +203 -0
- data/lib/fdx_api/models/state_tax_withholding.rb +95 -0
- data/lib/fdx_api/models/state_tax_withholding2.rb +95 -0
- data/lib/fdx_api/models/statement_entity.rb +135 -0
- data/lib/fdx_api/models/stock_security_entity.rb +147 -0
- data/lib/fdx_api/models/stock_type.rb +29 -0
- data/lib/fdx_api/models/stock_type2.rb +29 -0
- data/lib/fdx_api/models/sub_account_type.rb +29 -0
- data/lib/fdx_api/models/sub_account_type1.rb +29 -0
- data/lib/fdx_api/models/sub_account_type2.rb +29 -0
- data/lib/fdx_api/models/sub_account_type4.rb +29 -0
- data/lib/fdx_api/models/supplemental_status.rb +44 -0
- data/lib/fdx_api/models/supplemental_status2.rb +44 -0
- data/lib/fdx_api/models/suspected_fraud_incident_entity.rb +133 -0
- data/lib/fdx_api/models/sweep_security_entity.rb +135 -0
- data/lib/fdx_api/models/synchronizable_array_entity.rb +96 -0
- data/lib/fdx_api/models/synchronizable_array_links_entity.rb +95 -0
- data/lib/fdx_api/models/synchronizable_array_links_entity2.rb +95 -0
- data/lib/fdx_api/models/tax.rb +218 -0
- data/lib/fdx_api/models/tax_data.rb +653 -0
- data/lib/fdx_api/models/tax_data_for_qr.rb +675 -0
- data/lib/fdx_api/models/tax_form_attribute.rb +106 -0
- data/lib/fdx_api/models/tax_lot_entity.rb +140 -0
- data/lib/fdx_api/models/tax_party.rb +138 -0
- data/lib/fdx_api/models/tax_party1.rb +140 -0
- data/lib/fdx_api/models/tax_party2.rb +138 -0
- data/lib/fdx_api/models/tax_party3.rb +138 -0
- data/lib/fdx_api/models/tax_party4.rb +139 -0
- data/lib/fdx_api/models/tax_party6.rb +140 -0
- data/lib/fdx_api/models/tax_party7.rb +140 -0
- data/lib/fdx_api/models/tax_party8.rb +139 -0
- data/lib/fdx_api/models/tax_party_type.rb +23 -0
- data/lib/fdx_api/models/tax_party_type2.rb +24 -0
- data/lib/fdx_api/models/tax_refund_direct_deposit.rb +108 -0
- data/lib/fdx_api/models/tax_refund_direct_deposit2.rb +108 -0
- data/lib/fdx_api/models/tax_statement.rb +174 -0
- data/lib/fdx_api/models/tax_statement1.rb +175 -0
- data/lib/fdx_api/models/tax_statement2.rb +175 -0
- data/lib/fdx_api/models/tax_statement4.rb +175 -0
- data/lib/fdx_api/models/tax_statement6.rb +175 -0
- data/lib/fdx_api/models/tax_statement_list.rb +85 -0
- data/lib/fdx_api/models/telephone_number.rb +105 -0
- data/lib/fdx_api/models/telephone_number_plus_extension.rb +105 -0
- data/lib/fdx_api/models/telephone_number_plus_extension1.rb +105 -0
- data/lib/fdx_api/models/telephone_number_plus_extension2.rb +105 -0
- data/lib/fdx_api/models/telephone_number_type.rb +29 -0
- data/lib/fdx_api/models/time_and_occurrence_based_transfer_limits.rb +115 -0
- data/lib/fdx_api/models/time_and_occurrence_based_transfer_limits1.rb +115 -0
- data/lib/fdx_api/models/time_and_occurrence_based_transfer_limits3.rb +115 -0
- data/lib/fdx_api/models/timeframe_based_limits_for_a_payment_network.rb +139 -0
- data/lib/fdx_api/models/timeframe_based_limits_for_a_payment_network1.rb +138 -0
- data/lib/fdx_api/models/timeframe_based_limits_for_a_payment_network2.rb +138 -0
- data/lib/fdx_api/models/timeframe_based_limits_for_a_payment_network3.rb +138 -0
- data/lib/fdx_api/models/timeframe_based_limits_for_a_payment_network5.rb +138 -0
- data/lib/fdx_api/models/transaction.rb +357 -0
- data/lib/fdx_api/models/transaction_reason.rb +26 -0
- data/lib/fdx_api/models/transaction_reason2.rb +27 -0
- data/lib/fdx_api/models/transaction_reward_entity.rb +97 -0
- data/lib/fdx_api/models/transaction_reward_entity2.rb +107 -0
- data/lib/fdx_api/models/transaction_status.rb +29 -0
- data/lib/fdx_api/models/transaction_status2.rb +29 -0
- data/lib/fdx_api/models/transactions_entity.rb +109 -0
- data/lib/fdx_api/models/transfer_entity.rb +169 -0
- data/lib/fdx_api/models/transfer_for_create_entity.rb +129 -0
- data/lib/fdx_api/models/transfer_for_create_entity1.rb +129 -0
- data/lib/fdx_api/models/transfers_entity.rb +113 -0
- data/lib/fdx_api/models/treasury_management_type.rb +30 -0
- data/lib/fdx_api/models/type_data_type.rb +26 -0
- data/lib/fdx_api/models/type_data_type2.rb +24 -0
- data/lib/fdx_api/models/type_form_type.rb +176 -0
- data/lib/fdx_api/models/type_form_type1.rb +176 -0
- data/lib/fdx_api/models/unit_type.rb +23 -0
- data/lib/fdx_api/models/unit_type1.rb +23 -0
- data/lib/fdx_api/models/unit_type3.rb +23 -0
- data/lib/fdx_api/models/updates_metadata_entity.rb +77 -0
- data/lib/fdx_api/models/updates_metadata_entity2.rb +77 -0
- data/lib/fdx_api/models/vesting_entity.rb +186 -0
- data/lib/fdx_api/utilities/date_time_helper.rb +11 -0
- data/lib/fdx_api/utilities/file_wrapper.rb +28 -0
- data/lib/fdx_api/utilities/union_type_lookup.rb +240 -0
- data/lib/fdx_api.rb +661 -0
- metadata +717 -0
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# fdx_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
module FdxApi
|
|
7
|
+
# Payee to whom funds can be transferred. Can be extended to support
|
|
8
|
+
# additional types of payees
|
|
9
|
+
class PayeeEntityErrorException < APIException
|
|
10
|
+
SKIP = Object.new
|
|
11
|
+
private_constant :SKIP
|
|
12
|
+
|
|
13
|
+
# When payee is a merchant, typically a business from which goods or
|
|
14
|
+
# services are rendered, this field will be populated
|
|
15
|
+
# @return [MerchantEntity1]
|
|
16
|
+
attr_accessor :merchant
|
|
17
|
+
|
|
18
|
+
# The constructor.
|
|
19
|
+
# @param [String] reason The reason for raising an exception.
|
|
20
|
+
# @param [HttpResponse] response The HttpReponse of the API call.
|
|
21
|
+
def initialize(reason, response)
|
|
22
|
+
super(reason, response)
|
|
23
|
+
hash = APIHelper.json_deserialize(@response.raw_body)
|
|
24
|
+
unbox(hash)
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Populates this object by extracting properties from a hash.
|
|
28
|
+
# @param [Hash] hash The deserialized response sent by the server in the
|
|
29
|
+
# response body.
|
|
30
|
+
def unbox(hash)
|
|
31
|
+
return nil unless hash
|
|
32
|
+
|
|
33
|
+
@merchant = MerchantEntity1.from_hash(hash['merchant']) if hash['merchant']
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Provides a human-readable string representation of the object.
|
|
37
|
+
def to_s
|
|
38
|
+
class_name = self.class.name.split('::').last
|
|
39
|
+
"<#{class_name} merchant: #{@merchant}>"
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# Provides a debugging-friendly string with detailed object information.
|
|
43
|
+
def inspect
|
|
44
|
+
class_name = self.class.name.split('::').last
|
|
45
|
+
"<#{class_name} merchant: #{@merchant.inspect}>"
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
end
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
# fdx_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
require 'date'
|
|
7
|
+
module FdxApi
|
|
8
|
+
# Represents a payment
|
|
9
|
+
class PaymentEntityErrorException < APIException
|
|
10
|
+
SKIP = Object.new
|
|
11
|
+
private_constant :SKIP
|
|
12
|
+
|
|
13
|
+
# ID of the account used to source funds for payment
|
|
14
|
+
# @return [String]
|
|
15
|
+
attr_accessor :from_account_id
|
|
16
|
+
|
|
17
|
+
# ID of the payee to receive funds for the payment
|
|
18
|
+
# @return [String]
|
|
19
|
+
attr_accessor :to_payee_id
|
|
20
|
+
|
|
21
|
+
# Amount for the payment. Must be positive
|
|
22
|
+
# @return [Float]
|
|
23
|
+
attr_accessor :amount
|
|
24
|
+
|
|
25
|
+
# User's account identifier with the merchant
|
|
26
|
+
# @return [String]
|
|
27
|
+
attr_accessor :merchant_account_id
|
|
28
|
+
|
|
29
|
+
# Date that the funds are scheduled to be delivered
|
|
30
|
+
# @return [Date]
|
|
31
|
+
attr_accessor :due_date
|
|
32
|
+
|
|
33
|
+
# Uniquely identifies a payment. Used within the API to reference a payment
|
|
34
|
+
# @return [String]
|
|
35
|
+
attr_accessor :payment_id
|
|
36
|
+
|
|
37
|
+
# The recurring payment that spawned this payment. Null if payment is not
|
|
38
|
+
# associated with a recurring payment
|
|
39
|
+
# @return [String]
|
|
40
|
+
attr_accessor :recurring_payment_id
|
|
41
|
+
|
|
42
|
+
# When the payment was scheduled
|
|
43
|
+
# @return [DateTime]
|
|
44
|
+
attr_accessor :scheduled_timestamp
|
|
45
|
+
|
|
46
|
+
# When the payment was processed
|
|
47
|
+
# @return [DateTime]
|
|
48
|
+
attr_accessor :processed_timestamp
|
|
49
|
+
|
|
50
|
+
# When the payment failed. Includes when the payment was determined to lack
|
|
51
|
+
# sufficient funds
|
|
52
|
+
# @return [DateTime]
|
|
53
|
+
attr_accessor :failed_timestamp
|
|
54
|
+
|
|
55
|
+
# When the payment was cancelled
|
|
56
|
+
# @return [DateTime]
|
|
57
|
+
attr_accessor :cancelled_timestamp
|
|
58
|
+
|
|
59
|
+
# When the payment execution started
|
|
60
|
+
# @return [DateTime]
|
|
61
|
+
attr_accessor :started_processing_timestamp
|
|
62
|
+
|
|
63
|
+
# Defines the status of the payment
|
|
64
|
+
# @return [PaymentStatus3]
|
|
65
|
+
attr_accessor :status
|
|
66
|
+
|
|
67
|
+
# Links to related payment entities
|
|
68
|
+
# @return [Array[HateoasLink]]
|
|
69
|
+
attr_accessor :links
|
|
70
|
+
|
|
71
|
+
# The constructor.
|
|
72
|
+
# @param [String] reason The reason for raising an exception.
|
|
73
|
+
# @param [HttpResponse] response The HttpReponse of the API call.
|
|
74
|
+
def initialize(reason, response)
|
|
75
|
+
super(reason, response)
|
|
76
|
+
hash = APIHelper.json_deserialize(@response.raw_body)
|
|
77
|
+
unbox(hash)
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# Populates this object by extracting properties from a hash.
|
|
81
|
+
# @param [Hash] hash The deserialized response sent by the server in the
|
|
82
|
+
# response body.
|
|
83
|
+
def unbox(hash)
|
|
84
|
+
return nil unless hash
|
|
85
|
+
|
|
86
|
+
@from_account_id =
|
|
87
|
+
hash.key?('fromAccountId') ? hash['fromAccountId'] : nil
|
|
88
|
+
@to_payee_id = hash.key?('toPayeeId') ? hash['toPayeeId'] : nil
|
|
89
|
+
@amount = hash.key?('amount') ? hash['amount'] : nil
|
|
90
|
+
@merchant_account_id =
|
|
91
|
+
hash.key?('merchantAccountId') ? hash['merchantAccountId'] : SKIP
|
|
92
|
+
@due_date = hash.key?('dueDate') ? hash['dueDate'] : nil
|
|
93
|
+
@payment_id = hash.key?('paymentId') ? hash['paymentId'] : nil
|
|
94
|
+
@recurring_payment_id =
|
|
95
|
+
hash.key?('recurringPaymentId') ? hash['recurringPaymentId'] : SKIP
|
|
96
|
+
@scheduled_timestamp = if hash.key?('scheduledTimestamp')
|
|
97
|
+
(DateTimeHelper.from_rfc3339(hash['scheduledTimestamp']) if hash['scheduledTimestamp'])
|
|
98
|
+
else
|
|
99
|
+
SKIP
|
|
100
|
+
end
|
|
101
|
+
@processed_timestamp = if hash.key?('processedTimestamp')
|
|
102
|
+
(DateTimeHelper.from_rfc3339(hash['processedTimestamp']) if hash['processedTimestamp'])
|
|
103
|
+
else
|
|
104
|
+
SKIP
|
|
105
|
+
end
|
|
106
|
+
@failed_timestamp = if hash.key?('failedTimestamp')
|
|
107
|
+
(DateTimeHelper.from_rfc3339(hash['failedTimestamp']) if hash['failedTimestamp'])
|
|
108
|
+
else
|
|
109
|
+
SKIP
|
|
110
|
+
end
|
|
111
|
+
@cancelled_timestamp = if hash.key?('cancelledTimestamp')
|
|
112
|
+
(DateTimeHelper.from_rfc3339(hash['cancelledTimestamp']) if hash['cancelledTimestamp'])
|
|
113
|
+
else
|
|
114
|
+
SKIP
|
|
115
|
+
end
|
|
116
|
+
@started_processing_timestamp = if hash.key?('startedProcessingTimestamp')
|
|
117
|
+
(DateTimeHelper.from_rfc3339(hash['startedProcessingTimestamp']) if hash['startedProcessingTimestamp'])
|
|
118
|
+
else
|
|
119
|
+
SKIP
|
|
120
|
+
end
|
|
121
|
+
@status = hash.key?('status') ? hash['status'] : nil
|
|
122
|
+
# Parameter is an array, so we need to iterate through it
|
|
123
|
+
@links = nil
|
|
124
|
+
unless hash['links'].nil?
|
|
125
|
+
@links = []
|
|
126
|
+
hash['links'].each do |structure|
|
|
127
|
+
@links << (HateoasLink.from_hash(structure) if structure)
|
|
128
|
+
end
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
@links = SKIP unless hash.key?('links')
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
# Provides a human-readable string representation of the object.
|
|
135
|
+
def to_s
|
|
136
|
+
class_name = self.class.name.split('::').last
|
|
137
|
+
"<#{class_name} from_account_id: #{@from_account_id}, to_payee_id: #{@to_payee_id}, amount:"\
|
|
138
|
+
" #{@amount}, merchant_account_id: #{@merchant_account_id}, due_date: #{@due_date},"\
|
|
139
|
+
" payment_id: #{@payment_id}, recurring_payment_id: #{@recurring_payment_id},"\
|
|
140
|
+
" scheduled_timestamp: #{@scheduled_timestamp}, processed_timestamp:"\
|
|
141
|
+
" #{@processed_timestamp}, failed_timestamp: #{@failed_timestamp}, cancelled_timestamp:"\
|
|
142
|
+
" #{@cancelled_timestamp}, started_processing_timestamp: #{@started_processing_timestamp},"\
|
|
143
|
+
" status: #{@status}, links: #{@links}>"
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
# Provides a debugging-friendly string with detailed object information.
|
|
147
|
+
def inspect
|
|
148
|
+
class_name = self.class.name.split('::').last
|
|
149
|
+
"<#{class_name} from_account_id: #{@from_account_id.inspect}, to_payee_id:"\
|
|
150
|
+
" #{@to_payee_id.inspect}, amount: #{@amount.inspect}, merchant_account_id:"\
|
|
151
|
+
" #{@merchant_account_id.inspect}, due_date: #{@due_date.inspect}, payment_id:"\
|
|
152
|
+
" #{@payment_id.inspect}, recurring_payment_id: #{@recurring_payment_id.inspect},"\
|
|
153
|
+
" scheduled_timestamp: #{@scheduled_timestamp.inspect}, processed_timestamp:"\
|
|
154
|
+
" #{@processed_timestamp.inspect}, failed_timestamp: #{@failed_timestamp.inspect},"\
|
|
155
|
+
" cancelled_timestamp: #{@cancelled_timestamp.inspect}, started_processing_timestamp:"\
|
|
156
|
+
" #{@started_processing_timestamp.inspect}, status: #{@status.inspect}, links:"\
|
|
157
|
+
" #{@links.inspect}>"
|
|
158
|
+
end
|
|
159
|
+
end
|
|
160
|
+
end
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# fdx_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
require 'date'
|
|
7
|
+
module FdxApi
|
|
8
|
+
# A recurring payment. Financial institution is free to adjust the payment
|
|
9
|
+
# date to accommodate weekends and holidays
|
|
10
|
+
class RecurringPaymentEntityErrorException < APIException
|
|
11
|
+
SKIP = Object.new
|
|
12
|
+
private_constant :SKIP
|
|
13
|
+
|
|
14
|
+
# Defines how often the payment repeats
|
|
15
|
+
# @return [RecurringPaymentFrequency2]
|
|
16
|
+
attr_accessor :frequency
|
|
17
|
+
|
|
18
|
+
# Defines how long the payment repeats for
|
|
19
|
+
# @return [RecurringPaymentDurationEntity2]
|
|
20
|
+
attr_accessor :duration
|
|
21
|
+
|
|
22
|
+
# ID of the account used to source funds for payment
|
|
23
|
+
# @return [String]
|
|
24
|
+
attr_accessor :from_account_id
|
|
25
|
+
|
|
26
|
+
# ID of the payee to receive funds for the payment
|
|
27
|
+
# @return [String]
|
|
28
|
+
attr_accessor :to_payee_id
|
|
29
|
+
|
|
30
|
+
# Amount for the payment. Must be positive
|
|
31
|
+
# @return [Float]
|
|
32
|
+
attr_accessor :amount
|
|
33
|
+
|
|
34
|
+
# User's account identifier with the merchant
|
|
35
|
+
# @return [String]
|
|
36
|
+
attr_accessor :merchant_account_id
|
|
37
|
+
|
|
38
|
+
# Date that the funds are scheduled to be delivered
|
|
39
|
+
# @return [Date]
|
|
40
|
+
attr_accessor :due_date
|
|
41
|
+
|
|
42
|
+
# Uniquely identifies a recurring payment. Used within the API to reference
|
|
43
|
+
# a recurring payment
|
|
44
|
+
# @return [String]
|
|
45
|
+
attr_accessor :recurring_payment_id
|
|
46
|
+
|
|
47
|
+
# When the recurring payment was scheduled
|
|
48
|
+
# @return [DateTime]
|
|
49
|
+
attr_accessor :scheduled_timestamp
|
|
50
|
+
|
|
51
|
+
# When the recurring payment was cancelled
|
|
52
|
+
# @return [DateTime]
|
|
53
|
+
attr_accessor :cancelled_timestamp
|
|
54
|
+
|
|
55
|
+
# When the last payment executed
|
|
56
|
+
# @return [DateTime]
|
|
57
|
+
attr_accessor :processed_timestamp
|
|
58
|
+
|
|
59
|
+
# When the recurring payment failed
|
|
60
|
+
# @return [DateTime]
|
|
61
|
+
attr_accessor :failed_timestamp
|
|
62
|
+
|
|
63
|
+
# Defines the status of the recurring payment
|
|
64
|
+
# @return [RecurringPaymentStatus2]
|
|
65
|
+
attr_accessor :status
|
|
66
|
+
|
|
67
|
+
# The constructor.
|
|
68
|
+
# @param [String] reason The reason for raising an exception.
|
|
69
|
+
# @param [HttpResponse] response The HttpReponse of the API call.
|
|
70
|
+
def initialize(reason, response)
|
|
71
|
+
super(reason, response)
|
|
72
|
+
hash = APIHelper.json_deserialize(@response.raw_body)
|
|
73
|
+
unbox(hash)
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# Populates this object by extracting properties from a hash.
|
|
77
|
+
# @param [Hash] hash The deserialized response sent by the server in the
|
|
78
|
+
# response body.
|
|
79
|
+
def unbox(hash)
|
|
80
|
+
return nil unless hash
|
|
81
|
+
|
|
82
|
+
@frequency = hash.key?('frequency') ? hash['frequency'] : nil
|
|
83
|
+
@duration = RecurringPaymentDurationEntity2.from_hash(hash['duration']) if hash['duration']
|
|
84
|
+
@from_account_id =
|
|
85
|
+
hash.key?('fromAccountId') ? hash['fromAccountId'] : nil
|
|
86
|
+
@to_payee_id = hash.key?('toPayeeId') ? hash['toPayeeId'] : nil
|
|
87
|
+
@amount = hash.key?('amount') ? hash['amount'] : nil
|
|
88
|
+
@merchant_account_id =
|
|
89
|
+
hash.key?('merchantAccountId') ? hash['merchantAccountId'] : SKIP
|
|
90
|
+
@due_date = hash.key?('dueDate') ? hash['dueDate'] : nil
|
|
91
|
+
@recurring_payment_id =
|
|
92
|
+
hash.key?('recurringPaymentId') ? hash['recurringPaymentId'] : SKIP
|
|
93
|
+
@scheduled_timestamp = if hash.key?('scheduledTimestamp')
|
|
94
|
+
(DateTimeHelper.from_rfc3339(hash['scheduledTimestamp']) if hash['scheduledTimestamp'])
|
|
95
|
+
else
|
|
96
|
+
SKIP
|
|
97
|
+
end
|
|
98
|
+
@cancelled_timestamp = if hash.key?('cancelledTimestamp')
|
|
99
|
+
(DateTimeHelper.from_rfc3339(hash['cancelledTimestamp']) if hash['cancelledTimestamp'])
|
|
100
|
+
else
|
|
101
|
+
SKIP
|
|
102
|
+
end
|
|
103
|
+
@processed_timestamp = if hash.key?('processedTimestamp')
|
|
104
|
+
(DateTimeHelper.from_rfc3339(hash['processedTimestamp']) if hash['processedTimestamp'])
|
|
105
|
+
else
|
|
106
|
+
SKIP
|
|
107
|
+
end
|
|
108
|
+
@failed_timestamp = if hash.key?('failedTimestamp')
|
|
109
|
+
(DateTimeHelper.from_rfc3339(hash['failedTimestamp']) if hash['failedTimestamp'])
|
|
110
|
+
else
|
|
111
|
+
SKIP
|
|
112
|
+
end
|
|
113
|
+
@status = hash.key?('status') ? hash['status'] : nil
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
# Provides a human-readable string representation of the object.
|
|
117
|
+
def to_s
|
|
118
|
+
class_name = self.class.name.split('::').last
|
|
119
|
+
"<#{class_name} frequency: #{@frequency}, duration: #{@duration}, from_account_id:"\
|
|
120
|
+
" #{@from_account_id}, to_payee_id: #{@to_payee_id}, amount: #{@amount},"\
|
|
121
|
+
" merchant_account_id: #{@merchant_account_id}, due_date: #{@due_date},"\
|
|
122
|
+
" recurring_payment_id: #{@recurring_payment_id}, scheduled_timestamp:"\
|
|
123
|
+
" #{@scheduled_timestamp}, cancelled_timestamp: #{@cancelled_timestamp},"\
|
|
124
|
+
" processed_timestamp: #{@processed_timestamp}, failed_timestamp: #{@failed_timestamp},"\
|
|
125
|
+
" status: #{@status}>"
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# Provides a debugging-friendly string with detailed object information.
|
|
129
|
+
def inspect
|
|
130
|
+
class_name = self.class.name.split('::').last
|
|
131
|
+
"<#{class_name} frequency: #{@frequency.inspect}, duration: #{@duration.inspect},"\
|
|
132
|
+
" from_account_id: #{@from_account_id.inspect}, to_payee_id: #{@to_payee_id.inspect},"\
|
|
133
|
+
" amount: #{@amount.inspect}, merchant_account_id: #{@merchant_account_id.inspect},"\
|
|
134
|
+
" due_date: #{@due_date.inspect}, recurring_payment_id: #{@recurring_payment_id.inspect},"\
|
|
135
|
+
" scheduled_timestamp: #{@scheduled_timestamp.inspect}, cancelled_timestamp:"\
|
|
136
|
+
" #{@cancelled_timestamp.inspect}, processed_timestamp: #{@processed_timestamp.inspect},"\
|
|
137
|
+
" failed_timestamp: #{@failed_timestamp.inspect}, status: #{@status.inspect}>"
|
|
138
|
+
end
|
|
139
|
+
end
|
|
140
|
+
end
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# fdx_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
module FdxApi
|
|
7
|
+
# Http response received.
|
|
8
|
+
class ApiResponse < CoreLibrary::ApiResponse
|
|
9
|
+
# The constructor
|
|
10
|
+
# @param [HttpResponse] http_response The original, raw response from the api.
|
|
11
|
+
# @param [Object] data The data field specified for the response.
|
|
12
|
+
# @param [Array<String>] errors Any errors returned by the server.
|
|
13
|
+
def initialize(http_response,
|
|
14
|
+
data: nil,
|
|
15
|
+
errors: nil)
|
|
16
|
+
super
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# fdx_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
module FdxApi
|
|
7
|
+
# Utility class for OAuth 2 authorization and token management.
|
|
8
|
+
class BearerAuth < CoreLibrary::HeaderAuth
|
|
9
|
+
include CoreLibrary
|
|
10
|
+
# Display error message on occurrence of authentication failure.
|
|
11
|
+
# @returns [String] The oAuth error message.
|
|
12
|
+
def error_message
|
|
13
|
+
'BearerAuth: access_token is undefined.'
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
# Initialization constructor.
|
|
17
|
+
def initialize(bearer_auth_credentials)
|
|
18
|
+
auth_params = {}
|
|
19
|
+
@_access_token = bearer_auth_credentials.access_token unless
|
|
20
|
+
bearer_auth_credentials.nil? || bearer_auth_credentials.access_token.nil?
|
|
21
|
+
auth_params[:Authorization] = "Bearer #{@_access_token}" unless @_access_token.nil?
|
|
22
|
+
|
|
23
|
+
super auth_params
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Data class for BearerAuthCredentials.
|
|
28
|
+
class BearerAuthCredentials
|
|
29
|
+
attr_reader :access_token
|
|
30
|
+
|
|
31
|
+
def initialize(access_token:)
|
|
32
|
+
raise ArgumentError, 'access_token cannot be nil' if access_token.nil?
|
|
33
|
+
|
|
34
|
+
@access_token = access_token
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
def clone_with(access_token: nil)
|
|
38
|
+
access_token ||= self.access_token
|
|
39
|
+
|
|
40
|
+
BearerAuthCredentials.new(access_token: access_token)
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# fdx_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
module FdxApi
|
|
7
|
+
# Utility class for basic authorization.
|
|
8
|
+
class TaxBasicAuth < CoreLibrary::HeaderAuth
|
|
9
|
+
include CoreLibrary
|
|
10
|
+
# Display error message on occurrence of authentication failure.
|
|
11
|
+
# @returns [String] The oAuth error message.
|
|
12
|
+
def error_message
|
|
13
|
+
'TaxBasicAuth: username or password is undefined.'
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
# Initialization constructor.
|
|
17
|
+
def initialize(tax_basic_auth_credentials)
|
|
18
|
+
auth_params = {}
|
|
19
|
+
unless tax_basic_auth_credentials.nil? ||
|
|
20
|
+
tax_basic_auth_credentials.username.nil? ||
|
|
21
|
+
tax_basic_auth_credentials.password.nil?
|
|
22
|
+
auth_params['Authorization'] =
|
|
23
|
+
"Basic #{AuthHelper.get_base64_encoded_value(tax_basic_auth_credentials.username,
|
|
24
|
+
tax_basic_auth_credentials.password)}"
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
super auth_params
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Data class for TaxBasicAuthCredentials.
|
|
32
|
+
class TaxBasicAuthCredentials
|
|
33
|
+
attr_reader :username, :password
|
|
34
|
+
|
|
35
|
+
def initialize(username:, password:)
|
|
36
|
+
raise ArgumentError, 'username cannot be nil' if username.nil?
|
|
37
|
+
raise ArgumentError, 'password cannot be nil' if password.nil?
|
|
38
|
+
|
|
39
|
+
@username = username
|
|
40
|
+
@password = password
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
def clone_with(username: nil, password: nil)
|
|
44
|
+
username ||= self.username
|
|
45
|
+
password ||= self.password
|
|
46
|
+
|
|
47
|
+
TaxBasicAuthCredentials.new(username: username, password: password)
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
end
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# fdx_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
module FdxApi
|
|
7
|
+
##
|
|
8
|
+
# ProxySettings encapsulates HTTP proxy configuration for Faraday,
|
|
9
|
+
# including optional basic authentication.
|
|
10
|
+
#
|
|
11
|
+
class ProxySettings < CoreLibrary::ProxySettings
|
|
12
|
+
end
|
|
13
|
+
end
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# fdx_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
module FdxApi
|
|
7
|
+
# Initializes a new instance of RequestLoggingConfiguration.
|
|
8
|
+
class RequestLoggingConfiguration < CoreLibrary::ApiRequestLoggingConfiguration
|
|
9
|
+
# @param log_body [Boolean] Indicates whether the message body should be logged. Default is false.
|
|
10
|
+
# @param log_headers [Boolean] Indicates whether the message headers should be logged. Default is false.
|
|
11
|
+
# @param headers_to_exclude [Array<String>] Array of headers not displayed in logging. Default is an empty array.
|
|
12
|
+
# @param headers_to_include [Array<String>] Array of headers to be displayed in logging. Default is an empty array.
|
|
13
|
+
# @param headers_to_unmask [Array<String>] Array of headers which values are non-sensitive to display in logging.
|
|
14
|
+
# Default is an empty array.
|
|
15
|
+
def initialize(log_body: false, log_headers: false, headers_to_include: nil,
|
|
16
|
+
headers_to_exclude: nil, headers_to_unmask: nil,
|
|
17
|
+
include_query_in_path: false)
|
|
18
|
+
super(
|
|
19
|
+
log_body,
|
|
20
|
+
log_headers,
|
|
21
|
+
headers_to_exclude,
|
|
22
|
+
headers_to_include,
|
|
23
|
+
headers_to_unmask,
|
|
24
|
+
include_query_in_path
|
|
25
|
+
)
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
|
|
29
|
+
headers_to_exclude: nil, headers_to_unmask: nil, include_query_in_path: nil)
|
|
30
|
+
log_body ||= self.log_body
|
|
31
|
+
log_headers ||= self.log_headers
|
|
32
|
+
headers_to_include ||= self.headers_to_include
|
|
33
|
+
headers_to_exclude ||= self.headers_to_exclude
|
|
34
|
+
headers_to_unmask ||= self.headers_to_unmask
|
|
35
|
+
include_query_in_path ||= self.include_query_in_path
|
|
36
|
+
|
|
37
|
+
RequestLoggingConfiguration.class.new(log_body: log_body, log_headers: log_headers,
|
|
38
|
+
headers_to_include: headers_to_include,
|
|
39
|
+
headers_to_exclude: headers_to_exclude,
|
|
40
|
+
headers_to_unmask: headers_to_unmask,
|
|
41
|
+
include_query_in_path: include_query_in_path)
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# Initializes a new instance of ResponseLoggingConfiguration.
|
|
46
|
+
class ResponseLoggingConfiguration < CoreLibrary::ApiResponseLoggingConfiguration
|
|
47
|
+
# @param log_body [Boolean] Indicates whether the message body should be logged. Default is false.
|
|
48
|
+
# @param log_headers [Boolean] Indicates whether the message headers should be logged. Default is false.
|
|
49
|
+
# @param headers_to_exclude [Array<String>] Array of headers not displayed in logging. Default is an empty array.
|
|
50
|
+
# @param headers_to_include [Array<String>] Array of headers to be displayed in logging. Default is an empty array.
|
|
51
|
+
# @param headers_to_unmask [Array<String>] Array of headers which values are non-sensitive to display in logging.
|
|
52
|
+
# Default is an empty array.
|
|
53
|
+
def initialize(log_body: false, log_headers: false, headers_to_include: nil,
|
|
54
|
+
headers_to_exclude: nil, headers_to_unmask: nil)
|
|
55
|
+
super(
|
|
56
|
+
log_body,
|
|
57
|
+
log_headers,
|
|
58
|
+
headers_to_exclude,
|
|
59
|
+
headers_to_include,
|
|
60
|
+
headers_to_unmask
|
|
61
|
+
)
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
|
|
65
|
+
headers_to_exclude: nil, headers_to_unmask: nil)
|
|
66
|
+
log_body ||= self.log_body
|
|
67
|
+
log_headers ||= self.log_headers
|
|
68
|
+
headers_to_include ||= self.headers_to_include
|
|
69
|
+
headers_to_exclude ||= self.headers_to_exclude
|
|
70
|
+
headers_to_unmask ||= self.headers_to_unmask
|
|
71
|
+
|
|
72
|
+
ResponseLoggingConfiguration.new(log_body: log_body, log_headers: log_headers,
|
|
73
|
+
headers_to_include: headers_to_include,
|
|
74
|
+
headers_to_exclude: headers_to_exclude,
|
|
75
|
+
headers_to_unmask: headers_to_unmask)
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Initializes a new instance of LoggingConfiguration.
|
|
80
|
+
class LoggingConfiguration < CoreLibrary::ApiLoggingConfiguration
|
|
81
|
+
# @param logger [LoggerInterface] The logger to use for logging messages.
|
|
82
|
+
# @param log_level [LogLevel] The log level to determine which messages should be logged.
|
|
83
|
+
# @param request_logging_config [RequestLoggingConfiguration] Options for logging HTTP requests.
|
|
84
|
+
# @param response_logging_config [ResponseLoggingConfiguration] Options for logging HTTP responses.
|
|
85
|
+
# @param mask_sensitive_headers [Boolean] Indicates whether sensitive headers should be masked in logged messages.
|
|
86
|
+
def initialize(logger: nil, log_level: nil, mask_sensitive_headers: true,
|
|
87
|
+
request_logging_config: nil,
|
|
88
|
+
response_logging_config: nil)
|
|
89
|
+
request_logging_config ||= RequestLoggingConfiguration.new
|
|
90
|
+
response_logging_config ||= ResponseLoggingConfiguration.new
|
|
91
|
+
super(
|
|
92
|
+
logger,
|
|
93
|
+
log_level,
|
|
94
|
+
request_logging_config,
|
|
95
|
+
response_logging_config,
|
|
96
|
+
mask_sensitive_headers
|
|
97
|
+
)
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
def clone_with(logger: nil, log_level: nil, mask_sensitive_headers: nil,
|
|
101
|
+
request_logging_config: nil, response_logging_config: nil)
|
|
102
|
+
logger ||= self.logger
|
|
103
|
+
log_level ||= self.log_level
|
|
104
|
+
mask_sensitive_headers = self.mask_sensitive_headers ||= mask_sensitive_headers
|
|
105
|
+
request_logging_config ||= self.request_logging_config.clone
|
|
106
|
+
response_logging_config ||= self.response_logging_config.clone
|
|
107
|
+
|
|
108
|
+
LoggingConfiguration.new(logger: logger, log_level: log_level,
|
|
109
|
+
mask_sensitive_headers: mask_sensitive_headers,
|
|
110
|
+
request_logging_config: request_logging_config,
|
|
111
|
+
response_logging_config: response_logging_config)
|
|
112
|
+
end
|
|
113
|
+
end
|
|
114
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# fdx_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
module FdxApi
|
|
7
|
+
# Represents the generic logger facade
|
|
8
|
+
class AbstractLogger < Logger
|
|
9
|
+
# Logs a message with a specified log level and additional parameters.
|
|
10
|
+
# @param level [Symbol] The log level of the message.
|
|
11
|
+
# @param message [String] The message to log.
|
|
12
|
+
# @param params [Hash] Additional parameters to include in the log message.
|
|
13
|
+
def log(level, message, params)
|
|
14
|
+
raise NotImplementedError, 'This method needs to be implemented in a child class.'
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|